Documents - Search Get

Serviço:

Search Service

Versão da API:

2023-10-01-Preview

Procura documentos no índice.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2023-10-01-Preview

Com parâmetros opcionais:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2023-10-01-Preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API do Cliente.
$count	query		boolean	Um valor que especifica se pretende obter a contagem total de resultados. A predefinição é falso. Definir este valor como verdadeiro pode ter um impacto no desempenho. Tenha em atenção que a contagem devolvida é uma aproximação.
$filter	query		string	O OData $filter expressão a aplicar à consulta de pesquisa.
$orderby	query		string[]	A lista de OData $orderby expressões pelas quais ordenar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar ascendente e desc para indicar descendente. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificado orderBy, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
$select	query		string[]	A lista de campos a obter. Se não for especificado, todos os campos marcados como recuperáveis no esquema são incluídos.
$skip	query		integer int32	O número de resultados da pesquisa a ignorar. Este valor não pode ser superior a 100 000. Se precisar de analisar documentos em sequência, mas não puder utilizar $skip devido a esta limitação, considere utilizar $orderby numa chave totalmente ordenada e, em vez disso, $filter com uma consulta de intervalo.
$top	query		integer int32	O número de resultados da pesquisa a obter. Isto pode ser utilizado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser utilizado para emitir outro pedido de Pesquisa para a próxima página de resultados.
answers	query		QueryAnswerType	Este parâmetro só é válido se o tipo de consulta for semantic. Se estiver definida, a consulta devolve respostas extraídas das passagens principais nos documentos mais bem classificados. O número de respostas devolvidas pode ser configurado ao acrescentar o caráter | de pipe seguido da opção count-<number of answers> após o valor do parâmetro de respostas, como extractive|count-3. A contagem predefinida é 1. O limiar de confiança pode ser configurado ao acrescentar o caráter | de pipe seguido da opção threshold-<confidence threshold> após o valor do parâmetro answers, como extractive|threshold-0.9. O limiar predefinido é 0,7.
captions	query		QueryCaptionType	Este parâmetro só é válido se o tipo de consulta for semantic. Se estiver definida, a consulta devolve legendas extraídas de passagens-chave nos documentos mais bem classificados. Quando a opção Legendas está definida extractivecomo , o realce está ativado por predefinição e pode ser configurado ao acrescentar o caráter | de pipe seguido da opção highlight-<true/false> , como extractive|highlight-true. A predefinição é None.
debug	query		QueryDebugMode	Ativa uma ferramenta de depuração que pode ser utilizada para explorar ainda mais os resultados da pesquisa.
facet	query		string[]	A lista de expressões de facetas a aplicar à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido de uma lista separada por vírgulas de pares name:value.
highlight	query		string[]	A lista de nomes de campo a utilizar para os destaques de acesso. Apenas os campos pesquisáveis podem ser utilizados para o realce de resultados.
highlightPostTag	query		string	Uma etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. A predefinição é </em>.
highlightPreTag	query		string	Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. A predefinição é <em>.
minimumCoverage	query		number double	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de pesquisa para que a consulta seja reportada como um êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 100.
queryLanguage	query		QueryLanguage	O idioma da consulta.
queryType	query		QueryType	Um valor que especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "full" se a consulta utilizar a sintaxe de consulta Lucene.
scoringParameter	query		string[]	A lista de valores de parâmetros a utilizar nas funções de classificação (por exemplo, referencePointParameter) com o formato name-values. Por exemplo, se o perfil de classificação definir uma função com um parâmetro chamado "mylocation", a cadeia de parâmetros será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile	query		string	O nome de um perfil de classificação para avaliar pontuações de correspondência para documentos correspondentes para ordenar os resultados.
scoringStatistics	query		ScoringStatistics	Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência.
search	query		string	Uma expressão de consulta de pesquisa em texto completo; Utilize "*" ou omita este parâmetro para corresponder a todos os documentos.
searchFields	query		string[]	A lista de nomes de campos para os quais pretende definir o âmbito da pesquisa em texto completo. Ao utilizar a pesquisa em campo (fieldName:searchExpression) numa consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados neste parâmetro.
searchMode	query		SearchMode	Um valor que especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência.
semanticConfiguration	query		string	O nome da configuração semântica que lista os campos que devem ser utilizados para classificação semântica, legendas, destaques e respostas
semanticErrorHandling	query		SemanticErrorMode	Permite ao utilizador escolher se uma chamada semântica deve falhar completamente ou devolver resultados parciais (predefinição).
semanticFields	query		string[]	A lista de nomes de campos utilizados para a classificação semântica.
semanticMaxWaitInMilliseconds	query		integer int32	Permite que o utilizador defina um limite superior sobre a quantidade de tempo que o melhoramento semântico demora a concluir o processamento antes de o pedido falhar.
semanticQuery	query		string	Permite definir uma consulta de pesquisa separada que será utilizada exclusivamente para a reconserção semântica, legendas semânticas e respostas semânticas. É útil para cenários em que é necessário utilizar diferentes consultas entre a fase de obtenção e classificação base e a fase semântica L2.
sessionId	query		string	Um valor a ser utilizado para criar uma sessão autocolante, que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja utilizado, será efetuada uma tentativa de melhor esforço para direcionar o mesmo conjunto de réplicas. Tenha em atenção que reutilizar repetidamente os mesmos valores sessionID pode interferir com o balanceamento de carga dos pedidos entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor utilizado como sessionId não pode começar com um caráter "_".
speller	query		Speller	Melhore a recolha de pesquisas ao corrigir ortográficos termos de consulta de pesquisa individuais.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Respostas

