Documents - Search Post

Serviço:: Search Service

Versão da API:: 2023-10-01-Preview

Pesquisa documentos no índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	A ID de acompanhamento enviada com a solicitação para ajudar na depuração.

Corpo da solicitação

Nome	Tipo	Description
answers	QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta de pesquisa.
captions	QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta de pesquisa.
count	boolean	Um valor que especifica se a contagem total de resultados deve ser buscada. O padrão é false. Definir esse valor como true pode ter um impacto no desempenho. Observe que a contagem retornada é uma aproximação.
debug	QueryDebugMode	Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais seus resultados reclassificados.
facets	string[]	A lista de expressões de faceta a serem aplicadas à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido por uma lista separada por vírgulas de pares nome:valor.
filter	string	A expressão $filter OData a ser aplicada à consulta de pesquisa.
highlight	string	A lista separada por vírgulas de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.
highlightPostTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage	number (double)	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 100.
orderby	string	A lista separada por vírgulas do OData $orderby expressões pelas quais classificar 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 crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $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. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene.
scoringParameters	string[]	A lista de valores de parâmetro a serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile	string	O nome de um perfil de pontuação para avaliar as pontuações de correspondência de documentos correspondentes para classificar os resultados.
scoringStatistics	ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é "local". Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.
search	string	Uma expressão de consulta de pesquisa de texto completo; Use "*" ou omita esse parâmetro para corresponder a todos os documentos.
searchFields	string	A lista separada por vírgulas de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre todos os nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se qualquer um ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.
select	string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos.
semanticConfiguration	string	O nome de uma configuração semântica que será usada ao processar documentos para consultas de semântica de tipo.
semanticErrorHandling	SemanticErrorMode	Permite que o usuário escolha se uma chamada semântica deve falhar completamente ou retornar resultados parciais (padrão).
semanticFields	string	A lista separada por vírgulas de nomes de campo usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permite que o usuário defina um limite superior na quantidade de tempo necessária para que o enriquecimento semântico conclua o processamento antes que a solicitação falhe.
semanticQuery	string	Permite definir uma consulta de pesquisa separada que será usada exclusivamente para o reclassificado semântico, legendas semânticas e respostas semânticas. É útil para cenários em que há a necessidade de usar consultas diferentes entre a fase de recuperação e classificação base e a fase semântica L2.
sessionId	string	Um valor a ser usado para criar uma sessão autoadesiva, que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere '_'.
skip	integer (int32)	O número de resultados da pesquisa a serem ignoradas. Esse valor não pode ser maior que 100.000. Se você precisar verificar documentos em sequência, mas não puder usar ignorar devido a essa limitação, considere usar orderby em uma chave totalmente ordenada e filtrar com uma consulta de intervalo.
speller	QuerySpellerType	Um valor que especificou o tipo do verificador ortográfico a ser usado para corrigir os termos de consulta de pesquisa individuais com correção ortográfica.
top	integer (int32)	O número de resultados da pesquisa a serem recuperados. Isso pode ser usado 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 usado para emitir outra solicitação de pesquisa para a próxima página de resultados.
vectorFilterMode	VectorFilterMode	Determina se os filtros são aplicados antes ou depois que a pesquisa de vetor é executada. O padrão é 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Os parâmetros de consulta para consultas de pesquisa vetor e híbrida.

Respostas

Nome	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

SearchIndexSearchDocumentsPost

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Resposta de exemplo

Código de status:: 200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "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"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

Definições

Nome	Description
AnswerResult	Uma resposta é uma passagem de texto extraída do conteúdo dos documentos mais relevantes que corresponderam à consulta. As respostas são extraídas dos principais resultados da pesquisa. Os candidatos de resposta são pontuados e as principais respostas são selecionadas.
CaptionResult	As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. Eles geralmente são usados como resumo do documento. As legendas são retornadas apenas para consultas do tipo 'semântica'..
DocumentDebugInfo	Contém informações de depuração que podem ser usadas para explorar ainda mais os resultados da pesquisa.
QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta de pesquisa.
QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta de pesquisa.
QueryDebugMode	Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa.
QueryLanguage	O idioma da consulta.
QueryResultDocumentRerankerInput	As cadeias de caracteres concatenadas brutas que foram enviadas para o processo de enriquecimento semântico.
QueryResultDocumentSemanticField	Descrição dos campos que foram enviados para o processo de enriquecimento semântico, bem como como eles foram usados
QuerySpellerType	Um valor que especificou o tipo do verificador ortográfico a ser usado para corrigir os termos de consulta de pesquisa individuais com correção ortográfica.
QueryType	Especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene e a 'semântica' se a sintaxe da consulta não for necessária.
RawVectorQuery	Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de vetor bruto é fornecido.
ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é "local". Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.
SearchDocumentsResult	Resposta que contém os resultados da pesquisa de um índice.
SearchError	Descreve uma condição de erro para a API.
SearchMode	Especifica se qualquer um ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.
SearchRequest	Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa.
SearchResult	Contém um documento encontrado por uma consulta de pesquisa, além de metadados associados.
SemanticDebugInfo
SemanticErrorMode	Permite que o usuário escolha se uma chamada semântica deve falhar completamente ou retornar resultados parciais (padrão).
SemanticErrorReason	Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de classificação semântica.
SemanticFieldState	A maneira como o campo foi usado para o processo de enriquecimento semântico (totalmente usado, parcialmente usado ou não utilizado)
SemanticSearchResultsType	Tipo de resposta parcial retornada para uma solicitação de classificação semântica.
VectorFilterMode	Determina se os filtros são aplicados antes ou depois que a pesquisa de vetor é executada.
VectorizableTextQuery	Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de texto que precisa ser vetorizado é fornecido.
VectorQueryKind	O tipo de consulta de vetor que está sendo executada.

