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

資源：AssistAnswer

AssistAnswer 資源，AssistResponse 的主要部分。

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

string

不可變動。ID。AssistAnswer 的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
state

enum (State)

生成答案的狀態。
connectorDisplayNames

map (key: string, value: string)

僅供輸出。將內部連接器代理程式名稱 (內嵌在工具名稱中的機器 ID，例如 custom_mcp_<fingerprint>_agent) 對應至連接器的人類可讀顯示名稱。在為自訂 MCP / Agent Gateway 連接器提供服務時填入，因此面向使用者的介面 (例如工具呼叫方塊) 可以顯示連接器名稱，而非內部 ID。如果沒有這類連接器，則為空白。
replies[]

object (Reply)

助理的回覆。
assistSkippedReasons[]

enum (AssistSkippedReason)

未接聽輔助電話的原因。
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

選用。這個欄位包含各種政策檢查結果的相關資訊，例如遭禁用的詞組或 Model Armor 檢查。如果系統因違反政策而略過輔助通話，才會填入這個欄位。

狀態

生成答案的狀態。

列舉
STATE_UNSPECIFIED 不明。
IN_PROGRESS 正在執行輔助作業。
FAILED 輔助作業失敗。
SUCCEEDED 輔助作業已成功。
SKIPPED 已略過輔助作業。
CANCELLED 已取消輔助作業 (例如用戶端關閉串流)。可能包含部分回應。

回覆

助理通話的多部分回覆之一。

JSON 表示法 
{
  "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 (AssistantGroundedContent)
  }
  // End of mutually exclusive fields.
}
欄位
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"。
助理回覆的替代方案。以下列出互斥欄位。回應中最多會設定一個欄位：
groundedContent

object (AssistantGroundedContent)

助理可能提供有根據的回覆文字或媒體。
互斥欄位的結尾。

AssistantGroundedContent

一段內容，以及可能包含的基礎資訊。

並非所有內容都需要根據事實。「沒問題，我很樂意為你搜尋。」這類詞組不需要根據事實。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of mutually exclusive fields.
}
欄位
content

object (AssistantContent)

內容。
citationMetadata

object (CitationMetadata)

生成內容的來源出處。另請參閱 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

選用。內容的中繼資料。目前僅適用於研究助理的答案。
各種模態的基礎中繼資料。目前僅支援文字。以下列出互斥欄位。回應中最多會設定一個欄位：
textGroundingMetadata

object (TextGroundingMetadata)

根據文字來源的基礎中繼資料。
互斥欄位的結尾。

TextGroundingMetadata

文字來源的基礎詳細資料。

JSON 表示法 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "visualSegments": [
    {
      object (VisualSegment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
欄位
segments[]

object (Segment)

文字部分的基礎資訊。
visualSegments[]

object (VisualSegment)

視覺內容各部分的基礎資訊。
references[]

object (Reference)

以脈絡資料為基準的文字參考資料。

區隔

文字片段的基礎資訊。

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

string (int64 format)

以零為基準的索引，表示區隔的開頭，以 UTF-8 字串的位元組為單位 (也就是說，以多個位元組編碼的字元長度會超過一)。
endIndex

string (int64 format)

片段的結尾 (不含)。
referenceIndices[]

integer

區隔的參照。
groundingScore

number

區隔的分數。
text

string

文字區塊本身。

VisualSegment

視覺片段的基礎資訊。

JSON 表示法 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
欄位
referenceIndices[]

integer

視覺片段的參考資料。
contentId

string

視覺片段的 Content ID。如要顯示視覺元素的引用內容，這個 contentId 必須與 groundedContent.content_metadata.content_id 欄位相符。

參考資料

參照內容和相關文件的中繼資料。

JSON 表示法 
{
  "content": string,
  "codeSnippet": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "chunkMetadata": {
    object
  }
}
欄位
content

string

參照的文字內容。
codeSnippet

string

參考文件中的程式碼片段。
documentMetadata

object (DocumentMetadata)

文件元資料。
chunkMetadata

object (Struct format)

僅供輸出。來自上游資料來源連接器的通用結構化區塊中繼資料。

DocumentMetadata

文件元資料。

JSON 表示法 
{
  "language": enum (Language),
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
欄位
language

enum (Language)
document

string

文件資源名稱。
uri

string

文件的 URI。其中可能包含重新導向至實際網站的網址。
title

string

標題：
pageIdentifier

string

網頁 ID。
domain

string

文件 URI 中的網域名稱。請注意，uri 欄位可能包含重新導向至實際網站的網址，在這種情況下，該欄位會包含目標網站的網域名稱。
mimeType

string

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

語言

參照內容的語言。目前僅用於代碼。

列舉
LANGUAGE_UNSPECIFIED
PYTHON
SQL

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 (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of mutually exclusive fields.
}
欄位
role

string

內容製作人。可以是「model」或「user」。
thought

boolean

選用。指出該部分是否為模型所想。
內含資料。以下列出互斥欄位。回應中最多會設定一個欄位：
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 由於違反顧客政策 (例如查詢或回覆含有禁用詞組)，AI 助理忽略查詢或拒絕回答。

CustomerPolicyEnforcementResult

顧客政策違規處置結果。包含各種政策檢查的結果，例如禁用詞組或 Model Armor 檢查。

JSON 表示法 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ],
  "violationSource": enum (ViolationSource)
}
欄位
verdict

enum (Verdict)

客戶政策違規處置的最終判決。如果只有一項政策禁止處理，則判定結果為 BLOCK。
policyResults[]

object (PolicyEnforcementResult)

顧客政策違規處置結果。如果因違反政策而略過輔助通話，系統才會填入這個欄位。其中包含因篩選器而無法處理的查詢結果。
violationSource

enum (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": {
    object (ModelArmorEnforcementResult)
  }
  // End of mutually exclusive fields.
}
欄位
特定政策類型的結果。可能是錯誤，也可能是政策執行結果的詳細資訊。以下列出互斥欄位。回應中最多會設定一個欄位：
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

禁止用語政策的政策執行結果。
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Model Armor 政策的政策強制執行結果。
互斥欄位的結尾。

BannedPhraseEnforcementResult

禁止使用的詞組政策的客戶政策執行結果。

JSON 表示法 
{
  "bannedPhrases": [
    string
  ]
}
欄位
bannedPhrases[]

string

查詢或答案中出現的禁用詞組。

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 (Status)
  }
  // End of mutually exclusive fields.
}
欄位
Model Armor 政策結果。以下列出互斥欄位。回應中最多會設定一個欄位：
modelArmorViolation

string

發現的 Model Armor 違規事項。
error

object (Status)

如果政策強制執行失敗，Model Armor 會傳回錯誤。
互斥欄位的結尾。

ViolationSource

如果因違反政策而略過輔助通話，這個欄位會顯示違規來源。

列舉
VIOLATION_SOURCE_UNSPECIFIED 不明的值。
SYSTEM 系統回覆內容含有違規事項。
PROMPT 使用者提示中發現違規內容。
ATTACHMENT 在使用者附件中發現違規內容。

方法

get

 取得 AssistAnswer。