Compartilhar via


Documents - Search Get

Pesquisa documentos no índice.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

A URL do ponto de extremidade do serviço de pesquisa.

indexName
path True

string

O nome do índice.

api-version
query True

string

Versão da API do cliente.

$count
query

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.

$filter
query

string

A expressão OData $filter a ser aplicada à consulta de pesquisa.

$orderby
query

string[]

A lista de expressões $orderby OData pelas quais classificar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar crescente e desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão resolvidos pelas pontuações de correspondência de documentos. Se nenhum OrderBy for especificado, a ordem de classificação padrão será decrescente pela pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.

$select
query

string[]

A lista de campos a serem recuperados. Se não for especificado, todos os campos marcados como recuperáveis no esquema serão incluídos.

$skip
query

integer

int32

O número de resultados de pesquisa a ser ignorado. Esse valor não deve ser maior que 100.000. Se você precisar examinar documentos em sequência, mas não puder usar $skip devido a essa limitação, considere usar $orderby em uma chave totalmente ordenada e $filter com uma consulta de intervalo.

$top
query

integer

int32

O número de resultados de pesquisa a ser recuperado. 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.

answers
query

QueryAnswerType

Esse parâmetro só será válido se o tipo de consulta for semantic. Se definida, a consulta retornará respostas extraídas de passagens-chave nos documentos mais bem classificados. O número de respostas retornadas pode ser configurado acrescentando o caractere | de pipe seguido pela opção count-<number of answers> após o valor do parâmetro answers, como extractive|count-3. A contagem padrão é 1. O limite de confiança pode ser configurado acrescentando o caractere | de pipe seguido pela opção threshold-<confidence threshold> após o valor do parâmetro answers, como extractive|threshold-0.9. O limite padrão é 0,7.

captions
query

QueryCaptionType

Esse parâmetro só será válido se o tipo de consulta for semantic. Se definida, a consulta retornará legendas extraídas de passagens-chave nos documentos mais bem classificados. Quando Captions é definido extractivecomo , o realce é habilitado por padrão e pode ser configurado acrescentando o caractere | de pipe seguido pela opção highlight-<true/false> , como extractive|highlight-true. Assume o padrão de None.

debug
query

QueryDebugMode

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

facet
query

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.

highlight
query

string[]

A lista de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.

highlightPostTag
query

string

Uma marca de cadeia de caracteres que é acrescentada para atingir realces. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPreTag
query

string

Uma marca de cadeia de caracteres que é prefixada para atingir realces. Deve ser definido com highlightPostTag. O padrão é <em>.

minimumCoverage
query

number

double

Um número entre 0 e 100 indicando o percentual do índice que deve ser coberto por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas um réplica. O padrão é 100.

queryLanguage
query

QueryLanguage

O idioma da consulta.

queryType
query

QueryType

Um valor que especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene.

scoringParameter
query

string[]

A lista de valores de parâmetro a serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "mylocation--122.2,44.8" (sem as aspas).

scoringProfile
query

string

O nome de um perfil de pontuação para avaliar as pontuações correspondentes para corresponder documentos para classificar os resultados.

scoringStatistics
query

ScoringStatistics

Um valor que especifica se queremos calcular estatísticas de pontuação (como a frequência do documento) globalmente para uma pontuação mais consistente ou localmente, para menor latência.

search
query

string

Uma expressão de consulta de pesquisa de texto completo; Use "*" ou omita esse parâmetro para corresponder a todos os documentos.

searchFields
query

string[]

A lista de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados nesse parâmetro.

searchMode
query

SearchMode

Um valor que especifica se qualquer ou todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.

semanticConfiguration
query

string

O nome da configuração semântica que lista quais campos devem ser usados para classificação semântica, legendas, realces e respostas

semanticErrorHandling
query

SemanticErrorMode

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

semanticFields
query

string[]

A lista de nomes de campo usados para classificação semântica.

semanticMaxWaitInMilliseconds
query

integer

int32

Permite que o usuário defina um limite superior na quantidade de tempo que leva para que o enriquecimento semântico conclua o processamento antes que a solicitação falhe.

semanticQuery
query

string