AnswerResult

Objeto

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

Nome	Tipo	Description
highlights	string	Mesma passagem de texto da propriedade Text com frases de texto realçadas mais relevantes para a consulta.
key	string	A chave do documento da qual a resposta foi extraída.
score	number (double)	O valor da pontuação representa o quão relevante é a resposta para a consulta em relação a outras respostas retornadas para a consulta.
text	string	A passagem de texto extraída do conteúdo do documento como a resposta.

CaptionResult

Objeto

As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. Eles geralmente são usados como resumo do documento. As legendas são retornadas apenas para consultas do tipo 'semântica'..

Nome	Tipo	Description
highlights	string	Mesma passagem de texto que na propriedade Text com frases 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

Objeto

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

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

QueryAnswerType

Enumeração

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

Valor	Description
none	Não retorne respostas para a consulta.
extractive	Extrai os candidatos de resposta do conteúdo dos documentos retornados em resposta a uma consulta expressa como uma pergunta em linguagem natural.

QueryCaptionType

Enumeração

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

Valor	Description
none	Não retorne legendas para a consulta.
extractive	Extrai legendas dos documentos correspondentes que contêm passagens relevantes para a consulta de pesquisa.

QueryDebugMode

Enumeração

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

Valor	Description
disabled	Nenhuma informação de depuração de consulta será retornada.
semantic	Permite que o usuário explore ainda mais seus resultados reclassificados.

QueryLanguage

Enumeração

O idioma da consulta.

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

QueryResultDocumentRerankerInput

Objeto

As cadeias de caracteres concatenadas brutas que foram enviadas para o processo de enriquecimento semântico.

Nome	Tipo	Description
content	string	As cadeias de caracteres concatenadas brutas para os campos de conteúdo que foram usados para enriquecimento semântico.
keywords	string	As cadeias de caracteres concatenadas brutas para os campos de palavra-chave que foram usados para enriquecimento semântico.
title	string	A cadeia de caracteres bruta para o campo de título que foi usado para enriquecimento semântico.

QueryResultDocumentSemanticField

Objeto

Descrição dos campos que foram enviados para o processo de enriquecimento semântico, bem como como eles foram usados

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

QuerySpellerType

Enumeração

Um valor que especificou o tipo do verificador ortográfico a ser usado para corrigir os termos de consulta de pesquisa individuais com correção ortográfica.

Valor	Description
none	O verificador ortográfico não está habilitado.
lexicon	O verificador ortográfico corrige os termos de consulta individuais usando um léxico estático para o idioma especificado pelo parâmetro queryLanguage.

QueryType

Enumeração

Especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene e a 'semântica' se a sintaxe da consulta não for necessária.

Valor	Description
simple	Usa a sintaxe de consulta simples para pesquisas. O texto de pesquisa é interpretado usando uma linguagem de consulta simples que permite símbolos como +, * e "". As consultas são avaliadas em todos os campos pesquisáveis por padrão, a menos que o parâmetro searchFields seja especificado.
full	Usa a sintaxe de consulta Lucene completa para pesquisas. O texto de pesquisa é interpretado usando a linguagem de consulta Lucene, que permite pesquisas específicas de campo e ponderadas, bem como outros recursos avançados.
semantic	Mais adequado para consultas expressas em linguagem natural em vez de palavras-chave. Melhora a precisão dos resultados da pesquisa ao classificar novamente os principais resultados da pesquisa usando um modelo de classificação treinado no corpus da Web.

RawVectorQuery

Objeto

Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de vetor bruto é fornecido.

