Documents - Search Post

Referência

Serviço:: Search Service

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

Procura documentos no índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-11-01-preview

Parâmetros do URI

Name	Em	Necessá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 do Pedido

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

Corpo do Pedido

Name	Tipo	Description
answers	QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta da pesquisa.
captions	QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta da 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	Permite 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	O OData $filter expressão a ser aplicada à consulta de pesquisa.
highlight	string	A lista separada por vírgulas de nomes de campos a serem usados para destaques de cliques. Apenas os campos pesquisáveis podem ser usados para realce de cliques.
highlightPostTag	string	Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. O padrão é <em>.
hybridSearch	HybridSearch	Os parâmetros de consulta para configurar comportamentos de pesquisa híbridos.
minimumCoverage	number	Um número entre 0 e 100 que indica a porcentagem do índice que deve ser coberta por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 100.
orderby	string	A lista separada por vírgulas de 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 ascendente, ou desc para indicar descendente. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.
queryLanguage	QueryLanguage	Um valor que especifica o idioma da consulta de pesquisa.
queryRewrites	QueryRewritesType	Um valor que especifica se as regravações 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 sua consulta usar a sintaxe de consulta Lucene.
scoringParameters	string[]	A lista de valores de parâmetros 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 define uma função com um parâmetro chamado 'mylocation', a string do parâmetro seria "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 para documentos correspondentes, a fim de classificar os resultados.
scoringStatistics	ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. 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 este parâmetro para corresponder a todos os documentos.
searchFields	string	A lista separada por vírgulas de nomes de campos 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 quaisquer nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se algum 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 do tipo semântica.
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 campos usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer	Permite que o usuário defina um limite superior na quantidade de tempo que leva para o enriquecimento semântico concluir o processamento antes que a solicitação falhe.
semanticQuery	string	Permite definir uma consulta de pesquisa separada que será usada exclusivamente para reclassificação semântica, legendas semânticas e respostas semânticas. É útil para cenários em que há necessidade de usar consultas diferentes entre a fase de recuperação de base e classificação e a fase semântica L2.
sessionId	string	Um valor a ser usado para criar uma sessão pegajosa, que pode ajudar a obter resultados mais consistentes. Contanto que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Desconfie de que a reutilização repetida dos mesmos valores de sessionID pode 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 ignorar. Este valor não pode ser superior a 100.000. Se você precisar digitalizar documentos em sequência, mas não puder usar skip 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 corretor ortográfico a ser usado para corrigir a ortografia de termos de consulta de pesquisa individuais.
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 ou não aplicados antes ou depois da pesquisa vetorial ser executada. O padrão é 'preFilter' para novos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	Os parâmetros de consulta para consultas de pesquisa vetoriais e híbridas.

Respostas

Name	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

Pedido de amostra

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

Código de estado:: 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

Pedido de amostra

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

Código de estado:: 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

