Documents - Search Post

Serviço:: Search Service

Versão da API:: 2026-04-01

Pesquisa documentos no índice.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

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 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	A expressão $filter OData 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 a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage	number (double)	Um número entre 0 e 100 que indica 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 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 é a ordem crescente. Os empates serão interrompidos 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.
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 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 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 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 todos os nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se qualquer um 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 de semântica de tipo.
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 necessária 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 o 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	string	Um valor a ser usado para criar uma sessão fixa, o que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. 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 (int32)	O número de resultados da pesquisa a serem ignoradas. Esse valor não pode 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.
top	integer (int32)	O número de resultados da pesquisa a serem recuperados. Isso pode ser usado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser usado para emitir outra solicitação de pesquisa para a próxima página de resultados.
vectorFilterMode	VectorFilterMode	Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial. O padrão é 'preFilter' para novos índices.
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	Os parâmetros de consulta para consultas de pesquisa vetor e híbrida.

Respostas

Nome	Tipo	Description
200 OK	SearchDocumentsResult	A solicitação foi bem-sucedida.
Other Status Codes	SearchDocumentsResult	Êxito
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Solicitação de exemplo

HTTP

POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01


{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "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",
      "oversampling": 20,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Resposta de exemplo

Código de status:: 200

{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "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>"
        }
      ],
      "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>"
        }
      ],
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Código de status:: 206

{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "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>"
        }
      ],
      "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>"
        }
      ],
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "This is a caption from the document.",
          "highlights": "This is a <em>caption</em> from the document."
        }
      ],
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-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=2026-04-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=2026-04-01"
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
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 comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
QueryAnswerResult	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.
QueryAnswerType	Esse parâmetro só será válido se o tipo de consulta for `semantic`. Se definido, a consulta retornará respostas extraídas das principais passagens nos documentos mais bem classificados. O número de respostas retornadas pode ser configurado anexando o caractere `\|` de barra vertical seguido pela `count-<number of answers>` opção após o valor do parâmetro de respostas, como `extractive\|count-3`. A contagem padrão é 1. O limite de confiança pode ser configurado anexando o caractere `\|` de barra vertical seguido pela `threshold-<confidence threshold>` opção após o valor do parâmetro de respostas, como `extractive\|threshold-0.9`. O limite padrão é 0,7. O comprimento máximo de caracteres das respostas pode ser configurado anexando o caractere de barra vertical '\|' seguido pelo 'count-number< of maximum character length>', como 'extractive\|maxcharlength-600'.
QueryCaptionResult	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ão retornadas apenas para consultas do tipo `semantic`.
QueryCaptionType	Esse parâmetro só será válido se o tipo de consulta for `semantic`. Se definida, a consulta retornará legendas extraídas das principais passagens nos documentos mais bem classificados. Quando Legendas é definido como `extractive`, o realce é ativado por padrão e pode ser configurado anexando o caractere `\|` de barra vertical seguido pela `highlight-<true/false>` opção, como `extractive\|highlight-true`. Usa `None` como padrão. O comprimento máximo de caracteres das legendas pode ser configurado anexando o caractere de barra vertical '\|' seguido pelo 'número de< contagem do comprimento> máximo de caracteres', como 'extractive\|maxcharlength-600'.
QueryDebugMode	Habilita uma ferramenta de depuração que pode ser usada para explorar ainda mais os resultados da pesquisa. Você pode habilitar vários modos de depuração simultaneamente, separando-os com um \| caractere, por exemplo: semantic\|queryRewrites.
QueryResultDocumentSubscores	A divisão de subscores entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta de vetor é mostrada como um objeto separado na mesma ordem em que foram recebidos.
QueryType	Especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária.
ScoringStatistics	Um valor que especifica se queremos 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 de pontuar. O uso de estatísticas de pontuação global pode aumentar a latência das consultas de pesquisa.
SearchDocumentsResult	Resposta que contém os resultados da 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, 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.
SemanticErrorMode	Permite ao usuário escolher se uma chamada semântica deve falhar completamente ou devolver 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 de vetor. Ambas
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.
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.
VectorizedQuery	Os parâmetros de consulta a serem usados para pesquisa de vetor quando um valor de vetor bruto é fornecido.
VectorQueryKind	O tipo de consulta vetorial que está sendo executada.
VectorsDebugInfo	"Contém informações de depuração específicas para busca vetorial e híbrida.")

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=none

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

ErrorAdditionalInfo

Objeto

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

Nome	Tipo	Description
info		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 comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

QueryAnswerResult

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 de resposta são pontuados e as principais 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 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.

