SearchIndexClient class

Paquete:

@azure/search-documents

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

Constructores

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Crea una instancia de SearchIndexClient. Uso de ejemplo: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

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
pipeline	Una referencia a la canalización HTTP interna para su uso con solicitudes sin procesar
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.
createAlias(SearchAlias, OperationOptions)	Crea un nuevo alias de búsqueda.
createIndex(SearchIndex, OperationOptions)	Crea un nuevo índice.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Crea una nueva base de conocimientos.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Crea una nueva fuente de conocimiento.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Crea un nuevo alias de búsqueda o actualiza un alias si ya existe.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Crea un nuevo índice o modifica uno existente.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Crea una nueva base de conocimiento o actualiza una base de conocimientos si ya existe.
createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Crea un nuevo objeto SynonymMap o modifica uno existente.
createSynonymMap(SynonymMap, OperationOptions)	Crea un objeto SynonymMap en un servicio de búsqueda.
deleteAlias(SearchAlias, DeleteAliasOptions)	Elimina un alias de búsqueda y su asignación asociada a un índice. Esta operación es permanente, sin opción de recuperación. Esta operación no modifica el índice asignado.
deleteAlias(string, DeleteAliasOptions)	Elimina un alias de búsqueda y su asignación asociada a un índice. Esta operación es permanente, sin opción de recuperación. Esta operación no modifica el índice asignado.
deleteIndex(SearchIndex, DeleteIndexOptions)	Elimina un índice existente.
deleteIndex(string, DeleteIndexOptions)	Elimina un índice existente.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Elimina una base de conocimiento existente.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Elimina una base de conocimiento existente.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Elimina una fuente existente.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Elimina una fuente existente.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Elimina un objeto SynonymMap existente.
getAlias(string, OperationOptions)	Recupera una definición de alias.
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.
getIndexStatsSummary(GetIndexStatsSummaryOptions)	Recupera una lista de índices existentes en el servicio.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Recupera una definición de base de conocimiento.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Recupera el KnowledgeRetrievalClient correspondiente a este SearchIndexClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Recupera una definición de origen de conocimiento.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Devuelve el estado actual y el historial de sincronización de un origen de conocimiento.
getSearchClient<TModel>(string, SearchClientOptions)	Recupera searchClient correspondiente a searchIndexClient.
getServiceStatistics(OperationOptions)	Recupera estadísticas sobre el servicio, como el recuento de documentos, índice, etc.
getSynonymMap(string, OperationOptions)	Recupera información sobre un objeto SynonymMap.
listAliases(OperationOptions)	Enumera todos los alias disponibles para un servicio de búsqueda.
listIndexes(OperationOptions)	Recupera una lista de índices existentes en el servicio.
listIndexesNames(OperationOptions)	Recupera una lista de nombres de índices existentes en el servicio.
listKnowledgeBases(ListKnowledgeBasesOptions)	Recupera una lista de KnowledgeBases existentes en el servicio.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Recupera una lista de KnowledgeSources 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.

Uso de ejemplo:

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

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

pipeline

Una referencia a la canalización HTTP interna para su uso con solicitudes sin procesar

pipeline: Pipeline

Valor de propiedad

Pipeline

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>

createAlias(SearchAlias, OperationOptions)

Crea un nuevo alias de búsqueda.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Parámetros

alias

SearchAlias

La definición del alias que se va a crear.

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<SearchAlias>

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>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Crea una nueva base de conocimientos.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parámetros

knowledgeBase

KnowledgeBase

Definición de la base de conocimiento a crear.

options

CreateKnowledgeBaseOptions

options parámetros.

Devoluciones

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Crea una nueva fuente de conocimiento.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parámetros

knowledgeSource

KnowledgeSource

La definición de la fuente de conocimiento que se va a crear.

options

CreateKnowledgeSourceOptions

Parámetros de opciones.

Devoluciones

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Crea un nuevo alias de búsqueda o actualiza un alias si ya existe.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Parámetros

alias

SearchAlias

Definición del alias que se va a crear o actualizar.

options

CreateOrUpdateAliasOptions

Parámetros de opciones.

Devoluciones

Promise<SearchAlias>

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>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Crea una nueva base de conocimiento o actualiza una base de conocimientos si ya existe.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Parámetros

knowledgeBaseName

string

nombre de la base de conocimientos para crear o actualizar.

knowledgeBase

KnowledgeBase

Definición de la base de conocimiento para crear o actualizar.

options

CreateOrUpdateKnowledgeBaseOptions

options parámetros.