Name	Tipo	Description
200 OK	SearchDocumentsResult	Resposta que contém documentos que correspondem aos critérios de pesquisa.
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchIndexSearchDocumentsGet

Pedido de amostra

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2023-10-01-Preview

Resposta da amostra

Código de estado:

200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definições

Name	Description
AnswerResult	Uma resposta é uma passagem de texto extraída do conteúdo dos documentos mais relevantes que correspondem à consulta. As respostas são extraídas dos principais resultados da pesquisa. Os candidatos às respostas são classificados e as principais respostas estão selecionadas.
CaptionResult	As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. São frequentemente utilizados como resumo do documento. As legendas só são devolvidas para consultas do tipo "semântica".
DocumentDebugInfo	Contém informações de depuração que podem ser utilizadas para explorar ainda mais os resultados da pesquisa.
QueryAnswerType	Um valor que especifica se as respostas devem ser devolvidas como parte da resposta da pesquisa.
QueryCaptionType	Um valor que especifica se as legendas devem ser devolvidas como parte da resposta da pesquisa.
QueryDebugMode	Ativa uma ferramenta de depuração que pode ser utilizada para explorar ainda mais os resultados da pesquisa.
QueryLanguage	O idioma da consulta.
QueryResultDocumentRerankerInput	As cadeias concatenadas não processadas que foram enviadas para o processo de melhoramento semântico.
QueryResultDocumentSemanticField	Descrição dos campos que foram enviados para o processo de melhoramento semântico, bem como como foram utilizados
QuerySpellerType	Um valor que especificou o tipo do soletrador a utilizar para corrigir ortográficos termos de consulta de pesquisa individuais.
QueryType	Especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "completo" se a consulta utilizar a sintaxe da consulta Lucene e a sintaxe "semântica" se a sintaxe da consulta não for necessária.
RawVectorQuery	Os parâmetros de consulta a utilizar para pesquisa de vetores quando é fornecido um valor de vetor não processado.
ScoringStatistics	Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência. A predefinição é "local". Utilize "global" para agregar estatísticas de classificação globalmente antes de classificar. A utilização de estatísticas de classificação globais pode aumentar a latência das consultas de pesquisa.
SearchDocumentsResult	Resposta que contém resultados de pesquisa de um índice.
SearchError	Descreve uma condição de erro para a API.
SearchMode	Especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência.
SearchRequest	Parâmetros para filtrar, ordenar, facetar, paginar e outros comportamentos de consulta de pesquisa.
SearchResult	Contém um documento encontrado por uma consulta de pesquisa, bem como metadados associados.
SemanticDebugInfo
SemanticErrorMode	Permite ao utilizador escolher se uma chamada semântica deve falhar completamente ou devolver resultados parciais (predefinição).
SemanticErrorReason	Motivo pelo qual foi devolvida uma resposta parcial para um pedido de classificação semântica.
SemanticFieldState	A forma como o campo foi utilizado para o processo de melhoramento semântico (totalmente utilizado, parcialmente utilizado ou não utilizado)
SemanticSearchResultsType	Tipo de resposta parcial que foi devolvida para um pedido de classificação semântica.
Speller	Melhore a recolha de pesquisas ao corrigir ortográficos termos de consulta de pesquisa individuais.
VectorFilterMode	Determina se os filtros são aplicados antes ou depois de a pesquisa de vetor ser executada.
VectorizableTextQuery	Os parâmetros de consulta a utilizar para pesquisa de vetores quando é fornecido um valor de texto que precisa de ser vetorizado.
VectorQueryKind	O tipo de consulta de vetor que está a ser executada.

