Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Documents

Package version

Class representing a Documents.

Hierarchy

  • Documents

Index

Constructors

constructor

Methods

autocompleteGet

  • autocompleteGet(searchText: string, suggesterName: string, options?: Models.DocumentsAutocompleteGetOptionalParams): Promise<Models.DocumentsAutocompleteGetResponse>
  • autocompleteGet(searchText: string, suggesterName: string, callback: coreHttp.ServiceCallback<AutocompleteResult>): void
  • autocompleteGet(searchText: string, suggesterName: string, options: DocumentsAutocompleteGetOptionalParams, callback: coreHttp.ServiceCallback<AutocompleteResult>): void
  • Autocompletes incomplete query terms based on input text and matching terms in the index.

    Parameters

    • searchText: string

      The incomplete term which should be auto-completed.

    • suggesterName: string

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

    • Optional options: Models.DocumentsAutocompleteGetOptionalParams

    Returns Promise<Models.DocumentsAutocompleteGetResponse>

    Promise<Models.DocumentsAutocompleteGetResponse>

  • Parameters

    • searchText: string

      The incomplete term which should be auto-completed.

    • suggesterName: string

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

    • callback: coreHttp.ServiceCallback<AutocompleteResult>

      The callback

    Returns void

  • Parameters

    • searchText: string

      The incomplete term which should be auto-completed.

    • suggesterName: string

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

    • options: DocumentsAutocompleteGetOptionalParams

      The optional parameters

    • callback: coreHttp.ServiceCallback<AutocompleteResult>

      The callback

    Returns void

autocompletePost

count

  • count(options?: coreHttp.RequestOptionsBase): Promise<Models.DocumentsCountResponse>
  • count(callback: coreHttp.ServiceCallback<number>): void
  • count(options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<number>): void

get

  • get(key: string, options?: Models.DocumentsGetOptionalParams): Promise<Models.DocumentsGetResponse>
  • get(key: string, callback: coreHttp.ServiceCallback<any>): void
  • get(key: string, options: DocumentsGetOptionalParams, callback: coreHttp.ServiceCallback<any>): void

index

searchGet

searchPost

suggestGet

  • suggestGet(searchText: string, suggesterName: string, options?: Models.DocumentsSuggestGetOptionalParams): Promise<Models.DocumentsSuggestGetResponse>
  • suggestGet(searchText: string, suggesterName: string, callback: coreHttp.ServiceCallback<SuggestDocumentsResult>): void
  • suggestGet(searchText: string, suggesterName: string, options: DocumentsSuggestGetOptionalParams, callback: coreHttp.ServiceCallback<SuggestDocumentsResult>): void
  • 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: Models.DocumentsSuggestGetOptionalParams

    Returns Promise<Models.DocumentsSuggestGetResponse>

    Promise<Models.DocumentsSuggestGetResponse>

  • 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.

    • callback: coreHttp.ServiceCallback<SuggestDocumentsResult>

      The callback

    Returns void

  • 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.

    • options: DocumentsSuggestGetOptionalParams

      The optional parameters

    • callback: coreHttp.ServiceCallback<SuggestDocumentsResult>

      The callback

    Returns void

suggestPost

Generated using TypeDoc