Devoluciones

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(string, KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Parámetros

sourceName

string

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Devoluciones

Promise<KnowledgeSource>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Crea un nuevo objeto SynonymMap o modifica uno existente.

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

Parámetros

synonymMap

SynonymMap

Información que describe el objeto SynonymMap que se va a crear.

options

CreateOrUpdateSynonymMapOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Crea un objeto 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>

deleteAlias(SearchAlias, DeleteAliasOptions)

Elimina un alias de búsqueda y su asignación asociada a un índice. Esta operación es permanente, sin opción de recuperación. Esta operación no modifica el índice asignado.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Parámetros

alias

SearchAlias

El alias que se va a eliminar.

options

DeleteAliasOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Elimina un alias de búsqueda y su asignación asociada a un índice. Esta operación es permanente, sin opción de recuperación. Esta operación no modifica el índice asignado.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Parámetros

aliasName

string

Nombre del alias que se va a eliminar.

options

DeleteAliasOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

Elimina un índice existente.

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

Parámetros

index

SearchIndex

El índice que se va a eliminar.

options

DeleteIndexOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteIndex(string, DeleteIndexOptions)

Elimina un índice existente.

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Parámetros

indexName

string

Nombre del índice que se va a eliminar.

options

DeleteIndexOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Elimina una base de conocimiento existente.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parámetros

knowledgeBase

KnowledgeBase

La base de conocimiento para eliminar.

options

DeleteKnowledgeBaseOptions

options parámetros.

Devoluciones

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Elimina una base de conocimiento existente.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Parámetros

knowledgeBaseName

string

nombre de la base de conocimientos para eliminar.

options

DeleteKnowledgeBaseOptions

options parámetros.

Devoluciones

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

Elimina una fuente existente.

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parámetros

source

KnowledgeSource

la fuente de conocimiento que se va a eliminar.

options

DeleteKnowledgeSourceOptions

options parámetros.

Devoluciones

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

Elimina una fuente existente.

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Parámetros

sourceName

string

Nombre de la fuente de conocimiento que se va a eliminar.

options

DeleteKnowledgeSourceOptions

options parámetros.

Devoluciones

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Elimina un objeto SynonymMap existente.

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

Parámetros

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<void>

getAlias(string, OperationOptions)

Recupera una definición de alias.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Parámetros

aliasName

string

Nombre del alias que se va a recuperar.

options

OperationOptions

Parámetros de opciones.

Devoluciones

Promise<SearchAlias>

getIndex(string, OperationOptions)

Recupera información sobre un índice.

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

Parámetros

indexName

string

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

Nombre del índice.

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchIndexStatistics>

getIndexStatsSummary(GetIndexStatsSummaryOptions)

Recupera una lista de índices existentes en el servicio.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parámetros

options

GetIndexStatsSummaryOptions

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

Devoluciones

IndexStatisticsSummaryIterator

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Recupera una definición de base de conocimiento.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Parámetros

knowledgeBaseName

string

Nombre de la base de conocimiento para recuperar.

options

GetKnowledgeBaseOptions

options parámetros.

Devoluciones

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Recupera el KnowledgeRetrievalClient correspondiente a este SearchIndexClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Parámetros

knowledgeBaseName

string

Nombre de la base de conocimiento

options

KnowledgeRetrievalClientOptions

KnowledgeRetrievalOpciones de cliente

Devoluciones

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Recupera una definición de origen de conocimiento.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Parámetros

sourceName

string

El nombre del origen de conocimiento que se va a recuperar.

options

GetKnowledgeSourceOptions

Parámetros de opciones.

Devoluciones

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Devuelve el estado actual y el historial de sincronización de un origen de conocimiento.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Parámetros

sourceName

string

Nombre del origen de conocimiento para el que se va a recuperar el estado.

options

GetKnowledgeSourceStatusOptions

Parámetros de opciones.

Devoluciones

Promise<KnowledgeSourceStatus>

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, índice, etc.

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

Parámetros

options

OperationOptions

Argumentos opcionales adicionales.

Devoluciones

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

Recupera información sobre un objeto 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>

listAliases(OperationOptions)

Enumera todos los alias disponibles para un servicio de búsqueda.

function listAliases(options?: OperationOptions): AliasIterator

Parámetros

options

OperationOptions

Parámetros de opciones.

Devoluciones

AliasIterator

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

listKnowledgeBases(ListKnowledgeBasesOptions)

Recupera una lista de KnowledgeBases existentes en el servicio.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parámetros

options

ListKnowledgeBasesOptions

Opciones para la operación de la base de conocimiento de la lista.

Devoluciones

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

Recupera una lista de KnowledgeSources existentes en el servicio.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parámetros

options

ListKnowledgeSourcesOptions

Opciones para la operación de lista de fuentes de conocimiento.

Devoluciones

KnowledgeSourceIterator

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[]>