- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- GroundingPassages
- GroundingPassage
- SemanticRetrieverConfig
- AnswerStyle
- InputFeedback
- BlockReason
根据输入 GenerateAnswerRequest
根据模型生成依据结果的答案。
HTTP 请求
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateAnswer
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
model |
必需。用于生成依据反馈的 格式: |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "contents": [ { object ( |
字段 | |
---|---|
contents[] |
必需。当前与模型对话的内容。对于单轮查询,只有单个问题需要回答。对于多轮查询,此字段为重复字段,包含对话记录和包含题目的列表中的最后一个 注意:models.generateAnswer 目前仅支持英语查询。 |
answerStyle |
必需。应采用哪种样式返回答案。 |
safetySettings[] |
可选。用于屏蔽不安全内容的唯一 此政策将于 |
联合字段 grounding_source 。答案的基础。grounding_source 只能是下列其中一项: |
|
inlinePassages |
内嵌在请求中提供的段落。 |
semanticRetriever |
从通过 Semantic Retriever API 创建的资源中检索的内容。 |
temperature |
可选。控制输出的随机性。 值的范围为 [0.0,1.0](含 [0.0,1.0])。接近 1.0 的值将产生更加多样化和更具创造性的回答,而接近 0.0 的值通常会导致模型给出的回答更直接。对于归因问答用例,通常建议采用较低的温度 (~0.2)。 |
响应正文
模型针对有根据的答案给出的回答。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "answer": { object ( |
字段 | |
---|---|
answer |
模型提供的候选答案。 注意:该模型始终会尝试提供有据可依的答案,即使根据指定段落很难回答的情况下也是如此。在这种情况下,可能会提供低质量或缺乏依据的答案,以及较低的 |
answerableProbability |
仅供输出。模型对答案正确且基于输入段落的概率估算值。 可回答概率较低表示答案可能没有依据来源。 当
|
inputFeedback |
仅供输出。与用于回答问题的输入数据相关的反馈,与模型针对问题生成的回答不同。 “输入数据”可以是以下一项或多项:
|
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/generative-language
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
https://www.googleapis.com/auth/generative-language.tuning
https://www.googleapis.com/auth/generative-language.tuning.readonly
如需了解详情,请参阅身份验证概览。
GroundingPassages
重复段落列表。
JSON 表示法 |
---|
{
"passages": [
{
object ( |
字段 | |
---|---|
passages[] |
段落列表。 |
GroundingPassage
内嵌在着陆配置中所含的段落。
JSON 表示法 |
---|
{
"id": string,
"content": {
object ( |
字段 | |
---|---|
id |
用于在有根据的回答中注明此段落的段落的标识符。 |
content |
段落的内容。 |
SemanticRetrieverConfig
用于从使用 Semantic Retriever API 创建的 Corpus
或 Document
检索依据内容的配置。
JSON 表示法 |
---|
{ "source": string, "query": { object ( |
字段 | |
---|---|
source |
必需。用于检索的资源的名称,例如 corpora/123 或 corpora/123/documents/abc。 |
query |
必需。用于相似性与给定资源中的 |
metadataFilters[] |
可选。用于从资源中选择 |
maxChunksCount |
可选。要检索的相关 |
minimumRelevanceScore |
可选。检索到的相关 |
AnswerStyle
设定有依据的答案的样式。
枚举 | |
---|---|
ANSWER_STYLE_UNSPECIFIED |
未指定的答案样式。 |
ABSTRACTIVE |
简洁而抽象的风格。 |
EXTRACTIVE |
风格简短且提取。 |
VERBOSE |
包含额外详细信息的详细样式。回复的格式可以是句子、段落、多个段落或项目符号等。 |
InputFeedback
与用于回答问题的输入数据相关的反馈,与模型针对问题生成的回答不同。
JSON 表示法 |
---|
{ "safetyRatings": [ { object ( |
字段 | |
---|---|
safetyRatings[] |
输入安全性评分。每个类别最多只能有一个评分。 |
blockReason |
可选。如果设置了此字段,则输入会被屏蔽,并且不会返回任何候选项。改写您输入的内容。 |
BlockReason
指定禁止输入的原因。
枚举 | |
---|---|
BLOCK_REASON_UNSPECIFIED |
默认值。此值未使用。 |
SAFETY |
出于安全考虑,输入已被屏蔽。您可以检查 safetyRatings ,了解哪个安全类别将其屏蔽。 |
OTHER |
输入因其他原因已被屏蔽。 |