- 資源:AssistAnswer
- JSON 表示法
- 「State」
- 回覆
- AssistantGroundedContent
- TextGroundingMetadata
- 區隔
- VisualSegment
- 參考資料
- DocumentMetadata
- 語言
- BoundingBox
- BoundingPoly
- NormalizedVertex
- SearchEntryPoint
- AssistantContent
- Blob
- 檔案
- ExecutableCode
- CodeExecutionResult
- 結果
- CitationMetadata
- 引用
- ContentMetadata
- ContentKind
- AssistSkippedReason
- RequiredAuthorization
- AuthConfig
- OAuth2Credential
- CustomerPolicyEnforcementResult
- 判決
- PolicyEnforcementResult
- BannedPhraseEnforcementResult
- ModelArmorEnforcementResult
- ViolationSource
- 方法
資源:AssistAnswer
AssistAnswer 資源,AssistResponse 的主要部分。
| JSON 表示法 |
|---|
{ "name": string, "state": enum ( |
| 欄位 | |
|---|---|
name |
不可變動。ID。 這個欄位必須是 UTF-8 編碼的字串,長度上限為 1024 個字元。 |
state |
生成答案的狀態。 |
connectorDisplayNames |
僅供輸出。將內部連接器代理程式名稱 (內嵌在工具名稱中的機器 ID,例如 |
replies[] |
助理的回覆。 |
diagnosticInfo |
選用。處理要求時收集的診斷資訊。這項資訊僅供人類讀者參考,主要用於偵錯。資料結構如有變更,恕不另行通知。 |
assistSkippedReasons[] |
未接聽輔助電話的原因。 |
requiredAuthorizations[] |
僅供輸出。必要授權清單。只有在使用者未獲授權使用特定 |
customerPolicyEnforcementResult |
選用。這個欄位包含各種政策檢查結果的相關資訊,例如遭禁用的詞組或 Model Armor 檢查。如果系統因違反政策而略過輔助通話,才會填入這個欄位。 |
狀態
生成答案的狀態。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
不明。 |
IN_PROGRESS |
正在執行輔助作業。 |
FAILED |
輔助作業失敗。 |
SUCCEEDED |
輔助作業已成功。 |
SKIPPED |
已略過輔助作業。 |
CANCELLED |
已取消輔助作業 (例如用戶端關閉串流)。可能包含部分回應。 |
回覆
助理通話的多部分回覆之一。
| JSON 表示法 |
|---|
{
"replyId": string,
"createTime": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"groundedContent": {
object ( |
| 欄位 | |
|---|---|
replyId |
僅供輸出。設定後,即可在 |
createTime |
回覆的建立時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
| 助理回覆的替代方案。以下列出互斥欄位。回應中最多會設定一個欄位: | |
groundedContent |
助理可能提供有根據的回覆文字或媒體。 |
| 互斥欄位的結尾。 | |
AssistantGroundedContent
一段內容,以及可能包含的基礎資訊。
並非所有內容都需要根據事實。「沒問題,我很樂意為你搜尋。」這類詞組不需要根據事實。
| JSON 表示法 |
|---|
{ "content": { object ( |
| 欄位 | |
|---|---|
content |
內容。 |
citationMetadata |
生成內容的來源出處。另請參閱 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check |
contentMetadata |
選用。內容的中繼資料。目前僅適用於研究助理的答案。 |
| 各種模態的基礎中繼資料。目前僅支援文字。以下列出互斥欄位。回應中最多會設定一個欄位: | |
textGroundingMetadata |
根據文字來源的基礎中繼資料。 |
| 互斥欄位的結尾。 | |
TextGroundingMetadata
文字來源的基礎詳細資料。
| JSON 表示法 |
|---|
{ "segments": [ { object ( |
| 欄位 | |
|---|---|
segments[] |
文字部分的基礎資訊。 |
visualSegments[] |
視覺內容各部分的基礎資訊。 |
references[] |
以脈絡資料為基準的文字參考資料。 |
searchEntryPoints[] |
選用。用於建立基準的網頁搜尋 Google 搜尋進入點。 |
區隔
文字片段的基礎資訊。
| JSON 表示法 |
|---|
{ "startIndex": string, "endIndex": string, "referenceIndices": [ integer ], "groundingScore": number, "text": string } |
| 欄位 | |
|---|---|
startIndex |
以零為基準的索引,表示區隔的開頭,以 UTF-8 字串的位元組為單位 (也就是說,以多個位元組編碼的字元長度會超過一)。 |
endIndex |
片段的結尾 (不含)。 |
referenceIndices[] |
區隔的參照。 |
groundingScore |
區隔的分數。 |
text |
文字區塊本身。 |
VisualSegment
視覺片段的基礎資訊。
| JSON 表示法 |
|---|
{ "referenceIndices": [ integer ], "contentId": string } |
| 欄位 | |
|---|---|
referenceIndices[] |
視覺片段的參考資料。 |
contentId |
視覺片段的 Content ID。如要顯示視覺元素的引用內容,這個 contentId 必須與 |
參考資料
參照內容和相關文件的中繼資料。
| JSON 表示法 |
|---|
{
"content": string,
"codeSnippet": string,
"documentMetadata": {
object ( |
| 欄位 | |
|---|---|
content |
參照的文字內容。 |
codeSnippet |
參考文件中的程式碼片段。 |
documentMetadata |
文件元資料。 |
chunkMetadata |
僅供輸出。來自上游資料來源連接器的通用結構化區塊中繼資料。 |
DocumentMetadata
文件元資料。
| JSON 表示法 |
|---|
{ "language": enum ( |
| 欄位 | |
|---|---|
language |
|
boundingBoxes[] |
選用。這個參照的定界框。重複使用,以支援產生多個頁面的參照。 |
document |
文件資源名稱。 |
uri |
文件的 URI。其中可能包含重新導向至實際網站的網址。 |
title |
標題: |
pageIdentifier |
網頁 ID。 |
domain |
文件 URI 中的網域名稱。請注意, |
mimeType |
文件的 MIME 類型。https://www.iana.org/assignments/media-types/media-types.xhtml。 |
語言
參照內容的語言。目前僅用於代碼。
| 列舉 | |
|---|---|
LANGUAGE_UNSPECIFIED |
|
PYTHON |
|
SQL |
|
BoundingBox
產生單一頁面的定界框。
| JSON 表示法 |
|---|
{
"pageNumber": string,
"boundingPoly": {
object ( |
| 欄位 | |
|---|---|
pageNumber |
|
boundingPoly |
文件中文字內容的定界多邊形。 |
BoundingPoly
文件中文字內容的定界多邊形。
| JSON 表示法 |
|---|
{
"normalizedVertices": [
{
object ( |
| 欄位 | |
|---|---|
normalizedVertices[] |
|
正規化 Vertex
頂點代表圖片中的 2D 點。
注意:正規化頂點座標是相對於原始圖片,範圍介於 0 到 1 之間。
| JSON 表示法 |
|---|
{ "x": number, "y": number } |
| 欄位 | |
|---|---|
x |
X 座標。 |
y |
Y 座標 (從圖片頂端開始計算)。 |
SearchEntryPoint
Google 搜尋進入點。
| JSON 表示法 |
|---|
{ "renderedContent": string } |
| 欄位 | |
|---|---|
renderedContent |
可嵌入網頁或應用程式網頁檢視區塊的網頁內容程式碼片段。 |
AssistantContent
多模態內容。
| JSON 表示法 |
|---|
{ "role": string, "thought": boolean, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "inlineData": { object ( |
| 欄位 | |
|---|---|
role |
內容製作人。可以是「model」或「user」。 |
thought |
選用。指出該部分是否為模型所想。 |
| 內含資料。以下列出互斥欄位。回應中最多會設定一個欄位: | |
text |
內嵌文字。 |
inlineData |
內嵌二進位資料。 |
file |
檔案,例如語音摘要。 |
executableCode |
模型生成的程式碼,用於執行。 |
codeExecutionResult |
執行 ExecutableCode 的結果。 |
| 互斥欄位的結尾。 | |
Blob
內嵌 Blob。
| JSON 表示法 |
|---|
{ "mimeType": string, "data": string } |
| 欄位 | |
|---|---|
mimeType |
這是必要旗標,所產生資料的媒體類型 (MIME 類型)。 |
data |
這是必要旗標,原始位元組。 Base64 編碼字串。 |
檔案
檔案,例如語音摘要。
| JSON 表示法 |
|---|
{ "mimeType": string, "fileId": string } |
| 欄位 | |
|---|---|
mimeType |
這是必要旗標,檔案的媒體類型 (MIME 類型)。 |
fileId |
這是必要旗標,檔案 ID。 |
ExecutableCode
模型生成的程式碼,供模型執行。
| JSON 表示法 |
|---|
{ "code": string } |
| 欄位 | |
|---|---|
code |
這是必要旗標,程式碼內容。目前僅支援 Python。 |
CodeExecutionResult
執行 ExecutableCode 的結果。
| JSON 表示法 |
|---|
{
"outcome": enum ( |
| 欄位 | |
|---|---|
outcome |
這是必要旗標,執行程式碼的結果。 |
output |
選用。如果執行程式碼成功,則包含 stdout;否則包含 stderr 或其他說明。 |
結果
列舉執行程式碼的可能結果。
| 列舉 | |
|---|---|
OUTCOME_UNSPECIFIED |
未指定狀態。請勿使用這個值。 |
OUTCOME_OK |
程式碼已順利執行完畢。 |
OUTCOME_FAILED |
程式碼執行完成,但發生失敗。stderr 應包含原因。 |
OUTCOME_DEADLINE_EXCEEDED |
執行程式碼時間過長,因此已取消。輸出內容可能不完整。 |
CitationMetadata
內容的來源出處集合。
| JSON 表示法 |
|---|
{
"citations": [
{
object ( |
| 欄位 | |
|---|---|
citations[] |
僅供輸出。引用清單。 |
引用內容
內容的來源出處。
| JSON 表示法 |
|---|
{
"startIndex": integer,
"endIndex": integer,
"uri": string,
"title": string,
"license": string,
"publicationDate": {
object ( |
| 欄位 | |
|---|---|
startIndex |
僅供輸出。內容的起始索引。 |
endIndex |
僅供輸出。內容的結尾索引。 |
uri |
僅供輸出。歸因的網址參照。 |
title |
僅供輸出。歸因的標題。 |
license |
僅供輸出。出處的授權。 |
publicationDate |
僅供輸出。歸因的發布日期。 |
ContentMetadata
內容的中繼資料。
| JSON 表示法 |
|---|
{
"contentKind": enum ( |
| 欄位 | |
|---|---|
contentKind |
內容類型。顯示這項內容屬於研究助理回覆的哪個部分。 |
contentId |
內容的 ID。這項功能可將研究問題與答案連結。舉例來說,研究問題的答案部分會與問題具有相同的 |
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 |
由於違反顧客政策 (例如查詢或回覆含有禁用詞組),AI 助理忽略查詢或拒絕回答。 |
RequiredAuthorization
代表代理正常運作所需的授權。
| JSON 表示法 |
|---|
{
"authorization": string,
"displayName": string,
"authorizationUri": string,
"authConfig": {
object ( |
| 欄位 | |
|---|---|
authorization |
僅供輸出。 |
displayName |
僅供輸出。授權的顯示名稱。 |
authorizationUri |
僅供輸出。使用者應開啟的授權 URI。 |
authConfig |
僅供輸出。第三方 (ADK) 代理人要求的授權設定。授權來自 ADK 代理程式時,系統會填入這個值;在這種情況下,通常不會設定上述第一方 |
AuthConfig
第三方授權的設定。
| JSON 表示法 |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"oauth2": {
object ( |
| 欄位 | |
|---|---|
| 憑證的設定。以下列出互斥欄位。回應中最多會設定一個欄位: | |
oauth2 |
OAuth2 憑證設定。 |
| 互斥欄位的結尾。 | |
OAuth2Credential
OAuth2 授權設定。
| JSON 表示法 |
|---|
{ "clientId": string, "clientSecret": string, "nonce": string, "state": string, "redirectUri": string, "authResponseUri": string, "authCode": string, "accessToken": string, "refreshToken": string, "idToken": string, "expireTime": string, "expireDuration": string, "audience": string, "codeVerifier": string, "codeChallengeMethod": string, "tokenEndpointAuthMethod": string } |
| 欄位 | |
|---|---|
clientId |
僅供輸出。用戶端 ID。 |
clientSecret |
僅供輸出。用戶端密鑰。 |
nonce |
僅供輸出。Nonce 值。 |
state |
僅供輸出。狀態值。 |
redirectUri |
僅供輸出。重新導向 URI。 |
authResponseUri |
僅供輸出。授權回應 URI。 |
authCode |
僅供輸出。授權碼。 |
accessToken |
僅供輸出。存取權杖。 |
refreshToken |
僅供輸出。更新權杖。 |
idToken |
僅供輸出。ID 權杖。 |
expireTime |
僅供輸出。到期時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
expireDuration |
僅供輸出。到期時限。 以秒為單位的時間長度,最多 9 個小數位數,結尾為「 |
audience |
僅供輸出。目標對象。 |
codeVerifier |
僅供輸出。程式碼驗證碼。 |
codeChallengeMethod |
僅供輸出。驗證碼問題方法。 |
tokenEndpointAuthMethod |
僅供輸出。權杖端點授權方法。 |
CustomerPolicyEnforcementResult
顧客政策違規處置結果。包含各種政策檢查的結果,例如禁用詞組或 Model Armor 檢查。
| JSON 表示法 |
|---|
{ "verdict": enum ( |
| 欄位 | |
|---|---|
verdict |
客戶政策違規處置的最終判決。如果只有一項政策禁止處理,則判定結果為 BLOCK。 |
policyResults[] |
顧客政策違規處置結果。如果因違反政策而略過輔助通話,系統才會填入這個欄位。其中包含因篩選器而無法處理的查詢結果。 |
violationSource |
僅供輸出。違規來源。 |
判定結果
客戶政策違規處置的判決結果。
| 列舉 | |
|---|---|
UNSPECIFIED |
不明的值。 |
ALLOW |
未違反政策。 |
BLOCK |
由於違反顧客政策,系統已封鎖處理程序。 |
PolicyEnforcementResult
單一政策類型的客戶政策強制執行結果。
| JSON 表示法 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "bannedPhraseEnforcementResult": { object ( |
| 欄位 | |
|---|---|
| 特定政策類型的結果。可能是錯誤,也可能是政策執行結果的詳細資訊。以下列出互斥欄位。回應中最多會設定一個欄位: | |
bannedPhraseEnforcementResult |
禁止用語政策的政策執行結果。 |
modelArmorEnforcementResult |
Model Armor 政策的政策強制執行結果。 |
| 互斥欄位的結尾。 | |
BannedPhraseEnforcementResult
禁止使用的詞組政策的客戶政策執行結果。
| JSON 表示法 |
|---|
{ "bannedPhrases": [ string ] } |
| 欄位 | |
|---|---|
bannedPhrases[] |
查詢或答案中出現的禁用詞組。 |
ModelArmorEnforcementResult
Model Armor 政策的客戶政策執行結果。
| JSON 表示法 |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"modelArmorViolation": string,
"error": {
object ( |
| 欄位 | |
|---|---|
| Model Armor 政策結果。以下列出互斥欄位。回應中最多會設定一個欄位: | |
modelArmorViolation |
發現的 Model Armor 違規事項。 |
error |
如果政策強制執行失敗,Model Armor 會傳回錯誤。 |
| 互斥欄位的結尾。 | |
ViolationSource
如果因違反政策而略過輔助通話,這個欄位會顯示違規來源。
| 列舉 | |
|---|---|
VIOLATION_SOURCE_UNSPECIFIED |
不明的值。 |
SYSTEM |
系統回覆內容含有違規事項。 |
PROMPT |
使用者提示中發現違規內容。 |
ATTACHMENT |
在使用者附件中發現違規內容。 |
方法 |
|
|---|---|
|
取得 AssistAnswer。 |