AnswerResult

Uma resposta é uma passagem de texto extraída do conteúdo dos documentos mais relevantes que correspondem à consulta. As respostas são extraídas dos principais resultados da pesquisa. Os candidatos às respostas são classificados e as principais respostas estão selecionadas.

Name	Tipo	Description
highlights	string	A mesma passagem de texto que na propriedade Texto com expressões de texto realçadas mais relevantes para a consulta.
key	string	A chave do documento de onde a resposta foi extraída.
score	number	O valor da classificação representa a relevância da resposta para a consulta relativamente a outras respostas devolvidas para a consulta.
text	string	A passagem de texto extraída do conteúdo do documento como resposta.

CaptionResult

As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. São frequentemente utilizados como resumo do documento. As legendas só são devolvidas para consultas do tipo "semântica".

Name	Tipo	Description
highlights	string	A mesma passagem de texto que na propriedade Texto com expressões realçadas mais relevantes para a consulta.
text	string	Uma passagem de texto representativa extraída do documento mais relevante para a consulta de pesquisa.

DocumentDebugInfo

Contém informações de depuração que podem ser utilizadas para explorar ainda mais os resultados da pesquisa.

Name	Tipo	Description
semantic	SemanticDebugInfo	Contém informações de depuração específicas de pedidos de classificação semântica.

QueryAnswerType

Um valor que especifica se as respostas devem ser devolvidas como parte da resposta da pesquisa.

Name	Tipo	Description
extractive	string	Extrai os candidatos de resposta dos conteúdos dos documentos devolvidos em resposta a uma consulta expressa como uma pergunta em linguagem natural.
none	string	Não devolva respostas para a consulta.

QueryCaptionType

Um valor que especifica se as legendas devem ser devolvidas como parte da resposta da pesquisa.

Name	Tipo	Description
extractive	string	Extrai legendas dos documentos correspondentes que contêm passagens relevantes para a consulta de pesquisa.
none	string	Não devolva legendas para a consulta.

QueryDebugMode

Ativa uma ferramenta de depuração que pode ser utilizada para explorar ainda mais os resultados da pesquisa.

Name	Tipo	Description
disabled	string	Não serão devolvidas informações de depuração de consultas.
semantic	string	Permite que o utilizador explore ainda mais os resultados rerancados.

QueryLanguage

O idioma da consulta.