Name	Description
AnswerResult	Uma resposta é uma passagem de texto extraída do conteúdo dos documentos mais relevantes que correspondem à consulta. As respostas são extraídas dos principais resultados da pesquisa. Os candidatos às respostas são pontuados e as melhores respostas são selecionadas.
CaptionResult	As legendas são as passagens mais representativas do documento em relação à consulta de pesquisa. São frequentemente utilizados como resumo de documentos. As legendas só são retornadas 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HybridCountAndFacetMode	Determina se a contagem e as facetas devem incluir todos os documentos que correspondem à consulta de pesquisa ou apenas os documentos recuperados na janela 'maxTextRecallSize'. O valor padrão é 'countAllResults'.
HybridSearch	Parâmetros de consulta para configurar comportamentos de pesquisa híbridos.
QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta da pesquisa.
QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta da pesquisa.
QueryDebugMode	Permite uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa. Você pode ativar vários modos de depuração simultaneamente, separando-os com um \| caractere, por exemplo: semantic\|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 foram utilizados
QueryResultDocumentSubscores	A divisão de subpontuações entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta vetorial é mostrada como um objeto separado na mesma ordem em que foram recebidas.
QueryRewritesDebugInfo	Contém informações de depuração específicas para regravações de consulta.
QueryRewritesType	Um valor que especifica se as regravações de consulta devem ser geradas para aumentar a consulta de pesquisa.
QueryRewritesValuesDebugInfo	Contém informações de depuração específicas para regravações de consulta.
QuerySpellerType	Um valor que especificou o tipo do corretor ortográfico a ser usado para corrigir a ortografia de termos de consulta de pesquisa individuais.
QueryType	Especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'completo' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária.
RawVectorQuery	Os parâmetros de consulta a serem usados para pesquisa vetorial quando um valor vetorial bruto é fornecido.
ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. 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 resultados de pesquisa de um índice.
SearchMode	Especifica se algum ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.
SearchRequest	Parâmetros para filtragem, classificação, facetagem, 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 vetorial serão filtrados com base no valor '@search.score'. Observe que este é o @search.score retornado como parte da resposta da pesquisa. A direção do limiar 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 forma como o campo foi utilizado para o processo de enriquecimento semântico (totalmente utilizado, parcialmente utilizado ou não utilizado)
SemanticQueryRewritesResultType	Tipo de reescrita de consulta que foi usada para essa solicitação.
SemanticSearchResultsType	Tipo de resposta parcial que foi retornada para uma solicitação de classificação semântica.
SingleVectorFieldResult	Um único resultado de campo vetorial. Os valores de semelhança @search.score e vetorial são retornados. A semelhança vetorial está relacionada à @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 ou não aplicados antes ou depois da pesquisa vetorial ser executada.
VectorizableImageBinaryQuery	Os parâmetros de consulta a serem usados para pesquisa vetorial quando um binário codificado de base 64 de uma imagem que precisa ser vetorizada é fornecido.
VectorizableImageUrlQuery	Os parâmetros de consulta a serem usados para pesquisa vetorial 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 vetorial quando um valor de texto que precisa ser vetorizado é fornecido.
VectorQueryKind	O tipo de consulta vetorial que está sendo executada.
VectorsDebugInfo
VectorSimilarityThreshold	Os resultados da consulta vetorial serão filtrados com base na métrica de semelhança vetorial. Note que esta é a definição canônica de métrica de semelhança, não a versão '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 vetorial que está sendo executada.

AnswerResult

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

Name	Tipo	Description
highlights	string	Mesma passagem de texto que na 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 resposta.

CaptionResult

As legendas são as passagens mais representativas do documento em relação à consulta de pesquisa. São frequentemente utilizados como resumo de documentos. As legendas só são retornadas para consultas do tipo semantic.

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

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

DocumentDebugInfo

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

Name	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 pesquisa vetorial e híbrida.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HybridCountAndFacetMode

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

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

HybridSearch

Parâmetros de consulta para configurar comportamentos de pesquisa híbridos.

Name	Tipo	Description
countAndFacetMode	HybridCountAndFacetMode	Determina se a contagem e as facetas devem incluir todos os documentos que correspondem à 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 correspondentes às consultas vetoriais para produzir uma única lista final de resultados. Escolher um valor maxTextRecallSize maior permitirá recuperar e paginar mais documentos (usando os parâmetros superior e ignorado), 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 da pesquisa.

Name	Tipo	Description
extractive	string	Extrai os candidatos de resposta do conteúdo dos documentos devolvidos 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 da pesquisa.

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

QueryDebugMode

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

Name	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 regravações 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 vetorial.

QueryLanguage

O idioma da consulta.

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

QueryResultDocumentRerankerInput

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

Name	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 usada para enriquecimento semântico.

QueryResultDocumentSemanticField

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

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

QueryResultDocumentSubscores

A divisão de subpontuações entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta vetorial é mostrada como um objeto separado na mesma ordem em que foram recebidas.

Name	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 semelhança vetorial e os valores @search.score para cada consulta vetorial.

QueryRewritesDebugInfo

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

Name	Tipo	Description
text	QueryRewritesValuesDebugInfo	Lista de regravações de consulta geradas para a consulta de texto.
vectors	QueryRewritesValuesDebugInfo[]	Lista de regravações de consulta geradas para as consultas de texto vetorizáveis.

QueryRewritesType

Um valor que especifica se as regravações de consulta devem ser geradas para aumentar a consulta de pesquisa.

Name	Tipo	Description
generative	string	Gere termos de consulta alternativos para aumentar a recuperação de uma solicitação de pesquisa.
none	string	Não gere regravações de consulta adicionais para esta consulta.

QueryRewritesValuesDebugInfo

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

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

QuerySpellerType

Um valor que especificou o tipo do corretor ortográfico a ser usado para corrigir a ortografia de termos de consulta de pesquisa individuais.

