SearchIndexerClient class
Classe para executar operações para gerenciar indexadores (criar, atualizar, listar/excluir), fontes de dados & conjuntos de habilidades.
Construtores
Search |
Cria uma instância de SearchIndexerClient. Exemplo de uso:
|
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 |
service |
A versão da API a ser usada ao se comunicar com o serviço. |
Métodos
create |
Cria um novo dataSource em um serviço de pesquisa. |
create |
Cria um novo indexador em um serviço de pesquisa. |
create |
Cria uma nova fonte de dados ou modifica uma existente. |
create |
Cria um novo indexador ou modifica um existente. |
create |
Cria um conjunto de habilidades ou modifica um existente. |
create |
Cria um novo conjunto de habilidades em um serviço de pesquisa. |
delete |
Exclui uma fonte de dados existente. |
delete |
Exclui um indexador existente. |
delete |
Exclui um Conjunto de Habilidades existente. |
get |
Recupera informações sobre um DataSource |
get |
Recupera informações sobre um indexador. |
get |
Retorna o histórico de execução e do status atual de um indexador. |
get |
Recupera informações sobre um Conjunto de Habilidades. |
list |
Recupera uma lista de fontes de dados existentes no serviço. |
list |
Recupera uma lista de nomes de fontes de dados existentes no serviço. |
list |
Recupera uma lista de indexadores existentes no serviço. |
list |
Recupera uma lista de nomes de indexadores existentes no serviço. |
list |
Recupera uma lista de conjuntos de habilidades existentes no serviço. |
list |
Recupera uma lista de nomes de conjuntos de habilidades existentes no serviço. |
reset |
Redefine o estado de controle de alterações associado a um indexador. |
run |
Executa um indexador sob demanda. |
Detalhes do construtor
SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)
Cria uma instância de SearchIndexerClient.
Exemplo de uso:
const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchIndexerClient(
"<endpoint>",
new AzureKeyCredential("<Admin Key>");
);
new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)
Parâmetros
- endpoint
-
string
O ponto de extremidade do serviço de pesquisa
- credential
Usado para autenticar solicitações para o serviço.
- options
- SearchIndexerClientOptions
Usado para configurar o cliente 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
createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)
Cria um novo dataSource em um serviço de pesquisa.
function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Parâmetros
- dataSourceConnection
- SearchIndexerDataSourceConnection
A definição de dataSource a ser criada em um serviço de pesquisa.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerDataSourceConnection>
createIndexer(SearchIndexer, OperationOptions)
Cria um novo indexador em um serviço de pesquisa.
function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>
Parâmetros
- indexer
- SearchIndexer
A definição do indexador a ser criada em um serviço de pesquisa.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexer>
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)
Cria uma nova fonte de dados ou modifica uma existente.
function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>
Parâmetros
- dataSourceConnection
- SearchIndexerDataSourceConnection
As informações que descrevem a fonte de dados a ser criada/atualizada.
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerDataSourceConnection>
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)
Cria um novo indexador ou modifica um existente.
function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>
Parâmetros
- indexer
- SearchIndexer
As informações que descrevem o indexador a ser criado/atualizado.
- options
- CreateorUpdateIndexerOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexer>
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)
Cria um conjunto de habilidades ou modifica um existente.
function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>
Parâmetros
- skillset
- SearchIndexerSkillset
As informações que descrevem o índice a ser criado.
- options
- CreateOrUpdateSkillsetOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerSkillset>
createSkillset(SearchIndexerSkillset, OperationOptions)
Cria um novo conjunto de habilidades em um serviço de pesquisa.
function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>
Parâmetros
- skillset
- SearchIndexerSkillset
O conjunto de habilidades que contém uma ou mais habilidades a serem criadas em um serviço de pesquisa.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerSkillset>
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)
Exclui uma fonte de dados existente.
function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>
Parâmetros
- dataSourceConnection
-
string | SearchIndexerDataSourceConnection
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)
Exclui um indexador existente.
function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>
Parâmetros
- indexer
-
string | SearchIndexer
Indexador/Nome do indexador a ser excluído.
- options
- DeleteIndexerOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)
Exclui um Conjunto de Habilidades existente.
function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>
Parâmetros
- skillset
-
string | SearchIndexerSkillset
Conjunto de habilidades/nome do conjunto de habilidades a ser excluído.
- options
- DeleteSkillsetOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
getDataSourceConnection(string, OperationOptions)
Recupera informações sobre um DataSource
function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Parâmetros
- dataSourceConnectionName
-
string
- options
- OperationOptions
Argumentos opcionais adicionais
Retornos
Promise<SearchIndexerDataSourceConnection>
getIndexer(string, OperationOptions)
Recupera informações sobre um indexador.
function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>
Parâmetros
- indexerName
-
string
O nome do Indexador.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexer>
getIndexerStatus(string, OperationOptions)
Retorna o histórico de execução e do status atual de um indexador.
function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>
Parâmetros
- indexerName
-
string
o nome do indexador.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerStatus>
getSkillset(string, OperationOptions)
Recupera informações sobre um Conjunto de Habilidades.
function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>
Parâmetros
- skillsetName
-
string
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<SearchIndexerSkillset>
listDataSourceConnections(OperationOptions)
Recupera uma lista de fontes de dados existentes no serviço.
function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>
Parâmetros
- options
- OperationOptions
Opções para a operação de indexadores de lista.
Retornos
Promise<SearchIndexerDataSourceConnection[]>
listDataSourceConnectionsNames(OperationOptions)
Recupera uma lista de nomes de fontes de dados existentes no serviço.
function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>
Parâmetros
- options
- OperationOptions
Opções para a operação de indexadores de lista.
Retornos
Promise<string[]>
listIndexers(OperationOptions)
Recupera uma lista de indexadores existentes no serviço.
function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>
Parâmetros
- options
- OperationOptions
Opções para a operação de indexadores de lista.
Retornos
Promise<SearchIndexer[]>
listIndexersNames(OperationOptions)
Recupera uma lista de nomes de indexadores existentes no serviço.
function listIndexersNames(options?: OperationOptions): Promise<string[]>
Parâmetros
- options
- OperationOptions
Opções para a operação de indexadores de lista.
Retornos
Promise<string[]>
listSkillsets(OperationOptions)
Recupera uma lista de conjuntos de habilidades existentes no serviço.
function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>
Parâmetros
- options
- OperationOptions
Opções para a operação listar conjuntos de habilidades.
Retornos
Promise<SearchIndexerSkillset[]>
listSkillsetsNames(OperationOptions)
Recupera uma lista de nomes de conjuntos de habilidades existentes no serviço.
function listSkillsetsNames(options?: OperationOptions): Promise<string[]>
Parâmetros
- options
- OperationOptions
Opções para a operação listar conjuntos de habilidades.
Retornos
Promise<string[]>
resetIndexer(string, OperationOptions)
Redefine o estado de controle de alterações associado a um indexador.
function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Parâmetros
- indexerName
-
string
O nome do indexador a ser redefinido.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>
runIndexer(string, OperationOptions)
Executa um indexador sob demanda.
function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Parâmetros
- indexerName
-
string
O nome do indexador a ser executado.
- options
- OperationOptions
Argumentos opcionais adicionais.
Retornos
Promise<void>