Partilhar via

SearchClient class

  • Referência
Pacote:
@azure/search-documents

Classe utilizada para efetuar operações num índice de pesquisa, incluindo consultar documentos no índice, bem como adicioná-los, atualizá-los e removê-los.

Construtores

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

Cria uma instância do SearchClient.

Utilização de exemplo: 

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

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

Opcionalmente, o tipo de modelo pode ser utilizado para ativar sugestões de escrita e tipo fortes:

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

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

Propriedades

apiVersion

A versão da API a utilizar ao comunicar com o serviço.
endpoint

O ponto final do serviço de pesquisa
indexName

O nome do índice
serviceVersion

A versão do serviço a utilizar ao comunicar com o serviço.

Métodos

autocomplete(string, string, AutocompleteOptions<TModel>)

Com base num searchText parcial do utilizador, devolva uma lista de potenciais cadeias de conclusão com base num sugeridor 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 }
);
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Eliminar um conjunto de documentos.
deleteDocuments(TModel[], IndexDocumentsOptions)

Eliminar um conjunto de documentos.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Obter um documento específico a partir do índice por chave.
getDocumentsCount(OperationOptions)

Obtém o número de documentos no índice.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Efetue um conjunto de modificações de índice (carregar, intercalar, mergeOrUpload, eliminar) para o conjunto de documentos especificado. Esta operação pode ser parcialmente bem-sucedida e nem todas as operações de documento serão refletidas no índice. Se quiser tratar isto como uma exceção, defina a opção throwOnAnyFailure como verdadeira. Para obter mais detalhes sobre como funciona a intercalação, consulte: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Atualize um conjunto de documentos no índice. Para obter mais detalhes sobre como funciona a intercalação, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Atualize um conjunto de documentos no índice ou carregue-os se não existirem. Para obter mais detalhes sobre como funciona a intercalação, consulte https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Efetua uma pesquisa no índice atual, tendo em conta 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,
});
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Devolve uma breve lista de sugestões com base no searchText e no sugeridor 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,
});
uploadDocuments(TModel[], IndexDocumentsOptions)

Carregue uma matriz de documentos para o índice.

Detalhes do Construtor

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

Cria uma instância do SearchClient.

Utilização de exemplo: 

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

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

Opcionalmente, o tipo de modelo pode ser utilizado para ativar sugestões de escrita 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

endpoint

string

O ponto final do serviço de pesquisa

indexName

string

O nome do índice

credential

KeyCredential | TokenCredential

Utilizado para autenticar pedidos para o serviço.

options
SearchClientOptions

Utilizado para configurar o cliente de Pesquisa.

Detalhes de Propriedade

apiVersion

Aviso

Esta API foi preterida.

use {@Link serviceVersion} instead

A versão da API a utilizar ao comunicar com o serviço.

apiVersion: string

Valor de Propriedade

string

endpoint

O ponto final do serviço de pesquisa

endpoint: string

Valor de Propriedade

string

indexName

O nome do índice

indexName: string

Valor de Propriedade

string

serviceVersion

A versão do serviço a utilizar ao comunicar com o serviço.

serviceVersion: string

Valor de Propriedade

string

Detalhes de Método

autocomplete(string, string, AutocompleteOptions<TModel>)

Com base num searchText parcial do utilizador, devolva uma lista de potenciais cadeias de conclusão com base num sugeridor 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

searchText

string

O texto de pesquisa no qual se baseiam os resultados da conclusão automática.

suggesterName

string

O nome do sugeridor, conforme especificado na coleção de sugestores que faz parte da definição do índice.

options

AutocompleteOptions<TModel>

Opções para a operação de conclusão automática.

Devoluções

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Eliminar um conjunto de documentos.

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

Parâmetros

keyName

keyof TModel

O nome da chave primária no índice.

keyValues

string[]

Os principais valores chave dos documentos a eliminar.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Eliminar um conjunto de documentos.

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

Parâmetros

documents

TModel[]

Documentos a eliminar.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>

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

Obter um documento específico a partir do índice por chave.

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

Parâmetros

key

string

O valor da chave primária do documento

options

GetDocumentOptions<TModel, TFields>

Opções adicionais

Devoluções

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Obtém o número de documentos no índice.

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

Parâmetros

options
OperationOptions

Opções para a operação de contagem.

Devoluções

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Efetue um conjunto de modificações de índice (carregar, intercalar, mergeOrUpload, eliminar) para o conjunto de documentos especificado. Esta operação pode ser parcialmente bem-sucedida e nem todas as operações de documento serão refletidas no índice. Se quiser tratar isto como uma exceção, defina a opção throwOnAnyFailure como verdadeira. Para obter mais detalhes sobre como funciona a intercalação, 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>

Uma matriz de ações a executar no índice.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Atualize um conjunto de documentos no índice. Para obter mais detalhes sobre como funciona a intercalação, 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[]

Os documentos atualizados.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Atualize um conjunto de documentos no índice ou carregue-os se não existirem. Para obter mais detalhes sobre como funciona a intercalação, 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[]

Os documentos atualizados.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>

Efetua uma pesquisa no índice atual, tendo em conta 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

searchText

string

Texto a procurar

options

SearchOptions<TModel, TFields>

Opções para a operação de pesquisa.

Devoluções

Promise<SearchDocumentsResult<TModel, TFields>>

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

Devolve uma breve lista de sugestões com base no searchText e no sugeridor 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

searchText

string

O texto de pesquisa a utilizar para sugerir documentos. Tem de ter, pelo menos, 1 caráter e não ter mais de 100 carateres.

suggesterName

string

O nome do sugeridor, conforme especificado na coleção de sugestores que faz parte da definição do índice.

options

SuggestOptions<TModel, TFields>

Opções para a operação de sugestão

Devoluções

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Carregue uma matriz de documentos para o índice.

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

Parâmetros

documents

TModel[]

Os documentos a carregar.

options
IndexDocumentsOptions

Opções adicionais.

Devoluções

Promise<IndexDocumentsResult>