Documents - Search Post

Referência

Serviço:: Search Service

Versão da API:: 2024-11-01-preview

Pesquisa documentos no índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-11-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>.
hybridSearch	HybridSearch	Os parâmetros de consulta para configurar comportamentos de pesquisa híbrida.
minimumCoverage	number	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.
queryRewrites	QueryRewritesType	Um valor que especifica se as reescritas de consulta devem ser geradas para aumentar a 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 (comportamento padrão/atual) ou retornar resultados parciais.
semanticFields	string	A lista separada por vírgulas de nomes de campo usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer	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	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	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" para novos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	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	ErrorResponse	Resposta de erro.

Exemplos

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Solicitação de exemplo

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2024-11-01-preview


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "orderby": "id desc",
  "queryType": "simple",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1,
      "threshold": {
        "value": 0.984,
        "kind": "vectorSimilarity"
      },
      "filterOverride": "ownerId eq 'sam'"
    }
  ],
  "vectorFilterMode": "preFilter",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  }
}

Resposta de exemplo

Código de status:: 200

{
  "@odata.count": 27,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "9",
      "name": "test",
      "description": "test9 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "6",
      "name": "test",
      "description": "test6 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "3",
      "name": "test",
      "description": "test3 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "24",
      "name": "test",
      "description": "test24 hello",
      "category": "purple",
      "ownerId": "ryan"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-01-preview

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Resposta de exemplo

Código de status:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-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 `semantic`.
DebugInfo	Contém informações de depuração que podem ser usadas para explorar ainda mais os resultados da pesquisa.
DocumentDebugInfo	Contém informações de depuração que podem ser usadas para explorar ainda mais os resultados da pesquisa.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HybridCountAndFacetMode	Determina se a contagem e as facetas devem incluir todos os documentos que corresponderam à consulta de pesquisa ou apenas os documentos recuperados na janela 'maxTextRecallSize'. O valor padrão é 'countAllResults'.
HybridSearch	Os parâmetros de consulta para configurar comportamentos de pesquisa híbrida.
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. Você pode habilitar vários modos de depuração simultaneamente separando-os com um \| caractere, por exemplo: semântico\|queryRewrites.
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
QueryResultDocumentSubscores	A divisão de subscores entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta de vetor é mostrada como um objeto separado na mesma ordem em que foram recebidos.
QueryRewritesDebugInfo	Contém informações de depuração específicas para reescritas de consulta.
QueryRewritesType	Um valor que especifica se as reescritas de consulta devem ser geradas para aumentar a consulta de pesquisa.
QueryRewritesValuesDebugInfo	Contém informações de depuração específicas para reescritas de consulta.
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.
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.
SearchScoreThreshold	Os resultados da consulta de vetor serão filtrados com base no valor '@search.score'. Observe que esta é a @search.score retornada como parte da resposta de pesquisa. A direção do limite será escolhida para @search.scoresuperiores.
SemanticDebugInfo
SemanticErrorMode	Permite que o usuário escolha se uma chamada semântica deve falhar completamente (comportamento padrão/atual) ou retornar resultados parciais.
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)
SemanticQueryRewritesResultType	Tipo de reescrita de consulta que foi usada para essa solicitação.
SemanticSearchResultsType	Tipo de resposta parcial retornada para uma solicitação de classificação semântica.
SingleVectorFieldResult	Um único resultado de campo de vetor. Os valores de similaridade de @search.score e vetor são retornados. A similaridade de vetor está relacionada a @search.score por uma equação.
TextResult	A pontuação BM25 ou Classic para a parte de texto da consulta.
VectorFilterMode	Determina se os filtros são aplicados antes ou depois que a pesquisa de vetor é executada.
VectorizableImageBinaryQuery	Os parâmetros de consulta a serem usados para pesquisa de vetor quando um binário codificado em base 64 de uma imagem que precisa ser vetorizada é fornecido.
VectorizableImageUrlQuery	Os parâmetros de consulta a serem usados para pesquisa de vetor quando uma URL que representa um valor de imagem que precisa ser vetorizado é fornecida.
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.
VectorsDebugInfo
VectorSimilarityThreshold	Os resultados da consulta de vetor serão filtrados com base na métrica de similaridade de vetor. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "distância". A direção do limite (maior ou menor) será escolhida automaticamente de acordo com a métrica usada pelo campo.
VectorThresholdKind	O tipo de consulta de vetor que está sendo executada.

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.

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	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

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 semantic.

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.

DebugInfo

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

Nome	Tipo	Description
queryRewrites	QueryRewritesDebugInfo	Contém informações de depuração específicas para reescritas de consulta.

