SearchClient class

  • Referencia
Paquete:
@azure/search-documents

Clase que se usa para realizar operaciones en un índice de búsqueda, incluida la consulta de documentos en el índice, así como la adición, actualización y eliminación de ellos.

Constructores

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Crea una instancia de SearchClient.

Ejemplo de uso:

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

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

Opcionalmente, el tipo del modelo se puede usar para habilitar sugerencias de tipo y escritura seguras:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

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
indexName

Nombre del índice
serviceVersion

La versión del servicio que se va a usar al comunicarse con el servicio.

Métodos

autocomplete(string, string, AutocompleteOptions<TModel>)

En función de un searchText parcial del usuario, devuelve una lista de posibles cadenas de finalización basadas en un proveedor de sugerencias especificado.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Elimina un conjunto de documentos.
deleteDocuments(TModel[], IndexDocumentsOptions)

Elimina un conjunto de documentos.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Recupere un documento determinado del índice por clave.
getDocumentsCount(OperationOptions)

Recupera el número de documentos del índice.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Realice un conjunto de modificaciones de índice (carga, combinación, mergeOrUpload, delete) para el conjunto de documentos especificado. Esta operación puede realizarse correctamente parcialmente y no todas las operaciones de documento se reflejarán en el índice. Si desea tratar esto como una excepción, establezca la throwOnAnyFailure opción en true. Para obtener más información sobre cómo funciona la combinación, consulte: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Actualice un conjunto de documentos en el índice. Para obtener más información sobre cómo funciona la combinación, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Actualice un conjunto de documentos en el índice o cárguelos si no existen. Para obtener más información sobre cómo funciona la combinación, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Realiza una búsqueda en el índice actual según los argumentos especificados.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Devuelve una breve lista de sugerencias basadas en searchText y el proveedor de sugerencias especificados.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});
uploadDocuments(TModel[], IndexDocumentsOptions)

Cargue una matriz de documentos en el índice.

Detalles del constructor

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Crea una instancia de SearchClient.

Ejemplo de uso:

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

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

Opcionalmente, el tipo del modelo se puede usar para habilitar sugerencias de tipo y escritura seguras:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

new SearchClient(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions)

Parámetros

endpoint

string

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

indexName

string

Nombre del índice

credential

KeyCredential | TokenCredential

Se usa para autenticar las solicitudes en el servicio.

options
SearchClientOptions

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

Punto de conexión del servicio de búsqueda

endpoint: string

Valor de propiedad

string

indexName

Nombre del índice

indexName: string

Valor de propiedad

string

serviceVersion

La versión del servicio que se va a usar al comunicarse con el servicio.

serviceVersion: string

Valor de propiedad

string

Detalles del método

autocomplete(string, string, AutocompleteOptions<TModel>)

En función de un searchText parcial del usuario, devuelve una lista de posibles cadenas de finalización basadas en un proveedor de sugerencias especificado.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);

function autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>

Parámetros

searchText

string

Texto de búsqueda en el que se van a basar los resultados de autocompletar.

suggesterName

string

Nombre del proveedor de sugerencias tal y como se especifica en la colección suggesters que forma parte de la definición del índice.

options

AutocompleteOptions<TModel>

Opciones para la operación de autocompletar.

Devoluciones

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Elimina un conjunto de documentos.

function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

keyName

keyof TModel

Nombre de su clave principal en el índice.

keyValues

string[]

Los valores de clave principal de los documentos que se van a eliminar.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Elimina un conjunto de documentos.

function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

documents

TModel[]

Documentos que se van a eliminar.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>

getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Recupere un documento determinado del índice por clave.

function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>

Parámetros

key

string

Valor de clave principal del documento

options

GetDocumentOptions<TModel, TFields>

Opciones adicionales

Devoluciones

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Recupera el número de documentos del índice.

function getDocumentsCount(options?: OperationOptions): Promise<number>

Parámetros

options
OperationOptions

Opciones para la operación count.

Devoluciones

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Realice un conjunto de modificaciones de índice (carga, combinación, mergeOrUpload, delete) para el conjunto de documentos especificado. Esta operación puede realizarse correctamente parcialmente y no todas las operaciones de documento se reflejarán en el índice. Si desea tratar esto como una excepción, establezca la throwOnAnyFailure opción en true. Para obtener más información sobre cómo funciona la combinación, consulte: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

batch

IndexDocumentsBatch<TModel>

Matriz de acciones que se van a realizar en el índice.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Actualice un conjunto de documentos en el índice. Para obtener más información sobre cómo funciona la combinación, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

documents

TModel[]

Documentos actualizados.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Actualice un conjunto de documentos en el índice o cárguelos si no existen. Para obtener más información sobre cómo funciona la combinación, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

documents

TModel[]

Documentos actualizados.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>

Realiza una búsqueda en el índice actual según los argumentos especificados.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});

function search<TFields>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>

Parámetros

searchText

string

Texto que se va a buscar

options

SearchOptions<TModel, TFields>

Opciones para la operación de búsqueda.

Devoluciones

Promise<SearchDocumentsResult<TModel, TFields>>

suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Devuelve una breve lista de sugerencias basadas en searchText y el proveedor de sugerencias especificados.

Ejemplo

import {
  AzureKeyCredential,
  SearchClient,
  SearchFieldArray,
} from "@azure/search-documents";

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});

function suggest<TFields>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>

Parámetros

searchText

string

Texto de búsqueda que se va a usar para sugerir documentos. Debe tener 1 carácter como mínimo y no más de 100 caracteres.

suggesterName

string

Nombre del proveedor de sugerencias tal como se especifica en la colección suggesters que forma parte de la definición de índice.

options

SuggestOptions<TModel, TFields>

Opciones para la operación de sugerencia

Devoluciones

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Cargue una matriz de documentos en el índice.

function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parámetros

documents

TModel[]

Documentos que se van a cargar.

options
IndexDocumentsOptions

Opciones adicionales.

Devoluciones

Promise<IndexDocumentsResult>