REST Resource: projects.locations.collections.dataStores.sessions.answers

资源：Answer

定义一个回答。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
字段
name

string

不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

回答生成的状态。
answerText

string

文本回答。
citations[]

object (Citation)

引用。
groundingSupports[]

object (GroundingSupport)

可选。接地支持。
references[]

object (Reference)

引用。
relatedQuestions[]

string

建议的相关问题。
steps[]

object (Step)

回答生成步骤。
queryUnderstandingInfo

object (QueryUnderstandingInfo)

查询理解信息。
answerSkippedReasons[]

enum (AnswerSkippedReason)

回答被跳过的其他原因。这提供了忽略情况发生的原因。如果未跳过任何内容，则不会设置此字段。
createTime

string (Timestamp format)

仅限输出。回答创建时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
completeTime

string (Timestamp format)

仅限输出。回答完成时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
safetyRatings[]

object (SafetyRating)

可选。安全评分。
groundingScore

number

一个介于 [0, 1] 之间的得分，用于描述回答与参考块的关联程度。

状态

回答生成状态的枚举。

枚举
STATE_UNSPECIFIED 未知。
IN_PROGRESS 回答生成目前正在进行中。
FAILED 回答生成目前已失败。
SUCCEEDED 回答生成已成功。
STREAMING 回答生成目前正在进行中。

引用

片段的引用信息。

JSON 表示法 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
字段
startIndex

string (int64 format)

指示片段起始位置的索引，以字节 (UTF-8 unicode) 为单位。如果存在多字节字符（例如非 ASCII 字符），则索引长度会大于字符串长度。
endIndex

string (int64 format)

归因片段的结束位置（不包含该位置本身）。以字节 (UTF-8 unicode) 为单位。如果存在多字节字符（例如非 ASCII 字符），则索引长度会大于字符串长度。
sources[]

object (CitationSource)

归因片段的引用来源。

CitationSource

引用来源。

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

string

引用来源的 ID。

GroundingSupport

answerText 中某个主张的接地支持。

JSON 表示法 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
字段
startIndex

string (int64 format)

必需。指示主张起始位置的索引，以字节 (UTF-8 unicode) 为单位。
endIndex

string (int64 format)

必需。主张的结束位置（不包含该位置本身）。
sources[]

object (CitationSource)

可选。相应主张的引用来源。
groundingScore

number

范围在 [0, 1] 之间的分数，描述特定主张基于引用的接地程度。值越高，表示引用块对主张的支持程度越高。
groundingCheckRequired

boolean

指示相应主张是否需要接地检查。如果系统认为相应主张不需要归因/接地检查，则此字段设置为 false。在这种情况下，系统不会对主张进行接地检查，因此不会返回 groundingScore、sources。

Reference

引用。

JSON 表示法 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
字段
联合字段 content。搜索结果内容。content 只能是下列其中一项：
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

非结构化文档信息。
chunkInfo

object (ChunkInfo)

块信息。
structuredDocumentInfo

object (StructuredDocumentInfo)

结构化文档信息。

UnstructuredDocumentInfo

非结构化文档信息。

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
字段
document

string

文档资源名称。
uri

string

文档的 URI。
title

string

标题。
chunkContents[]

object (ChunkContent)

从文档内容派生的引用块内容的列表。
structData

object (Struct format)

文档的结构化 JSON 元数据。它会根据搜索结果中块的结构化数据进行填充。

ChunkContent

块内容。

JSON 表示法 
{
  "content": string,
  "pageIdentifier": string,
  "relevanceScore": number
}
字段
content

string

文本块内容。
pageIdentifier

string

页面标识符。
relevanceScore

number

相应块与给定查询的相关性。值范围从 0.0（完全不相关）到 1.0（完全相关）。该值仅供参考。由于模型重新训练或实现更改，同一查询和块的该值可能随时更改。

ChunkInfo

块信息。

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

string

块资源名称。
content

string

文本块内容。
documentMetadata

object (DocumentMetadata)

文档元数据。
relevanceScore

number

相应块与给定查询的相关性。值范围从 0.0（完全不相关）到 1.0（完全相关）。该值仅供参考。由于模型重新训练或实现更改，同一查询和块的该值可能随时更改。

DocumentMetadata

文档元数据。

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

string

文档资源名称。
uri

string

文档的 URI。
title

string

标题。
pageIdentifier

string

页面标识符。
structData

object (Struct format)

文档的结构化 JSON 元数据。它会根据搜索结果中块的结构化数据进行填充。

StructuredDocumentInfo

结构化搜索信息。

JSON 表示法 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
字段
document

string

文档资源名称。
structData

object (Struct format)

结构化搜索数据。
title

string

仅限输出。文档标题。
uri

string

仅限输出。文档的 URI。

步骤

步骤信息。

JSON 表示法 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
字段
state

enum (State)

步骤的状态。
description

string

步骤的说明。
thought

string

步骤的思考过程。
actions[]

object (Action)

操作。

状态

步骤的状态枚举。

枚举
STATE_UNSPECIFIED 未知。
IN_PROGRESS 步骤目前正在进行中。
FAILED 步骤目前已失败。
SUCCEEDED 步骤已成功。

操作

操作。

JSON 表示法 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
字段
observation

object (Observation)

观察结果。
联合字段 action。操作。action 只能是下列其中一项：
searchAction

object (SearchAction)

搜索操作。

SearchAction

搜索操作。

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

string

要搜索的查询。

观察

观察结果。

JSON 表示法 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
字段
searchResults[]

object (SearchResult)

搜索操作观察到的搜索结果，可以是摘要信息或块信息，具体取决于用户设置的引用类型。

SearchResult

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
字段
document

string

