你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Documents - Search Get

参考

服务:: Search Service

API 版本:: 2024-07-01

在索引中搜索文档。

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-01

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
indexName	path	True	string	索引的名称。
api-version	query	True	string	客户端 API 版本。
$count	query		boolean	一个值，该值指定是否提取结果总数。默认值为 false。将此值设置为 true 可能会影响性能。请注意，返回的计数是近似值。
$filter	query		string	要应用于搜索查询的 OData $filter表达式。
$orderby	query		string[]	要对其结果进行排序的 OData $orderby表达式的列表。每个表达式可以是字段名称，也可以是对 geo.distance（）或 search.score（）函数的调用。每个表达式后跟 asc 以指示升序，反序列化表示降序。默认值为升序。关系将由匹配文档的分数中断。如果未指定 OrderBy，则默认排序顺序按文档匹配分数降序。最多可以有 32 个$orderby子句。
$select	query		string[]	要检索的字段列表。如果未指定，则包含标记为在架构中可检索的所有字段。
$skip	query		integer int32	要跳过的搜索结果数。此值不能大于 100,000。如果需要按顺序扫描文档，但由于此限制而无法使用$skip，请考虑对完全有序的键使用$orderby，并改用范围查询$filter。
$top	query		integer int32	要检索的搜索结果数。这可以与$skip结合使用来实现搜索结果的客户端分页。如果由于服务器端分页而截断结果，响应将包含一个延续标记，该标记可用于发出下一页结果的另一个搜索请求。
answers	query		QueryAnswerType	仅当查询类型 `semantic`时，此参数才有效。如果设置，查询将返回从排名最高的文档中的关键段落中提取的答案。可以通过在 answers 参数值后追加管道字符 `\|` 后跟 `count-<number of answers>` 选项来配置返回的答案数，例如 `extractive\|count-3`。默认计数为 1。可以通过追加管道字符 `\|` 后接答案参数值（如 `extractive\|threshold-0.9`）后 `threshold-<confidence threshold>` 选项来配置置信度阈值。默认阈值为 0.7。
captions	query		QueryCaptionType	仅当查询类型 `semantic`时，此参数才有效。如果已设置，查询将返回从排名最高的文档中的关键段落中提取的标题。当 Captions 设置为 `extractive`时，默认情况下会启用突出显示，并且可以通过追加管道字符 `\|` 后跟 `highlight-<true/false>` 选项（例如 `extractive\|highlight-true`）进行配置。默认为 `None`。
facet	query		string[]	要应用于搜索查询的分面表达式列表。每个分面表达式都包含一个字段名称，可以选择后跟逗号分隔的名称：值对列表。
highlight	query		string[]	要用于命中突出显示的字段名称列表。只能使用可搜索字段进行命中突出显示。
highlightPostTag	query		string	追加到命中突出显示的字符串标记。必须使用 highlightPreTag 进行设置。默认值为 /em <>。
highlightPreTag	query		string	前面追加的字符串标记以命中突出显示。必须使用 highlightPostTag 进行设置。默认值为 em><。
minimumCoverage	query		number double	介于 0 和 100 之间的数字，指示搜索查询必须涵盖的索引百分比，以便将查询报告为成功。此参数可用于确保仅包含一个副本的服务的搜索可用性。默认值为 100。
queryType	query		QueryType	一个值，指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”。
scoringParameter	query		string[]	在评分函数（例如 referencePointParameter）中使用格式名称值的参数值列表。例如，如果计分配置文件使用名为“mylocation”的参数定义函数，则参数字符串将为“mylocation--122.2,44.8”（不含引号）。
scoringProfile	query		string	要评估匹配文档的匹配分数的计分配置文件的名称，以便对结果进行排序。
scoringStatistics	query		ScoringStatistics	一个值，该值指定是全局计算计分统计信息（如文档频率），以更一致评分，还是在本地计算延迟较低。
search	query		string	全文搜索查询表达式;使用“*”或省略此参数以匹配所有文档。
searchFields	query		string[]	要限定全文搜索范围的字段名称列表。在完整的 Lucene 查询中使用字段搜索（fieldName：searchExpression），每个字段搜索表达式的字段名称优先于此参数中列出的任何字段名称。
searchMode	query		SearchMode	一个值，该值指定是否必须匹配任何搜索词或全部搜索词，以便将文档计数为匹配项。
semanticConfiguration	query		string	语义配置的名称，其中列出了哪些字段应该用于语义排名、标题、突出显示和答案
semanticErrorHandling	query		SemanticErrorMode	允许用户选择语义调用是否应完全失败，还是返回部分结果（默认值）。
semanticMaxWaitInMilliseconds	query		integer int32	允许用户在请求失败之前设置语义扩充完成处理所需的时间上限。
semanticQuery	query		string	允许设置单独的搜索查询，该查询将仅用于语义重排、语义标题和语义答案。对于需要在基础检索和排名阶段和 L2 语义阶段之间使用不同的查询的情况，非常有用。
sessionId	query		string	用于创建粘滞会话的值，有助于获取更一致的结果。只要使用了同一 sessionId，就会尝试以相同的副本集为目标。谨慎地重复使用相同的 sessionID 值可能会干扰跨副本的请求负载均衡，并对搜索服务的性能产生不利影响。用作 sessionId 的值不能以“_”字符开头。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string uuid	随请求一起发送的跟踪 ID，以帮助进行调试。

