@azure/search package

Classes

GeographyPoint	Representa um ponto geográfico em coordenadas globais.
SearchApiKeyCredential	Essa classe é usada para autenticar a Pesquisa usando uma chave de API recuperada do portal do Azure.
SearchIndexClient	Classe usada para executar operações em um índice de pesquisa, incluindo consultar documentos no índice, bem como adicioná-los, atualizá-los e removê-los.

Interfaces

AutocompleteItem	O resultado das solicitações de preenchimento automático.
AutocompleteRequest	Parâmetros para correspondência difusa e outros comportamentos de consulta de preenchimento automático.
AutocompleteResult	O resultado da consulta de preenchimento automático.
FacetResult	Um único bucket de um resultado de consulta de faceta. Relata o número de documentos com um valor de campo que está dentro de um intervalo específico ou com um determinado valor ou intervalo.
GetDocumentOptions	Opções para recuperar um único documento.
IndexDocuments	Opções para a operação modificar lote de índice.
IndexDocumentsResult	Resposta que contém o status de operações para todos os documentos na solicitação de indexação.
IndexingResult	Status de uma operação de indexação para um único documento.
ListSearchResultsPageSettings	Argumentos para recuperar a próxima página de resultados da pesquisa.
MergeDocumentsOptions	Opções para a operação atualizar documentos.
RawSearchRequest	Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa.
SearchDocumentsPageResult	Resposta que contém os resultados da pesquisa de um índice.
SearchDocumentsResult	Resposta que contém os resultados da pesquisa de um índice.
SearchDocumentsResultBase	Resposta que contém os resultados da pesquisa de um índice.
SearchRequest	Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa.
SuggestDocumentsResult	Resposta que contém os resultados da consulta de sugestão de um índice.
SuggestRequest	Parâmetros para filtragem, classificação, correspondência difusa e outros comportamentos de consulta de sugestões.
UploadDocumentsOptions	Opções para a operação carregar documentos.

Aliases de tipo

AutocompleteMode	Define valores para AutocompleteMode. Os valores possíveis incluem: 'oneTerm', 'twoTerms', 'oneTermWithContext'
AutocompleteOptions	Opções para recuperar o texto de conclusão de um searchText parcial.
CountDocumentsOptions	Opções para executar a operação de contagem no índice.
DeleteDocumentsOptions	Opções para a operação excluir documentos.
IndexAction	Representa uma ação de índice que opera em um documento.
IndexActionType	Define valores para IndexActionType. Os valores possíveis incluem: 'upload', 'merge', 'mergeOrUpload', 'delete'
QueryType	Define valores para QueryType. Os valores possíveis incluem: 'simple', 'full'
SearchIndexClientOptions	Opções de cliente usadas para configurar solicitações de API do Cognitive Search.
SearchIterator	Um iterador para resultados de pesquisa de uma consulta paticular. Fará solicitações conforme necessário durante a iteração. Use .byPage() para fazer uma solicitação ao servidor por iteração.
SearchMode	Define valores para SearchMode. Os valores possíveis incluem: 'any', 'all'
SearchOptions	Opções para confirmar uma solicitação de pesquisa completa.
SearchResult	Contém um documento encontrado por uma consulta de pesquisa, além de metadados associados.
SuggestOptions	Opções para recuperar sugestões com base no searchText.
SuggestResult	Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados.

Funções

odata(TemplateStringsArray, unknown[])

Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Exemplo de uso: const baseRateMax = 200; const ratingMin = 4; const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`; Para obter mais informações sobre a sintaxe com suporte, consulte: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter

Detalhes da função

odata(TemplateStringsArray, unknown[])

Escapa de uma expressão de filtro odata para evitar erros com literais de cadeia de caracteres entre aspas. Exemplo de uso:

const baseRateMax = 200;
const ratingMin = 4;
const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

Para obter mais informações sobre a sintaxe com suporte, consulte: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter

function odata(strings: TemplateStringsArray, values: unknown[]): string

Parâmetros

strings

TemplateStringsArray

values

unknown[]

Retornos

string