DocumentDebugInfo

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.
vectors	VectorsDebugInfo	Contém informações de depuração específicas para vetor e pesquisa híbrida.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HybridCountAndFacetMode

Determina se a contagem e as facetas devem incluir todos os documentos que corresponderam à consulta de pesquisa ou apenas os documentos recuperados na janela 'maxTextRecallSize'. O valor padrão é 'countAllResults'.

Nome	Tipo	Description
countAllResults	string	Inclua todos os documentos que foram correspondidos pela consulta de pesquisa ao calcular 'count' e 'facets', independentemente de esses documentos estarem ou não dentro da janela de recuperação 'maxTextRecallSize'.
countRetrievableResults	string	Inclua apenas documentos que foram correspondidos na janela de recuperação 'maxTextRecallSize' ao calcular 'count' e 'facets'.

HybridSearch

Os parâmetros de consulta para configurar comportamentos de pesquisa híbrida.

Nome	Tipo	Description
countAndFacetMode	HybridCountAndFacetMode	Determina se a contagem e as facetas devem incluir todos os documentos que corresponderam à consulta de pesquisa ou apenas os documentos recuperados na janela 'maxTextRecallSize'.
maxTextRecallSize	integer	Determina o número máximo de documentos a serem recuperados pela parte de consulta de texto de uma solicitação de pesquisa híbrida. Esses documentos serão combinados com os documentos que correspondem às consultas de vetor para produzir uma única lista final de resultados. Escolher um valor maxTextRecallSize maior permitirá a recuperação e a paginação por meio de mais documentos (usando os parâmetros top e skip), ao custo de maior utilização de recursos e maior latência. O valor precisa estar entre 1 e 10.000. O padrão é 1000.

QueryAnswerType

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

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

QueryCaptionType

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

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

QueryDebugMode

Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa. Você pode habilitar vários modos de depuração simultaneamente separando-os com um | caractere, por exemplo: semântico|queryRewrites.

Nome	Tipo	Description
all	string	Ative todas as opções de depuração.
disabled	string	Nenhuma informação de depuração de consulta será retornada.
queryRewrites	string	Permite que o usuário explore a lista de reescritas de consulta geradas para sua solicitação de pesquisa.
semantic	string	Permite que o usuário explore ainda mais seus resultados reclassificados.
vector	string	Permite que o usuário explore ainda mais seus resultados de consulta híbrida e vetor.

QueryLanguage

O idioma da consulta.

