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

資源：AssistAnswer

AssistAnswer 資源，是 AssistResponse 的主要部分。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "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)

答案生成狀態。
replies[]

object (Reply)

Google 助理的回覆。
diagnosticInfo

object (Struct format)

(選用步驟) 處理要求時收集的診斷資訊。這項資訊僅供人解讀，主要用於偵錯。資料結構如有變更，恕不另行通知。
assistSkippedReasons[]

enum (AssistSkippedReason)

未接聽輔助通話的原因。
requiredAuthorizations[]

object (RequiredAuthorization)

僅供輸出。必要授權清單。只有在使用者未獲授權使用特定 Authorization，但叫用的代理程式需要該 Authorization 時，才會填入這個欄位。
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

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

狀態

答案生成狀態。

列舉
STATE_UNSPECIFIED 不明。
IN_PROGRESS 正在執行輔助作業。
FAILED 輔助作業失敗。
SUCCEEDED 已成功執行輔助操作。
SKIPPED 已略過輔助作業。

回覆

助理通話多部分回應的其中一部分。

JSON 表示法 
{
  "replyId": string,

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
欄位
replyId

string

僅供輸出。設定後，即可在 AssistAnswer 資源中找出回覆的專屬 ID。在 AssistantService.StreamAssist 呼叫期間，回應串流中可能會出現多則具有相同 ID 的 Reply 訊息 (跨多個 [AssistantService.StreamAssistResponse][] 訊息)。這些代表最終 AssistAnswer 資源中單一 Reply 訊息的部分。
聯集欄位 reply。助理回覆的替代方案。reply 只能是下列其中一項：
groundedContent

object (AssistantGroundedContent)

助理可能提供有根據的回覆文字或媒體。

AssistantGroundedContent

一段內容，以及可能的地基資訊。

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

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

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
欄位
content

object (AssistantContent)

內容。
citationMetadata

object (CitationMetadata)

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

object (ContentMetadata)

選用。內容的中繼資料。目前僅適用於研究助理的答案。
聯集欄位 metadata。各種模態的基礎中繼資料。目前僅支援文字。metadata 只能是下列其中一項：
textGroundingMetadata

object (TextGroundingMetadata)

根據文字來源建立基礎的中繼資料。

TextGroundingMetadata

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

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

object (Segment)

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

object (Reference)

基礎文字的參照。
searchEntryPoints[]

object (SearchEntryPoint)

(選用步驟) 用於建立基準的網頁搜尋 Google 搜尋進入點。

區隔

文字片段的基礎資訊。

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

文字片段本身。

參考資料

參照內容和相關文件元資料。

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

string

參照的文字內容。
documentMetadata

object (DocumentMetadata)

文件相關中繼資料。

DocumentMetadata

文件相關中繼資料。

JSON 表示法 
{
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
欄位
boundingBoxes[]

object (BoundingBox)

(選用步驟) 這項參照的定界框。重複執行以支援跨多個頁面的參照。
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。

BoundingBox

產生單一頁面的定界框。

JSON 表示法 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
欄位
pageNumber

string
boundingPoly

object (BoundingPoly)

文件中文字內容的定界多邊形。

BoundingPoly

文件中文字內容的定界多邊形。

JSON 表示法 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
欄位
normalizedVertices[]

object (NormalizedVertex)

正規化 Vertex

頂點代表圖片中的 2D 點。

注意：正規化後的頂點座標是相對於原始圖片，範圍介於 0 到 1 之間。

JSON 表示法 
{
  "x": number,
  "y": number
}
欄位
x

number

X 座標。
y

number

Y 座標 (從圖片頂端開始)。

SearchEntryPoint

Google 搜尋進入點。

JSON 表示法 
{
  "renderedContent": string
}
欄位
renderedContent

string

可內嵌在網頁或應用程式 WebView 中的網頁內容程式碼片段。

AssistantContent

多模態內容。

JSON 表示法 
{
  "role": string,
  "thought": boolean,

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
欄位
role

string

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

boolean

(選用步驟) 指出該部分是否為模型所想。
聯集欄位 data。包含的資料。data 只能是下列其中一項：
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 助理忽略查詢或拒絕回答。

RequiredAuthorization

代表代理程式運作所需的授權。

JSON 表示法 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string
}
欄位
authorization

string

僅供輸出。Authorization 的名稱。
displayName

string

僅供輸出。授權的顯示名稱。
authorizationUri

string

僅供輸出。使用者應開啟的授權 URI。

CustomerPolicyEnforcementResult

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

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

enum (Verdict)

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

object (PolicyEnforcementResult)

客戶政策違規處置結果。如果因違反政策而略過輔助通話，系統才會填入這項資訊。其中包含導致查詢處理作業遭到封鎖的篩選器結果。

判定結果

客戶政策違規處置的判決結果。

列舉
UNSPECIFIED 不明的值。
ALLOW 並未違反政策。
BLOCK 處理作業遭客戶政策封鎖。

PolicyEnforcementResult

單一政策類型的客戶政策強制執行結果。

JSON 表示法 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
欄位
聯集欄位 enforcement_result。特定政策類型的結果。可能是錯誤，也可能是政策違規處置結果的詳細資訊。enforcement_result 只能是下列其中一項：
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

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

object (ModelArmorEnforcementResult)

Model Armor 政策的政策強制執行結果。

BannedPhraseEnforcementResult

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

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

string

查詢或答案中出現的違規詞組。

ModelArmorEnforcementResult

Model Armor 政策的客戶政策執行結果。

JSON 表示法 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
欄位
聯集欄位 result。Model Armor 政策結果。result 只能是下列其中一項：
modelArmorViolation

string

發現的 Model Armor 違規事項。
error

object (Status)

如果政策強制執行失敗，Model Armor 會傳回錯誤。

方法

get

 取得 AssistAnswer。