SearchIndexClient class

Paquete:

@azure/search-documents

Clase para realizar operaciones para administrar índices (crear, actualizar, enumerar o eliminar), & mapa de sinónimos.

Constructores

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

Propiedades

apiVersion	La versión de LA API que se va a usar al comunicarse con el servicio.
endpoint	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

analyzeText(string, AnalyzeTextOptions)	Llama manualmente a un analizador o tokenizador en el texto proporcionado.
createIndex(SearchIndex, OperationOptions)	crea un nuevo índice.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Crea un nuevo índice o modifica uno existente.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Crea un nuevo SynonymMap o modifica uno existente.
createSynonymMap(SynonymMap, OperationOptions)	Crea un nuevo SynonymMap en un servicio de búsqueda.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Elimina un índice existente.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Elimina un SynonymMap existente.
getIndex(string, OperationOptions)	Recupera información sobre un índice.
getIndexStatistics(string, OperationOptions)	Recupera estadísticas sobre un índice, como el recuento de documentos y el tamaño del almacenamiento de índices.
getSearchClient<TModel>(string, SearchClientOptions)	Recupera searchClient correspondiente a searchIndexClient.
getServiceStatistics(OperationOptions)	Recupera estadísticas sobre el servicio, como el recuento de documentos, índices, etc.
getSynonymMap(string, OperationOptions)	Recupera información sobre synonymMap.
listIndexes(OperationOptions)	Recupera una lista de índices existentes en el servicio.
listIndexesNames(OperationOptions)	Recupera una lista de nombres de índices existentes en el servicio.
listSynonymMaps(OperationOptions)	Recupera una lista de synonymMaps existentes en el servicio.
listSynonymMapsNames(OperationOptions)	Recupera una lista de nombres de synonymMaps existentes en el servicio.

Detalles del constructor

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crea una instancia de SearchIndexClient.

Ejemplo de uso:

const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

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

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

SearchIndexClientOptions

Se usa para configurar el cliente de índice 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

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

analyzeText(string, AnalyzeTextOptions)

Llama manualmente a un analizador o tokenizador en el texto proporcionado.

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

Parámetros

indexName

string

Nombre del índice que contiene el campo que se va a analizar.

options

AnalyzeTextOptions

Argumentos adicionales

Devoluciones

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

crea un nuevo índice.

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

Parámetros

index

SearchIndex

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

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

Crea un nuevo índice o modifica uno existente.

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

Parámetros

index

SearchIndex

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

options

CreateOrUpdateIndexOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crea un nuevo SynonymMap o modifica uno existente.

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

Parámetros

synonymMap

SynonymMap

Información que describe synonymMap que se va a crear.

options

CreateOrUpdateSynonymMapOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

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

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

Parámetros

synonymMap

SynonymMap

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

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Elimina un índice existente.

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

Parámetros

index

string | SearchIndex

options

DeleteIndexOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Elimina un SynonymMap existente.

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

Parámetros

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

getIndex(string, OperationOptions)

Recupera información sobre un índice.

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

Parámetros

indexName

string

El nombre del índice.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Recupera estadísticas sobre un índice, como el recuento de documentos y el tamaño del almacenamiento de índices.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

Parámetros

indexName

string

El nombre del índice.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

Recupera searchClient correspondiente a searchIndexClient.

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

Parámetros

indexName

string

Nombre del índice

options

SearchClientOptions

Opciones de SearchClient

Devoluciones

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Recupera estadísticas sobre el servicio, como el recuento de documentos, índices, etc.

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

Parámetros

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Recupera información sobre synonymMap.

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

Parámetros

synonymMapName

string

Nombre del objeto SynonymMap.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SynonymMap>

listIndexes(OperationOptions)

Recupera una lista de índices existentes en el servicio.

function listIndexes(options?: OperationOptions): IndexIterator

Parámetros

options

OperationOptions

Opciones para la operación de índice de lista.

Devoluciones

IndexIterator

listIndexesNames(OperationOptions)

Recupera una lista de nombres de índices existentes en el servicio.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parámetros

options

OperationOptions

Opciones para la operación de índice de lista.

Devoluciones

IndexNameIterator

listSynonymMaps(OperationOptions)

Recupera una lista de synonymMaps existentes en el servicio.

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

Parámetros

options

OperationOptions

Opciones para la operación SynonymMaps de lista.

Devoluciones

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Parámetros

options

OperationOptions

Opciones para la operación SynonymMaps de lista.

Devoluciones

Promise<string[]>