REST Resource: projects.locations.collections.engines.sessions.assistAnswers

资源：AssistAnswer

AssistAnswer 资源，AssistResponse 的主要组成部分。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
字段
name

string

不可变。标识符。AssistAnswer 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
state

enum (State)

答案生成的状态。
replies[]

object (Reply)

助理的回答。
assistSkippedReasons[]

enum (AssistSkippedReason)

未接听辅助通话的原因。
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

可选。该字段包含有关各种政策检查结果的信息，例如违禁短语或 Model Armor 检查。仅当因违反政策而跳过辅助通话时，系统才会填充此字段。

州

答案生成的状态。

枚举
STATE_UNSPECIFIED 未知。
IN_PROGRESS 辅助操作正在进行中。
FAILED 辅助操作失败。
SUCCEEDED 辅助操作已成功完成。
SKIPPED 已跳过辅助操作。

回复

辅助调用多部分响应的一部分。

JSON 表示法 
{

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
字段
联合字段 reply。助理回答的替代方案。reply 只能是下列其中一项：
groundedContent

object (AssistantGroundedContent)

助理可能提供的接地回答文本或媒体。

AssistantGroundedContent

一段内容，可能还包括其依据信息。

并非所有内容都需要接地。“当然，我很乐意为您搜索。”之类的短语不需要接地。

JSON 表示法 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
字段
content

object (AssistantContent)

内容。
citationMetadata

object (CitationMetadata)

生成内容的来源提供方信息。另请参阅 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

可选。内容的元数据。目前仅用于研究助理的回答。
联合字段 metadata。各种模态的 grounding 元数据。目前仅支持文本。metadata 只能是下列其中一项：
textGroundingMetadata

object (TextGroundingMetadata)

基于文本来源的依据的元数据。

TextGroundingMetadata

文本来源的依据详细信息。

JSON 表示法 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
字段
segments[]

object (Segment)

文本部分的基础信息。
references[]

object (Reference)

已接地文本的参考信息。

细分

文本段的接地信息。

JSON 表示法 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
字段
startIndex

string (int64 format)

从零开始的索引，用于指示分段的起始位置，以 UTF-8 字符串的字节数来衡量（即，以多个字节编码的字符的长度大于 1）。
endIndex

string (int64 format)

分段的结束时间（不含）。
referenceIndices[]

integer

细分的参考资料。
groundingScore

number

细分的得分。
text

string

文本段本身。

参考文档

参考内容和相关文档元数据。

JSON 表示法 
{
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
字段
content

string

参考文本内容。
documentMetadata

object (DocumentMetadata)

文档元数据。

DocumentMetadata

文档元数据。

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
字段
document

string

文档资源名称。
uri

string

相应文档的 URI。它可能包含重定向到实际网站的网址。
title

string

标题。
pageIdentifier

string

网页标识符。
domain

string

文档 URI 中的域名。请注意，uri 字段可能包含重定向到实际网站的网址，在这种情况下，该字段将包含目标网站的域名。
mimeType

string

文档的 MIME 类型。https://www.iana.org/assignments/media-types/media-types.xhtml。

AssistantContent

多模态内容。

JSON 表示法 
{
  "role": string,
  "thought": boolean,

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
字段
role

string

内容的制作方。可以是“model”或“user”。
thought

boolean

可选。表示相应部分是否由模型生成。
联合字段 data。包含的数据。data 只能是下列其中一项：
text

string

内嵌文本。
inlineData

object (Blob)

内嵌二进制数据。
file

object (File)

文件，例如音频摘要。
executableCode

object (ExecutableCode)

模型生成的旨在执行的代码。
codeExecutionResult

object (CodeExecutionResult)

执行 ExecutableCode 的结果。

Blob

内嵌 blob。

JSON 表示法 
{
  "mimeType": string,
  "data": string
}
字段
mimeType

string

必需。生成的数据的媒体类型 (MIME 类型)。
data

string (bytes format)

必需。原始字节。

使用 base64 编码的字符串。

文件

文件，例如音频摘要。

JSON 表示法 
{
  "mimeType": string,
  "fileId": string
}
字段
mimeType

string

必需。文件的媒体类型 (MIME 类型)。
fileId

string

必需。文件 ID。

ExecutableCode

由模型生成且旨在由模型执行的代码。

JSON 表示法 
{
  "code": string
}
字段
code

string

必需。代码内容。目前仅支持 Python。

CodeExecutionResult

执行 ExecutableCode 的结果。

JSON 表示法 
{
  "outcome": enum (Outcome),
  "output": string
}
字段
outcome

enum (Outcome)

必需。代码执行结果。
output

string

可选。如果代码执行成功，则包含 stdout；否则包含 stderr 或其他说明。

结果

代码执行的可能结果的枚举。

枚举
OUTCOME_UNSPECIFIED 未指定状态。请勿使用此值。
OUTCOME_OK 代码已成功执行完毕。
OUTCOME_FAILED 代码执行完毕，但失败了。stderr 应包含原因。
OUTCOME_DEADLINE_EXCEEDED 代码执行运行时间过长，已被取消。可能存在部分输出，也可能不存在。

CitationMetadata

一段内容的一组来源提供方信息。

JSON 表示法 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
字段
citations[]

object (Citation)

仅限输出。引用列表。

引用

内容来源信息。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
字段
startIndex

integer

仅限输出。内容中的起始索引。
endIndex

integer

仅限输出。内容中的结束索引。
uri

string

仅限输出。提供方信息的网址引用。
title

string

仅限输出。提供方信息的标题。
license

string

仅限输出。提供方信息的许可。
publicationDate

object (Date)

仅限输出。提供方信息的发布日期。

ContentMetadata

内容的元数据。

JSON 表示法 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
字段
contentKind

enum (ContentKind)

内容的类型。显示相应内容属于研究助理回答的哪个部分。
contentId

string

内容的 ID。用于将研究问题与答案相关联。例如，研究问题的答案的各个部分将与问题具有相同的 contentId。

ContentKind

可能的内容种类。目前仅用于区分研究助理完整回答中的各个部分。

枚举
CONTENT_KIND_UNSPECIFIED 未知。
RESEARCH_PLAN 研究计划。
RESEARCH_QUESTION 研究问题。
RESEARCH_ANSWER 研究回答。
RESEARCH_REPORT 研究报告。
RESEARCH_AUDIO_SUMMARY 研究音频摘要。

AssistSkippedReason

未接听辅助通话的可能原因。

枚举
ASSIST_SKIPPED_REASON_UNSPECIFIED 默认值。未指定跳过原因。
NON_ASSIST_SEEKING_QUERY_IGNORED 助理忽略了查询，因为该查询似乎不是在寻求答案。
CUSTOMER_POLICY_VIOLATION 由于违反了客户政策（例如，查询或回答中包含禁用短语），助理忽略了查询或拒绝回答。

CustomerPolicyEnforcementResult

客户政策执行结果。包含各种政策检查的结果，例如违禁短语或 Model Armor 检查。

JSON 表示法 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
字段
verdict

enum (Verdict)

客户政策违规处置的最终判决。如果只有一项政策阻止了处理，则判决为“阻止”。
policyResults[]

object (PolicyEnforcementResult)

客户政策执行结果。仅当因违反政策而跳过辅助调用时填充。它包含阻止查询处理的过滤条件的结果。

判定

客户政策违规处置的判决。

枚举
UNSPECIFIED 未知值。
ALLOW 没有违反政策。
BLOCK 处理因违反客户政策而被阻止。

PolicyEnforcementResult

单个政策类型的客户政策执行结果。

JSON 表示法 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
字段
联合字段 enforcement_result。特定政策类型的结果。可以是错误，也可以是有关政策违规处置结果的详细信息。enforcement_result 只能是下列其中一项：
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

禁止用语政策的政策执行结果。
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Model Armor 政策的政策强制执行结果。

BannedPhraseEnforcementResult

针对违禁短语政策的客户政策执行结果。

JSON 表示法 
{
  "bannedPhrases": [
    string
  ]
}
字段
bannedPhrases[]

string

查询或回答中发现的违禁短语。

ModelArmorEnforcementResult

Model Armor 政策的客户政策强制执行结果。

JSON 表示法 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
字段
联合字段 result。Model Armor 政策结果。result 只能是下列其中一项：
modelArmorViolation

string

发现的 Model Armor 违规行为。
error

object (Status)

如果政策强制执行因某种原因而失败，Model Armor 返回的错误。

方法

get

 获取 AssistAnswer。