Class SearchIndexClient

constructor

• new SearchIndexClient(endpoint, credential, options?): SearchIndexClient

• Creates an instance of SearchIndexClient.

  Example usage:

  import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
  
  const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
  Copy

  Parameters

  • endpoint: string

    The endpoint of the search service
  • credential: any

    Used to authenticate requests to the service.
  • options: SearchIndexClientOptions = {}

    Used to configure the Search Index client.

  Returns SearchIndexClient

ReadonlyapiVersion

Readonlyendpoint

Readonlypipeline

ReadonlyserviceVersion

analyzeText

• analyzeText(indexName, options): Promise<AnalyzeResult>

• Calls an analyzer or tokenizer manually on provided text.

  Parameters

  • indexName: string

    The name of the index that contains the field to analyze
  • options: any

    Additional arguments

  Returns Promise<AnalyzeResult>

createAlias

• createAlias(alias, options?): Promise<SearchAlias>

• Creates a new search alias.

  Parameters

  • alias: SearchAlias

    The definition of the alias to create.
  • options: OperationOptions = {}

    The options parameters.

  Returns Promise<SearchAlias>

createIndex

• createIndex(index, options?): Promise<SearchIndex>

• Creates a new index.

  Parameters

  • index: SearchIndex

    The information describing the index to be created.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndex>

createKnowledgeBase

• createKnowledgeBase(knowledgeBase, options?): Promise<KnowledgeBase>

• Creates a new knowledgebase.

  Parameters

  • knowledgeBase: KnowledgeBase

    definition of the knowledgebase to create.
  • Optionaloptions: CreateKnowledgeBaseOptions

    options parameters.

  Returns Promise<KnowledgeBase>

createKnowledgeSource

• createKnowledgeSource(knowledgeSource, options?): Promise<KnowledgeSource>

• Creates a new knowledge source.

  Parameters

  • knowledgeSource: KnowledgeSource

    The definition of the knowledge source to create.
  • Optionaloptions: CreateKnowledgeSourceOptions

    The options parameters.

  Returns Promise<KnowledgeSource>

createOrUpdateAlias

• createOrUpdateAlias(alias, options?): Promise<SearchAlias>

• Creates a new search alias or updates an alias if it already exists.

  Parameters

  • alias: SearchAlias

    The definition of the alias to create or update.
  • options: CreateOrUpdateAliasOptions = {}

    The options parameters.

  Returns Promise<SearchAlias>

createOrUpdateIndex

• createOrUpdateIndex(index, options?): Promise<SearchIndex>

• Creates a new index or modifies an existing one.

  Parameters

  • index: SearchIndex

    The information describing the index to be created.
  • options: CreateOrUpdateIndexOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndex>

createOrUpdateKnowledgeBase

• createOrUpdateKnowledgeBase(knowledgeBaseName, knowledgeBase, options?): Promise<KnowledgeBase>

• Creates a new knowledge base or updates a knowledge base if it already exists.

  Parameters

  • knowledgeBaseName: string

    name of the knowledge base to create or update.
  • knowledgeBase: KnowledgeBase

    definition of the knowledge base to create or update.
  • Optionaloptions: CreateOrUpdateKnowledgeBaseOptions

    options parameters.

  Returns Promise<KnowledgeBase>

createOrUpdateKnowledgeSource

• createOrUpdateKnowledgeSource(sourceName, knowledgeSource, options?): Promise<KnowledgeSource>

• Parameters

  • sourceName: string
  • knowledgeSource: KnowledgeSource
  • Optionaloptions: CreateOrUpdateKnowledgeSourceOptions

  Returns Promise<KnowledgeSource>

createOrUpdateSynonymMap

• createOrUpdateSynonymMap(synonymMap, options?): Promise<SynonymMap>

• Creates a new SynonymMap or modifies an existing one.

  Parameters

  • synonymMap: SynonymMap

    The information describing the SynonymMap to be created.
  • options: CreateOrUpdateSynonymMapOptions = {}

    Additional optional arguments.

  Returns Promise<SynonymMap>

createSynonymMap

• createSynonymMap(synonymMap, options?): Promise<SynonymMap>

• Creates a new SynonymMap in a search service.

  Parameters

  • synonymMap: SynonymMap

    The synonymMap definition to create in a search service.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SynonymMap>

