对 Document
执行语义搜索。
HTTP 请求
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
必需。要查询的 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"query": string,
"resultsCount": integer,
"metadataFilters": [
{
object ( |
字段 | |
---|---|
query |
必需。用于执行语义搜索的查询字符串。 |
resultsCount |
可选。要返回的 如果未指定,则最多返回 10 个 |
metadataFilters[] |
可选。针对 注意:此请求不支持 查询示例:(year >= 2020 OR year < 2010) AND (类型 = 戏剧 OR 类型 = 行动)
数值范围的查询示例:(year > 2015 AND year <= 2020)
注意:只有数值支持对同一键使用“AND”。字符串值仅支持对同一键使用“OR”。 |
响应正文
来自 documents.query
的响应,其中包含相关分块的列表。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"relevantChunks": [
{
object ( |
字段 | |
---|---|
relevantChunks[] |
返回的相关区块。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
如需了解详情,请参阅身份验证概览。