Name	Tipo	Description
lexicon	string	O Speller corrige termos de consulta individuais usando um léxico estático para o idioma especificado pelo parâmetro queryLanguage.
none	string	Ortografia não ativada.

QueryType

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

Name	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 ponderadas e específicas de campo, 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 reclassificando os principais resultados de 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 vetorial quando um valor vetorial bruto é fornecido.

Name	Tipo	Description
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa exaustiva de vizinhos k-nearest em todos os vetores dentro do índice vetorial. Útil para cenários em que as correspondências exatas são críticas, como a determinação de valores de verdade no terreno.
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 vetorial 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 retornar como principais hits.
kind	string: vector	O tipo de consulta vetorial que está sendo executada.
oversampling	number	Fator de sobreamostragem. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele pode ser definido somente quando 'rerankWithOriginalVectors' é true. Este parâmetro só é permitido quando é utilizado um método de compressão no campo vetorial subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas vetoriais. Observe que isso só pode ser definido se todos os 'campos' usarem a mesma métrica de similaridade.
vector	number[]	A representação vetorial de uma consulta de pesquisa.
weight	number	Peso relativo da consulta vetorial quando comparado com outra consulta vetorial e/ou a consulta de texto dentro da mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maiores serão os documentos que corresponderam a essa consulta na classificação 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 documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. 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.

Name	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 resultados de pesquisa de um índice.

Name	Tipo	Description
@odata.count	integer	A contagem total de resultados encontrados pela operação de pesquisa, ou nula se a contagem não foi solicitada. Se presente, a contagem pode ser maior do que o número de resultados nesta 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 esse URL para formular outra solicitação de pesquisa GET ou POST para obter a próxima parte da resposta da pesquisa. Certifique-se de usar 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 Respostas não tiver sido especificado ou definido como 'Nenhum'.
@search.coverage	number	Um valor que indica a porcentagem do índice que foi incluído na consulta, ou null se minimumCoverage não foi especificado na solicitação.
@search.debug	DebugInfo	Depurar informações que se aplicam aos resultados da pesquisa como um todo.
@search.facets	object	Os resultados da consulta de facetas para a operação de pesquisa, organizados como uma coleção de buckets para cada campo facetado; null se a consulta não incluir expressões de faceta.
@search.nextPageParameters	SearchRequest	A carga JSON de continuação retornada quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar esse JSON junto com @odata.nextLink para formular outra solicitação de Pesquisa POST para obter a próxima parte da resposta da 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 que foi retornada para uma solicitação de classificação semântica.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Tipo de reescrita de consulta que foi usada para recuperar documentos.
value	SearchResult[]	A sequência de resultados retornada pela consulta.

SearchMode

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

Name	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, facetagem, paginação e outros comportamentos de consulta de pesquisa.

Name	Tipo	Description
answers	QueryAnswerType	Um valor que especifica se as respostas devem ser retornadas como parte da resposta da pesquisa.
captions	QueryCaptionType	Um valor que especifica se as legendas devem ser retornadas como parte da resposta da 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	Permite 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	O OData $filter expressão a ser aplicada à consulta de pesquisa.
highlight	string	A lista separada por vírgulas de nomes de campos a serem usados para destaques de cliques. Apenas os campos pesquisáveis podem ser usados para realce de cliques.
highlightPostTag	string	Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. O padrão é <em>.
hybridSearch	HybridSearch	Os parâmetros de consulta para configurar comportamentos de pesquisa híbridos.
minimumCoverage	number	Um número entre 0 e 100 que indica a porcentagem do índice que deve ser coberta por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 100.
orderby	string	A lista separada por vírgulas de 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 ascendente, ou desc para indicar descendente. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.
queryLanguage	QueryLanguage	Um valor que especifica o idioma da consulta de pesquisa.
queryRewrites	QueryRewritesType	Um valor que especifica se as regravações 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 sua consulta usar a sintaxe de consulta Lucene.
scoringParameters	string[]	A lista de valores de parâmetros 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 define uma função com um parâmetro chamado 'mylocation', a string do parâmetro seria "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 para documentos correspondentes, a fim de classificar os resultados.
scoringStatistics	ScoringStatistics	Um valor que especifica se queremos calcular estatísticas de pontuação (como frequência de documentos) globalmente para uma pontuação mais consistente ou localmente para uma latência mais baixa. 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 este parâmetro para corresponder a todos os documentos.
searchFields	string	A lista separada por vírgulas de nomes de campos 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 quaisquer nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se algum 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 do tipo semântica.
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 campos usados para classificação semântica.
semanticMaxWaitInMilliseconds	integer	Permite que o usuário defina um limite superior na quantidade de tempo que leva para o enriquecimento semântico concluir o processamento antes que a solicitação falhe.
semanticQuery	string	Permite definir uma consulta de pesquisa separada que será usada exclusivamente para reclassificação semântica, legendas semânticas e respostas semânticas. É útil para cenários em que há necessidade de usar consultas diferentes entre a fase de recuperação de base e classificação e a fase semântica L2.
sessionId	string	Um valor a ser usado para criar uma sessão pegajosa, que pode ajudar a obter resultados mais consistentes. Contanto que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Desconfie de que a reutilização repetida dos mesmos valores de sessionID pode 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 ignorar. Este valor não pode ser superior a 100.000. Se você precisar digitalizar documentos em sequência, mas não puder usar skip 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 corretor ortográfico a ser usado para corrigir a ortografia de termos de consulta de pesquisa individuais.
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 ou não aplicados antes ou depois da pesquisa vetorial ser executada. O padrão é 'preFilter' para novos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Os parâmetros de consulta para consultas de pesquisa vetoriais e híbridas.