Permite definir uma consulta de pesquisa separada que será usada exclusivamente para reclassificado semântico, legendas semânticas e respostas semânticas. É útil para cenários em que há a necessidade de usar consultas diferentes entre a fase de recuperação e classificação base e a fase semântica L2.

sessionId
query

string

Um valor a ser usado para criar uma sessão autoadesiva, o que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, será feita uma tentativa de melhor esforço para atingir o mesmo conjunto de réplica. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere “_”.

speller
query

Speller

Melhore o recall de pesquisa corrigindo os termos de consulta de pesquisa individuais.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string

uuid

A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

Nome Tipo Description
200 OK

SearchDocumentsResult

Resposta que contém documentos que correspondem aos critérios de pesquisa.

Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchIndexSearchDocumentsGet

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AnswerResult

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

CaptionResult

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

DocumentDebugInfo

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

HybridCountAndFacetMode

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

HybridSearch

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

QueryAnswerType

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

QueryCaptionType

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

QueryDebugMode

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

QueryLanguage

O idioma da consulta.

QueryResultDocumentRerankerInput

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

QueryResultDocumentSemanticField

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

QuerySpellerType

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

QueryType

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

RawVectorQuery

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

ScoringStatistics

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

SearchDocumentsResult

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

SearchMode

Especifica se algum ou todos os termos de pesquisa devem ser iguais para considerar o documento uma correspondência.

SearchRequest

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

SearchResult

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

SearchScoreThreshold

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

SemanticDebugInfo
SemanticErrorMode

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

SemanticErrorReason

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

SemanticFieldState

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

SemanticSearchResultsType

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

Speller

Melhore o recall de pesquisa corrigindo os termos de consulta de pesquisa individuais com correção ortográfica.

VectorFilterMode

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

VectorizableImageBinaryQuery

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

VectorizableImageUrlQuery

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

VectorizableTextQuery

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

VectorQueryKind

O tipo de consulta vetor que está sendo executada.

VectorSimilarityThreshold

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

VectorThresholdKind

O tipo de consulta vetor que está sendo executada.

AnswerResult

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

Nome Tipo Description
highlights

string

Mesma passagem de texto que na propriedade Text com frases de texto realçadas mais relevantes para a consulta.

key

string

A chave do documento do qual a resposta foi extraída.

score

number

O valor da pontuação representa o quão relevante é a resposta para a consulta em relação a outras respostas retornadas para a consulta.

text

string

A passagem de texto extraída do conteúdo do documento como a resposta.

CaptionResult

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

Nome Tipo Description
highlights

string

Mesma passagem de texto que na propriedade Text com frases realçadas mais relevantes para a consulta.

text

string

Uma passagem de texto representativa extraída do documento mais relevante para a consulta de pesquisa.

DocumentDebugInfo

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

Nome Tipo Description
semantic

SemanticDebugInfo

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

ErrorAdditionalInfo

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

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

HybridCountAndFacetMode

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

Nome Tipo Description
countAllResults

string

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

countRetrievableResults

string

Inclua apenas documentos que foram correspondidos na janela de recuperação 'maxTextRecallSize' ao calcular 'count' e 'facets'.

HybridSearch

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

Nome Tipo Description
countAndFacetMode

HybridCountAndFacetMode

Determina se a contagem e as facetas devem incluir todos os documentos que corresponderam à consulta de pesquisa ou apenas os documentos recuperados na janela 'maxTextRecallSize'.

maxTextRecallSize

integer

Determina o número máximo de documentos a serem recuperados pela parte de consulta de texto de uma solicitação de pesquisa híbrida. Esses documentos serão combinados com os documentos que correspondem às consultas vetoriais para produzir uma única lista final de resultados. Escolher um valor maxTextRecallSize maior permitirá a recuperação e a paginação por meio de mais documentos (usando os parâmetros superior e skip), ao custo de maior utilização de recursos e maior latência. O valor precisa estar entre 1 e 10.000. O padrão é 1000.

QueryAnswerType

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

Nome Tipo Description
extractive

string

Extrai candidatos de resposta do conteúdo dos documentos retornados em resposta a uma consulta expressa como uma pergunta em linguagem natural.

none

string

Não retorne respostas para a consulta.

QueryCaptionType

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

Nome Tipo Description
extractive

string

Extrai legendas dos documentos correspondentes que contêm passagens relevantes para a consulta de pesquisa.