QueryAnswerType

Enumeração

Esse parâmetro só será válido se o tipo de consulta for semantic. Se definido, a consulta retornará respostas extraídas das principais passagens nos documentos mais bem classificados. O número de respostas retornadas pode ser configurado anexando o caractere | de barra vertical seguido pela count-<number of answers> opção após o valor do parâmetro de respostas, como extractive|count-3. A contagem padrão é 1. O limite de confiança pode ser configurado anexando o caractere | de barra vertical seguido pela threshold-<confidence threshold> opção após o valor do parâmetro de respostas, como extractive|threshold-0.9. O limite padrão é 0,7. O comprimento máximo de caracteres das respostas pode ser configurado anexando o caractere de barra vertical '|' seguido pelo 'count-number< of maximum character length>', como 'extractive|maxcharlength-600'.

Valor	Description
none	Não retorne respostas para a consulta.
extractive	Extrai os candidatos de resposta do conteúdo dos documentos retornados em resposta a uma consulta expressa como uma pergunta em linguagem natural.

QueryCaptionResult

Objeto

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ão retornadas apenas para consultas do tipo semantic.

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.

QueryCaptionType

Enumeração

Esse parâmetro só será válido se o tipo de consulta for semantic. Se definida, a consulta retornará legendas extraídas das principais passagens nos documentos mais bem classificados. Quando Legendas é definido como extractive, o realce é ativado por padrão e pode ser configurado anexando o caractere | de barra vertical seguido pela highlight-<true/false> opção, como extractive|highlight-true. Usa None como padrão. O comprimento máximo de caracteres das legendas pode ser configurado anexando o caractere de barra vertical '|' seguido pelo 'número de< contagem do comprimento> máximo de caracteres', como 'extractive|maxcharlength-600'.

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. Você pode habilitar vários modos de depuração simultaneamente, separando-os com um | caractere, por exemplo: semantic|queryRewrites.

Valor	Description
disabled	Nenhuma informação de depuração de consulta será retornada.
semantic	Permite que o usuário explore ainda mais seus resultados reclassificados.
vector	Permite que o usuário explore ainda mais seus resultados de consulta híbrida e vetor.
queryRewrites	Permite que o usuário explore a lista de reescritas de consulta geradas para sua solicitação de pesquisa.
innerHits	Permite que o usuário recupere informações de pontuação sobre vetores correspondentes em uma coleção de tipos complexos.
all	Ative todas as opções de depuração.

QueryResultDocumentSubscores

Objeto

A divisão de subscores entre os componentes de consulta de texto e vetor da consulta de pesquisa para este documento. Cada consulta de vetor é mostrada como um objeto separado na mesma ordem em que foram recebidos.

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 similaridade vetorial e

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 e 'semântica' se a sintaxe de consulta não for necessária.

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.

ScoringStatistics

Enumeração

Um valor que especifica se queremos 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 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 que contém os resultados da pesquisa de um índice.

Nome	Tipo	Description
@odata.count	integer (int64)	A contagem total de resultados encontrados pela operação de pesquisa ou nulo se a contagem não foi solicitada. Se presente, a contagem poderá 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	QueryAnswerResult[]	Os resultados da consulta de respostas para a operação de pesquisa; nulo se o parâmetro de consulta de respostas não foi especificado ou definido como 'none'.
@search.coverage	number (double)	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	Os resultados da consulta de faceta 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	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
@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, 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 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	A expressão $filter OData 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 a realces de clique. Deve ser definido com highlightPreTag. O padrão é </em>.
highlightPreTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. O padrão é <em>.
minimumCoverage	number (double)	Um número entre 0 e 100 que indica 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 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 é a ordem crescente. Os empates serão interrompidos 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.
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 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 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 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 todos os nomes de campo listados neste parâmetro.
searchMode	SearchMode	Um valor que especifica se qualquer um 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 de semântica de tipo.
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 necessária 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 o 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	string	Um valor a ser usado para criar uma sessão fixa, o que pode ajudar a obter resultados mais consistentes. Desde que a mesma sessionId seja usada, uma tentativa de melhor esforço será feita para atingir o mesmo conjunto de réplicas. 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 (int32)	O número de resultados da pesquisa a serem ignoradas. Esse valor não pode 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.
top	integer (int32)	O número de resultados da pesquisa a serem recuperados. Isso pode ser usado em conjunto com $skip para implementar a paginação do lado do cliente dos resultados da pesquisa. Se os resultados forem truncados devido à paginação do lado do servidor, a resposta incluirá um token de continuação que pode ser usado para emitir outra solicitação de pesquisa para a próxima página de resultados.
vectorFilterMode	VectorFilterMode	Determina se os filtros são aplicados antes ou depois da execução da pesquisa vetorial. O padrão é 'preFilter' para novos índices.
vectorQueries	VectorQuery[]: VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[] VectorizedQuery[]	Os parâmetros de consulta para consultas de pesquisa vetor 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	QueryCaptionResult[]	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ã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 busca são ordenados pelo RerankerScore/RerankerBoostedScore com base em useScoringProfileBoostedRanking na Configuração Semântica. RerankerBoostedScore é retornado apenas para consultas do tipo 'semântica'.
@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 ao usuário escolher se uma chamada semântica deve falhar completamente ou devolver 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	Se `semanticMaxWaitInMilliseconds` foi definido e a duração do processamento semântico excedeu esse valor. Somente os resultados base foram retornados.
capacityOverloaded	A solicitação foi limitada. Somente os resultados base 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 nenhum enriquecimento semântico ou reclassificado.
rerankedResults	Os resultados foram reclassificados com o modelo de reclassificador e incluirão legendas semânticas. Eles não incluirão respostas, realces de respostas ou realces de legenda.

