Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Documents

Package version

Class representing a Documents.

Hierarchy

  • Documents

Index

Constructors

constructor

  • new Documents(client: SearchClient): Documents

Methods

autocompleteGet

autocompletePost

count

get

index

searchGet

searchPost

suggestGet

  • Suggests documents in the index that match the given partial query text.

    Parameters

    • searchText: string

      The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.

    • suggesterName: string

      The name of the suggester as specified in the suggesters collection that's part of the index definition.

    • Optional options: DocumentsSuggestGetOptionalParams

      The options parameters.

    Returns Promise<DocumentsSuggestGetResponse>

suggestPost

Generated using TypeDoc