Partilhar via


Documents - Search Post

Procura documentos no índice.

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

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.

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

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.

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.

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.

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[]:

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

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

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

Resposta da amostra

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

SearchIndexSearchDocumentsSemanticPost

Pedido de amostra

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

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

{
  "@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-07-01"
}

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.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

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.

QueryType

Especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'full' se sua consulta usar a sintaxe de consulta Lucene.

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.

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.

SemanticSearchResultsType

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

VectorFilterMode

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

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.

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.

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.

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.

QueryType

Especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'full' se sua consulta usar a sintaxe de consulta Lucene.

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.

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.

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

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.

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

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.

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.

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.

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[]:

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

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.

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.

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.

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.

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.

text

string

O texto a ser vetorizado 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.

VectorQueryKind

O tipo de consulta vetorial que está sendo executada.

Name Tipo Description
text

string

Consulta vetorial onde um valor de texto que precisa ser vetorizado é fornecido.

vector

string

Consulta vetorial onde um valor vetorial bruto é fornecido.