SearchIndexClient class

Pacote:

@azure/search-documents

Classe para executar operações para gerenciar índices (criar, atualizar, listar/excluir) & sinônimos.

Construtores

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Cria uma instância de SearchIndexClient. Exemplo de uso: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Propriedades

apiVersion	A versão da API a ser usada ao se comunicar com o serviço.
endpoint	O ponto de extremidade do serviço de pesquisa
serviceVersion	A versão da API a ser usada ao se comunicar com o serviço.

Métodos

analyzeText(string, AnalyzeTextOptions)	Chama um analisador ou criador de tokens manualmente no texto fornecido.
createIndex(SearchIndex, OperationOptions)	Cria um novo índice.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Cria um novo índice ou modifica um existente.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Cria um novo SynonymMap ou modifica um existente.
createSynonymMap(SynonymMap, OperationOptions)	Cria um novo SynonymMap em um serviço de pesquisa.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Exclui um índice existente.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Exclui um SynonymMap existente.
getIndex(string, OperationOptions)	Recupera informações sobre um índice.
getIndexStatistics(string, OperationOptions)	Recupera estatísticas sobre um índice, como a contagem de documentos e o tamanho do armazenamento de índice.
getSearchClient<TModel>(string, SearchClientOptions)	Recupera o SearchClient correspondente a este SearchIndexClient
getServiceStatistics(OperationOptions)	Recupera estatísticas sobre o serviço, como a contagem de documentos, índice etc.
getSynonymMap(string, OperationOptions)	Recupera informações sobre um SynonymMap.
listIndexes(OperationOptions)	Recupera uma lista de índices existentes no serviço.
listIndexesNames(OperationOptions)	Recupera uma lista de nomes de índices existentes no serviço.
listSynonymMaps(OperationOptions)	Recupera uma lista de SynonymMaps existentes no serviço.
listSynonymMapsNames(OperationOptions)	Recupera uma lista de nomes de SynonymMaps existentes no serviço.

Detalhes do construtor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Cria uma instância de SearchIndexClient.

Exemplo de uso:

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

endpoint

string

O ponto de extremidade do serviço de pesquisa

credential

KeyCredential | TokenCredential

Usado para autenticar solicitações para o serviço.

options

SearchIndexClientOptions

Usado para configurar o cliente de Índice de Pesquisa.

Detalhes da propriedade

apiVersion

Aviso

Essa API foi preterida.

use {@Link serviceVersion} instead

A versão da API a ser usada ao se comunicar com o serviço.

apiVersion: string

Valor da propriedade

string

endpoint

O ponto de extremidade do serviço de pesquisa

endpoint: string

Valor da propriedade

string

serviceVersion

A versão da API a ser usada ao se comunicar com o serviço.

serviceVersion: string

Valor da propriedade

string

Detalhes do método

analyzeText(string, AnalyzeTextOptions)

Chama um analisador ou criador de tokens manualmente no texto fornecido.

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

Parâmetros

indexName

string

O nome do índice que contém o campo a ser analisado

options

AnalyzeTextOptions

Argumentos adicionais

Retornos

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Cria um novo índice.

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

Parâmetros

index

SearchIndex

As informações que descrevem o índice a ser criado.

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Cria um novo índice ou modifica um existente.

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

Parâmetros

index

SearchIndex

As informações que descrevem o índice a ser criado.

options

CreateOrUpdateIndexOptions

Argumentos opcionais adicionais.

Retornos

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Cria um novo SynonymMap ou modifica um existente.

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

Parâmetros

synonymMap

SynonymMap

As informações que descrevem o SynonymMap a ser criado.

options

CreateOrUpdateSynonymMapOptions

Argumentos opcionais adicionais.

Retornos

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Cria um novo SynonymMap em um serviço de pesquisa.

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

Parâmetros

synonymMap

SynonymMap

A definição de synonymMap a ser criada em um serviço de pesquisa.

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Exclui um índice existente.

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

Parâmetros

index

string | SearchIndex

options

DeleteIndexOptions

Argumentos opcionais adicionais.

Retornos

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Exclui um SynonymMap existente.

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

Parâmetros

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Argumentos opcionais adicionais.

Retornos

Promise<void>

getIndex(string, OperationOptions)

Recupera informações sobre um índice.

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

Parâmetros

indexName

string

O nome do índice.

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Recupera estatísticas sobre um índice, como a contagem de documentos e o tamanho do armazenamento de índice.

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

Parâmetros

indexName

string

O nome do índice.

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Recupera o SearchClient correspondente a este SearchIndexClient

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

Parâmetros

indexName

string

Nome do índice

options

SearchClientOptions

Opções do SearchClient

Retornos

SearchClient<TModel>

getServiceStatistics(OperationOptions)

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

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

Parâmetros

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Recupera informações sobre um SynonymMap.

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

Parâmetros

synonymMapName

string

O nome do SynonymMap.

options

OperationOptions

Argumentos opcionais adicionais.

Retornos

Promise<SynonymMap>

listIndexes(OperationOptions)

Recupera uma lista de índices existentes no serviço.

function listIndexes(options?: OperationOptions): IndexIterator

Parâmetros

options

OperationOptions

Opções para a operação de índice de lista.

Retornos

IndexIterator

listIndexesNames(OperationOptions)

Recupera uma lista de nomes de índices existentes no serviço.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parâmetros

options

OperationOptions

Opções para a operação de índice de lista.

Retornos

IndexNameIterator

listSynonymMaps(OperationOptions)

Recupera uma lista de SynonymMaps existentes no serviço.

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

Parâmetros

options

OperationOptions

Opções para a operação SynonymMaps de lista.

Retornos

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Recupera uma lista de nomes de SynonymMaps existentes no serviço.

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

Parâmetros

options

OperationOptions

Opções para a operação SynonymMaps de lista.

Retornos

Promise<string[]>