响应

名称	类型	说明
200 OK	SearchDocumentsResult	包含与搜索条件匹配的文档的响应。
Other Status Codes	ErrorResponse	错误响应。

示例

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

示例请求

HTTP

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

示例响应

状态代码:: 200

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

SearchIndexSearchDocumentsSemanticGet

示例请求

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

示例响应

状态代码:: 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
    }
  ],
  "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"
      ]
    }
  ]
}

定义

名称	说明
AnswerResult	答案是从与查询匹配的最相关文档的内容中提取的文本段落。答案是从排名靠前的搜索结果中提取的。对考生进行评分，并且选择了排名靠前的答案。
CaptionResult	标题是文档相对于搜索查询最具代表性的段落。它们通常用作文档摘要。仅返回 `semantic`类型的查询的标题。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
QueryAnswerType	一个值，该值指定是否应作为搜索响应的一部分返回答案。
QueryCaptionType	一个值，该值指定是否应返回标题作为搜索响应的一部分。
QueryType	指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”。
RawVectorQuery	提供原始向量值时用于矢量搜索的查询参数。
ScoringStatistics	一个值，该值指定是全局计算计分统计信息（如文档频率），以更一致评分，还是在本地计算延迟较低。默认值为“local”。在评分之前，使用“全局”全局聚合评分统计信息。使用全局计分统计信息可以提高搜索查询的延迟。
SearchDocumentsResult	包含索引搜索结果的响应。
SearchMode	指定是否必须匹配任何搜索词或所有搜索词，以便将文档计数为匹配项。
SearchRequest	用于筛选、排序、分面、分页和其他搜索查询行为的参数。
SearchResult	包含搜索查询找到的文档，以及关联的元数据。
SemanticErrorMode	允许用户选择语义调用是否应完全失败（默认/当前行为），还是返回部分结果。
SemanticErrorReason	语义排名请求返回部分响应的原因。
SemanticSearchResultsType	为语义排名请求返回的部分响应的类型。
VectorFilterMode	确定是否在执行矢量搜索之前或之后应用筛选器。
VectorizableTextQuery	提供需要矢量化的文本值时用于矢量搜索的查询参数。
VectorQueryKind	要执行的矢量查询的类型。

AnswerResult

答案是从与查询匹配的最相关文档的内容中提取的文本段落。答案是从排名靠前的搜索结果中提取的。对考生进行评分，并且选择了排名靠前的答案。

名称	类型	说明
highlights	string	与 Text 属性中的文本段落相同，其中突出显示的文本短语与查询最相关的文本短语。
key	string	从中提取答案的文档的键。
score	number	分数值表示答案与查询相对于为查询返回的其他答案的相关性。
text	string	从文档内容中提取的文本段落作为答案。

CaptionResult

标题是文档相对于搜索查询最具代表性的段落。它们通常用作文档摘要。仅返回 semantic类型的查询的标题。

名称	类型	说明
highlights	string	与 Text 属性中的文本段落相同，其中突出显示的短语与查询最相关的短语。
text	string	从文档中提取的与搜索查询最相关的代表性文本段落。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

QueryAnswerType

一个值，该值指定是否应作为搜索响应的一部分返回答案。