Name	Tipo	Description
ar-eg	string	Valor da linguagem de consulta para árabe (Egito).
ar-jo	string	Valor da linguagem de consulta para árabe (Jordânia).
ar-kw	string	Valor da linguagem de consulta para árabe (Kuwait).
ar-ma	string	Valor da linguagem de consulta para árabe (Marrocos).
ar-sa	string	Valor da linguagem de consulta para árabe (Arábia Saudita).
bg-bg	string	Valor da linguagem de consulta para búlgaro (Bulgária).
bn-in	string	Valor da linguagem de consulta para Bengali (Índia).
ca-es	string	Valor da linguagem de consulta para catalão.
cs-cz	string	Valor da linguagem de consulta para checo (República Checa).
da-dk	string	Valor da linguagem de consulta para dinamarquês (Dinamarca).
de-de	string	Valor da linguagem de consulta para alemão (Alemanha).
el-gr	string	Valor da linguagem de consulta para grego (Grécia).
en-au	string	Valor da linguagem de consulta para inglês (Austrália).
en-ca	string	Valor da linguagem de consulta para inglês (Canadá).
en-gb	string	Valor da linguagem de consulta para inglês (Grã-Bretanha).
en-in	string	Valor da linguagem de consulta para inglês (Índia).
en-us	string	Valor da linguagem de consulta para inglês (Estados Unidos).
es-es	string	Valor da linguagem de consulta para espanhol (Espanha).
es-mx	string	Valor da linguagem de consulta para espanhol (México).
et-ee	string	Valor da linguagem de consulta para estónio (Estónia).
eu-es	string	Valor da linguagem de consulta para basco.
fa-ae	string	Valor da linguagem de consulta para persa (U.A.E.).
fi-fi	string	Valor da linguagem de consulta para finlandês (Finlândia).
fr-ca	string	Valor da linguagem de consulta para francês (Canadá).
fr-fr	string	Valor da linguagem de consulta para francês (França).
ga-ie	string	Valor da linguagem de consulta para irlandês (Irlanda).
gl-es	string	Valor da linguagem de consulta para galego.
gu-in	string	Valor da linguagem de consulta para Gujarati (Índia).
he-il	string	Valor da linguagem de consulta para hebraico (Israel).
hi-in	string	Valor da linguagem de consulta para Hindi (Índia).
hr-ba	string	Valor da linguagem de consulta para croata (Bósnia e Herzegovina).
hr-hr	string	Valor da linguagem de consulta para croata (Croácia).
hu-hu	string	Valor da linguagem de consulta para húngaro (Hungria).
hy-am	string	Valor da linguagem de consulta para arménio (Arménia).
id-id	string	Valor da linguagem de consulta para indonésio (Indonésia).
is-is	string	Valor da linguagem de consulta para islandês (Islândia).
it-it	string	Valor da linguagem de consulta para italiano (Itália).
ja-jp	string	Valor da linguagem de consulta para japonês (Japão).
kn-in	string	Valor da linguagem de consulta para Kannada (Índia).
ko-kr	string	Valor da linguagem de consulta para coreano (Coreia).
lt-lt	string	Valor da linguagem de consulta para lituano (Lituânia).
lv-lv	string	Valor da linguagem de consulta para letão (Letónia).
ml-in	string	Valor da linguagem de consulta para Malayalam (Índia).
mr-in	string	Valor da linguagem de consulta para Marathi (Índia).
ms-bn	string	Valor da linguagem de consulta para Malaio (Brunei Darussalam).
ms-my	string	Valor da linguagem de consulta para Malaio (Malásia).
nb-no	string	Valor da linguagem de consulta para norueguês (Noruega).
nl-be	string	Valor da linguagem de consulta para neerlandês (Bélgica).
nl-nl	string	Valor da linguagem de consulta para neerlandês (Países Baixos).
no-no	string	Valor da linguagem de consulta para norueguês (Noruega).
none	string	Linguagem de consulta não especificada.
pa-in	string	Valor da linguagem de consulta para Punjabi (Índia).
pl-pl	string	Valor da linguagem de consulta para polaco (Polónia).
pt-br	string	Valor da linguagem de consulta para português (Brasil).
pt-pt	string	Valor da linguagem de consulta para português (Portugal).
ro-ro	string	Valor da linguagem de consulta para romeno (Roménia).
ru-ru	string	Valor da linguagem de consulta para russo (Rússia).
sk-sk	string	Valor da linguagem de consulta para eslovaco (Eslováquia).
sl-sl	string	Valor da linguagem de consulta para esloveno (Eslovénia).
sr-ba	string	Valor da linguagem de consulta para sérvio (Bósnia e Herzegovina).
sr-me	string	Valor da linguagem de consulta para sérvio (Montenegro).
sr-rs	string	Valor da linguagem de consulta para sérvio (Sérvia).
sv-se	string	Valor da linguagem de consulta para sueco (Suécia).
ta-in	string	Valor da linguagem de consulta para Tamil (Índia).
te-in	string	Valor da linguagem de consulta para Telugu (Índia).
th-th	string	Valor da linguagem de consulta para tailandês (Tailândia).
tr-tr	string	Valor da linguagem de consulta para turco (Turquia).
uk-ua	string	Valor da linguagem de consulta para ucraniano (Ucrânia).
ur-pk	string	Valor da linguagem de consulta para Urdu (Paquistão).
vi-vn	string	Valor da linguagem de consulta para vietnamitas (Viet Nam).
zh-cn	string	Valor da linguagem de consulta para chinês (China).
zh-tw	string	Valor da linguagem de consulta para chinês (Taiwan).

