SearchIndexClient class
Classe para executar operações para gerenciar índices (criar, atualizar, listar/excluir), & sinônimos.
Construtores
| Search |
Cria uma instância de SearchIndexClient. Uso de exemplo: |
Propriedades
| api |
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 |
| pipeline | Uma referência ao pipeline HTTP interno para uso com solicitações brutas |
| service |
A versão da API a ser usada ao se comunicar com o serviço. |
Métodos
| analyze |
Chama um analisador ou tokenizador manualmente no texto fornecido. |
| create |
Cria um novo alias de pesquisa. |
| create |
Cria um novo índice. |
| create |
Cria uma nova base de conhecimento. |
| create |
Cria uma nova fonte de conhecimento. |
| create |
Cria um novo alias de pesquisa ou atualiza um alias se ele já existir. |
| create |
Cria um novo índice ou modifica um existente. |
| create |
Cria uma nova base de conhecimento ou atualiza uma base de conhecimento se ela já existir. |
| create |
|
| create |
Cria um novo SynonymMap ou modifica um existente. |
| create |
Cria um novo SynonymMap em um serviço de pesquisa. |
| delete |
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. |
| delete |
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. |
| delete |
Exclui um índice existente. |
| delete |
Exclui um índice existente. |
| delete |
Exclui uma base de dados de conhecimento existente. |
| delete |
Exclui uma base de dados de conhecimento existente. |
| delete |
Exclui uma fonte existente. |
| delete |
Exclui uma fonte existente. |
| delete |
Exclui um SynonymMap existente. |
| get |
Recupera uma definição de alias. |
| get |
Recupera informações sobre um índice. |
| get |
Recupera estatísticas sobre um índice, como a contagem de documentos e o tamanho do armazenamento de índice. |
| get |
Recupera uma lista de índices existentes no serviço. |
| get |
Recupera uma definição de base de conhecimento. |
| get |
Recupera o KnowledgeRetrievalClient correspondente a este SearchIndexClient |
| get |
Recupera uma definição de fonte de conhecimento. |
| get |
Retorna o status atual e o histórico de sincronização de uma fonte de conhecimento. |
| get |
Recupera o SearchClient correspondente a este SearchIndexClient |
| get |
Recupera estatísticas sobre o serviço, como a contagem de documentos, índice etc. |
| get |
Recupera informações sobre um SynonymMap. |
| list |
Lista todos os aliases disponíveis para um serviço de pesquisa. |
| list |
Recupera uma lista de índices existentes no serviço. |
| list |
Recupera uma lista de nomes de índices existentes no serviço. |
| list |
Recupera uma lista das Bases de Conhecimento existentes no serviço. |
| list |
Recupera uma lista de KnowledgeSources existentes no serviço. |
| list |
Recupera uma lista de SynonymMaps existentes no serviço. |
| list |
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.
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
- endpoint
-
string
O ponto de extremidade do serviço de pesquisa
- credential
Usado para autenticar solicitações no 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: stringValor da propriedade
string
endpoint
O ponto de extremidade do serviço de pesquisa
endpoint: stringValor da propriedade
string
pipeline
Uma referência ao pipeline HTTP interno para uso com solicitações brutas
pipeline: PipelineValor da propriedade
serviceVersion
A versão da API a ser usada ao se comunicar com o serviço.
serviceVersion: stringValor da propriedade
string
Detalhes do método
analyzeText(string, AnalyzeTextOptions)
Chama um analisador ou tokenizador 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>
createAlias(SearchAlias, OperationOptions)
Cria um novo alias de pesquisa.
function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>Parâmetros
- alias
- SearchAlias
A definição do alias a ser criado.
- options
- OperationOptions
Os parâmetros de opções.
Retornos
Promise<SearchAlias>
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>
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)
Cria uma nova base de conhecimento.
function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>Parâmetros
- knowledgeBase
- KnowledgeBase
Definição da base de conhecimento a ser criada.
- options
- CreateKnowledgeBaseOptions
parâmetros de opções.
Retornos
Promise<KnowledgeBase>
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)
Cria uma nova fonte de conhecimento.
function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>Parâmetros
- knowledgeSource
- KnowledgeSource
A definição da fonte de conhecimento a ser criada.
- options
- CreateKnowledgeSourceOptions
Os parâmetros de opções.
Retornos
Promise<KnowledgeSource>
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)
Cria um novo alias de pesquisa ou atualiza um alias se ele já existir.
function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>Parâmetros
- alias
- SearchAlias
A definição do alias a ser criado ou atualizado.
- options
- CreateOrUpdateAliasOptions
Os parâmetros de opções.
Retornos
Promise<SearchAlias>
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>
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)
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
- knowledgeBaseName
-
string
Nome da base de conhecimento para criar ou atualizar.
- knowledgeBase
- KnowledgeBase
Definição da base de conhecimento a ser criada ou atualizada.
parâmetros de opções.
Retornos
Promise<KnowledgeBase>
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>Parâmetros
- sourceName
-
string
- knowledgeSource
- KnowledgeSource
Retornos
Promise<KnowledgeSource>
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>
deleteAlias(SearchAlias, DeleteAliasOptions)
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
- alias
- SearchAlias
O alias a ser excluído.
- options
- DeleteAliasOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteAlias(string, DeleteAliasOptions)
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
- aliasName
-
string
Nome do alias a ser excluído.
- options
- DeleteAliasOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteIndex(SearchIndex, DeleteIndexOptions)
Exclui um índice existente.
function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>Parâmetros
- index
- SearchIndex
O índice a ser excluído.
- options
- DeleteIndexOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteIndex(string, DeleteIndexOptions)
Exclui um índice existente.
function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>Parâmetros
- indexName
-
string
Nome do índice a ser excluído.
- options
- DeleteIndexOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)
Exclui uma base de dados de conhecimento existente.
function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>Parâmetros
- knowledgeBase
- KnowledgeBase
A base de conhecimento para deletar.
- options
- DeleteKnowledgeBaseOptions
parâmetros de opções.
Retornos
Promise<void>
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)
Exclui uma base de dados de conhecimento existente.
function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>Parâmetros
- knowledgeBaseName
-
string
Nome da base de conhecimento para deletar.
- options
- DeleteKnowledgeBaseOptions
parâmetros de opções.
Retornos
Promise<void>
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)
Exclui uma fonte existente.
function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>Parâmetros
- source
- KnowledgeSource
a fonte de conhecimento a ser excluída.
- options
- DeleteKnowledgeSourceOptions
parâmetros de opções.
Retornos
Promise<void>
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)
Exclui uma fonte existente.
function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>Parâmetros
- sourceName
-
string
Nome da fonte de conhecimento a ser excluída.
- options
- DeleteKnowledgeSourceOptions
parâmetros de opções.
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>
getAlias(string, OperationOptions)
Recupera uma definição de alias.
function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>Parâmetros
- aliasName
-
string
O nome do alias a ser recuperado.
- options
- OperationOptions
Os parâmetros de opções.
Retornos
Promise<SearchAlias>
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>
getIndexStatsSummary(GetIndexStatsSummaryOptions)
Recupera uma lista de índices existentes no serviço.
function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIteratorParâmetros
- options
- GetIndexStatsSummaryOptions
Opções para a operação de índice de lista.
Retornos
getKnowledgeBase(string, GetKnowledgeBaseOptions)
Recupera uma definição de base de conhecimento.
function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>Parâmetros
- knowledgeBaseName
-
string
Nome da base de conhecimento para recuperar.
- options
- GetKnowledgeBaseOptions
parâmetros de opções.
Retornos
Promise<KnowledgeBase>
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)
Recupera o KnowledgeRetrievalClient correspondente a este SearchIndexClient
function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClientParâmetros
- knowledgeBaseName
-
string
Nome da base de conhecimento
- options
- KnowledgeRetrievalClientOptions
Opções do KnowledgeRetrievalClient
Retornos
getKnowledgeSource(string, GetKnowledgeSourceOptions)
Recupera uma definição de fonte de conhecimento.
function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>Parâmetros
- sourceName
-
string
O nome da fonte de conhecimento a ser recuperada.
- options
- GetKnowledgeSourceOptions
Os parâmetros de opções.
Retornos
Promise<KnowledgeSource>
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)
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
- sourceName
-
string
O nome da fonte de conhecimento para a qual recuperar o status.
- options
- GetKnowledgeSourceStatusOptions
Os parâmetros de opções.
Retornos
Promise<KnowledgeSourceStatus>
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>
listAliases(OperationOptions)
Lista todos os aliases disponíveis para um serviço de pesquisa.
function listAliases(options?: OperationOptions): AliasIteratorParâmetros
- options
- OperationOptions
Os parâmetros de opções.
Retornos
listIndexes(OperationOptions)
Recupera uma lista de índices existentes no serviço.
function listIndexes(options?: OperationOptions): IndexIteratorParâmetros
- options
- OperationOptions
Opções para a operação de índice de lista.
Retornos
listIndexesNames(OperationOptions)
Recupera uma lista de nomes de índices existentes no serviço.
function listIndexesNames(options?: OperationOptions): IndexNameIteratorParâmetros
- options
- OperationOptions
Opções para a operação de índice de lista.
Retornos
listKnowledgeBases(ListKnowledgeBasesOptions)
Recupera uma lista das Bases de Conhecimento existentes no serviço.
function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIteratorParâmetros
- options
- ListKnowledgeBasesOptions
Opções para a operação da base de conhecimento da lista.
Retornos
listKnowledgeSources(ListKnowledgeSourcesOptions)
Recupera uma lista de KnowledgeSources existentes no serviço.
function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIteratorParâmetros
- options
- ListKnowledgeSourcesOptions
Opções para a operação listar fontes de conhecimento.
Retornos
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[]>
