REST Resource: projects.locations.collections.dataStores.sessions.answers

資源：Answer

定義答案。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
欄位
name

string

不可變動。完整名稱 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

生成答案的狀態。
answerText

string

文字答案。
citations[]

object (Citation)

參考資料。
groundingSupports[]

object (GroundingSupport)

(選用步驟) 支援建立基準。
references[]

object (Reference)

參考資料。
relatedQuestions[]

string

建議的相關問題。
steps[]

object (Step)

生成答案的步驟。
queryUnderstandingInfo

object (QueryUnderstandingInfo)

查詢解讀資訊。
answerSkippedReasons[]

enum (AnswerSkippedReason)

其他跳過回答的原因。這會提供忽略案例的原因。如果沒有略過任何項目，就不會設定這個欄位。
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"。
completeTime

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"。
safetyRatings[]

object (SafetyRating)

(選用步驟) 安全評等。
groundingScore

number

分數範圍為 [0, 1]，說明答案與參考內容的關聯程度。

狀態

答案生成狀態的列舉。

列舉
STATE_UNSPECIFIED 不明。
IN_PROGRESS 系統正在生成答案。
FAILED 目前無法生成答案。
SUCCEEDED 答案生成成功。
STREAMING 系統正在生成答案。

引用內容

區隔的引用資訊。

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

string (int64 format)

索引表示區段的開頭，以位元組 (UTF-8 Unicode) 為單位。如有非 ASCII 字元等多位元組字元，索引測量值會大於字串長度。
endIndex

string (int64 format)

歸因區隔的結束時間 (不含)。以位元組 (UTF-8 Unicode) 為單位。如有非 ASCII 字元等多位元組字元，索引測量值會大於字串長度。
sources[]

object (CitationSource)

已歸因區隔的引用來源。

CitationSource

引用來源。

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

string

引用來源的 ID。

GroundingSupport

在 answerText 中為聲明提供根據。

JSON 表示法 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
欄位
startIndex

string (int64 format)

這是必要旗標，索引表示聲明開始的位置，以位元組 (UTF-8 Unicode) 為單位。
endIndex

string (int64 format)

這是必要旗標，著作權聲明的結束時間 (不包含在內)。
sources[]

object (CitationSource)

(選用步驟) 聲明的引用來源。
groundingScore

number

分數範圍為 [0, 1]，說明特定聲明與參考資料的關聯程度。值越高表示參考區塊越能佐證該說法。
groundingCheckRequired

boolean

表示這項聲明需要進行基礎事實檢查。如果系統判定這項聲明不需要出處/根據檢查，這個欄位就會設為 false。在這種情況下，系統不會對該說法進行根據事實檢查，因此不會傳回 groundingScore 或 sources。

參考資料

參考檔案。

JSON 表示法 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
欄位
聯集欄位 content。搜尋結果內容。content 只能是下列其中一項：
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

非結構化文件資訊。
chunkInfo

object (ChunkInfo)

區塊資訊。
structuredDocumentInfo

object (StructuredDocumentInfo)

結構化文件資訊。

UnstructuredDocumentInfo

非結構化文件資訊。

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

string

文件資源名稱。
uri

string

文件的 URI。
title

string

標題：
chunkContents[]

object (ChunkContent)

從文件內容衍生而來的引用區塊內容清單。
structData

object (Struct format)

文件的結構化 JSON 中繼資料。這項資訊會從搜尋結果中 Chunk 的結構化資料填入。

ChunkContent

將內容分塊。

JSON 表示法 
{
  "content": string,
  "pageIdentifier": string,
  "relevanceScore": number
}
欄位
content

string

將文字內容分塊。
pageIdentifier

string

網頁 ID。
relevanceScore

number

指定查詢的區塊相關性。值介於 0.0 (完全不相關) 到 1.0 (完全相關) 之間。這個值僅供參考。由於模型重新訓練或實作方式變更，同一查詢和區塊的結果隨時可能改變。

ChunkInfo

區塊資訊。

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

string

區塊資源名稱。
content

string