QueryResultDocumentRerankerInput

As cadeias concatenadas não processadas que foram enviadas para o processo de melhoramento semântico.

Name	Tipo	Description
content	string	As cadeias concatenadas não processadas para os campos de conteúdo que foram utilizados para melhoramento semântico.
keywords	string	As cadeias concatenadas não processadas para os campos de palavra-chave que foram utilizados para melhoramento semântico.
title	string	A cadeia não processada para o campo de título utilizado para melhoramento semântico.

QueryResultDocumentSemanticField

Descrição dos campos que foram enviados para o processo de melhoramento semântico, bem como como foram utilizados

Name	Tipo	Description
name	string	O nome do campo que foi enviado para o processo de melhoramento semântico
state	SemanticFieldState	A forma como o campo foi utilizado para o processo de melhoramento semântico (totalmente utilizado, parcialmente utilizado ou não utilizado)

QuerySpellerType

Um valor que especificou o tipo do soletrador a utilizar para corrigir ortográficos termos de consulta de pesquisa individuais.

Name	Tipo	Description
lexicon	string	O speller corrige termos de consulta individuais com um léxico estático para a linguagem especificada pelo parâmetro queryLanguage.
none	string	O corretor ortográfico não está ativado.

QueryType

Especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "completo" se a consulta utilizar a sintaxe da consulta Lucene e a sintaxe "semântica" se a sintaxe da consulta não for necessária.

Name	Tipo	Description
full	string	Utiliza a sintaxe de consulta Lucene completa para pesquisas. O texto de pesquisa é interpretado com a linguagem de consulta Lucene que permite pesquisas específicas e ponderadas do campo, bem como outras funcionalidades avançadas.
semantic	string	Mais adequado para consultas expressas em linguagem natural em oposição a palavras-chave. Melhora a precisão dos resultados da pesquisa ao voltar a classificar os principais resultados de pesquisa com um modelo de classificação preparado no corpus Web.
simple	string	Utiliza a sintaxe de consulta simples para pesquisas. O texto de pesquisa é interpretado com uma linguagem de consulta simples que permite símbolos como +, * e "". As consultas são avaliadas em todos os campos pesquisáveis por predefinição, a menos que o parâmetro searchFields seja especificado.

RawVectorQuery

Os parâmetros de consulta a utilizar para pesquisa de vetores quando é fornecido um valor de vetor não processado.

Name	Tipo	Description
exhaustive	boolean	Quando verdadeiro, aciona uma pesquisa de vizinho k-próxima exaustiva em todos os vetores dentro do índice de vetor. Útil para cenários em que as correspondências exatas são críticas, como determinar valores de verdade básica.
fields	string	Campos de Vetor do tipo Coleção(Edm.Single) a incluir no vetor pesquisado.
k	integer	Número de vizinhos mais próximos a regressar à medida que os primeiros atingem.
kind	string: vector	O tipo de consulta de vetor que está a ser executada.
vector	number[]	A representação de vetor de uma consulta de pesquisa.

ScoringStatistics

Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência. A predefinição é "local". Utilize "global" para agregar estatísticas de classificação globalmente antes de classificar. A utilização de estatísticas de classificação globais pode aumentar a latência das consultas de pesquisa.

Name	Tipo	Description
global	string	As estatísticas de classificação serão calculadas globalmente para uma classificação mais consistente.
local	string	As estatísticas de classificação serão calculadas localmente para uma latência mais baixa.

SearchDocumentsResult

Resposta que contém resultados de pesquisa de um índice.

