Compartilhar via

Documents - Search Post

Serviço:
Search Service
Versão da API:
2025-09-01

Pesquisa documentos no índice.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

A URL do ponto de extremidade do serviço de pesquisa.
indexName
 path True

string

O nome do índice.
api-version
 query True

string

Versão da API do cliente.

Cabeçalho da solicitação

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

string (uuid)

O ID de rastreamento enviado com a solicitação para ajudar na depuração.

Corpo da solicitação

Nome Tipo Description
answers

QueryAnswerType

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

QueryCaptionType

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

boolean

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

QueryDebugMode

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

string[]

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

string

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

string

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

string

Uma tag de string anexada aos destaques da ocorrência. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag

string

Uma tag de string que é anexada para atingir os destaques. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage

number (double)

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 bem-sucedida. 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 expressões OData $orderby para 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 é ordem crescente. Os empates serão desfeitos pelas pontuações dos documentos da partida. 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.
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â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 do parâmetro será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile

string

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

ScoringStatistics

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

string

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

string

A lista separada por vírgulas de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre 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 (int32)

minimum: 700

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 e classificação de base e a fase semântica L2.
sessionId

string

Um valor a ser usado para criar uma sessão fixa, o que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Tenha cuidado, pois a reutilização dos mesmos valores de sessionID repetidamente 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 (int32)

O número de resultados da pesquisa a serem ignorados. Esse valor não pode ser maior que 100.000. Se você precisar verificar 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 (int32)

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

VectorFilterMode

Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial. O padrão é 'preFilter' para novos índices.
vectorQueries VectorQuery[]:

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

Respostas

Nome Tipo Description
200 OK

SearchDocumentsResult

Resposta contendo documentos que correspondem aos critérios de pesquisa.
Other Status Codes

SearchDocumentsResult

Resposta contendo documentos parciais que correspondem aos critérios de pesquisa.
Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Solicitação de exemplo

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Resposta de exemplo

Código de status:
200 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}
Código de status:
206 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Solicitação de exemplo

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-09-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 de exemplo

