SearchClient class

Cria uma instância do SearchClient.

Exemplo de uso:

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

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

Opcionalmente, o tipo do modelo pode ser usado para habilitar dicas de digitação e tipo fortes:

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

A versão da API a ser usada ao se comunicar com o serviço.

apiVersion: string

Valor da propriedade

O ponto de extremidade do serviço de pesquisa

endpoint: string

Valor da propriedade

O nome do índice

indexName: string

Valor da propriedade

A versão do serviço a ser usada ao se comunicar com o serviço.

serviceVersion: string

Valor da propriedade

Com base em um searchText parcial do usuário, retorne uma lista de cadeias de caracteres de conclusão potenciais com base em um sugestor especificado.

Exemplo

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

Retornos

Exclua um conjunto de documentos.

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

Parâmetros

Retornos

Exclua um conjunto de documentos.

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

Parâmetros

Retornos

Recupere um documento específico do índice por chave.

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

Parâmetros

Retornos

Recupera o número de documentos no índice.

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

Parâmetros

Retornos

Execute um conjunto de modificações de índice (upload, merge, mergeOrUpload, delete) para o conjunto determinado de documentos. Essa operação pode ter êxito parcial e nem todas as operações de documento serão refletidas no índice. Se você quiser tratar isso como uma exceção, defina a opção throwOnAnyFailure como true. Para obter mais detalhes sobre como a mesclagem funciona, 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

Retornos

Atualize um conjunto de documentos no índice. Para obter mais detalhes sobre como a mesclagem funciona, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parâmetros

Retornos

Atualize um conjunto de documentos no índice ou carregue-os se eles não existirem. Para obter mais detalhes sobre como a mesclagem funciona, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

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

Parâmetros

Retornos

Executa uma pesquisa no índice atual considerando os argumentos especificados.

Exemplo

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

Retornos

Retorna uma pequena lista de sugestões com base no searchText e no sugestor especificado.

Exemplo

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

Retornos

Carregue uma matriz de documentos no índice.

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

Parâmetros

Retornos