SearchResult

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

Name	Tipo	Description
@search.captions	CaptionResult[]	As legendas são as passagens mais representativas do documento em relação à consulta de pesquisa. São frequentemente utilizados como resumo de documentos. As legendas só são retornadas 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; null se o realce de hit não estiver habilitado para a consulta.
@search.rerankerScore	number	A pontuação de relevância calculada pelo classificador semântico para os principais resultados de pesquisa. Os resultados da pesquisa são classificados primeiro pelo RerankerScore 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 vetorial serão filtrados com base no valor '@search.score'. Observe que este é o @search.score retornado como parte da resposta da pesquisa. A direção do limiar será escolhida para @search.scoresuperiores.

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

SemanticDebugInfo

Name	Tipo	Description
contentFields	QueryResultDocumentSemanticField[]	Os campos de conteúdo que foram enviados para o processo de enriquecimento semântico, bem como como foram utilizados
keywordFields	QueryResultDocumentSemanticField[]	Os campos de palavras-chave que foram enviados para o processo de enriquecimento semântico, bem como a forma como foram utilizados
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 a forma como foi utilizado

SemanticErrorMode

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

Name	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 a razão para a falha.

SemanticErrorReason

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

Name	Tipo	Description
capacityOverloaded	string	O pedido foi acelerado. Apenas os resultados de base foram devolvidos.
maxWaitExceeded	string	Se `semanticMaxWaitInMilliseconds` foi definido e a duração do processamento semântico excedeu esse valor. Apenas os resultados de base foram devolvidos.
transient	string	Pelo menos uma etapa do processo semântico falhou.

SemanticFieldState

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

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

SemanticQueryRewritesResultType

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

Name	Tipo	Description
originalQueryOnly	string	As regravações de consulta não foram geradas com êxito para essa solicitação. Apenas a consulta original foi usada para recuperar os resultados.

SemanticSearchResultsType

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

Name	Tipo	Description
baseResults	string	Resultados sem qualquer enriquecimento semântico ou reclassificação.
rerankedResults	string	Os resultados foram reclassificados com o modelo de reclassificação e incluirão legendas semânticas. Eles não incluirão respostas, destaques de respostas ou destaques de legenda.

SingleVectorFieldResult

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

Name	Tipo	Description
searchScore	number	O @search.score valor calculado a partir da pontuação de similaridade vetorial. Esta é a pontuação que é visível em uma consulta de vetor único de campo único pura.
vectorSimilarity	number	A pontuação de semelhança vetorial para este documento. Note que esta é a definição canônica de métrica de semelhança, não a versão 'distância'. Por exemplo, semelhança cosseno em vez de distância cosseno.

TextResult

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

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

VectorFilterMode

Determina se os filtros são ou não aplicados antes ou depois da pesquisa vetorial ser executada.

Name	Tipo	Description
postFilter	string	O filtro será aplicado depois que o conjunto candidato de resultados vetoriais 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 vetorial quando um binário codificado de base 64 de uma imagem que precisa ser vetorizada é fornecido.