Código de status:
200 
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}
Código de status:
206 
{
  "@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

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 a resposta 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. Eles são frequentemente usados como resumo de documentos. As legendas são retornadas apenas para consultas do tipo semantic.
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
QueryAnswerType

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

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

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

O detalhamento de sublinhados entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta vetorial é mostrada como um objeto separado na mesma ordem em que foram recebidas.
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 de vetor quando um valor de vetor bruto é fornecido.
ScoringStatistics

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

Resposta contendo 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, facetamento, 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.
SingleVectorFieldResult

Um único resultado de campo vetorial. Ambos e @search.score os valores de similaridade vetorial são retornados. A similaridade vetorial está relacionada por @search.score uma equação.
TextResult

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

Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial.
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 vetorial que está sendo executada.
VectorsDebugInfo

AnswerResult

Objeto

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 a resposta são pontuados e as melhores respostas são selecionadas.

Nome Tipo Description
highlights

string

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

string

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

number (double)

O valor da pontuação representa a relevância da 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

Objeto

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

Nome Tipo Description
highlights

string

Mesma passagem de texto da 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.

DocumentDebugInfo

Objeto

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

Nome Tipo Description
vectors

VectorsDebugInfo

Contém informações de depuração específicas para pesquisa vetorial e híbrida.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

QueryAnswerType

Enumeração

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

Valor Description
none

Não retorne respostas para a consulta.
extractive

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

QueryCaptionType

Enumeração

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

Valor Description
none

Não retorne legendas para a consulta.
extractive

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

QueryDebugMode

Enumeração

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

Valor Description
disabled

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

Permite que o usuário explore ainda mais seus resultados de consulta híbrida e vetorial.

QueryResultDocumentSubscores

Objeto

O detalhamento de sublinhados entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta vetorial é mostrada como um objeto separado na mesma ordem em que foram recebidas.

Nome Tipo Description
documentBoost

number (double)

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

TextResult

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

<string,  SingleVectorFieldResult>

A semelhança de vetor e @search.score os valores para cada consulta vetorial.

QueryType

Enumeração

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

Valor Description
simple

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

Usa a sintaxe de consulta Lucene completa para pesquisas. O texto da pesquisa é interpretado usando a linguagem de consulta Lucene, que permite pesquisas ponderadas e específicas do campo, bem como outros recursos avançados.
semantic

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 da pesquisa usando um modelo de classificação treinado no corpus da Web.

RawVectorQuery

Objeto

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-vizinho mais próximo em todos os vetores dentro do índice de vetor. Útil para cenários em que as correspondências exatas são críticas, como determinar valores verdadeiros.
fields

string

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

integer (int32)

Número de vizinhos mais próximos a retornar como principais sucessos.
kind string:

vector

O tipo de consulta vetorial que está sendo executada.
oversampling

number (double)

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

number[] (float)

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

number (float)

Peso relativo da consulta vetorial quando comparada a outra consulta vetorial e/ou à 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, 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

Enumeração

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 menor latência. O padrão é 'local'. Use 'global' para agregar estatísticas de pontuação globalmente antes de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.

Valor Description
local

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

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

SearchDocumentsResult

Objeto

Resposta contendo resultados de pesquisa de um índice.

Nome Tipo Description
@odata.count

integer (int64)

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

string

URL de continuação retornada quando a consulta não pode retornar todos os resultados solicitados em uma única resposta. Você pode usar essa URL para formular outra solicitação 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[]

As respostas consultam os resultados da operação de pesquisa; null se o parâmetro de consulta answers não tiver sido especificado ou definido como 'none'.
@search.coverage

number (double)

Um valor que indica a porcentagem do índice que foi incluído na consulta ou nulo se minimumCoverage não tiver sido especificado na solicitação.
@search.facets

object

Os resultados da consulta de faceta para a operação de pesquisa, organizados como uma coleção de buckets para cada campo facetado; null se a consulta não incluir nenhuma expressão de faceta.
@search.nextPageParameters

SearchRequest

Continuação da carga JSON 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 retornados pela consulta.

SearchMode

Enumeração

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

Valor Description
any

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

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

SearchRequest

Objeto

Parâmetros para filtragem, classificação, facetamento, 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 da pesquisa.
captions

QueryCaptionType

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

boolean

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

QueryDebugMode

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

string[]

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

string

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

string

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

string

Uma tag de string anexada aos destaques da ocorrência. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag

string

Uma tag de string que é anexada para atingir os destaques. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage

number (double)

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 bem-sucedida. 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 expressões OData $orderby para 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 é ordem crescente. Os empates serão desfeitos pelas pontuações dos documentos da partida. 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.
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â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 do parâmetro será "mylocation--122.2,44.8" (sem as aspas).
scoringProfile

string

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

ScoringStatistics

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

string

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

string

A lista separada por vírgulas de nomes de campo para os quais definir o escopo da pesquisa de texto completo. Ao usar a pesquisa em campo (fieldName:searchExpression) em uma consulta Lucene completa, os nomes de campo de cada expressão de pesquisa em campo têm precedência sobre 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 (int32)

minimum: 700

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 e classificação de base e a fase semântica L2.
sessionId

string

Um valor a ser usado para criar uma sessão fixa, o que pode ajudar a obter resultados mais consistentes. Desde que o mesmo sessionId seja usado, uma tentativa de melhor esforço será feita para direcionar o mesmo conjunto de réplicas. Tenha cuidado, pois a reutilização dos mesmos valores de sessionID repetidamente 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 (int32)

O número de resultados da pesquisa a serem ignorados. Esse valor não pode ser maior que 100.000. Se você precisar verificar 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 (int32)

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

VectorFilterMode

Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial. O padrão é 'preFilter' para novos índices.
vectorQueries VectorQuery[]:

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

SearchResult

Objeto

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 em relação à consulta de pesquisa. Eles são frequentemente usados como resumo de documentos. As legendas são retornadas apenas para consultas do tipo 'semântica'.
@search.documentDebugInfo

DocumentDebugInfo

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

object

Fragmentos de texto do documento que indicam os termos de pesquisa correspondentes, organizados por cada campo aplicável; null se o realce de ocorrências não tiver sido habilitado para a consulta.
@search.rerankerBoostedScore

number (double)

A pontuação de relevância calculada aumentando a pontuação do Reclassificador. Os resultados da pesquisa são classificados pelo RerankerScore/RerankerBoostedScore com base em useScoringProfileBoostedRanking na Configuração Semântica. RerankerBoostedScore só é retornado para consultas do tipo 'semântico'
@search.rerankerScore

number (double)

A pontuação de relevância calculada pelo classificador semântico para os principais resultados da 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 (double)

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

SemanticErrorMode

Enumeração

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

Valor Description
partial

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

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.

SemanticErrorReason

Enumeração

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

Valor Description
maxWaitExceeded

If semanticMaxWaitInMilliseconds foi definido e a duração do processamento semântico excedeu esse valor. Apenas os resultados básicos foram retornados.
capacityOverloaded

A solicitação foi limitada. Apenas os resultados básicos foram retornados.
transient

Pelo menos uma etapa do processo semântico falhou.

SemanticSearchResultsType

Enumeração

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

Valor Description
baseResults

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

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

SingleVectorFieldResult

Objeto

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

Nome Tipo Description
searchScore

number (double)

O @search.score valor calculado a partir da pontuação de similaridade do vetor. Essa é a pontuação visível em uma consulta de vetor único de campo único pura.
vectorSimilarity

number (double)

A pontuação de similaridade vetorial para este documento. Observe que esta é a definição canônica de métrica de similaridade, não a versão 'distância'. Por exemplo, similaridade de cosseno em vez de distância de cosseno.

TextResult

Objeto

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

Nome Tipo Description
searchScore

number (double)

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

VectorFilterMode

Enumeração

Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial.

Valor Description
postFilter

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 os solicitados pelo parâmetro 'k'.
preFilter

O filtro será aplicado antes da consulta de pesquisa.

VectorizableTextQuery

Objeto

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-vizinho mais próximo em todos os vetores dentro do índice de vetor. Útil para cenários em que as correspondências exatas são críticas, como determinar valores verdadeiros.
fields

string

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

integer (int32)

Número de vizinhos mais próximos a retornar como principais sucessos.
kind string:

text

O tipo de consulta vetorial que está sendo executada.
oversampling

number (double)

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

string

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

number (float)

Peso relativo da consulta vetorial quando comparada a outra consulta vetorial e/ou à 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, 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

Enumeração

O tipo de consulta vetorial que está sendo executada.

Valor Description
vector

Consulta vetorial em que um valor vetorial bruto é fornecido.
text

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

VectorsDebugInfo

Objeto
Nome Tipo Description
subscores

QueryResultDocumentSubscores

O detalhamento das subpontuações do documento antes do método de fusão/combinação do conjunto de resultados escolhido, como RRF.