名称	类型	说明
extractive	string	从以自然语言表示的查询中返回的文档内容中提取答案候选项。
none	string	不要返回查询的答案。

QueryCaptionType

一个值，该值指定是否应返回标题作为搜索响应的一部分。

名称	类型	说明
extractive	string	从匹配的文档中提取标题，其中包含与搜索查询相关的段落。
none	string	不要返回查询的标题。

QueryType

指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”。

名称	类型	说明
full	string	使用完整的 Lucene 查询语法进行搜索。搜索文本是使用 Lucene 查询语言解释的，该语言允许特定于字段的和加权的搜索以及其他高级功能。
semantic	string	最适合以自然语言表示的查询，而不是关键字。通过使用在 Web corpus 上训练的排名模型重新对排名靠前的搜索结果进行排名来提高搜索结果的精度。
simple	string	使用简单的查询语法进行搜索。搜索文本是使用简单的查询语言解释的，该语言允许使用 +、* 和“”等符号。默认情况下，所有可搜索字段都会计算查询，除非指定 searchFields 参数。

RawVectorQuery

提供原始向量值时用于矢量搜索的查询参数。

名称	类型	说明
exhaustive	boolean	如果为 true，则触发矢量索引中所有向量中最接近的邻域搜索。对于精确匹配至关重要的方案（例如确定基本真相值）非常有用。
fields	string	要包含在搜索矢量中的集合（Edm.Single）类型的向量字段。
k	integer	要作为热门命中返回的最近的邻居数。
kind	string: vector	要执行的矢量查询的类型。
oversampling	number	过度采样因子。最小值为 1。它替代索引定义中配置的“defaultOversampling”参数。仅当“rerankWithOriginalVectors”为 true 时，才能设置它。仅当在基础向量字段上使用压缩方法时，才允许此参数。
vector	number[]	搜索查询的向量表示形式。
weight	number	与同一搜索请求中的其他向量查询和/或文本查询相比，矢量查询的相对权重。当合并由不同向量查询生成的多个排名列表的结果和/或通过文本查询检索的结果时，将使用此值。权重越高，匹配该查询的文档将处于最终排名中。默认值为 1.0，该值必须是大于零的正数。

ScoringStatistics

一个值，该值指定是全局计算计分统计信息（如文档频率），以更一致评分，还是在本地计算延迟较低。默认值为“local”。在评分之前，使用“全局”全局聚合评分统计信息。使用全局计分统计信息可以提高搜索查询的延迟。

名称	类型	说明
global	string	计分统计信息将以全局方式计算，以便进行更一致的评分。
local	string	评分统计信息将在本地计算，以降低延迟。

SearchDocumentsResult

包含索引搜索结果的响应。

名称	类型	说明
@odata.count	integer	搜索操作找到的结果总数，如果未请求计数，则为 null。如果存在，则计数可能大于此响应中的结果数。如果使用$top或$skip参数，或者查询不能在单个响应中返回所有请求的文档，则可能会发生这种情况。
@odata.nextLink	string	当查询无法在单个响应中返回所有请求的结果时返回的延续 URL。可以使用此 URL 构建另一个 GET 或 POST 搜索请求来获取搜索响应的下一部分。请确保使用与生成此响应的请求相同的谓词（GET 或 POST）。
@search.answers	AnswerResult[]	搜索操作的答案查询结果;如果未指定 answers 查询参数或设置为“none”，则为 null。
@search.coverage	number	一个值，指示查询中包含的索引百分比;如果未在请求中指定 minimumCoverage，则为 null。
@search.facets	object	搜索操作的分面查询结果，组织为每个分面字段的存储桶集合;如果查询不包含任何分面表达式，则为 null。
@search.nextPageParameters	SearchRequest	当查询无法在单个响应中返回所有请求的结果时返回的延续 JSON 有效负载。可以将此 JSON 与 @odata.nextLink 一起使用来构建另一个 POST 搜索请求，以获取搜索响应的下一部分。
@search.semanticPartialResponseReason	SemanticErrorReason	语义排名请求返回部分响应的原因。
@search.semanticPartialResponseType	SemanticSearchResultsType	为语义排名请求返回的部分响应的类型。
value	SearchResult[]	查询返回的结果序列。

SearchMode

指定是否必须匹配任何搜索词或所有搜索词，以便将文档计数为匹配项。