Nome	Tipo	Description
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa completa de k-nearest vizinho em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade de base.
fields	string	Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.
k	integer (int32)	Número de vizinhos mais próximos a serem retornados como as principais ocorrências.
kind	string: vector	O tipo de consulta de vetor que está sendo executada.
vector	number[] (float)	A representação de vetor de uma consulta de pesquisa.

ScoringStatistics

Enumeração

Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é "local". Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.

Valor	Description
local	As estatísticas de pontuação serão calculadas localmente para menor latência.
global	As estatísticas de pontuação serão calculadas globalmente para uma pontuação mais consistente.

SearchDocumentsResult

Objeto

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

Nome	Tipo	Description
@odata.count	integer (int64)	A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não foi solicitada. Se presente, a contagem poderá ser maior do que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se a consulta não puder retornar todos os documentos solicitados em uma única resposta.
@odata.nextLink	string	URL de continuação retornada quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar essa URL para formular outra solicitação GET ou POST Search para obter a próxima parte da resposta de pesquisa. Use o mesmo verbo (GET ou POST) que a solicitação que produziu essa 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 foi especificado ou definido como 'none'.
@search.coverage	number (double)	Um valor que indica o percentual do índice que foi incluído na consulta ou nulo se minimumCoverage não foi especificado na solicitação.
@search.facets	object	Os resultados da consulta de faceta para a operação de pesquisa, organizada como uma coleção de buckets para cada campo facetado; nulo se a consulta não incluir nenhuma expressão de faceta.
@search.nextPageParameters	SearchRequest	Conteúdo JSON de continuação retornado quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar esse JSON juntamente com @odata.nextLink para formular outra solicitação post search para obter a próxima parte da resposta de pesquisa.
@search.semanticPartialResponseReason	SemanticErrorReason	Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de classificação semântica.
@search.semanticPartialResponseType	SemanticSearchResultsType	Tipo de resposta parcial retornada para uma solicitação de classificação semântica.
value	SearchResult[]	A sequência de resultados retornados pela consulta.

SearchError

Objeto

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

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível pelo ser humano do erro.

SearchMode

Enumeração

Especifica se qualquer um ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.

Valor	Description
any	Qualquer um dos termos de pesquisa deve ser correspondido para contar o documento como uma correspondência.
all	Todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.

SearchRequest

Objeto

Parâmetros para filtragem, classificação, faceta, paginação e outros comportamentos de consulta de pesquisa.

Nome	Tipo	Description
answers	QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta de pesquisa.
captions	QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta de pesquisa.
count	boolean	Um valor que especifica se a contagem total de resultados deve ser buscada. O padrão é false. Definir esse valor como true pode ter um impacto no desempenho. Observe que a contagem retornada é uma aproximação.
debug	QueryDebugMode	Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais seus resultados reclassificados.
facets	string[]	A lista de expressões de faceta a serem aplicadas à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido por uma lista separada por vírgulas de pares nome:valor.
filter	string	A expressão $filter OData a ser aplicada à consulta de pesquisa.
highlight	string	A lista separada por vírgulas de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.
highlightPostTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage	number (double)	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 100.
orderby	string	A lista separada por vírgulas do OData $orderby expressões pelas quais classificar 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 crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $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. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene.
scoringParameters	string[]	A lista de valores de parâmetro a serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile	string	O nome de um perfil de pontuação para avaliar as pontuações de correspondência de documentos correspondentes para classificar os resultados.
scoringStatistics	ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é "local". Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.
search	string	Uma expressão de consulta de pesquisa de texto completo; Use "*" ou omita esse parâmetro para corresponder a todos os documentos.
searchFields	string	A lista separada por vírgulas de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre todos os nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se qualquer um ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.
select	string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos.
semanticConfiguration	string	O nome de uma configuração semântica que será usada ao processar documentos para consultas de semântica de tipo.
semanticErrorHandling	SemanticErrorMode	Permite que o usuário escolha se uma chamada semântica deve falhar completamente ou retornar resultados parciais (padrão).
semanticFields	string	A lista separada por vírgulas de nomes de campo usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permite que o usuário defina um limite superior na quantidade de tempo necessária para que o enriquecimento semântico conclua o processamento antes que a solicitação falhe.
semanticQuery	string	Permite definir uma consulta de pesquisa separada que será usada exclusivamente para o reclassificado semântico, legendas semânticas e respostas semânticas. É útil para cenários em que há a necessidade de usar consultas diferentes entre a fase de recuperação e classificação base e a fase semântica L2.
sessionId	string	Um valor a ser usado para criar uma sessão autoadesiva, que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere '_'.
skip	integer (int32)	O número de resultados da pesquisa a serem ignoradas. Esse valor não pode ser maior que 100.000. Se você precisar verificar documentos em sequência, mas não puder usar ignorar devido a essa limitação, considere usar orderby em uma chave totalmente ordenada e filtrar com uma consulta de intervalo.
speller	QuerySpellerType	Um valor que especificou o tipo do verificador ortográfico a ser usado para corrigir os termos de consulta de pesquisa individuais com correção ortográfica.
top	integer (int32)	O número de resultados da pesquisa a serem recuperados. Isso pode ser usado 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 usado para emitir outra solicitação de pesquisa para a próxima página de resultados.
vectorFilterMode	VectorFilterMode	Determina se os filtros são aplicados antes ou depois que a pesquisa de vetor é executada. O padrão é 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Os parâmetros de consulta para consultas de pesquisa vetor e híbrida.

