SearchIndexClient class

Cria uma instância de SearchIndexClient.

Uso de exemplo:

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

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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

Parâmetros

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

apiVersion: string

Valor da propriedade

O ponto de extremidade do serviço de pesquisa

endpoint: string

Valor da propriedade

Uma referência ao pipeline HTTP interno para uso com solicitações brutas

pipeline: Pipeline

Valor da propriedade

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

serviceVersion: string

Valor da propriedade

Chama um analisador ou tokenizador manualmente no texto fornecido.

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

Parâmetros

Retornos

Cria um novo alias de pesquisa.

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

Parâmetros

Retornos

Cria um novo índice.

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

Parâmetros

Retornos

Cria uma nova base de conhecimento.

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

Parâmetros

Retornos

Cria uma nova fonte de conhecimento.

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

Parâmetros

Retornos

Cria um novo alias de pesquisa ou atualiza um alias se ele já existir.

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

Parâmetros

Retornos

Cria um novo índice ou modifica um existente.

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

Parâmetros

Retornos

Cria uma nova base de conhecimento ou atualiza uma base de conhecimento se ela já existir.

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

Parâmetros

Retornos

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parâmetros

Retornos

Cria um novo SynonymMap ou modifica um existente.

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

Exclui um alias de pesquisa e seu mapeamento associado a um índice. Essa operação é permanente, sem nenhuma opção de recuperação. O índice mapeado é intocado por essa operação.

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

Parâmetros

Retornos

Exclui um alias de pesquisa e seu mapeamento associado a um índice. Essa operação é permanente, sem nenhuma opção de recuperação. O índice mapeado é intocado por essa operação.

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

Parâmetros

Retornos

Exclui um índice existente.

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

Parâmetros

Retornos

Exclui um índice existente.

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

Parâmetros

Retornos

Exclui uma base de dados de conhecimento existente.

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

Parâmetros

Retornos

Exclui uma base de dados de conhecimento existente.

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

Parâmetros

Retornos

Exclui uma fonte existente.

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

Parâmetros

Retornos

Exclui uma fonte existente.

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

Parâmetros

Retornos

Exclui um SynonymMap existente.

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

Parâmetros

Retornos

Recupera uma definição de alias.

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

Parâmetros

Retornos

Recupera informações sobre um índice.

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

Parâmetros

Retornos

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

Retornos

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

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parâmetros

Retornos

Recupera uma definição de base de conhecimento.

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

Parâmetros

Retornos

Recupera o KnowledgeRetrievalClient correspondente a este SearchIndexClient

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

Parâmetros

Retornos

Recupera uma definição de fonte de conhecimento.

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

Parâmetros

Retornos

Retorna o status atual e o histórico de sincronização de uma fonte de conhecimento.

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

Parâmetros

Retornos

Recupera o SearchClient correspondente a este SearchIndexClient

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos

Recupera informações sobre um SynonymMap.

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

Parâmetros

Retornos

Lista todos os aliases disponíveis para um serviço de pesquisa.

function listAliases(options?: OperationOptions): AliasIterator

Parâmetros

Retornos

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

function listIndexes(options?: OperationOptions): IndexIterator

Parâmetros

Retornos

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parâmetros

Retornos

Recupera uma lista das Bases de Conhecimento existentes no serviço.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parâmetros

Retornos

Recupera uma lista de KnowledgeSources existentes no serviço.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parâmetros

Retornos

Recupera uma lista de SynonymMaps existentes no serviço.

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

Parâmetros

Retornos

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

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

Parâmetros

Retornos