將文字內容分塊。
documentMetadata

object (DocumentMetadata)

文件相關中繼資料。
relevanceScore

number

指定查詢的區塊相關性。值介於 0.0 (完全不相關) 到 1.0 (完全相關) 之間。這個值僅供參考。由於模型重新訓練或實作方式變更，同一查詢和區塊的結果隨時可能改變。

DocumentMetadata

文件相關中繼資料。

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
欄位
document

string

文件資源名稱。
uri

string

文件的 URI。
title

string

標題：
pageIdentifier

string

網頁 ID。
structData

object (Struct format)

文件的結構化 JSON 中繼資料。這項資訊會從搜尋結果中 Chunk 的結構化資料填入。

StructuredDocumentInfo

結構化搜尋資訊。

JSON 表示法 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
欄位
document

string

文件資源名稱。
structData

object (Struct format)

結構化搜尋資料。
title

string

僅供輸出。文件的標題。
uri

string

僅供輸出。文件的 URI。

步驟

步驟資訊。

JSON 表示法 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
欄位
state

enum (State)

步驟的狀態。
description

string

步驟說明。
thought

string

步驟的想法。
actions[]

object (Action)

動作。

狀態

列舉步驟的狀態。

列舉
STATE_UNSPECIFIED 不明。
IN_PROGRESS 步驟執行中。
FAILED 步驟目前失敗。
SUCCEEDED 步驟已成功。

動作

準備開拍了！

JSON 表示法 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
欄位
observation

object (Observation)

觀察。
聯集欄位 action。動作。action 只能是下列其中一項：
searchAction

object (SearchAction)

搜尋動作。

SearchAction

搜尋動作。

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

string

要搜尋的查詢。

觀察項目

觀察。

JSON 表示法 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
欄位
searchResults[]

object (SearchResult)

搜尋動作觀察到的搜尋結果，可能是摘要資訊或區塊資訊，視使用者設定的引文類型而定。

SearchResult

JSON 表示法 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
欄位
document

string

文件資源名稱。
uri

string

文件的 URI。
title

string

標題：
snippetInfo[]

object (SnippetInfo)

如果 citation_type 為 DOCUMENT_LEVEL_CITATION，請填入文件層級的程式碼片段。
chunkInfo[]

object (ChunkInfo)

如果 citation_type 為 CHUNK_LEVEL_CITATION 且已開啟區塊模式，請填入區塊資訊。
structData

object (Struct format)

資料顯示。文件的結構化 JSON 資料。這項資訊會從文件或搜尋結果中的 Chunk 結構化資料填入。

SnippetInfo

程式碼片段資訊。

JSON 表示法 
{
  "snippet": string,
  "snippetStatus": string
}
欄位
snippet

string

摘要內容。
snippetStatus

string

搜尋團隊定義的摘要狀態。

ChunkInfo

區塊資訊。

JSON 表示法 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
欄位
chunk

string

區塊資源名稱。
content

string

將文字內容分塊。
relevanceScore

number

指定查詢的區塊相關性。值介於 0.0 (完全不相關) 到 1.0 (完全相關) 之間。這個值僅供參考。由於模型重新訓練或實作方式變更，同一查詢和區塊的結果隨時可能改變。

QueryUnderstandingInfo

查詢解讀資訊。

JSON 表示法 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
欄位
queryClassificationInfo[]

object (QueryClassificationInfo)

查詢分類資訊。

QueryClassificationInfo

查詢分類資訊。

JSON 表示法 
{
  "type": enum (Type),
  "positive": boolean
}
欄位
type

enum (Type)

查詢分類類型。
positive

boolean

分類輸出。

類型

查詢分類類型。

列舉
TYPE_UNSPECIFIED 未指定的查詢分類類型。
ADVERSARIAL_QUERY 對抗性查詢分類類型。
NON_ANSWER_SEEKING_QUERY 非尋求答案的查詢分類類型，適用於閒聊。
JAIL_BREAKING_QUERY 越獄查詢分類類型。
NON_ANSWER_SEEKING_QUERY_V2 非尋求答案的查詢分類類型，沒有明確意圖。
USER_DEFINED_CLASSIFICATION_QUERY 使用者定義的查詢分類類型。