none

string

Não retorne legendas para a consulta.

QueryDebugMode

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

Nome Tipo Description
disabled

string

Nenhuma informação de depuração de consulta será retornada.

semantic

string

Permite que o usuário explore ainda mais seus resultados reclassificados.

QueryLanguage

O idioma da consulta.

Nome Tipo Description
ar-eg

string

Valor da linguagem de consulta para árabe (Egito).

ar-jo

string

Valor da linguagem de consulta para árabe (Jordânia).

ar-kw

string

Valor da linguagem de consulta para árabe (Kuwait).

ar-ma

string

Valor da linguagem de consulta para árabe (Marrocos).

ar-sa

string

Valor da linguagem de consulta para árabe (Arábia Saudita).

bg-bg

string

Valor da linguagem de consulta para búlgaro (Bulgária).

bn-in

string

Valor da linguagem de consulta para Bengali (Índia).

ca-es

string

Valor da linguagem de consulta para catalão.

cs-cz

string

Valor da linguagem de consulta para Tcheco (República Tcheca).

da-dk

string

Valor da linguagem de consulta para dinamarquês (Dinamarca).

de-de

string

Valor da linguagem de consulta para alemão (Alemanha).

el-gr

string

Valor da linguagem de consulta para grego (Grécia).

en-au

string

Valor da linguagem de consulta para inglês (Austrália).

en-ca

string

Valor da linguagem de consulta para inglês (Canadá).

en-gb

string

Valor da linguagem de consulta para inglês (Grã-Bretanha).

en-in

string

Valor da linguagem de consulta para inglês (Índia).

en-us

string

Valor do idioma de consulta para inglês (Estados Unidos).

es-es

string

Valor da linguagem de consulta para espanhol (Espanha).

es-mx

string

Valor da linguagem de consulta para espanhol (México).

et-ee

string

Valor da linguagem de consulta para estoniano (Estônia).

eu-es

string

Valor da linguagem de consulta para Basco.

fa-ae

string

Valor da linguagem de consulta para persa (U.A.E.).

fi-fi

string

Valor da linguagem de consulta para finlandês (Finlândia).

fr-ca

string

Valor da linguagem de consulta para francês (Canadá).

fr-fr

string

Valor da linguagem de consulta para francês (França).

ga-ie

string

Valor da linguagem de consulta para irlandês (Irlanda).

gl-es

string

Valor da linguagem de consulta para Galician.

gu-in

string

Valor da linguagem de consulta para Gujarati (Índia).

he-il

string

Valor da linguagem de consulta para hebraico (Israel).

hi-in

string

Valor da linguagem de consulta para hindi (Índia).

hr-ba

string

Valor da linguagem de consulta para croata (Bósnia e Herzegovina).

hr-hr

string

Valor da linguagem de consulta para croata (Croácia).

hu-hu

string

Valor da linguagem de consulta para húngaro (Hungria).

hy-am

string

Valor da linguagem de consulta para armênio (Armênia).

id-id

string

Valor da linguagem de consulta para Indonésio (Indonésia).

is-is

string

Valor da linguagem de consulta para islandês (Islândia).

it-it

string

Valor da linguagem de consulta para italiano (Itália).

ja-jp

string

Valor da linguagem de consulta para japonês (Japão).

kn-in

string

Valor da linguagem de consulta para Kannada (Índia).

ko-kr

string

Valor da linguagem de consulta para coreano (Coreia).

lt-lt

string

Valor da linguagem de consulta para lituano (Lituânia).

lv-lv

string

Valor da linguagem de consulta para letão (Letônia).

ml-in

string

Valor da linguagem de consulta para Malayalam (Índia).

mr-in

string

Valor da linguagem de consulta para Marathi (Índia).

ms-bn

string

Consultar o valor da linguagem para malaio (Brunei Darussalam).

ms-my

string

Valor da linguagem de consulta para Malaio (Malásia).

nb-no

string

Valor da linguagem de consulta para norueguês (Noruega).

nl-be

string

Valor da linguagem de consulta para holandês (Bélgica).

nl-nl

string

Valor da linguagem de consulta para holandês (Países Baixos).

no-no

string

Valor da linguagem de consulta para norueguês (Noruega).

none

string

