Package version
Creates an instance of SearchIndexClient.
Example usage:
const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchIndexClient(
"<endpoint>",
new AzureKeyCredential("<Admin Key>");
);The endpoint of the search service
Used to authenticate requests to the service.
Used to configure the Search Index client.
The API version to use when communicating with the service.
The endpoint of the search service
Calls an analyzer or tokenizer manually on provided text.
The name of the index that contains the field to analyze
Additional arguments
Creates a new index.
The information describing the index to be created.
Additional optional arguments.
Creates a new index or modifies an existing one.
The information describing the index to be created.
Additional optional arguments.
Creates a new SynonymMap or modifies an existing one.
The information describing the SynonymMap to be created.
Additional optional arguments.
Creates a new SynonymMap in a search service.
The synonymMap definition to create in a search service.
Additional optional arguments.
Deletes an existing index.
Additional optional arguments.
Deletes an existing SynonymMap.
Additional optional arguments.
Retrieves information about an index.
The name of the index.
Additional optional arguments.
Retrieves statistics about an index, such as the count of documents and the size of index storage.
The name of the index.
Additional optional arguments.
Retrieves the SearchClient corresponding to this SearchIndexClient
Name of the index
SearchClient Options
Retrieves statistics about the service, such as the count of documents, index, etc.
Additional optional arguments.
Retrieves information about a SynonymMap.
The name of the SynonymMap.
Additional optional arguments.
Retrieves a list of existing indexes in the service.
Options to the list index operation.
Retrieves a list of names of existing indexes in the service.
Options to the list index operation.
Retrieves a list of existing SynonymMaps in the service.
Options to the list SynonymMaps operation.
Retrieves a list of names of existing SynonymMaps in the service.
Options to the list SynonymMaps operation.
Generated using TypeDoc
Class to perform operations to manage (create, update, list/delete) indexes, & synonymmaps.