Name	Tipo	Description
@odata.count	integer	A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não tiver sido pedida. Se estiver presente, a contagem pode ser maior do que o número de resultados nesta resposta. Isto pode acontecer se utilizar os parâmetros $top ou $skip ou se a consulta não conseguir devolver todos os documentos pedidos numa única resposta.
@odata.nextLink	string	URL de continuação devolvido quando a consulta não consegue devolver todos os resultados pedidos numa única resposta. Pode utilizar este URL para formular outro pedido GET ou POST Search para obter a próxima parte da resposta de pesquisa. Certifique-se de que utiliza o mesmo verbo (GET ou POST) que o pedido que produziu esta resposta.
@search.answers	AnswerResult[]	Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta de respostas não tiver sido especificado ou definido como "nenhum".
@search.coverage	number	Um valor que indica a percentagem do índice incluído na consulta ou nulo se minimumCoverage não tiver sido especificado no pedido.
@search.facets	object	Os resultados da consulta faceta para a operação de pesquisa, organizados como uma coleção de registos para cada campo facetado; nulo se a consulta não incluir expressões de facetas.
@search.nextPageParameters	SearchRequest	Payload JSON de continuação devolvido quando a consulta não consegue devolver todos os resultados pedidos numa única resposta. Pode utilizar este JSON juntamente com @odata.nextLink para formular outro pedido post search para obter a próxima parte da resposta de pesquisa.
@search.semanticPartialResponseReason	SemanticErrorReason	Motivo pelo qual foi devolvida uma resposta parcial para um pedido de classificação semântica.
@search.semanticPartialResponseType	SemanticSearchResultsType	Tipo de resposta parcial que foi devolvida para um pedido de classificação semântica.
value	SearchResult[]	A sequência de resultados devolvida pela consulta.

SearchError

Descreve uma condição de erro para a API.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
message	string	Uma representação legível por humanos do erro.

SearchMode

Especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência.

Name	Tipo	Description
all	string	Todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência.
any	string	Qualquer um dos termos de pesquisa tem de ser correspondido para contar o documento como uma correspondência.

SearchRequest

Parâmetros para filtrar, ordenar, facetar, paginar e outros comportamentos de consulta de pesquisa.