Name	Tipo	Description
base64Image	string	A base 64 codificada binária de uma imagem a ser vetorizada para executar uma consulta de pesquisa vetorial.
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa exaustiva de vizinhos k-nearest em todos os vetores dentro do índice vetorial. Útil para cenários em que as correspondências exatas são críticas, como a determinação de valores de verdade no terreno.
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 vetorial 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 retornar como principais hits.
kind	string: imageBinary	O tipo de consulta vetorial que está sendo executada.
oversampling	number	Fator de sobreamostragem. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele pode ser definido somente quando 'rerankWithOriginalVectors' é true. Este parâmetro só é permitido quando é utilizado um método de compressão no campo vetorial subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas vetoriais. Observe que isso só pode ser definido se todos os 'campos' usarem a mesma métrica de similaridade.
weight	number	Peso relativo da consulta vetorial quando comparado com outra consulta vetorial e/ou a consulta de texto dentro da mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maiores serão os documentos que corresponderam a essa consulta na classificação 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 vetorial quando uma url que representa um valor de imagem que precisa ser vetorizado é fornecida.

Name	Tipo	Description
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa exaustiva de vizinhos k-nearest em todos os vetores dentro do índice vetorial. Útil para cenários em que as correspondências exatas são críticas, como a determinação de valores de verdade no terreno.
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 vetorial 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 retornar como principais hits.
kind	string: imageUrl	O tipo de consulta vetorial que está sendo executada.
oversampling	number	Fator de sobreamostragem. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele pode ser definido somente quando 'rerankWithOriginalVectors' é true. Este parâmetro só é permitido quando é utilizado um método de compressão no campo vetorial subjacente.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas vetoriais. Observe que isso só pode ser definido se todos os 'campos' usarem a mesma métrica de similaridade.
url	string	O URL de uma imagem a ser vetorizada para executar uma consulta de pesquisa vetorial.
weight	number	Peso relativo da consulta vetorial quando comparado com outra consulta vetorial e/ou a consulta de texto dentro da mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maiores serão os documentos que corresponderam a essa consulta na classificação 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 vetorial quando um valor de texto que precisa ser vetorizado é fornecido.

Name	Tipo	Description
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa exaustiva de vizinhos k-nearest em todos os vetores dentro do índice vetorial. Útil para cenários em que as correspondências exatas são críticas, como a determinação de valores de verdade no terreno.
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 vetorial 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 retornar como principais hits.
kind	string: text	O tipo de consulta vetorial que está sendo executada.
oversampling	number	Fator de sobreamostragem. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele pode ser definido somente quando 'rerankWithOriginalVectors' é true. Este parâmetro só é permitido quando é utilizado um método de compressão no campo vetorial 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 vetorial.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	O limite usado para consultas vetoriais. Observe que isso só pode ser definido se todos os 'campos' usarem a mesma métrica de similaridade.
weight	number	Peso relativo da consulta vetorial quando comparado com outra consulta vetorial e/ou a consulta de texto dentro da mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maiores serão os documentos que corresponderam a essa consulta na classificação final. O padrão é 1.0 e o valor precisa ser um número positivo maior que zero.

VectorQueryKind

O tipo de consulta vetorial que está sendo executada.

Name	Tipo	Description
imageBinary	string	Consulta vetorial onde um binário codificado de base 64 de uma imagem que precisa ser vetorizada é fornecido.
imageUrl	string	Consulta vetorial onde uma url que representa um valor de imagem que precisa ser vetorizado é fornecida.
text	string	Consulta vetorial onde um valor de texto que precisa ser vetorizado é fornecido.
vector	string	Consulta vetorial onde um valor vetorial bruto é fornecido.

VectorsDebugInfo

Name	Tipo	Description
subscores	QueryResultDocumentSubscores	A desagregação das subpontuações do documento antes do método de fusão/combinação do conjunto de resultados escolhido, como o RRF.

VectorSimilarityThreshold

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

Name	Tipo	Description
kind	string: vectorSimilarity	O tipo de limite usado para filtrar consultas vetoriais
value	number	O limite será filtrado com base no valor da métrica de similaridade. Note que esta é a definição canônica de métrica de semelhança, não a versão '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 vetorial que está sendo executada.

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

Partilhar via

Documents - Search Post

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Exemplos

SearchIndexSearchDocumentsPost

Pedido de amostra

Resposta da amostra

SearchIndexSearchDocumentsSemanticPost

Pedido de amostra

Resposta da amostra

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