SearchIndexClient class

Pacote:

@azure/search-documents

Classe a executar operações para gerir (criar, atualizar, listar/eliminar) índices, & sinónimos.

Construtores

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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>"); );

Propriedades

apiVersion	A versão da API a utilizar ao comunicar com o serviço.
endpoint	O ponto final do serviço de pesquisa
serviceVersion	A versão da API a utilizar ao comunicar com o serviço.

Métodos

analyzeText(string, AnalyzeTextOptions)	Chama manualmente um analisador ou tokenizer 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 num serviço de pesquisa.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Elimina um índice existente.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Elimina um SynonymMap existente.
getIndex(string, OperationOptions)	Obtém informações sobre um índice.
getIndexStatistics(string, OperationOptions)	Obtém estatísticas sobre um índice, como a contagem de documentos e o tamanho do armazenamento de índices.
getSearchClient<TModel>(string, SearchClientOptions)	Obtém o SearchClient correspondente a este SearchIndexClient
getServiceStatistics(OperationOptions)	Obtém estatísticas sobre o serviço, como a contagem de documentos, índice, etc.
getSynonymMap(string, OperationOptions)	Obtém informações sobre um SynonymMap.
listIndexes(OperationOptions)	Obtém uma lista de índices existentes no serviço.
listIndexesNames(OperationOptions)	Obtém uma lista de nomes de índices existentes no serviço.
listSynonymMaps(OperationOptions)	Obtém uma lista de SynonymMaps existentes no serviço.
listSynonymMapsNames(OperationOptions)	Obtém uma lista de nomes de SynonymMaps existentes no serviço.

Detalhes do Construtor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

endpoint

string

O ponto final do serviço de pesquisa

credential

KeyCredential | TokenCredential

Utilizado para autenticar pedidos para o serviço.

options

SearchIndexClientOptions

Utilizado para configurar o cliente do Índice de Pesquisa.

Detalhes de Propriedade

apiVersion

Aviso

Esta API foi preterida.

use {@Link serviceVersion} instead

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

apiVersion: string

Valor de Propriedade

string

endpoint

O ponto final do serviço de pesquisa

endpoint: string

Valor de Propriedade

string

serviceVersion

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

serviceVersion: string

Valor de Propriedade

string

Detalhes de Método

analyzeText(string, AnalyzeTextOptions)

Chama manualmente um analisador ou tokenizer 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 analisar

options

AnalyzeTextOptions

Argumentos adicionais

Devoluções

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.

Devoluções

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.

Devoluções

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.

Devoluções

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Cria um novo SynonymMap num serviço de pesquisa.

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

Parâmetros

synonymMap

SynonymMap

A definição de sinónimoMap a criar num serviço de pesquisa.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Elimina um índice existente.

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

Parâmetros

index

string | SearchIndex

options

DeleteIndexOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Elimina um SynonymMap existente.

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

Parâmetros

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

getIndex(string, OperationOptions)

Obtém 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.

Devoluções

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

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

indexName

string

O nome do índice.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Obtém 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 searchClient

Devoluções

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Obtém 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.

Devoluções

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Obtém 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.

Devoluções

Promise<SynonymMap>

listIndexes(OperationOptions)

Obtém 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.

Devoluções

IndexIterator

listIndexesNames(OperationOptions)

Obtém 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.

Devoluções

IndexNameIterator

listSynonymMaps(OperationOptions)

Obtém 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 da lista.

Devoluções

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

Obtém 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 da lista.

Devoluções

Promise<string[]>