Linguagem de consulta não especificada.

pa-in

string

Valor da linguagem de consulta para Punjabi (Índia).

pl-pl

string

Valor da linguagem de consulta para polonês (Polônia).

pt-br

string

Valor da linguagem de consulta para português (Brasil).

pt-pt

string

Valor da linguagem de consulta para português (Portugal).

ro-ro

string

Valor da linguagem de consulta para romeno (Romênia).

ru-ru

string

Valor da linguagem de consulta para russo (Rússia).

sk-sk

string

Valor da linguagem de consulta para Eslovaco (Eslováquia).

sl-sl

string

Valor da linguagem de consulta para esloveno (Eslovênia).

sr-ba

string

Valor da linguagem de consulta para sérvio (Bósnia e Herzegovina).

sr-me

string

Valor da linguagem de consulta para Sérvio (Montenegro).

sr-rs

string

Valor da linguagem de consulta para sérvio (Sérvia).

sv-se

string

Valor da linguagem de consulta para sueco (Suécia).

ta-in

string

Valor da linguagem de consulta para Tamil (Índia).

te-in

string

Valor da linguagem de consulta para Telugu (Índia).

th-th

string

Valor da linguagem de consulta para tailandês (Tailândia).

tr-tr

string

Valor da linguagem de consulta para turco (Turquia).

uk-ua

string

Valor da linguagem de consulta para ucraniano (Ucrânia).

ur-pk

string

Valor da linguagem de consulta para Urdu (Paquistão).

vi-vn

string

Valor da linguagem de consulta para vietnamita (Viet Nam).

zh-cn

string

Valor da linguagem de consulta para chinês (China).

zh-tw

string

Valor da linguagem de consulta para chinês (Taiwan).

QueryResultDocumentRerankerInput

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

Nome Tipo Description
content

string

As cadeias de caracteres concatenadas brutas para os campos de conteúdo que foram usados para enriquecimento semântico.

keywords

string

As cadeias de caracteres concatenadas brutas para os campos palavra-chave que foram usados para enriquecimento semântico.

title

string

A cadeia de caracteres bruta para o campo de título que foi usado para enriquecimento semântico.

QueryResultDocumentSemanticField

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

Nome Tipo Description
name

string

O nome do campo que foi enviado para o processo de enriquecimento semântico

state

SemanticFieldState

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

QuerySpellerType

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

Nome Tipo Description
lexicon

string

O Speller corrige os termos de consulta individuais usando um léxico estático para o idioma especificado pelo parâmetro queryLanguage.

none

string

Verificador ortográfico não habilitado.

QueryType

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

Nome Tipo Description
full

string

Usa a sintaxe de consulta Lucene completa para pesquisas. O texto de pesquisa é interpretado usando a linguagem de consulta Lucene que permite pesquisas específicas e ponderadas do 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 ao classificar novamente os principais resultados da pesquisa usando um modelo de classificação treinado no web corpus.

simple

string

Usa a sintaxe de consulta simples para pesquisas. O texto de pesquisa é interpretado usando uma linguagem de consulta simples que permite símbolos como +, * e "". As consultas são avaliadas em todos os campos pesquisáveis por padrão, a menos que o parâmetro searchFields seja especificado.

RawVectorQuery

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

Nome Tipo Description
exhaustive

boolean

Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

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 serem retornados como principais ocorrências.

kind string:

vector

O tipo de consulta vetor que está sendo executada.

oversampling

number

Fator oversampling. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo vetor subjacente.

threshold VectorThreshold:

O limite usado para consultas vetoriais. Observe que isso só poderá ser definido se todos os 'campos' usarem a mesma métrica de similaridade.

vector

number[]

A representação de vetor de uma consulta de pesquisa.

weight

number

Peso relativo da consulta vetor quando comparado com outra consulta vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta 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 desejamos calcular estatísticas de pontuação (como frequência de documento) globalmente para pontuação mais consistente ou localmente, para menor latência. O padrão é 'local'. Use 'global' para agregar estatísticas de pontuação globalmente antes da pontuação. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.

Nome Tipo Description
global

string

As estatísticas de pontuação serão calculadas globalmente para pontuação mais consistente.

local

string

As estatísticas de pontuação serão calculadas localmente para menor latência.