名称	类型	说明
all	string	必须匹配所有搜索词，才能将文档计数为匹配项。
any	string	必须匹配任何搜索词，才能将文档计数为匹配项。

SearchRequest

用于筛选、排序、分面、分页和其他搜索查询行为的参数。

名称	类型	说明
answers	QueryAnswerType	一个值，该值指定是否应作为搜索响应的一部分返回答案。
captions	QueryCaptionType	一个值，该值指定是否应返回标题作为搜索响应的一部分。
count	boolean	一个值，该值指定是否提取结果总数。默认值为 false。将此值设置为 true 可能会影响性能。请注意，返回的计数是近似值。
facets	string[]	要应用于搜索查询的分面表达式列表。每个分面表达式都包含一个字段名称，可以选择后跟逗号分隔的名称：值对列表。
filter	string	要应用于搜索查询的 OData $filter表达式。
highlight	string	用于命中突出显示的字段名称的逗号分隔列表。只能使用可搜索字段进行命中突出显示。
highlightPostTag	string	追加到命中突出显示的字符串标记。必须使用 highlightPreTag 进行设置。默认值为 /em <>。
highlightPreTag	string	前面追加的字符串标记以命中突出显示。必须使用 highlightPostTag 进行设置。默认值为 em><。
minimumCoverage	number	介于 0 和 100 之间的数字，指示搜索查询必须涵盖的索引百分比，以便将查询报告为成功。此参数可用于确保仅包含一个副本的服务的搜索可用性。默认值为 100。
orderby	string	OData 的逗号分隔列表$orderby用于对结果进行排序的表达式。每个表达式可以是字段名称，也可以是对 geo.distance（）或 search.score（）函数的调用。每个表达式后跟 asc 以指示升序，或 desc 表示降序。默认值为升序。关系将由匹配文档的分数中断。如果未指定$orderby，则默认排序顺序按文档匹配分数降序。最多可以有 32 个$orderby子句。
queryType	QueryType	一个值，指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”。
scoringParameters	string[]	在评分函数（例如 referencePointParameter）中使用格式名称值的参数值列表。例如，如果计分配置文件使用名为“mylocation”的参数定义函数，则参数字符串将为“mylocation--122.2,44.8”（不含引号）。
scoringProfile	string	要评估匹配文档的匹配分数的计分配置文件的名称，以便对结果进行排序。
scoringStatistics	ScoringStatistics	一个值，该值指定是全局计算计分统计信息（如文档频率），以更一致评分，还是在本地计算延迟较低。默认值为“local”。在评分之前，使用“全局”全局聚合评分统计信息。使用全局计分统计信息可以提高搜索查询的延迟。
search	string	全文搜索查询表达式;使用“*”或省略此参数以匹配所有文档。
searchFields	string	要限定全文搜索范围的字段名称的逗号分隔列表。在完整的 Lucene 查询中使用字段搜索（fieldName：searchExpression），每个字段搜索表达式的字段名称优先于此参数中列出的任何字段名称。
searchMode	SearchMode	一个值，该值指定是否必须匹配任何搜索词或全部搜索词，以便将文档计数为匹配项。
select	string	要检索的字段的逗号分隔列表。如果未指定，则包含标记为在架构中可检索的所有字段。
semanticConfiguration	string	处理类型语义查询的文档时将使用的语义配置的名称。
semanticErrorHandling	SemanticErrorMode	允许用户选择语义调用是否应完全失败（默认/当前行为），还是返回部分结果。
semanticMaxWaitInMilliseconds	integer	允许用户在请求失败之前设置语义扩充完成处理所需的时间上限。
semanticQuery	string	允许设置单独的搜索查询，该查询将仅用于语义重排、语义标题和语义答案。对于需要在基础检索和排名阶段和 L2 语义阶段之间使用不同的查询的情况，非常有用。
sessionId	string	用于创建粘滞会话的值，有助于获取更一致的结果。只要使用了同一 sessionId，就会尝试以相同的副本集为目标。谨慎地重复使用相同的 sessionID 值可能会干扰跨副本的请求负载均衡，并对搜索服务的性能产生不利影响。用作 sessionId 的值不能以“_”字符开头。
skip	integer	要跳过的搜索结果数。此值不能大于 100,000。如果需要按顺序扫描文档，但由于此限制而无法使用 skip，请考虑改用完全排序的键并使用范围查询进行筛选。
top	integer	要检索的搜索结果数。这可以与$skip结合使用来实现搜索结果的客户端分页。如果由于服务器端分页而截断结果，响应将包含一个延续标记，该标记可用于发出下一页结果的另一个搜索请求。
vectorFilterMode	VectorFilterMode	确定是否在执行矢量搜索之前或之后应用筛选器。对于新索引，默认值为“preFilter”。
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	矢量和混合搜索查询的查询参数。