deleteAlias

• deleteAlias(aliasName, options?): Promise<void>

• Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

  Parameters

  • aliasName: string

    Name of the alias to delete.
  • Optionaloptions: DeleteAliasOptions

    Additional optional arguments.

  Returns Promise<void>
• deleteAlias(alias, options?): Promise<void>

• Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

  Parameters

  • alias: SearchAlias

    The alias to delete.
  • Optionaloptions: DeleteAliasOptions

    Additional optional arguments.

  Returns Promise<void>

deleteIndex

• deleteIndex(indexName, options?): Promise<void>

• Deletes an existing index.

  Parameters

  • indexName: string

    Name of the index to delete.
  • Optionaloptions: DeleteIndexOptions

    Additional optional arguments.

  Returns Promise<void>
• deleteIndex(index, options?): Promise<void>

• Deletes an existing index.

  Parameters

  • index: SearchIndex

    The index to delete.
  • Optionaloptions: DeleteIndexOptions

    Additional optional arguments.

  Returns Promise<void>

deleteKnowledgeBase

• deleteKnowledgeBase(knowledgeBaseName, options?): Promise<void>

• Deletes an existing knowledge base.

  Parameters

  • knowledgeBaseName: string

    name of the knowledge base to delete.
  • Optionaloptions: DeleteKnowledgeBaseOptions

    options parameters.

  Returns Promise<void>
• deleteKnowledgeBase(knowledgeBase, options?): Promise<void>

• Deletes an existing knowledge base.

  Parameters

  • knowledgeBase: KnowledgeBase

    the knowledge base to delete.
  • Optionaloptions: DeleteKnowledgeBaseOptions

    options parameters.

  Returns Promise<void>

deleteKnowledgeSource

• deleteKnowledgeSource(sourceName, options?): Promise<void>

• Deletes an existing source.

  Parameters

  • sourceName: string

    name of the knowledge source to delete.
  • Optionaloptions: DeleteKnowledgeSourceOptions

    options parameters.

  Returns Promise<void>
• deleteKnowledgeSource(source, options?): Promise<void>

• Deletes an existing source.

  Parameters

  • source: KnowledgeSource

    the knowledge source to delete.
  • Optionaloptions: DeleteKnowledgeSourceOptions

    options parameters.

  Returns Promise<void>

deleteSynonymMap

• deleteSynonymMap(synonymMap, options?): Promise<void>

• Deletes an existing SynonymMap.

  Parameters

  • synonymMap: string | SynonymMap
  • options: DeleteSynonymMapOptions = {}

    Additional optional arguments.

  Returns Promise<void>

getAlias

• getAlias(aliasName, options?): Promise<SearchAlias>

• Retrieves an alias definition.

  Parameters

  • aliasName: string

    The name of the alias to retrieve.
  • options: OperationOptions = {}

    The options parameters.

  Returns Promise<SearchAlias>

getIndex

• getIndex(indexName, options?): Promise<SearchIndex>

• Retrieves information about an index.

  Parameters

  • indexName: string

    The name of the index.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndex>

getIndexStatistics

• getIndexStatistics(indexName, options?): Promise<SearchIndexStatistics>

• Retrieves statistics about an index, such as the count of documents and the size of index storage.

  Parameters

  • indexName: string

    The name of the index.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchIndexStatistics>

getIndexStatsSummary

• getIndexStatsSummary(options?): PagedAsyncIterableIterator<IndexStatisticsSummary, IndexStatisticsSummary[], {}>

• Retrieves a list of existing indexes in the service.

  Parameters

  • options: GetIndexStatsSummaryOptions = {}

    Options to the list index operation.

  Returns PagedAsyncIterableIterator<IndexStatisticsSummary, IndexStatisticsSummary[], {}>

getKnowledgeBase

• getKnowledgeBase(knowledgeBaseName, options?): Promise<KnowledgeBase>

• Retrieves a knowledge base definition.

  Parameters

  • knowledgeBaseName: string

    name of the knowledge base to retrieve.
  • Optionaloptions: GetKnowledgeBaseOptions

    options parameters.

  Returns Promise<KnowledgeBase>

getKnowledgeRetrievalClient

• getKnowledgeRetrievalClient(knowledgeBaseName, options?): KnowledgeRetrievalClient