文档资源名称。
uri

string

文档的 URI。
title

string

标题。
snippetInfo[]

object (SnippetInfo)

如果 citation_type 为 DOCUMENT_LEVEL_CITATION，则填充文档级摘要。
chunkInfo[]

object (ChunkInfo)

如果 citation_type 为 CHUNK_LEVEL_CITATION 且启用了块模式，则填充块信息。
structData

object (Struct format)

数据表示形式。文档的结构化 JSON 数据。它是根据文档中的结构化数据或搜索结果中的块进行填充的。

SnippetInfo

摘要信息。

JSON 表示法 
{
  "snippet": string,
  "snippetStatus": string
}
字段
snippet

string

摘要内容。
snippetStatus

string

由搜索团队定义的摘要状态。

ChunkInfo

块信息。

JSON 表示法 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
字段
chunk

string

块资源名称。
content

string

文本块内容。
relevanceScore

number

相应块与给定查询的相关性。值范围从 0.0（完全不相关）到 1.0（完全相关）。该值仅供参考。由于模型重新训练或实现更改，同一查询和块的该值可能随时更改。

QueryUnderstandingInfo

查询理解信息。

JSON 表示法 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
字段
queryClassificationInfo[]

object (QueryClassificationInfo)

查询分类信息。

QueryClassificationInfo

查询分类信息。

JSON 表示法 
{
  "type": enum (Type),
  "positive": boolean
}
字段
type

enum (Type)

查询分类类型。
positive

boolean

分类输出。

类型

查询分类类型。

枚举
TYPE_UNSPECIFIED 查询分类类型未指定。
ADVERSARIAL_QUERY 对抗性查询分类类型。
NON_ANSWER_SEEKING_QUERY 非求答查询分类类型，用于闲聊。
JAIL_BREAKING_QUERY 越狱查询分类类型。
NON_ANSWER_SEEKING_QUERY_V2 非求答查询分类类型，用于无明确意图的查询。
USER_DEFINED_CLASSIFICATION_QUERY 用户定义的查询分类类型。

AnswerSkippedReason

回答被跳过原因的枚举。

枚举
ANSWER_SKIPPED_REASON_UNSPECIFIED 默认值。回答跳过原因未指定。
ADVERSARIAL_QUERY_IGNORED 对抗性查询被忽略的情况。
NON_ANSWER_SEEKING_QUERY_IGNORED

非求答查询被忽略的情况

如果查询是闲聊，Google 会跳过回答。
OUT_OF_DOMAIN_QUERY_IGNORED

域外查询被忽略的情况。

如果没有高相关性搜索结果，Google 会跳过回答。
POTENTIAL_POLICY_VIOLATION

潜在违规情况。

如果检测到潜在违规，Google 会跳过回答。这包括可能涉及暴力或有害性的内容。
NO_RELEVANT_CONTENT

无相关内容的情况。

如果检索到的搜索结果中没有相关内容，Google 会跳过回答。
JAIL_BREAKING_QUERY_IGNORED

越狱查询被忽略的情况。

例如“以竞争公司 CEO 的语气回答”。如果查询被归类为越狱查询，Google 会跳过回答。
CUSTOMER_POLICY_VIOLATION

客户违规情况。

如果检测到客户违规，Google 会跳过摘要。相应政策由客户定义。
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

非求答查询被忽略的情况。

如果查询没有明确意图，Google 会跳过回答。
LOW_GROUNDED_ANSWER

低接地程度回答的情况。

如果无法生成具有良好接地程度的回答，Google 会跳过回答。
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

用户定义的查询分类被忽略的情况。

如果查询被归类为用户定义的查询类别，Google 会跳过回答。
UNHELPFUL_ANSWER

无帮助回答的情况。

如果回答没有帮助，Google 会跳过回答。这可能是由多种因素造成的，包括但不限于：查询无法回答、回答与查询不相关或回答格式不正确。

SafetyRating

与生成的内容对应的安全评级。

JSON 表示法 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
字段
category

enum (HarmCategory)

仅限输出。危害类别。
probability

enum (HarmProbability)

仅限输出。内容中的危害概率级别。
probabilityScore

number

仅限输出。危害概率得分。
severity

enum (HarmSeverity)

仅限输出。内容中的危害严重级别。
severityScore

number

仅限输出。危害严重级别得分。
blocked

boolean

仅限输出。指示内容是否因此评级而被滤除。

HarmCategory

将屏蔽内容的危害类别。

枚举
HARM_CATEGORY_UNSPECIFIED 未指定有害类别。
HARM_CATEGORY_HATE_SPEECH 有害类别为仇恨言论。
HARM_CATEGORY_DANGEROUS_CONTENT 有害类别为危险内容。
HARM_CATEGORY_HARASSMENT 有害类别为骚扰。
HARM_CATEGORY_SEXUALLY_EXPLICIT 有害类别为露骨色情内容。
HARM_CATEGORY_CIVIC_INTEGRITY 危害类别为公民诚信。

HarmProbability

内容中的危害概率级别。

枚举
HARM_PROBABILITY_UNSPECIFIED 危害概率未指定。
NEGLIGIBLE 可忽略的危害级别。
LOW 低危害级别。
MEDIUM 中等危害级别。
HIGH 高危害级别。

HarmSeverity

危害严重级别。

枚举
HARM_SEVERITY_UNSPECIFIED 危害严重级别未指定。
HARM_SEVERITY_NEGLIGIBLE 可忽略的危害严重级别。
HARM_SEVERITY_LOW 低危害严重级别。
HARM_SEVERITY_MEDIUM 中等危害严重级别。
HARM_SEVERITY_HIGH 高危害严重级别。

方法

get

 获取一个回答。