SingleVectorFieldResult

Objeto

Um único resultado de campo de vetor. Ambas

Nome	Tipo	Description
searchScore	number (double)	O
vectorSimilarity	number (double)	A pontuação de similaridade vetorial para este documento. Observe que essa é a definição canônica da métrica de similaridade, não a versão de "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 de vetor for retornado. Dependendo da seletividade do filtro, isso pode resultar em menos resultados do que o solicitado pelo parâmetro 'k'.
preFilter	O filtro será aplicado antes da consulta de pesquisa.
strictPostFilter	O filtro será aplicado depois que o conjunto global de resultados vetoriais do candidato top-k for retornado. Isso resultará em menos resultados do que os solicitados pelo parâmetro 'k'.

VectorizableImageBinaryQuery

Objeto

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 de base 64 de uma imagem a ser vetorizada para executar uma consulta de pesquisa vetorial.
exhaustive	boolean	Quando verdadeiro, dispara uma pesquisa completa de k-nearest vizinho 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 de base.
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 serem retornados como as principais ocorrências.
kind	string: imageBinary	Tipo de consulta.
oversampling	number (double)	Fator de sobrecarga. 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 de vetor subjacente.
weight	number (float)	Peso relativo da consulta de vetor quando comparado com outra consulta de 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 de vetor 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 no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

VectorizableImageUrlQuery

Objeto

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 verdadeiro, dispara uma pesquisa completa de k-nearest vizinho 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 de base.
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 serem retornados como as principais ocorrências.
kind	string: imageUrl	Tipo de consulta.
oversampling	number (double)	Fator de sobrecarga. 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 de vetor subjacente.
url	string	A URL de uma imagem a ser vetorizada para executar uma consulta de pesquisa vetorial.
weight	number (float)	Peso relativo da consulta de vetor quando comparado com outra consulta de 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 de vetor 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 no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

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 verdadeiro, dispara uma pesquisa completa de k-nearest vizinho 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 de base.
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 serem retornados como as principais ocorrências.
kind	string: text	Tipo de consulta.
oversampling	number (double)	Fator de sobrecarga. 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 de vetor subjacente.
text	string	O texto a ser vetorizado para executar uma consulta de pesquisa de vetor.
weight	number (float)	Peso relativo da consulta de vetor quando comparado com outra consulta de 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 de vetor 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 no ranking final. O padrão é 1,0 e o valor precisa ser um número positivo maior que zero.

VectorizedQuery

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 verdadeiro, dispara uma pesquisa completa de k-nearest vizinho 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 de base.
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 serem retornados como as principais ocorrências.
kind	string: vector	Tipo de consulta.
oversampling	number (double)	Fator de sobrecarga. 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 de vetor subjacente.
vector	number[] (float)	A representação de vetor de uma consulta de pesquisa.
weight	number (float)	Peso relativo da consulta de vetor quando comparado com outra consulta de 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 de vetor 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 no ranking 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 vetor em que um valor de vetor bruto é fornecido.
text	Consulta vetor em que um valor de texto que precisa ser vetorizado é fornecido.
imageUrl	Consulta vetorial em que é fornecida uma url que representa um valor de imagem que precisa ser vetorizado.
imageBinary	Consulta vetorial em que é fornecido um binário codificado de base 64 de uma imagem que precisa ser vetorizada.

VectorsDebugInfo

Objeto

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

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.