Name	Tipo	Description
answers	QueryAnswerType	Um valor que especifica se as respostas devem ser devolvidas como parte da resposta de pesquisa.
captions	QueryCaptionType	Um valor que especifica se as legendas devem ser devolvidas como parte da resposta da pesquisa.
count	boolean	Um valor que especifica se pretende obter a contagem total de resultados. A predefinição é falso. Definir este valor como verdadeiro pode ter um impacto no desempenho. Tenha em atenção que a contagem devolvida é uma aproximação.
debug	QueryDebugMode	Ativa uma ferramenta de depuração que pode ser utilizada para explorar ainda mais os resultados reclassificados.
facets	string[]	A lista de expressões de facetas a aplicar à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido de uma lista separada por vírgulas de pares name:value.
filter	string	O OData $filter expressão a aplicar à consulta de pesquisa.
highlight	string	A lista separada por vírgulas de nomes de campo a utilizar para os destaques de acesso. Apenas os campos pesquisáveis podem ser utilizados para o realce de resultados.
highlightPostTag	string	Uma etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. A predefinição é </em>.
highlightPreTag	string	Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. A predefinição é <em>.
minimumCoverage	number	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de pesquisa para que a consulta seja reportada como um êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 100.
orderby	string	A lista separada por vírgulas de OData $orderby expressões pelas quais ordenar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar ascendente ou desc para indicar descendente. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificada nenhuma $orderby, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
queryLanguage	QueryLanguage	Um valor que especifica o idioma da consulta de pesquisa.
queryType	QueryType	Um valor que especifica a sintaxe da consulta de pesquisa. A predefinição é "simples". Utilize "full" se a consulta utilizar a sintaxe de consulta Lucene.
scoringParameters	string[]	A lista de valores de parâmetros a utilizar nas funções de classificação (por exemplo, referencePointParameter) com o formato name-values. Por exemplo, se o perfil de classificação definir uma função com um parâmetro chamado "mylocation", a cadeia de parâmetros será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile	string	O nome de um perfil de classificação para avaliar pontuações de correspondência para documentos correspondentes para ordenar os resultados.
scoringStatistics	ScoringStatistics	Um valor que especifica se queremos calcular as estatísticas de classificação (como a frequência do documento) globalmente para uma classificação mais consistente, ou localmente, para uma menor latência. A predefinição é "local". Utilize "global" para agregar estatísticas de classificação globalmente antes de classificar. A utilização de estatísticas de classificação globais pode aumentar a latência das consultas de pesquisa.
search	string	Uma expressão de consulta de pesquisa em texto completo; Utilize "*" ou omita este parâmetro para corresponder a todos os documentos.
searchFields	string	A lista separada por vírgulas de nomes de campo para definir o âmbito da pesquisa em texto completo. Ao utilizar a pesquisa em campo (fieldName:searchExpression) numa consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se algum ou todos os termos de pesquisa têm de ser correspondidos para contar o documento como uma correspondência.
select	string	A lista de campos separados por vírgulas a obter. Se não for especificado, todos os campos marcados como recuperáveis no esquema são incluídos.
semanticConfiguration	string	O nome de uma configuração semântica que será utilizada ao processar documentos para consultas do tipo semântico.
semanticErrorHandling	SemanticErrorMode	Permite ao utilizador escolher se uma chamada semântica deve falhar completamente ou devolver resultados parciais (predefinição).
semanticFields	string	A lista separada por vírgulas de nomes de campo utilizados para classificação semântica.
semanticMaxWaitInMilliseconds	integer	Permite que o utilizador defina um limite superior sobre a quantidade de tempo que o melhoramento semântico demora a concluir o processamento antes de o pedido falhar.
semanticQuery	string	Permite definir uma consulta de pesquisa separada que será utilizada exclusivamente para a reconserção semântica, legendas semânticas e respostas semânticas. É útil para cenários em que é necessário utilizar diferentes consultas entre a fase de obtenção e classificação base e a fase semântica L2.
sessionId	string	Um valor a ser utilizado para criar uma sessão autocolante, o que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja utilizado, será efetuada uma tentativa de melhor esforço para direcionar o mesmo conjunto de réplicas. Tenha em atenção que reutilizar repetidamente os mesmos valores sessionID pode interferir com o balanceamento de carga dos pedidos entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor utilizado como sessionId não pode começar com um caráter "_".
skip	integer	O número de resultados da pesquisa a ignorar. Este valor não pode ser superior a 100 000. Se precisar de analisar documentos em sequência, mas não puder utilizar ignorar devido a esta limitação, considere utilizar orderby numa chave totalmente ordenada e filtre com uma consulta de intervalo.
speller	QuerySpellerType	Um valor que especificou o tipo do soletrador a utilizar para corrigir ortográficos termos de consulta de pesquisa individuais.
top	integer	O número de resultados da pesquisa a obter. Isto pode ser utilizado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser utilizado para emitir outro pedido de Pesquisa para a próxima página de resultados.
vectorFilterMode	VectorFilterMode	Determina se os filtros são aplicados antes ou depois de a pesquisa de vetor ser executada. A predefinição é "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Os parâmetros de consulta para consultas de vetor e pesquisa híbrida.

SearchResult

Contém um documento encontrado por uma consulta de pesquisa, bem como metadados associados.

Name	Tipo	Description
@search.captions	CaptionResult[]	As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. São frequentemente utilizados como resumo do documento. As legendas só são devolvidas para consultas do tipo "semântico".
@search.documentDebugInfo	DocumentDebugInfo[]	Contém informações de depuração que podem ser utilizadas para explorar ainda mais os resultados da pesquisa.
@search.highlights	object	Fragmentos de texto do documento que indicam os termos de pesquisa correspondentes, organizados por cada campo aplicável; null if hit highlighting was not enabled for the query.
@search.rerankerScore	number	A classificação de relevância calculada pelo classificador semântico para os principais resultados da pesquisa. Os resultados da pesquisa são ordenados primeiro pelo RerankerScore e, em seguida, pela Pontuação. RerankerScore só é devolvido para consultas do tipo "semântico".
@search.score	number	A classificação de relevância do documento em comparação com outros documentos devolvidos pela consulta.

SemanticDebugInfo