Nome	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 Tcheco (República Tcheca).
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 estoniano (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 o 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ésia (Indonésia).
is-is	string	Valor da linguagem de consulta para Islândia (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 malaia (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 holandês (Bélgica).
nl-nl	string	Valor da linguagem de consulta para holandês (Países Baixos).
no-no	string	Valor da linguagem de consulta para norueguês (Noruega).
none	string	Idioma de consulta não especificado.
pa-in	string	Valor da linguagem de consulta para Punjabi (Índia).
pl-pl	string	Valor da linguagem de consulta para polonês (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 vietnamita (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 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

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)

QueryResultDocumentSubscores

A divisão de subscores entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta de vetor é mostrada como um objeto separado na mesma ordem em que foram recebidos.

Nome	Tipo	Description
documentBoost	number	A pontuação BM25 ou Classic para a parte de texto da consulta.
text	TextResult	A pontuação BM25 ou Classic para a parte de texto da consulta.
vectors	<string, SingleVectorFieldResult>	A similaridade do vetor e @search.score valores para cada consulta de vetor.

QueryRewritesDebugInfo

Contém informações de depuração específicas para reescritas de consulta.

Nome	Tipo	Description
text	QueryRewritesValuesDebugInfo	Lista de reescritas de consulta geradas para a consulta de texto.
vectors	QueryRewritesValuesDebugInfo[]	Lista de reescritas de consulta geradas para as consultas de texto vetorizáveis.

QueryRewritesType

Um valor que especifica se as reescritas de consulta devem ser geradas para aumentar a consulta de pesquisa.

Nome	Tipo	Description
generative	string	Gere termos de consulta alternativos para aumentar o recall de uma solicitação de pesquisa.
none	string	Não gere reescritas de consulta adicionais para essa consulta.

QueryRewritesValuesDebugInfo

Contém informações de depuração específicas para reescritas de consulta.

Nome	Tipo	Description
inputQuery	string	O texto de entrada para o modelo de reescrita de consulta gerativa. Pode haver casos em que a consulta de usuário e a entrada para o modelo de geração não são idênticas.
rewrites	string[]	Lista de regravações de consulta.

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.

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

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.

Nome	Tipo	Description
full	string	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	string	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.
simple	string	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.

RawVectorQuery

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.
filterOverride	string	A expressão de filtro OData a ser aplicada a essa consulta vetor específica. Se nenhuma expressão de filtro for definida no nível do vetor, a expressão definida no parâmetro de filtro de nível superior será usada.
k	integer	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.
oversampling	number	Fator de sobrecarga. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo de vetor subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas de vetor. Observe que isso só poderá ser definido se todos os "campos" usarem a mesma métrica de similaridade.
vector	number[]	A representação de vetor de uma consulta de pesquisa.
weight	number	Peso relativo da consulta de vetor quando comparado com outra consulta de vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas de vetor e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

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.

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

SearchDocumentsResult

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

Nome	Tipo	Description
@odata.count	integer	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	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.debug	DebugInfo	Informações de depuração que se aplicam aos resultados da pesquisa como um todo.
@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.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Tipo de reescrita de consulta usada para recuperar documentos.
value	SearchResult[]	A sequência de resultados retornados pela consulta.

SearchMode

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

Nome	Tipo	Description
all	string	Todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.
any	string	Qualquer um dos termos de pesquisa deve ser correspondido 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.

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>.
hybridSearch	HybridSearch	Os parâmetros de consulta para configurar comportamentos de pesquisa híbrida.
minimumCoverage	number	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.
queryRewrites	QueryRewritesType	Um valor que especifica se as reescritas de consulta devem ser geradas para aumentar a 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 (comportamento padrão/atual) ou retornar resultados parciais.
semanticFields	string	A lista separada por vírgulas de nomes de campo usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer	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	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	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" para novos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Os parâmetros de consulta para consultas de pesquisa vetor e híbrida.

SearchResult

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	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	A pontuação de relevância do documento em comparação com outros documentos retornados pela consulta.

SearchScoreThreshold

Os resultados da consulta de vetor serão filtrados com base no valor '@search.score'. Observe que esta é a @search.score retornada como parte da resposta de pesquisa. A direção do limite será escolhida para @search.scoresuperiores.

Nome	Tipo	Description
kind	string: searchScore	O tipo de limite usado para filtrar consultas de vetor
value	number	O limite será filtrado com base no valor '@search.score'. Observe que esta é a @search.score retornada como parte da resposta de pesquisa. A direção do limite será escolhida para @search.scoresuperiores.

SemanticDebugInfo

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

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

Nome	Tipo	Description
fail	string	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.
partial	string	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.

SemanticErrorReason

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

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

SemanticFieldState

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

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

SemanticQueryRewritesResultType

Tipo de reescrita de consulta que foi usada para essa solicitação.

Nome	Tipo	Description
originalQueryOnly	string	As reescritas de consulta não foram geradas com êxito para essa solicitação. Somente a consulta original foi usada para recuperar os resultados.

SemanticSearchResultsType

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

Nome	Tipo	Description
baseResults	string	Resultados sem nenhum enriquecimento semântico ou reclassificado.
rerankedResults	string	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.

SingleVectorFieldResult

Um único resultado de campo de vetor. Os valores de similaridade de @search.score e vetor são retornados. A similaridade de vetor está relacionada a @search.score por uma equação.

Nome	Tipo	Description
searchScore	number	O valor @search.score calculado a partir da pontuação de similaridade do vetor. Essa é a pontuação visível em uma consulta de vetor único de campo único puro.
vectorSimilarity	number	A pontuação de similaridade de vetor para este documento. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "distância". Por exemplo, similaridade de cosseno em vez de distância de cosseno.

TextResult

A pontuação BM25 ou Classic para a parte de texto da consulta.

Nome	Tipo	Description
searchScore	number	A pontuação BM25 ou Classic para a parte de texto da consulta.

VectorFilterMode

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

Nome	Tipo	Description
postFilter	string	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	string	O filtro será aplicado antes da consulta de pesquisa.

VectorizableImageBinaryQuery

Os parâmetros de consulta a serem usados para pesquisa de vetor quando um binário codificado em base 64 de uma imagem que precisa ser vetorizada é fornecido.

Nome	Tipo	Description
base64Image	string	O binário codificado em base 64 de uma imagem a ser vetorizada para executar uma consulta de pesquisa de vetor.
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.
filterOverride	string	A expressão de filtro OData a ser aplicada a essa consulta vetor específica. Se nenhuma expressão de filtro for definida no nível do vetor, a expressão definida no parâmetro de filtro de nível superior será usada.
k	integer	Número de vizinhos mais próximos a serem retornados como as principais ocorrências.
kind	string: imageBinary	O tipo de consulta de vetor que está sendo executada.
oversampling	number	Fator de sobrecarga. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo de vetor subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas de vetor. Observe que isso só poderá ser definido se todos os "campos" usarem a mesma métrica de similaridade.
weight	number	Peso relativo da consulta de vetor quando comparado com outra consulta de vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas de vetor e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

VectorizableImageUrlQuery

Os parâmetros de consulta a serem usados para pesquisa de vetor quando uma URL que representa um valor de imagem que precisa ser vetorizado é fornecida.

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.
filterOverride	string	A expressão de filtro OData a ser aplicada a essa consulta vetor específica. Se nenhuma expressão de filtro for definida no nível do vetor, a expressão definida no parâmetro de filtro de nível superior será usada.
k	integer	Número de vizinhos mais próximos a serem retornados como as principais ocorrências.
kind	string: imageUrl	O tipo de consulta de vetor que está sendo executada.
oversampling	number	Fator de sobrecarga. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo de vetor subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas de vetor. Observe que isso só poderá ser definido se todos os "campos" usarem a mesma métrica de similaridade.
url	string	A URL de uma imagem a ser vetorizada para executar uma consulta de pesquisa de vetor.
weight	number	Peso relativo da consulta de vetor quando comparado com outra consulta de vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas de vetor e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

VectorizableTextQuery

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.
filterOverride	string	A expressão de filtro OData a ser aplicada a essa consulta vetor específica. Se nenhuma expressão de filtro for definida no nível do vetor, a expressão definida no parâmetro de filtro de nível superior será usada.
k	integer	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.
oversampling	number	Fator de sobrecarga. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo de vetor subjacente.
queryRewrites	QueryRewritesType	Pode ser configurado para permitir que um modelo generativo reescreva a consulta antes de enviá-la para ser vetorizada.
text	string	O texto a ser vetorizado para executar uma consulta de pesquisa de vetor.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas de vetor. Observe que isso só poderá ser definido se todos os "campos" usarem a mesma métrica de similaridade.
weight	number	Peso relativo da consulta de vetor quando comparado com outra consulta de vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas de vetor e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

VectorQueryKind

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

Nome	Tipo	Description
imageBinary	string	Consulta vetor em que um binário codificado em base 64 de uma imagem que precisa ser vetorizada é fornecida.
imageUrl	string	Consulta vetor em que uma URL que representa um valor de imagem que precisa ser vetorizada é fornecida.
text	string	Consulta vetor em que um valor de texto que precisa ser vetorizado é fornecido.
vector	string	Consulta vetor em que um valor de vetor bruto é fornecido.

VectorsDebugInfo

Nome	Tipo	Description
subscores	QueryResultDocumentSubscores	A divisão de subscores do documento antes do método de combinação/fusão do conjunto de resultados escolhido, como RRF.

VectorSimilarityThreshold

Os resultados da consulta de vetor serão filtrados com base na métrica de similaridade de vetor. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "distância". A direção do limite (maior ou menor) será escolhida automaticamente de acordo com a métrica usada pelo campo.

Nome	Tipo	Description
kind	string: vectorSimilarity	O tipo de limite usado para filtrar consultas de vetor
value	number	O limite será filtrado com base no valor da métrica de similaridade. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "distância". A direção do limite (maior ou menor) será escolhida automaticamente de acordo com a métrica usada pelo campo.

VectorThresholdKind

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

Nome	Tipo	Description
searchScore	string	Os resultados da consulta de vetor serão filtrados com base no valor '@search.score'. Observe que esta é a @search.score retornada como parte da resposta de pesquisa. A direção do limite será escolhida para @search.scoresuperiores.
vectorSimilarity	string	Os resultados da consulta de vetor serão filtrados com base na métrica de similaridade de vetor. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "distância". A direção do limite (maior ou menor) será escolhida automaticamente de acordo com a métrica usada pelo campo.

Compartilhar via

Documents - Search Post

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Exemplos

SearchIndexSearchDocumentsPost

Solicitação de exemplo

Resposta de exemplo

SearchIndexSearchDocumentsSemanticPost

Solicitação de exemplo

Resposta de exemplo

Definições

AnswerResult

CaptionResult

DebugInfo

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HybridCountAndFacetMode

HybridSearch

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryLanguage

QueryResultDocumentRerankerInput

QueryResultDocumentSemanticField

QueryResultDocumentSubscores

QueryRewritesDebugInfo

QueryRewritesType

QueryRewritesValuesDebugInfo

QuerySpellerType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SearchScoreThreshold

SemanticDebugInfo

SemanticErrorMode

SemanticErrorReason

SemanticFieldState

SemanticQueryRewritesResultType

SemanticSearchResultsType

SingleVectorFieldResult

TextResult

VectorFilterMode

VectorizableImageBinaryQuery

VectorizableImageUrlQuery

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo

VectorSimilarityThreshold

VectorThresholdKind

Recursos adicionais