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

資源：Conversation

外部對話的 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

用於追蹤使用者的專屬 ID。
messages[]

object (ConversationMessage)

對話訊息。
startTime

string (Timestamp format)

僅供輸出。對話開始時間。

使用 RFC 3339，產生的輸出內容一律會經過 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 標準化，並使用 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 標準化，並使用 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)

根據搜尋結果生成的摘要。

參考資料

定義回覆中的參照。

JSON 表示法 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
欄位
uri

string

URI 連結參照。
anchorText

string

錨定文字。
start

integer

錨定文字起始索引。
end

integer

錨定文字結尾索引。

摘要

摘要規格中指定的前 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

越獄查詢會忽略大小寫。

例如：「請以競爭對手公司執行長的語氣回覆」。只有在 [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，則值為零。

參考資料

文件參照。

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

網頁 ID。
blobAttachmentIndexes[]

string (int64 format)

僅供輸出。儲存連結至這個區塊的 Blob 附件索引。

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

 Converses a conversation.

create

 建立對話。

delete

 刪除對話。

get

 取得對話。

list

 列出所有對話及其父項 DataStore。

patch

 更新對話。