Name	Tipo	Description
contentFields	QueryResultDocumentSemanticField[]	Os campos de conteúdo que foram enviados para o processo de melhoramento semântico, bem como como foram utilizados
keywordFields	QueryResultDocumentSemanticField[]	Os campos de palavra-chave que foram enviados para o processo de melhoramento semântico, bem como como foram utilizados
rerankerInput	QueryResultDocumentRerankerInput	As cadeias concatenadas não processadas que foram enviadas para o processo de melhoramento semântico.
titleField	QueryResultDocumentSemanticField	O campo de título que foi enviado para o processo de melhoramento semântico, bem como como foi utilizado

SemanticErrorMode

Permite ao utilizador escolher se uma chamada semântica deve falhar completamente ou devolver resultados parciais (predefinição).

Name	Tipo	Description
fail	string	Se existir uma exceção durante o passo de processamento semântico, a consulta falhará e devolverá o código HTTP adequado consoante o erro.
partial	string	Se o processamento semântico falhar, os resultados parciais continuarão a ser devolvidos. A definição de resultados parciais depende do passo semântico que falhou e qual foi o motivo da falha.

SemanticErrorReason

Motivo pelo qual foi devolvida uma resposta parcial para um pedido de classificação semântica.

Name	Tipo	Description
capacityOverloaded	string	O pedido foi limitado. Apenas os resultados base foram devolvidos.
maxWaitExceeded	string	Se "semmanticMaxWaitInMilliseconds" tiver sido definido e a duração do processamento semântico exceder esse valor. Apenas os resultados base foram devolvidos.
transient	string	Pelo menos um passo do processo semântico falhou.

SemanticFieldState

A forma como o campo foi utilizado para o processo de melhoramento semântico (totalmente utilizado, parcialmente utilizado ou não utilizado)

Name	Tipo	Description
partial	string	O campo foi parcialmente utilizado para melhoramento semântico.
unused	string	O campo não foi utilizado para melhoramento semântico.
used	string	O campo foi totalmente utilizado para melhoramento semântico.

SemanticSearchResultsType

Tipo de resposta parcial que foi devolvida para um pedido de classificação semântica.

Name	Tipo	Description
baseResults	string	Resultados sem qualquer melhoramento semântico ou reclassificador.
rerankedResults	string	Os resultados foram reclassificados com o modelo de reranker e incluirão legendas semânticas. Não incluirão respostas, realces de respostas ou destaques legenda.

Speller

Melhore a recolha de pesquisas ao corrigir ortográficos termos de consulta de pesquisa individuais.

Name	Tipo	Description
lexicon	string	O speller corrige os termos de consulta individuais com um léxico estático para a linguagem especificada pelo parâmetro queryLanguage.
none	string	O ortográfico não está ativado.

VectorFilterMode

Determina se os filtros são aplicados antes ou depois de a pesquisa de vetor ser executada.

Name	Tipo	Description
postFilter	string	O filtro será aplicado após o conjunto de candidatos dos resultados do vetor ser devolvido. Dependendo da seletividade do filtro, isto pode resultar em menos resultados do que os pedidos pelo parâmetro "k".
preFilter	string	O filtro será aplicado antes da consulta de pesquisa.

VectorizableTextQuery

Os parâmetros de consulta a utilizar para pesquisa de vetores quando é fornecido um valor de texto que precisa de ser vetorizado.

Name	Tipo	Description
exhaustive	boolean	Quando verdadeiro, aciona uma pesquisa de vizinho k-próxima exaustiva em todos os vetores dentro do índice de vetor. Útil para cenários em que as correspondências exatas são críticas, como determinar valores de verdade básica.
fields	string	Campos de Vetor do tipo Coleção(Edm.Single) a incluir no vetor pesquisado.
k	integer	Número de vizinhos mais próximos a regressar à medida que os primeiros atingem.
kind	string: text	O tipo de consulta de vetor que está a ser executada.
text	string	O texto a ser vetorizado para executar uma consulta de pesquisa de vetor.

VectorQueryKind

O tipo de consulta de vetor que está a ser executada.

Name	Tipo	Description
text	string	Consulta de vetor onde é fornecido um valor de texto que precisa de ser vetorizado.
vector	string	Consulta de vetor onde é fornecido um valor de vetor não processado.