SearchIndexClient class

Cria uma instância de SearchIndexClient.

Utilização de exemplo:

const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

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

Parâmetros

A versão da API a utilizar ao comunicar com o serviço.

apiVersion: string

Valor de Propriedade

O ponto final do serviço de pesquisa

endpoint: string

Valor de Propriedade

A versão da API a utilizar ao comunicar com o serviço.

serviceVersion: string

Valor de Propriedade

Chama manualmente um analisador ou tokenizer no texto fornecido.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

Parâmetros

Devoluções

Cria um novo índice.

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

Parâmetros

Devoluções

Cria um novo índice ou modifica um existente.

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

Parâmetros

Devoluções

Cria um novo SynonymMap ou modifica um existente.

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

Parâmetros

Devoluções

Cria um novo SynonymMap num serviço de pesquisa.

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

Parâmetros

Devoluções

Elimina um índice existente.

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>

Parâmetros

Devoluções

Elimina um SynonymMap existente.

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

Parâmetros

Devoluções

Obtém informações sobre um índice.

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

Parâmetros

Devoluções

Obtém estatísticas sobre um índice, como a contagem de documentos e o tamanho do armazenamento de índices.

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

Parâmetros

Devoluções

Obtém o SearchClient correspondente a este SearchIndexClient

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

Parâmetros

Devoluções

Obtém estatísticas sobre o serviço, como a contagem de documentos, índice, etc.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

Parâmetros

Devoluções

Obtém informações sobre um SynonymMap.

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

Parâmetros

Devoluções

Obtém uma lista de índices existentes no serviço.

function listIndexes(options?: OperationOptions): IndexIterator

Parâmetros

Devoluções

Obtém uma lista de nomes de índices existentes no serviço.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parâmetros

Devoluções

Obtém uma lista de SynonymMaps existentes no serviço.

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

Parâmetros

Devoluções

Obtém uma lista de nomes de SynonymMaps existentes no serviço.

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

Parâmetros

Devoluções