SearchIndexClient class

Creates an instance of SearchIndexClient.

Example usage:

import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";

const indexClient = new SearchIndexClient("", new AzureKeyCredential(""));

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

Parameters

The API version to use when communicating with the service.

apiVersion: string

Property Value

The endpoint of the search service

endpoint: string

Property Value

A reference to the internal HTTP pipeline for use with raw requests

pipeline: Pipeline

Property Value

The API version to use when communicating with the service.

serviceVersion: string

Property Value

Calls an analyzer or tokenizer manually on provided text.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise

Parameters

Returns

Creates a new search alias.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise

Parameters

Returns

Creates a new index.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise

Parameters

Returns

Creates a new knowledgebase.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise

Parameters

Returns

Creates a new knowledge source.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise

Parameters

Returns

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

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise

Parameters

Returns

Creates a new index or modifies an existing one.

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise

Parameters

Returns

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

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise

Parameters

Returns

function createOrUpdateKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise

Parameters

Returns

Creates a new SynonymMap or modifies an existing one.

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise

Parameters

Returns

Creates a new SynonymMap in a search service.

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise

Parameters

Returns

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.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise

Parameters

Returns

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.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise

Parameters

Returns

Deletes an existing index.

function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise

Parameters

Returns

Deletes an existing index.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise

Parameters

Returns

Deletes an existing knowledge base.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise

Parameters

Returns

Deletes an existing knowledge base.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise

Parameters

Returns

Deletes an existing source.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise

Parameters

Returns

Deletes an existing source.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise

Parameters

Returns

Deletes an existing SynonymMap.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise

Parameters

Returns

Retrieves an alias definition.

function getAlias(aliasName: string, options?: OperationOptions): Promise

Parameters

Returns

Retrieves information about an index.

function getIndex(indexName: string, options?: OperationOptions): Promise

Parameters

Returns

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

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise

Parameters

Returns

Retrieves a knowledge base definition.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise

Parameters

Returns

Retrieves the KnowledgeRetrievalClient corresponding to this SearchIndexClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Parameters

Returns

Retrieves a knowledge source definition.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise

Parameters

Returns

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

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise

Parameters

Returns

Retrieves the SearchClient corresponding to this SearchIndexClient

function getSearchClient(indexName: string, options?: SearchClientOptions): SearchClient

Parameters

Returns

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

function getServiceStatistics(options?: OperationOptions): Promise

Parameters

Returns

Retrieves information about a SynonymMap.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise

Parameters

Returns

Lists all aliases available for a search service.

function listAliases(options?: OperationOptions): AliasIterator

Parameters

Returns

Retrieves a list of existing indexes in the service.

function listIndexes(options?: OperationOptions): IndexIterator

Parameters

Returns

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parameters

Returns

Retrieves a list of existing KnowledgeBases in the service.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parameters

Returns

Retrieves a list of existing KnowledgeSources in the service.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parameters

Returns

Retrieves a list of existing SynonymMaps in the service.

function listSynonymMaps(options?: OperationOptions): Promise

Parameters

Returns

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

function listSynonymMapsNames(options?: OperationOptions): Promise

Parameters

Returns