REST Resource: projects.locations.collections.dataStores.conversations

资源：对话

外部对话 proto 定义。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
字段
name

string

不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* 或 projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*。
state

enum (State)

相应对话的状态。
userPseudoId

string

用于跟踪用户的唯一标识符。
messages[]

object (ConversationMessage)

对话消息。
startTime

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"。
endTime

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"。

状态

对话状态的枚举。

枚举
STATE_UNSPECIFIED 未知。
IN_PROGRESS 对话当前处于打开状态。
COMPLETED 对话已结束。

ConversationMessage

定义对话消息。

JSON 表示法 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
字段
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"。

联合字段 message。

message 只能是下列其中一项：
userInput

object (TextInput)

用户文本输入。
reply

object (Reply)

搜索回复。

TextInput

定义文本输入。

JSON 表示法 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
字段
input

string

文本输入。
context

object (ConversationContext)

输入的对话上下文。

ConversationContext

定义对话的上下文

JSON 表示法 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
字段
contextDocuments[]

string

用户当前看到的文档列表。它包含文档资源引用。
activeDocument

string

用户当前打开的有效文档。它包含文档资源引用。

回复

定义向用户发送的回复消息。

JSON 表示法 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
字段
reply
(deprecated)

string

已弃用：请改用 summary。文本回复。
references[]
(deprecated)

object (Reference)

回复中的引用。
summary

object (Summary)

基于搜索结果的摘要。

Reference

定义回复中的引用。

JSON 表示法 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
字段
uri

string

URI 链接引用。
anchorText

string

定位文本。
start

integer

定位文本起始索引。
end

integer

定位文本结束索引。

摘要

由摘要规范指定的 top N 搜索结果的摘要。

JSON 表示法 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
字段
summaryText

string

摘要内容。
summarySkippedReasons[]

enum (SummarySkippedReason)

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

object (SafetyAttributes)

安全属性类别及其关联置信度得分的集合。
summaryWithMetadata

object (SummaryWithMetadata)

带有元数据信息的摘要。

SummarySkippedReason

摘要跳过原因的枚举。

枚举
SUMMARY_SKIPPED_REASON_UNSPECIFIED 默认值。摘要跳过原因未指定。
ADVERSARIAL_QUERY_IGNORED

对抗性查询被忽略的情况。

仅在 SummarySpec.ignore_adversarial_query 设置为 true 时使用。
NON_SUMMARY_SEEKING_QUERY_IGNORED

非摘要求取查询被忽略的情况。

如果查询是闲聊，Google 会跳过摘要。仅在 SummarySpec.ignore_non_summary_seeking_query 设置为 true 时使用。
OUT_OF_DOMAIN_QUERY_IGNORED

域外查询被忽略的情况。

如果没有高相关性搜索结果，Google 会跳过摘要。例如，数据存储区包含有关公司 A 的事实，但用户查询的是有关公司 B 的问题。
POTENTIAL_POLICY_VIOLATION

潜在违规情况。

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

LLM 插件未启用的情况。

如果 LLM 插件未启用，Google 会跳过摘要。
NO_RELEVANT_CONTENT

无相关内容的情况。

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

越狱查询被忽略的情况。

例如“以竞争公司 CEO 的语气回答”。仅在 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] 设置为 true 时使用。
CUSTOMER_POLICY_VIOLATION

客户违规情况。

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

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

如果查询没有明确意图，Google 会跳过摘要。仅在 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] 设置为 true 时使用。
TIME_OUT

超时的情况。

如果超时，Google 会跳过摘要。

SafetyAttributes

安全属性类别及其关联的置信度得分。

JSON 表示法 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
字段
categories[]

string

与所生成内容关联的“安全属性”类别的显示名称。顺序与得分匹配。
scores[]

number

每个类别的置信度分数越高，表示置信度越高。 顺序与类别匹配。

SummaryWithMetadata

带有元数据信息的摘要。

JSON 表示法 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
字段
summary

string

不含引用信息的摘要文本。
citationMetadata

object (CitationMetadata)

给定摘要的引用元数据。
references[]

object (Reference)

文档引用。
blobAttachments[]

object (BlobAttachment)

仅限输出。存储用于回答增强的多模态数据。

CitationMetadata

引用元数据。

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

object (Citation)

段落的引用。

引用

段落的引用信息。

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

string (int64 format)

索引指示段落的开始，以字节/Unicode 为单位衡量。
endIndex

string (int64 format)

归因段落的结束，不包括此索引。
sources[]

object (CitationSource)

归因段落的引用来源。

CitationSource

引用来源。

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

string (int64 format)

来自 SummaryWithMetadata.references 的文档引用索引。它是从 0 开始的索引，如果未明确设置 referenceIndex，则该值为零。

Reference

文档引用。

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

string

文档的标题。
document

string

必需。文档的 Document.name。所引用文档的完整资源名称，格式为 projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*。
uri

string

文档的 Cloud Storage 或 HTTP URI。
chunkContents[]

object (ChunkContent)

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

ChunkContent

块内容。

JSON 表示法 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
字段
content

string

文本块内容。
pageIdentifier

string

页面标识符。
blobAttachmentIndexes[]

string (int64 format)

仅限输出。存储与此块关联的 blobattachment 的索引。

BlobAttachment

存储附加到文本回答的二进制数据，例如图片、视频、音频等。

JSON 表示法 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
字段
data

object (Blob)

仅限输出。blob 数据。
attributionType

enum (AttributionType)

仅限输出。blob 的归因类型。

Blob

存储 blob 的类型和数据。

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

string

仅限输出。生成的数据的媒体类型（MIME 类型）。
data

string (bytes format)

仅限输出。原始字节。

使用 base64 编码的字符串。

AttributionType

定义 blob 的归因类型。

枚举
ATTRIBUTION_TYPE_UNSPECIFIED 归因类型未指定。
CORPUS 附件数据来自语料库。
GENERATED 附件数据由模型通过代码生成功能生成。

方法

converse

 进行一次对话。

create

 创建一个对话。

delete

 删除一个对话。

get

 获取一个对话。

list

 列出其父级 DataStore 下的所有对话。

patch

 更新一个对话。