SearchResult

Objeto

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

Nome	Tipo	Description
@search.captions	CaptionResult[]	As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. Eles geralmente são usados como resumo do documento. Legendas são retornadas apenas para consultas do tipo 'semântica'.
@search.documentDebugInfo	DocumentDebugInfo[]	Contém informações de depuração que podem ser usadas 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; nulo se o realce de ocorrência não estiver habilitado para a consulta.
@search.rerankerScore	number (double)	A pontuação de relevância computada pelo classificador semântico para os principais resultados da pesquisa. Os resultados da pesquisa são classificados pela RerankerScore primeiro e depois pela Pontuação. RerankerScore só é retornado para consultas do tipo 'semântica'.
@search.score	number (double)	A pontuação de relevância do documento em comparação com outros documentos retornados pela consulta.

SemanticDebugInfo

Objeto

Nome	Tipo	Description
contentFields	QueryResultDocumentSemanticField[]	Os campos de conteúdo que foram enviados para o processo de enriquecimento semântico, bem como como eles foram usados
keywordFields	QueryResultDocumentSemanticField[]	Os campos de palavra-chave que foram enviados para o processo de enriquecimento semântico, bem como como eles foram usados
rerankerInput	QueryResultDocumentRerankerInput	As cadeias de caracteres concatenadas brutas que foram enviadas para o processo de enriquecimento semântico.
titleField	QueryResultDocumentSemanticField	O campo de título que foi enviado para o processo de enriquecimento semântico, bem como como ele foi usado

SemanticErrorMode

Enumeração

Permite que o usuário escolha se uma chamada semântica deve falhar completamente ou retornar resultados parciais (padrão).

Valor	Description
partial	Se o processamento semântico falhar, os resultados parciais ainda retornarão. A definição de resultados parciais depende de qual etapa semântica falhou e qual foi o motivo da falha.
fail	Se houver uma exceção durante a etapa de processamento semântico, a consulta falhará e retornará o código HTTP apropriado dependendo do erro.

SemanticErrorReason

Enumeração

Motivo pelo qual uma resposta parcial foi retornada para uma solicitação de classificação semântica.

Valor	Description
maxWaitExceeded	Se 'semanticMaxWaitInMilliseconds' foi definido e a duração do processamento semântico excedeu esse valor. Somente os resultados base foram retornados.
capacityOverloaded	A solicitação foi limitada. Somente os resultados base foram retornados.
transient	Pelo menos uma etapa do processo semântico falhou.

SemanticFieldState

Enumeração

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

Valor	Description
used	O campo foi totalmente usado para enriquecimento semântico.
unused	O campo não foi usado para enriquecimento semântico.
partial	O campo foi parcialmente usado para enriquecimento semântico.

SemanticSearchResultsType

Enumeração

Tipo de resposta parcial retornada para uma solicitação de classificação semântica.

Valor	Description
baseResults	Resultados sem nenhum enriquecimento semântico ou reclassificado.
rerankedResults	Os resultados foram reclassificados com o modelo de reclassificador e incluirão legendas semânticas. Eles não incluirão respostas, realces de respostas ou realces de legenda.

VectorFilterMode

Enumeração

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

Valor	Description
postFilter	O filtro será aplicado depois que o conjunto candidato de resultados de vetor for retornado. Dependendo da seletividade do filtro, isso pode resultar em menos resultados do que o solicitado pelo parâmetro 'k'.
preFilter	O filtro será aplicado antes da consulta de pesquisa.

VectorizableTextQuery

Objeto

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

Nome	Tipo	Description
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa completa de k-nearest vizinho em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade de base.
fields	string	Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.
k	integer (int32)	Número de vizinhos mais próximos a serem retornados como as principais ocorrências.
kind	string: text	O tipo de consulta de vetor que está sendo executada.
text	string	O texto a ser vetorizado para executar uma consulta de pesquisa de vetor.

VectorQueryKind

Enumeração

O tipo de consulta de vetor que está sendo executada.

Valor	Description
vector	Consulta vetor em que um valor de vetor bruto é fornecido.
text	Consulta vetor em que um valor de texto que precisa ser vetorizado é fornecido.