Documents - Search Post

SearchDocumentsResult

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

ErrorResponse

Resposta de erro.

string

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

string

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

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.

string

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

string

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

string

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

object

As informações adicionais.

string

O tipo de informação adicional.

ErrorAdditionalInfo[]

O erro informações adicionais.

string

O código de erro.

ErrorDetail[]

Os detalhes do erro.

string

A mensagem de erro.

string

O destino do erro.

ErrorDetail

O objeto de erro.

string

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

string

Não retorne respostas para a consulta.

string

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

string

Não retorne legendas para a consulta.

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.

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.

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.

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.

string

Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.

integer

Número de vizinhos mais próximos a retornar como principais hits.

vector

O tipo de consulta vetorial que está sendo executada.

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.

number[]

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

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.

string

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

string

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

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.

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.

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

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.

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.

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.

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.

SearchResult[]

A sequência de resultados retornada pela consulta.

string

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

string

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

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.

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.

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.

string

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

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.

string

Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. O padrão é </em>.

string

Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. O padrão é <em>.

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.

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

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.

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

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

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.

string

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

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

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

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.

string

O nome de uma configuração semântica que será usada ao processar documentos para consultas do tipo semântica.

SemanticErrorMode

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

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.

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.

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

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.

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

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.

• RawVectorQuery[]
• VectorizableTextQuery[]

Os parâmetros de consulta para consultas de pesquisa vetoriais e híbridas.

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

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.

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

number

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

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.

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.

string

O pedido foi acelerado. Apenas os resultados de base foram devolvidos.

string

Se semanticMaxWaitInMilliseconds foi definido e a duração do processamento semântico excedeu esse valor. Apenas os resultados de base foram devolvidos.

string

Pelo menos uma etapa do processo semântico falhou.

string

Resultados sem qualquer enriquecimento semântico ou reclassificação.

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.

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

string

O filtro será aplicado antes da consulta de pesquisa.

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.

string

Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.

integer

Número de vizinhos mais próximos a retornar como principais hits.

text

O tipo de consulta vetorial que está sendo executada.

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.

string

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

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.

string

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

string

Consulta vetorial onde um valor vetorial bruto é fornecido.