SearchDocumentsResult

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

Nome Tipo Description
@odata.count

integer

A contagem total de resultados encontrada pela operação de pesquisa ou nula se a contagem não foi solicitada. Se presente, a contagem pode ser maior que o número de resultados nessa resposta. Isso pode acontecer se você usar os parâmetros $top ou $skip ou se a consulta não puder retornar todos os documentos solicitados em uma única resposta.

@odata.nextLink

string

URL de continuação retornada quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar essa URL para formular outra solicitação GET ou POST Search para obter a próxima parte da resposta de pesquisa. Use o mesmo verbo (GET ou POST) que a solicitação que produziu essa resposta.

@search.answers

AnswerResult[]

Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta de respostas não tiver sido especificado ou definido como 'none'.

@search.coverage

number

Um valor que indica o percentual do índice que foi incluído na consulta ou nulo se minimumCoverage não foi especificado na solicitação.

@search.facets

object

A consulta de faceta resulta para a operação de pesquisa, organizada como uma coleção de buckets para cada campo facetado; nulo se a consulta não incluir nenhuma expressão de faceta.

@search.nextPageParameters

SearchRequest

Conteúdo JSON de continuação retornado quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar esse JSON junto com @odata.nextLink para formular outra solicitação post search para obter a próxima parte da resposta de pesquisa.

@search.semanticPartialResponseReason

SemanticErrorReason

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

@search.semanticPartialResponseType

SemanticSearchResultsType

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

value

SearchResult[]

A sequência de resultados retornados pela consulta.

SearchMode

Especifica se algum ou todos os termos de pesquisa devem ser iguais para considerar o documento uma correspondência.

Nome Tipo Description
all

string

Todos os termos de pesquisa devem ser correspondidos para contar o documento como uma correspondência.

any

string

Qualquer um dos termos de pesquisa deve ser correspondido para contar o documento como uma correspondência.

SearchRequest

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

Nome Tipo Description
answers

QueryAnswerType

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

captions

QueryCaptionType

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

count

boolean

Um valor que especifica se a contagem total de resultados deve ser buscada. O padrão é false. Definir esse valor como true pode ter um impacto no desempenho. Observe que a contagem retornada é uma aproximação.

debug

QueryDebugMode

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

facets

string[]

A lista de expressões de faceta a serem aplicadas à consulta de pesquisa. Cada expressão de faceta contém um nome de campo, opcionalmente seguido por uma lista separada por vírgulas de pares nome:valor.

filter

string

A expressão OData $filter a ser aplicada à consulta de pesquisa.

highlight

string

A lista separada por vírgulas de nomes de campo a serem usados para realces de ocorrência. Somente campos pesquisáveis podem ser usados para realce de clique.

highlightPostTag

string

Uma marca de cadeia de caracteres que é acrescentada para atingir realces. Deve ser definido com highlightPreTag. O padrão é </em>.

highlightPreTag

string

Uma marca de cadeia de caracteres que é prefixada para atingir realces. Deve ser definido com highlightPostTag. O padrão é <em>.

hybridSearch

HybridSearch[]

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

minimumCoverage

number

Um número entre 0 e 100 indicando o percentual do índice que deve ser coberto por uma consulta de pesquisa para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas um réplica. O padrão é 100.

orderby

string

A lista separada por vírgulas de expressões $orderby OData pelas quais classificar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão resolvidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.

queryLanguage

QueryLanguage

Um valor que especifica o idioma da consulta de pesquisa.

queryType

QueryType

Um valor que especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se a consulta usar a sintaxe de consulta Lucene.

scoringParameters

string[]

A lista de valores de parâmetro a serem usados em funções de pontuação (por exemplo, referencePointParameter) usando o formato name-values. Por exemplo, se o perfil de pontuação definir uma função com um parâmetro chamado 'mylocation', a cadeia de caracteres de parâmetro será "mylocation--122.2,44.8" (sem as aspas).

scoringProfile

string

O nome de um perfil de pontuação para avaliar as pontuações correspondentes para corresponder documentos para classificar os resultados.

scoringStatistics

ScoringStatistics

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

search

string

Uma expressão de consulta de pesquisa de texto completo; Use "*" ou omita esse parâmetro para corresponder a todos os documentos.

