SearchIndexerClient class

Paquete:

@azure/search-documents

Clase para realizar operaciones para administrar indexadores (crear, actualizar, enumerar y eliminar), orígenes de datos & conjuntos de aptitudes.

Constructores

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Crea una instancia de SearchIndexerClient. Ejemplo de uso: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Propiedades

apiVersion	La versión de la API que se va a usar al comunicarse con el servicio.
endpoint	El punto de conexión del servicio de búsqueda
serviceVersion	La versión de la API que se va a usar al comunicarse con el servicio.

Métodos

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Crea un nuevo origen de datos en un servicio de búsqueda.
createIndexer(SearchIndexer, OperationOptions)	Crea un nuevo indexador en un servicio de búsqueda.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Crea un nuevo origen de datos o modifica uno existente.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Crea un indizador o modifica uno existente.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Crea un nuevo conjunto de aptitudes o modifica uno existente.
createSkillset(SearchIndexerSkillset, OperationOptions)	Crea un nuevo conjunto de aptitudes en un servicio de búsqueda.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Elimina un origen de datos existente.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Elimina un indexador existente.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Elimina un conjunto de aptitudes existente.
getDataSourceConnection(string, OperationOptions)	Recupera información sobre un origen de datos.
getIndexer(string, OperationOptions)	Recupera información sobre un indexador.
getIndexerStatus(string, OperationOptions)	Devuelve el historial de ejecución y el estado actual de un indizador.
getSkillset(string, OperationOptions)	Recupera información sobre un conjunto de aptitudes.
listDataSourceConnections(OperationOptions)	Recupera una lista de orígenes de datos existentes en el servicio.
listDataSourceConnectionsNames(OperationOptions)	Recupera una lista de nombres de orígenes de datos existentes en el servicio.
listIndexers(OperationOptions)	Recupera una lista de indizadores existentes en el servicio.
listIndexersNames(OperationOptions)	Recupera una lista de nombres de indexadores existentes en el servicio.
listSkillsets(OperationOptions)	Recupera una lista de conjuntos de aptitudes existentes en el servicio.
listSkillsetsNames(OperationOptions)	Recupera una lista de nombres de conjuntos de aptitudes existentes en el servicio.
resetIndexer(string, OperationOptions)	Restablece el estado de seguimiento de cambios asociado a un indexador.
runIndexer(string, OperationOptions)	Ejecuta un indexador a petición.

Detalles del constructor

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Crea una instancia de SearchIndexerClient.

Ejemplo 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

Punto de conexión del servicio de búsqueda

credential

KeyCredential | TokenCredential

Se usa para autenticar las solicitudes en el servicio.

options

SearchIndexerClientOptions

Se usa para configurar el cliente de búsqueda.

Detalles de las propiedades

apiVersion

Advertencia

Esta API ya está en desuso.

use {@Link serviceVersion} instead

La versión de la API que se va a usar al comunicarse con el servicio.

apiVersion: string

Valor de propiedad

string

endpoint

El punto de conexión del servicio de búsqueda

endpoint: string

Valor de propiedad

string

serviceVersion

La versión de la API que se va a usar al comunicarse con el servicio.

serviceVersion: string

Valor de propiedad

string

Detalles del método

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Crea un nuevo origen de datos en un servicio de búsqueda.

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

Parámetros

dataSourceConnection

SearchIndexerDataSourceConnection

Definición dataSource que se va a crear en un servicio de búsqueda.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Crea un nuevo indexador en un servicio de búsqueda.

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

Parámetros

indexer

SearchIndexer

Definición del indexador que se va a crear en un servicio de búsqueda.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Crea un nuevo origen de datos o modifica uno existente.

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

Parámetros

dataSourceConnection

SearchIndexerDataSourceConnection

Información que describe el origen de datos que se va a crear o actualizar.

options

CreateorUpdateDataSourceConnectionOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Crea un indizador o modifica uno existente.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parámetros

indexer

SearchIndexer

Información que describe el indexador que se va a crear o actualizar.

options

CreateorUpdateIndexerOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Crea un nuevo conjunto de aptitudes o modifica uno existente.

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

Parámetros

skillset

SearchIndexerSkillset

Información que describe el índice que se va a crear.

options

CreateOrUpdateSkillsetOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Crea un nuevo conjunto de aptitudes en un servicio de búsqueda.

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

Parámetros

skillset

SearchIndexerSkillset

Conjunto de aptitudes que contiene una o varias aptitudes para crear en un servicio de búsqueda.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Elimina un origen de datos existente.

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

Parámetros

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Elimina un indexador existente.

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

Parámetros

indexer

string | SearchIndexer

Indexador/Nombre del indizador que se va a eliminar.

options

DeleteIndexerOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Elimina un conjunto de aptitudes existente.

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

Parámetros

skillset

string | SearchIndexerSkillset

Conjunto de aptitudes o nombre del conjunto de aptitudes que se va a eliminar.

options

DeleteSkillsetOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

getDataSourceConnection(string, OperationOptions)

Recupera información sobre un origen de datos.

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

Parámetros

dataSourceConnectionName

string

options

OperationOptions

Argumentos opcionales adicionales

Devoluciones

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Recupera información sobre un indexador.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parámetros

indexerName

string

Nombre del indexador.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Devuelve el historial de ejecución y el estado actual de un indizador.

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

Parámetros

indexerName

string

El nombre del indizador.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Recupera información sobre un conjunto de aptitudes.

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

Parámetros

skillsetName

string

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Recupera una lista de orígenes de datos existentes en el servicio.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parámetros

options

OperationOptions

Opciones para la operación de indexadores de lista.

Devoluciones

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Recupera una lista de nombres de orígenes de datos existentes en el servicio.

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

Parámetros

options

OperationOptions

Opciones para la operación de indexadores de lista.

Devoluciones

Promise<string[]>

listIndexers(OperationOptions)

Recupera una lista de indizadores existentes en el servicio.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parámetros

options

OperationOptions

Opciones para la operación de indexadores de lista.

Devoluciones

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Recupera una lista de nombres de indexadores existentes en el servicio.

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

Parámetros

options

OperationOptions

Opciones para la operación de indexadores de lista.

Devoluciones

Promise<string[]>

listSkillsets(OperationOptions)

Recupera una lista de conjuntos de aptitudes existentes en el servicio.

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

Parámetros

options

OperationOptions

Opciones de la operación Conjuntos de aptitudes de lista.

Devoluciones

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Recupera una lista de nombres de conjuntos de aptitudes existentes en el servicio.

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

Parámetros

options

OperationOptions

Opciones de la operación Conjuntos de aptitudes de lista.

Devoluciones

Promise<string[]>

resetIndexer(string, OperationOptions)

Restablece el estado de seguimiento de cambios asociado a un indexador.

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

Parámetros

indexerName

string

Nombre del indizador que se va a restablecer.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

runIndexer(string, OperationOptions)

Ejecuta un indexador a petición.

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

Parámetros

indexerName

string

Nombre del indizador que se va a ejecutar.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>