• Retrieves the KnowledgeRetrievalClient corresponding to this SearchIndexClient

  Parameters

  • knowledgeBaseName: string

    Name of the knowledge base
  • Optionaloptions: KnowledgeRetrievalClientOptions

    KnowledgeRetrievalClient Options

  Returns KnowledgeRetrievalClient

getKnowledgeSource

• getKnowledgeSource(sourceName, options?): Promise<KnowledgeSource>

• Retrieves a knowledge source definition.

  Parameters

  • sourceName: string

    The name of the knowledge source to retrieve.
  • Optionaloptions: GetKnowledgeSourceOptions

    The options parameters.

  Returns Promise<KnowledgeSource>

getKnowledgeSourceStatus

• getKnowledgeSourceStatus(sourceName, options?): Promise<KnowledgeSourceStatus>

• Returns the current status and synchronization history of a knowledge source.

  Parameters

  • sourceName: string

    The name of the knowledge source for which to retrieve status.
  • Optionaloptions: GetKnowledgeSourceStatusOptions

    The options parameters.

  Returns Promise<KnowledgeSourceStatus>

getSearchClient

• getSearchClient<TModel>(indexName, options?): SearchClient<TModel>

• Retrieves the SearchClient corresponding to this SearchIndexClient

  Type Parameters

  • TModel extends object

    An optional type that represents the documents stored in the search index. For the best typing experience, all non-key fields should be marked optional and nullable, and the key property should have the non-nullable type string.

  Parameters

  • indexName: string

    Name of the index
  • Optionaloptions: SearchClientOptions

    SearchClient Options

  Returns SearchClient<TModel>

getServiceStatistics

• getServiceStatistics(options?): Promise<SearchServiceStatistics>

• Retrieves statistics about the service, such as the count of documents, index, etc.

  Parameters

  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SearchServiceStatistics>

getSynonymMap

• getSynonymMap(synonymMapName, options?): Promise<SynonymMap>

• Retrieves information about a SynonymMap.

  Parameters

  • synonymMapName: string

    The name of the SynonymMap.
  • options: OperationOptions = {}

    Additional optional arguments.

  Returns Promise<SynonymMap>

listAliases

• listAliases(options?): PagedAsyncIterableIterator<SearchAlias, SearchAlias[], {}>

• Lists all aliases available for a search service.

  Parameters

  • options: OperationOptions = {}

    The options parameters.

  Returns PagedAsyncIterableIterator<SearchAlias, SearchAlias[], {}>

listIndexes

• listIndexes(options?): PagedAsyncIterableIterator<SearchIndex, SearchIndex[], {}>

• Retrieves a list of existing indexes in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list index operation.

  Returns PagedAsyncIterableIterator<SearchIndex, SearchIndex[], {}>

listIndexesNames

• listIndexesNames(options?): PagedAsyncIterableIterator<string, string[], {}>

• Retrieves a list of names of existing indexes in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list index operation.

  Returns PagedAsyncIterableIterator<string, string[], {}>

listKnowledgeBases

• listKnowledgeBases(options?): PagedAsyncIterableIterator<KnowledgeBase, KnowledgeBase[], {}>

• Retrieves a list of existing KnowledgeBases in the service.

  Parameters

  • options: ListKnowledgeBasesOptions = {}

    Options to the list knowledge bases operation.

  Returns PagedAsyncIterableIterator<KnowledgeBase, KnowledgeBase[], {}>

listKnowledgeSources

• listKnowledgeSources(options?): PagedAsyncIterableIterator<KnowledgeSource, KnowledgeSource[], {}>

• Retrieves a list of existing KnowledgeSources in the service.

  Parameters

  • options: ListKnowledgeSourcesOptions = {}

    Options to the list knowledge sources operation.

  Returns PagedAsyncIterableIterator<KnowledgeSource, KnowledgeSource[], {}>

listSynonymMaps

• listSynonymMaps(options?): Promise<SynonymMap[]>

• Retrieves a list of existing SynonymMaps in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list SynonymMaps operation.

  Returns Promise<SynonymMap[]>

listSynonymMapsNames

• listSynonymMapsNames(options?): Promise<string[]>

• Retrieves a list of names of existing SynonymMaps in the service.

  Parameters

  • options: OperationOptions = {}

    Options to the list SynonymMaps operation.

  Returns Promise<string[]>