searchFields

string

A lista separada por vírgulas de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre quaisquer nomes de campo listados nesse parâmetro.

searchMode

SearchMode

Um valor que especifica se qualquer 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 ou retornar resultados parciais (padrão).

semanticFields

string

A lista separada por vírgulas de nomes de campo usados para classificação semântica.

semanticMaxWaitInMilliseconds

integer

Permite que o usuário defina um limite superior na quantidade de tempo que leva para que o enriquecimento semântico conclua o processamento antes que a solicitação falhe.

semanticQuery

string

Permite definir uma consulta de pesquisa separada que será usada exclusivamente para reescolhimento semântico, legendas semânticas e respostas semânticas. É útil para cenários em que há a necessidade de usar consultas diferentes entre a fase de recuperação e classificação base e a fase semântica L2.

sessionId

string

Um valor a ser usado para criar uma sessão autoadesiva, o que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, será feita uma tentativa de melhor esforço para atingir o mesmo conjunto de réplica. Tenha cuidado para que a reutilização dos mesmos valores sessionID repetidamente possa interferir no balanceamento de carga das solicitações entre réplicas e afetar negativamente o desempenho do serviço de pesquisa. O valor usado como sessionId não pode começar com um caractere “_”.

skip

integer

O número de resultados de pesquisa a ser ignorado. Esse valor não deve ser maior que 100.000. Se você precisar verificar documentos em sequência, mas não puder usar ignorar devido a essa limitação, considere usar orderby em uma chave totalmente ordenada e filtrar com uma consulta de intervalo.

speller

QuerySpellerType

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

top

integer

O número de resultados de pesquisa a ser recuperado. Isso pode ser usado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser usado para emitir outra solicitação de pesquisa para a próxima página de resultados.

vectorFilterMode

VectorFilterMode

Determina se os filtros são aplicados ou não antes ou depois que a pesquisa de vetor é executada. O padrão é 'preFilter'.

vectorQueries VectorQuery[]:

Os parâmetros de consulta para consultas de pesquisa híbrida e vetor.

SearchResult

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

Nome Tipo Description
@search.captions

CaptionResult[]

As legendas são as passagens mais representativas do documento relativamente para a consulta de pesquisa. Eles geralmente são usados como resumo do documento. 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; nulo se o realce de ocorrência 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 da pesquisa. Os resultados da pesquisa são classificados pela RerankerScore primeiro e depois pela Pontuação. RerankerScore só é retornado para consultas do tipo 'semântica'.

@search.score

number

A pontuação de relevância do documento em comparação com outros documentos retornados pela consulta.

SearchScoreThreshold

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

Nome 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 esse é o @search.score retornado como parte da resposta de pesquisa. A direção do limite será escolhida para maior @search.score.

SemanticDebugInfo

Nome Tipo Description
contentFields

QueryResultDocumentSemanticField[]

Os campos de conteúdo que foram enviados para o processo de enriquecimento semântico, bem como como foram usados

keywordFields

QueryResultDocumentSemanticField[]

Os campos palavra-chave que foram enviados para o processo de enriquecimento semântico, bem como como foram usados

rerankerInput

QueryResultDocumentRerankerInput

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

titleField

QueryResultDocumentSemanticField

O campo de título que foi enviado para o processo de enriquecimento semântico, bem como como ele foi usado

SemanticErrorMode

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

Nome Tipo Description
fail

string

Se houver uma exceção durante a etapa de processamento semântico, a consulta falhará e retornará o código HTTP apropriado dependendo do erro.

partial

string

Se o processamento semântico falhar, os resultados parciais ainda retornarão. A definição de resultados parciais depende de qual etapa semântica falhou e qual foi o motivo da falha.

SemanticErrorReason

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

Nome Tipo Description
capacityOverloaded

string

A solicitação foi restringida. Somente os resultados base foram retornados.

maxWaitExceeded

string

Se 'semanticMaxWaitInMilliseconds' foi definido e a duração do processamento semântico excedeu esse valor. Somente os resultados base foram retornados.

transient

string

Pelo menos uma etapa do processo semântico falhou.

SemanticFieldState

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

Nome Tipo Description
partial

string

O campo foi parcialmente usado para enriquecimento semântico.

unused

string