SearchResult

包含搜索查询找到的文档，以及关联的元数据。

名称	类型	说明
@search.captions	CaptionResult[]	标题是文档相对于搜索查询最具代表性的段落。它们通常用作文档摘要。仅针对类型为“semantic”的查询返回标题。
@search.highlights	object	文档中指示匹配的搜索词的文本片段，按每个适用字段进行组织;如果未为查询启用命中突出显示，则为 null。
@search.rerankerScore	number	语义排名器为排名靠前的搜索结果计算的相关性分数。搜索结果首先按 RerankerScore 排序，然后按分数排序。仅针对类型为“semantic”的查询返回 RerankerScore。
@search.score	number	与查询返回的其他文档相比，文档的相关性分数。

SemanticErrorMode

允许用户选择语义调用是否应完全失败（默认/当前行为），还是返回部分结果。

名称	类型	说明
fail	string	如果在语义处理步骤中出现异常，查询将失败并返回相应的 HTTP 代码，具体取决于错误。
partial	string	如果语义处理失败，部分结果仍返回。部分结果的定义取决于语义步骤失败的原因和失败的原因。

SemanticErrorReason

语义排名请求返回部分响应的原因。

名称	类型	说明
capacityOverloaded	string	请求受到限制。仅返回基本结果。
maxWaitExceeded	string	如果设置了 `semanticMaxWaitInMilliseconds` 并且语义处理持续时间超过了该值。仅返回基本结果。
transient	string	语义进程的至少一个步骤失败。

SemanticSearchResultsType

为语义排名请求返回的部分响应的类型。

名称	类型	说明
baseResults	string	不带任何语义扩充或重新调整的结果。
rerankedResults	string	已使用重新曲柄模型重新调整结果，并包含语义标题。它们不会包含任何答案、答案突出显示或标题突出显示。

VectorFilterMode

确定是否在执行矢量搜索之前或之后应用筛选器。

名称	类型	说明
postFilter	string	返回候选矢量结果集后，将应用筛选器。根据筛选器选择性，这可能会导致结果少于参数“k”请求的结果。
preFilter	string	筛选器将在搜索查询之前应用。

VectorizableTextQuery

提供需要矢量化的文本值时用于矢量搜索的查询参数。

名称	类型	说明
exhaustive	boolean	如果为 true，则触发矢量索引中所有向量中最接近的邻域搜索。对于精确匹配至关重要的方案（例如确定基本真相值）非常有用。
fields	string	要包含在搜索矢量中的集合（Edm.Single）类型的向量字段。
k	integer	要作为热门命中返回的最近的邻居数。
kind	string: text	要执行的矢量查询的类型。
oversampling	number	过度采样因子。最小值为 1。它替代索引定义中配置的“defaultOversampling”参数。仅当“rerankWithOriginalVectors”为 true 时，才能设置它。仅当在基础向量字段上使用压缩方法时，才允许此参数。
text	string	要进行矢量化以执行矢量搜索查询的文本。
weight	number	与同一搜索请求中的其他向量查询和/或文本查询相比，矢量查询的相对权重。当合并由不同向量查询生成的多个排名列表的结果和/或通过文本查询检索的结果时，将使用此值。权重越高，匹配该查询的文档将处于最终排名中。默认值为 1.0，该值必须是大于零的正数。

VectorQueryKind

要执行的矢量查询的类型。

名称	类型	说明
text	string	向量查询，其中提供了需要矢量化的文本值。
vector	string	提供原始向量值的矢量查询。

通过

Documents - Search Get

URI 参数

请求头

响应

示例

SearchIndexSearchDocumentsGet

示例请求

示例响应

SearchIndexSearchDocumentsSemanticGet

示例请求

示例响应

定义

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

其他资源