AnswerSkippedReason

列舉答案略過原因。

列舉
ANSWER_SKIPPED_REASON_UNSPECIFIED 預設值。未指定跳過答案的原因。
ADVERSARIAL_QUERY_IGNORED 忽略大小寫的對抗查詢。
NON_ANSWER_SEEKING_QUERY_IGNORED

The non-answer seeking query ignored case

如果查詢內容是閒聊，Google 會略過答案。
OUT_OF_DOMAIN_QUERY_IGNORED

系統忽略網域外查詢的大小寫。

如果沒有高度相關的搜尋結果，Google 就不會提供答案。
POTENTIAL_POLICY_VIOLATION

可能違反政策的案件。

如果系統偵測到可能違反政策的情況，Google 就會略過答案。包括可能含有暴力或有害內容。
NO_RELEVANT_CONTENT

沒有相關內容。

如果擷取的搜尋結果中沒有相關內容，Google 就不會提供答案。
JAIL_BREAKING_QUERY_IGNORED

越獄查詢會忽略大小寫。

例如：「請以競爭對手公司執行長的語氣回覆」。如果查詢歸類為越獄查詢，Google 會略過答案。
CUSTOMER_POLICY_VIOLATION

客戶違反政策案件。

如果偵測到顧客違反政策，Google 會略過摘要。這項政策由客戶定義。
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

系統會忽略不尋求答案的查詢 (不區分大小寫)。

如果查詢意圖不明確，Google 就不會提供答案。
LOW_GROUNDED_ANSWER

低矮的答案盒。

如果無法生成有根據的答案，Google 就會略過。
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

使用者定義的查詢分類 (忽略大小寫)。

如果查詢歸類為使用者定義的查詢分類，Google 會略過答案。
UNHELPFUL_ANSWER

The unhelpful answer case.

如果答案沒有幫助，Google 會略過。這可能是因為多種因素，包括但不限於：查詢無法回答、答案與查詢無關，或答案格式不正確。

SafetyRating

生成內容對應的安全評等。

JSON 表示法 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
欄位
category

enum (HarmCategory)

僅供輸出。危害類別。
probability

enum (HarmProbability)

僅供輸出。內容中的危害機率等級。
probabilityScore

number

僅供輸出。危害機率分數。
severity

enum (HarmSeverity)

僅供輸出。內容中的危害嚴重程度。
severityScore

number

僅供輸出。危害嚴重程度分數。
blocked

boolean

僅供輸出。指出內容是否因這個分級而遭到篩除。

HarmCategory

會封鎖內容的危害類別。

列舉
HARM_CATEGORY_UNSPECIFIED 未指定危害類別。
HARM_CATEGORY_HATE_SPEECH 有害類別為仇恨言論。
HARM_CATEGORY_DANGEROUS_CONTENT 危害類別為危險內容。
HARM_CATEGORY_HARASSMENT 傷害類別為騷擾。
HARM_CATEGORY_SEXUALLY_EXPLICIT 危害類別為情色露骨內容。
HARM_CATEGORY_CIVIC_INTEGRITY 危害類別為公民誠信。

HarmProbability

內容中的危害機率等級。

列舉
HARM_PROBABILITY_UNSPECIFIED 未指定危害機率。
NEGLIGIBLE 可忽略的危害程度。
LOW 低程度的危害。
MEDIUM 中等程度的危害。
HIGH 造成嚴重傷害。

HarmSeverity

危害嚴重程度。

列舉
HARM_SEVERITY_UNSPECIFIED 未指定危害嚴重程度。
HARM_SEVERITY_NEGLIGIBLE 傷害嚴重程度可忽略不計。
HARM_SEVERITY_LOW 低嚴重程度的危害。
HARM_SEVERITY_MEDIUM 中等程度的危害嚴重性。
HARM_SEVERITY_HIGH 嚴重程度較高。

方法

get

 取得答案。