O campo não foi usado para enriquecimento semântico.

used

string

O campo foi totalmente usado para enriquecimento semântico.

SemanticSearchResultsType

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

Nome Tipo Description
baseResults

string

Resultados sem nenhum enriquecimento semântico ou reescolhimento.

rerankedResults

string

Os resultados foram reclassificados com o modelo de reclassificador e incluirão legendas semânticas. Eles não incluirão respostas, respostas realçadas ou realces legenda.

Speller

Melhore o recall de pesquisa corrigindo os termos de consulta de pesquisa individuais com correção ortográfica.

Nome Tipo Description
lexicon

string

O Speller corrige os termos de consulta individuais usando um léxico estático para o idioma especificado pelo parâmetro queryLanguage.

none

string

Verificador ortográfico não habilitado.

VectorFilterMode

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

Nome Tipo Description
postFilter

string

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

preFilter

string

O filtro será aplicado antes da consulta de pesquisa.

VectorizableImageBinaryQuery

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

Nome Tipo Description
base64Image

string

O binário codificado em base 64 de uma imagem a ser vetorizada para executar uma consulta de pesquisa de vetor.

exhaustive

boolean

Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

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 serem retornados como principais ocorrências.

kind string:

imageBinary

O tipo de consulta vetor que está sendo executada.

oversampling

number

Fator oversampling. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo vetor subjacente.

threshold VectorThreshold:

O limite usado para consultas vetoriais. Observe que isso só poderá ser definido se todos os 'campos' usarem a mesma métrica de similaridade.

weight

number

Peso relativo da consulta vetor quando comparado com outra consulta vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta 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 de vetor quando uma URL que representa um valor de imagem que precisa ser vetorizado é fornecida.

Nome Tipo Description
exhaustive

boolean

Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

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 serem retornados como principais ocorrências.

kind string:

imageUrl

O tipo de consulta vetor que está sendo executada.

oversampling

number

Fator oversampling. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo vetor subjacente.

threshold VectorThreshold:

O limite usado para consultas vetoriais. Observe que isso só poderá ser definido se todos os 'campos' usarem a mesma métrica de similaridade.

url

string

A URL de uma imagem a ser vetorizada para executar uma consulta de pesquisa de vetor.

weight

number

Peso relativo da consulta vetor quando comparado com outra consulta vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta 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 de vetor quando um valor de texto que precisa ser vetorizado é fornecido.

Nome Tipo Description
exhaustive

boolean

Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

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 serem retornados como principais ocorrências.

kind string:

text

O tipo de consulta vetor que está sendo executada.

oversampling

number

Fator oversampling. O valor mínimo é 1. Ele substitui o parâmetro 'defaultOversampling' configurado na definição de índice. Ele só pode ser definido quando 'rerankWithOriginalVectors' for true. Esse parâmetro só é permitido quando um método de compactação é usado no campo vetor subjacente.

text

string

O texto a ser vetorizado para executar uma consulta de pesquisa de vetor.

threshold VectorThreshold:

O limite usado para consultas vetoriais. Observe que isso só poderá ser definido se todos os 'campos' usarem a mesma métrica de similaridade.

weight

number

Peso relativo da consulta vetor quando comparado com outra consulta vetor e/ou a consulta de texto na mesma solicitação de pesquisa. Esse valor é usado ao combinar os resultados de várias listas de classificação produzidas pelas diferentes consultas vetoriais e/ou os resultados recuperados por meio da consulta de texto. Quanto maior o peso, maior será o número de documentos correspondentes a essa consulta 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 vetor que está sendo executada.

Nome Tipo Description
imageBinary

string

Consulta vetorial em que um binário codificado em base 64 de uma imagem que precisa ser vetorizada é fornecida.

imageUrl

string

Consulta vetorial em que uma URL que representa um valor de imagem que precisa ser vetorizado é fornecida.

text

string

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

vector

string

Consulta vetorial em que um valor de vetor bruto é fornecido.

VectorSimilarityThreshold

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

Nome Tipo Description
kind string:

vectorSimilarity

O tipo de limite usado para filtrar consultas vetoriais

value

number

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

VectorThresholdKind

O tipo de consulta vetor que está sendo executada.

Nome Tipo Description
searchScore

string

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

vectorSimilarity

string

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