SearchIndexerClient class

Pacote:

@azure/search-documents

Classe para realizar operações para gerir indexadores (criar, atualizar, listar/eliminar), origens de dados & conjuntos de competências.

Construtores

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Cria uma instância de SearchIndexerClient. Utilização de exemplo: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Cria um novo dataSource num serviço de pesquisa.
createIndexer(SearchIndexer, OperationOptions)	Cria um novo indexador num serviço de pesquisa.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Cria uma nova origem de dados ou modifica uma existente.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Cria um novo indexador ou modifica um existente.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Cria um novo Conjunto de Competências ou modifica um existente.
createSkillset(SearchIndexerSkillset, OperationOptions)	Cria um novo conjunto de competências num serviço de pesquisa.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Elimina uma origem de dados existente.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Elimina um indexador existente.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Elimina um Conjunto de Competências existente.
getDataSourceConnection(string, OperationOptions)	Obtém informações sobre uma Origem de Dados
getIndexer(string, OperationOptions)	Obtém informações sobre um Indexador.
getIndexerStatus(string, OperationOptions)	Devolve o estado atual e o histórico de execução de um indexador.
getSkillset(string, OperationOptions)	Obtém informações sobre um Conjunto de Competências.
listDataSourceConnections(OperationOptions)	Obtém uma lista de origens de dados existentes no serviço.
listDataSourceConnectionsNames(OperationOptions)	Obtém uma lista de nomes de origens de dados existentes no serviço.
listIndexers(OperationOptions)	Obtém uma lista de indexadores existentes no serviço.
listIndexersNames(OperationOptions)	Obtém uma lista de nomes de indexadores existentes no serviço.
listSkillsets(OperationOptions)	Obtém uma lista de Conjuntos de Competências existentes no serviço.
listSkillsetsNames(OperationOptions)	Obtém uma lista de nomes de Conjuntos de Competências existentes no serviço.
resetIndexer(string, OperationOptions)	Repõe o estado de controlo de alterações associado a um indexador.
runIndexer(string, OperationOptions)	Executa um indexador a pedido.

Detalhes do Construtor

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Cria uma instância de SearchIndexerClient.

Utilização de exemplo:

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 final do serviço de pesquisa

credential

KeyCredential | TokenCredential

Utilizado para autenticar pedidos para o serviço.

options

SearchIndexerClientOptions

Utilizado para configurar o cliente 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

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Cria um novo dataSource num serviço de pesquisa.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parâmetros

dataSourceConnection

SearchIndexerDataSourceConnection

A definição dataSource a criar num serviço de pesquisa.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Cria um novo indexador num serviço de pesquisa.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parâmetros

indexer

SearchIndexer

A definição do indexador a criar num serviço de pesquisa.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Cria uma nova origem de dados ou modifica uma existente.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parâmetros

dataSourceConnection

SearchIndexerDataSourceConnection

As informações que descrevem a origem de dados a criar/atualizar.

options

CreateorUpdateDataSourceConnectionOptions

Argumentos opcionais adicionais.

Devoluções

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 criar/atualizar.

options

CreateorUpdateIndexerOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Cria um novo Conjunto de Competências ou modifica um existente.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parâmetros

skillset

SearchIndexerSkillset

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

options

CreateOrUpdateSkillsetOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Cria um novo conjunto de competências num serviço de pesquisa.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parâmetros

skillset

SearchIndexerSkillset

O conjunto de competências que contém uma ou mais competências para criar num serviço de pesquisa.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Elimina uma origem de dados existente.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parâmetros

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Elimina um indexador existente.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parâmetros

indexer

string | SearchIndexer

Indexador/Nome do indexador a eliminar.

options

DeleteIndexerOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Elimina um Conjunto de Competências existente.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parâmetros

skillset

string | SearchIndexerSkillset

Conjunto de competências/Nome do Conjunto de Competências a eliminar.

options

DeleteSkillsetOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

getDataSourceConnection(string, OperationOptions)

Obtém informações sobre uma Origem de Dados

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parâmetros

dataSourceConnectionName

string

options

OperationOptions

Argumentos opcionais adicionais

Devoluções

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

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

Devoluções

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Devolve o estado atual e o histórico de execução de um indexador.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parâmetros

indexerName

string

O nome do indexador.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Obtém informações sobre um Conjunto de Competências.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parâmetros

skillsetName

string

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Obtém uma lista de origens 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.

Devoluções

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Obtém uma lista de nomes de origens 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.

Devoluções

Promise<string[]>

listIndexers(OperationOptions)

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

Devoluções

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

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

Devoluções

Promise<string[]>

listSkillsets(OperationOptions)

Obtém uma lista de Conjuntos de Competências existentes no serviço.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parâmetros

options

OperationOptions

Opções para a operação lista conjuntos de competências.

Devoluções

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Obtém uma lista de nomes de Conjuntos de Competências existentes no serviço.

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

Parâmetros

options

OperationOptions

Opções para a operação lista conjuntos de competências.

Devoluções

Promise<string[]>

resetIndexer(string, OperationOptions)

Repõe o estado de controlo de alterações associado a um indexador.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parâmetros

indexerName

string

O nome do indexador a repor.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>

runIndexer(string, OperationOptions)

Executa um indexador a pedido.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parâmetros

indexerName

string

O nome do indexador a executar.

options

OperationOptions

Argumentos opcionais adicionais.

Devoluções

Promise<void>