Package google.cloud.discoveryengine.v1

QueryClassificationInfo

最近一次重新封存的時間。

score

double

每項建議的分數。分數範圍為 [0, 1]。

AdvancedSiteSearchConfig

進階站內搜尋的設定資料。

欄位

disable_initial_index

bool

如果設為 true，系統會停用 DataStore 的初始索引。

disable_automatic_refresh

bool

如果設為 true，系統會停用 DataStore 的自動重新整理功能。

AlertPolicyConfig

連接器層級的快訊設定。

欄位

alert_policy_name

string

不可變動。AlertPolicy 的完整資源名稱。

alert_enrollments[]

AlertEnrollment

(選用步驟) 每則快訊的註冊狀態。

AlertEnrollment

快訊註冊狀態。

欄位

alert_id

string

不可變動。快訊的 ID。

enroll_state

EnrollStates

這是必要旗標，客戶的註冊狀態。

EnrollStates

快訊的註冊狀態列舉。

列舉
`ENROLL_STATES_UNSPECIFIED`	預設值。適用於尚未回應快訊政策的客戶。
`ENROLLED`	客戶已註冊這項政策。
`DECLINED`	顧客拒絕這項政策。

AlertPolicyResourceConfig

資源層級快訊設定。適用於：* UserLicense * EngineUserData 資料連接器中的 AlertPolicyConfig 用途相同。無法輕鬆遷移。

欄位
`alert_policy`	`string` 不可變動。AlertPolicy 的完整資源名稱。
`alert_enrollments[]`	`AlertEnrollment` (選用步驟) 每則快訊的註冊狀態。
`contact_details[]`	`ContactDetails` (選用步驟) 每項警告政策的聯絡人詳細資料。
`language_code`	`string` (選用步驟) 通知使用的語言代碼

AlertEnrollment

快訊註冊狀態。

欄位

alert_id

string

不可變動。快訊的 ID。

enroll_state

EnrollState

這是必要旗標，客戶的註冊狀態。

notification_params

map<string, string>

(選用步驟) 用於例項化通知的參數。用於在註冊時觸發的通知。不會儲存。* Gemini Business 歡迎電子郵件。* Gemini Business 使用者邀請電子郵件。

EnrollState

快訊的註冊狀態列舉。

列舉
`ENROLL_STATE_UNSPECIFIED`	預設值。適用於尚未回應快訊政策的客戶。
`ENROLLED`	客戶已註冊這項政策。
`DECLINED`	顧客拒絕這項政策。

AlloyDbSource

要從中匯入資料的 AlloyDB 來源。

欄位
`project_id`	`string` 包含 AlloyDB 來源的專案 ID。長度上限為 128 個半形字元。如未指定，則會沿用父項要求的專案 ID。
`location_id`	`string` 這是必要旗標，要複製資料的 AlloyDB 位置，長度上限為 256 個半形字元。
`cluster_id`	`string` 這是必要旗標，要從中複製資料的 AlloyDB 叢集，長度上限為 256 個字元。
`database_id`	`string` 這是必要旗標，要複製資料的 AlloyDB 資料庫，長度上限為 256 個字元。
`table_id`	`string` 這是必要旗標，要複製資料的 AlloyDB 資料表，長度上限為 256 個字元。
`gcs_staging_dir`	`string` 要用於匯入作業的中介 Cloud Storage 目錄，長度上限為 2,000 個字元。如要將 AlloyDB 項目匯入特定 Cloud Storage 目錄，即可指定這項設定。確認 AlloyDB 服務帳戶具備必要的 Cloud Storage 管理員權限，可存取指定的 Cloud Storage 目錄。

答案

定義答案。

欄位
`name`	`string` 不可變動。完整名稱 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` 生成答案的狀態。
`answer_text`	`string` 文字答案。
`citations[]`	`Citation` 參考資料。
`grounding_supports[]`	`GroundingSupport` (選用步驟) 支援建立基準。
`references[]`	`Reference` 參考資料。
`related_questions[]`	`string` 建議的相關問題。
`steps[]`	`Step` 生成答案的步驟。
`query_understanding_info`	`QueryUnderstandingInfo` 查詢解讀資訊。
`answer_skipped_reasons[]`	`AnswerSkippedReason` 其他跳過回答的原因。這會提供忽略案例的原因。如果沒有略過任何項目，就不會設定這個欄位。
`create_time`	`Timestamp` 僅供輸出。答案建立時間戳記。
`complete_time`	`Timestamp` 僅供輸出。回答完成時間戳記。
`safety_ratings[]`	`SafetyRating` (選用步驟) 安全評等。
`grounding_score`	`double` 分數範圍為 [0, 1]，說明答案與參考內容的關聯程度。

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 會略過。這可能是因為多種因素，包括但不限於：查詢無法回答、答案與查詢無關，或答案格式不正確。

引用內容

區隔的引用資訊。

欄位

start_index

int64

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

end_index

int64

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

sources[]

CitationSource

已歸因區隔的引用來源。

CitationSource

引用來源。

欄位

reference_id

string

引用來源的 ID。

GroundingSupport

在 answer_text 中為聲明提供根據。

欄位
`start_index`	`int64` 這是必要旗標，索引表示聲明開始的位置，以位元組 (UTF-8 Unicode) 為單位。
`end_index`	`int64` 這是必要旗標，著作權聲明的結束時間 (不包含在內)。
`sources[]`	`CitationSource` (選用步驟) 聲明的引用來源。
`grounding_score`	`double` 分數範圍為 [0, 1]，說明特定聲明與參考資料的關聯程度。值越高表示參考區塊越能佐證該說法。
`grounding_check_required`	`bool` 表示這項聲明需要進行基礎事實檢查。如果系統判定這項聲明不需要出處/根據檢查，這個欄位就會設為 false。在這種情況下，系統不會對該說法進行根據事實檢查，因此不會傳回 `grounding_score` 或 `sources`。

QueryUnderstandingInfo

查詢解讀資訊。

欄位

query_classification_info[]

查詢分類資訊。

QueryClassificationInfo

查詢分類資訊。

欄位

type

Type

查詢分類類型。

positive

bool

分類輸出。

類型

查詢分類類型。

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

參考資料

參考檔案。

欄位
聯集欄位 `content`。搜尋結果內容。`content` 只能是下列其中一項：
`unstructured_document_info`	`UnstructuredDocumentInfo` 非結構化文件資訊。
`chunk_info`	`ChunkInfo` 區塊資訊。
`structured_document_info`	`StructuredDocumentInfo` 結構化文件資訊。

ChunkInfo

區塊資訊。

欄位
`chunk`	`string` 區塊資源名稱。
`content`	`string` 將文字內容分塊。
`document_metadata`	`DocumentMetadata` 文件相關中繼資料。
`relevance_score`	`float` 指定查詢的區塊相關性。值介於 0.0 (完全不相關) 到 1.0 (完全相關) 之間。這個值僅供參考。由於模型重新訓練或實作方式變更，同一查詢和區塊的結果隨時可能改變。

DocumentMetadata

文件相關中繼資料。

欄位
`document`	`string` 文件資源名稱。
`uri`	`string` 文件的 URI。
`title`	`string` 標題：
`page_identifier`	`string` 網頁 ID。
`struct_data`	`Struct` 文件的結構化 JSON 中繼資料。這項資訊會從搜尋結果中 Chunk 的結構化資料填入。

StructuredDocumentInfo

結構化搜尋資訊。

欄位
`document`	`string` 文件資源名稱。
`struct_data`	`Struct` 結構化搜尋資料。
`title`	`string` 僅供輸出。文件的標題。
`uri`	`string` 僅供輸出。文件的 URI。

UnstructuredDocumentInfo

非結構化文件資訊。

欄位
`document`	`string` 文件資源名稱。
`uri`	`string` 文件的 URI。
`title`	`string` 標題：
`chunk_contents[]`	`ChunkContent` 從文件內容衍生而來的引用區塊內容清單。
`struct_data`	`Struct` 文件的結構化 JSON 中繼資料。這項資訊會從搜尋結果中 Chunk 的結構化資料填入。

ChunkContent

將內容分塊。

欄位

content

string

將文字內容分塊。

page_identifier

string

網頁 ID。

relevance_score

float

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

狀態

列舉答案生成狀態。

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

步驟

步驟資訊。

欄位
`state`	`State` 步驟的狀態。
`description`	`string` 步驟說明。
`thought`	`string` 步驟的想法。
`actions[]`	`Action` 動作。

動作

準備開拍了！

欄位

observation

Observation

觀察。

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

search_action

SearchAction

搜尋動作。

觀察項目

觀察。

欄位

search_results[]

SearchResult

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

SearchResult

欄位
`document`	`string` 文件資源名稱。
`uri`	`string` 文件的 URI。
`title`	`string` 標題：
`snippet_info[]`	`SnippetInfo` 如果 citation_type 為 DOCUMENT_LEVEL_CITATION，請填入文件層級的程式碼片段。
`chunk_info[]`	`ChunkInfo` 如果 citation_type 為 CHUNK_LEVEL_CITATION 且已開啟區塊模式，請填入區塊資訊。
`struct_data`	`Struct` 資料顯示。文件的結構化 JSON 資料。這項資訊會從文件或搜尋結果中的 Chunk 結構化資料填入。

ChunkInfo

區塊資訊。

欄位

chunk

string

區塊資源名稱。

content

string

將文字內容分塊。

relevance_score

float

SnippetInfo

程式碼片段資訊。

欄位

snippet

string

摘要內容。

snippet_status

string

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

SearchAction

搜尋動作。

欄位

query

string

要搜尋的查詢。

狀態

列舉步驟的狀態。

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

AnswerGenerationSpec

生成答案的規格。

欄位

user_defined_classifier_spec

UserDefinedClassifierSpec

(選用步驟) 使用者指定分類器規格的規格。

UserDefinedClassifierSpec

使用者定義分類器的規格。

欄位
`enable_user_defined_classifier`	`bool` (選用步驟) 是否啟用及納入使用者定義的分類器。
`preamble`	`string` (選用步驟) 用於使用者定義分類器的序文。
`model_id`	`string` (選用步驟) 用於使用者定義分類器的模型 ID。
`task_marker`	`string` (選用步驟) 用於使用者定義分類器的工作標記。
`top_p`	`double` (選用步驟) 用於使用者定義分類器的 top-p 值。
`top_k`	`int64` (選用步驟) 用於使用者定義分類器的 top-k 值。
`temperature`	`double` (選用步驟) 用於使用者定義分類器的溫度值。
`seed`	`int32` (選用步驟) 用於使用者定義分類器的種子值。

AnswerQueryRequest

ConversationalSearchService.AnswerQuery 方法的要求訊息。

欄位
`serving_config`	`string` 這是必要旗標，搜尋供應設定的資源名稱，例如 `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` 或 `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`。這個欄位用於識別供應設定名稱，也就是用於進行搜尋的一組模型。
`query`	`Query` 這是必要旗標，目前的使用者查詢。
`session`	`string` 工作階段資源名稱。非必要。如未設定工作階段欄位，API 會處於無工作階段模式。我們支援自動工作階段模式：使用者可以將萬用字元 `-` 設為工作階段 ID。系統會自動產生並指派新的 ID。
`safety_spec`	`SafetySpec` 模型規格。
`related_questions_spec`	`RelatedQuestionsSpec` 相關問題規格。
`grounding_spec`	`GroundingSpec` (選用步驟) 接地規格。
`answer_generation_spec`	`AnswerGenerationSpec` 生成答案的規格。
`search_spec`	`SearchSpec` 搜尋規格。
`query_understanding_spec`	`QueryUnderstandingSpec` 查詢解讀規格。
`asynchronous_mode (deprecated)`	`bool` 這個項目已遭淘汰！已淘汰：這個欄位已淘汰，支援 Streaming Answer API。非同步模式控制。啟用後，系統會傳回回應，其中包含答案/工作階段資源名稱，但不含最終答案。API 使用者需要呼叫 `ConversationalSearchService.GetAnswer` 或 `ConversationalSearchService.GetSession` 方法進行輪詢，才能取得答案/工作階段的最新狀態。
`user_pseudo_id`	`string` 用於追蹤訪客的專屬 ID。舉例來說，這項功能可以透過 HTTP Cookie 實作，應能識別單一裝置上的訪客。訪客登入或登出網站時，這個專屬 ID 不應變更。這個欄位「不得」有固定值，例如 `unknown_visitor`。這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個字元。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 文件。
`end_user_spec`	`EndUserSpec` (選用步驟) 使用者規格。

AnswerGenerationSpec

生成答案的規格。

欄位
`model_spec`	`ModelSpec` 答案生成模型規格。
`prompt_spec`	`PromptSpec` 指定生成答案的提示。
`include_citations`	`bool` 指定是否要在答案中加入引文的中繼資料。預設值為 `false`。
`answer_language_code`	`string` Answer 的語言代碼。請使用 BCP47 定義的語言標記。注意：這項功能仍在實驗階段。
`ignore_adversarial_query`	`bool` 指定是否要篩除對抗查詢。預設值為 `false`。 Google 會採用搜尋查詢分類技術，偵測惡意查詢。如果搜尋查詢歸類為對抗性查詢，系統就不會傳回任何答案。舉例來說，使用者可能會詢問有關公司負面評論的問題，或提交旨在生成不安全或違反政策內容的查詢。如果這個欄位設為 `true`，我們會略過產生對抗性查詢的答案，改為傳回備用訊息。
`ignore_non_answer_seeking_query`	`bool` 指定是否要篩除並非尋求答案的查詢。預設值為 `false`。 Google 會使用搜尋查詢分類功能，偵測尋找答案的查詢。如果搜尋查詢歸類為非尋求答案的查詢，系統不會傳回任何答案。如果這個欄位設為 `true`，我們會略過非尋求答案的查詢，改為傳回備用訊息。
`ignore_jail_breaking_query`	`bool` (選用步驟) 指定是否要篩除越獄查詢。預設值為 `false`。 Google 會採用搜尋查詢分類技術，偵測越獄查詢。如果搜尋查詢歸類為越獄查詢，系統不會傳回摘要。使用者可能會在查詢中加入指令，變更回覆的語氣、風格、語言、內容，或要求模型扮演不同實體，例如「以競爭對手公司執行長的語氣回覆」。如果此欄位設為 `true`，我們會略過生成越獄查詢的摘要，改為傳回備用訊息。
`ignore_low_relevant_content`	`bool` 指定是否要篩除相關性偏低的查詢。如果將這個欄位設為 `false`，系統會使用所有搜尋結果 (無論是否相關) 生成答案。如果設為 `true` 或未設定，服務會自動決定行為。

ModelSpec

答案生成模型規格。

欄位

model_version

string

模型版本。如未設定，系統會使用預設的穩定版模型。允許的值包括：stable、preview。

PromptSpec

指定生成答案的提示。

欄位

preamble

string

自訂前言。

EndUserSpec

使用者規格。

欄位

end_user_metadata[]

EndUserMetaData

(選用步驟) 使用者中繼資料。

EndUserMetaData

使用者中繼資料。

欄位

聯集欄位 content。搜尋結果內容。content 只能是下列其中一項：

chunk_info

ChunkInfo

區塊資訊。

ChunkInfo

區塊資訊。

欄位

content

string

將文字內容分塊。最多 8,000 個半形字元。

document_metadata

QueryClassificationSpec

目前區塊的文件中繼資料。

DocumentMetadata

文件的中繼資料包含目前區塊的文件資訊。

欄位

title

string

文件標題。

GroundingSpec

接地規格。

欄位

include_grounding_supports

bool

(選用步驟) 指定是否要在答案中加入 grounding_supports。預設值為 false。

如果這個欄位設為 true，傳回的答案會包含 grounding_score，且每個聲明都會包含 GroundingSupports。

filtering_level

FilteringLevel

(選用步驟) 指定是否要根據基礎分數啟用篩選功能，以及要在哪個層級啟用這項功能。

FilteringLevel

根據答案基礎篩選的層級。

列舉
`FILTERING_LEVEL_UNSPECIFIED`	預設值為不套用篩選條件
`FILTERING_LEVEL_LOW`	根據低門檻篩選答案。
`FILTERING_LEVEL_HIGH`	根據高門檻篩選答案。

QueryUnderstandingSpec

查詢解讀規格。

欄位

query_classification_spec

查詢分類規格。

query_rephraser_spec

QueryRephraserSpec

查詢重述器規格。

disable_spell_correction

bool

(選用步驟) 是否要停用拼字修正功能。預設值為 false。

QueryClassificationSpec

查詢分類規格。

欄位

types[]

Type

已啟用查詢分類類型。

類型

查詢分類類型。

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

QueryRephraserSpec

查詢重述器規格。

欄位

disable

bool

停用查詢重述功能。

max_rephrase_steps

int32

改寫步驟上限。最多 5 個步驟。如未設定或設為 < 1，則預設值為 1。

model_spec

ModelSpec

(選用步驟) 查詢重述模型規格。

ModelSpec

查詢重述模型規格。

欄位

model_type

ModelType

(選用步驟) 已啟用查詢重述模型類型。如未設定，系統預設會使用 LARGE。

ModelType

查詢重述類型。目前僅支援單一跳躍 (max_rephrase_steps = 1) 的模型選取。如果是多跳 (max_rephrase_steps > 1)，則只有一個預設模型。

列舉
`MODEL_TYPE_UNSPECIFIED`	未指定的模型類型。
`SMALL`	小型查詢重述模型。Gemini 1.0 XS 模型。
`LARGE`	大型查詢重述模型。Gemini 1.0 Pro 模型。

RelatedQuestionsSpec

相關問題規格。

欄位

enable

bool

如果為 true，則啟用相關問題功能。

SafetySpec

安全規格。有兩種使用情境：1. 僅設定 safety_spec.enable 時，所有類別都會套用 BLOCK_LOW_AND_ABOVE 門檻。2. 當設定 safety_spec.enable，並設定部分 safety_settings 時，系統只會套用指定的 safety_settings。

欄位

enable

bool

啟用回覆的安全過濾功能。預設值為 false。

safety_settings[]

SafetySetting

(選用步驟) 安全性設定。只有在 safety_spec.enable 為 true 時，這項設定才會生效。

SafetySetting

安全性設定。

欄位

category

HarmCategory

這是必要旗標，危害類別。

threshold

HarmBlockThreshold

這是必要旗標，有害內容封鎖門檻。

HarmBlockThreshold

封鎖的機率門檻等級。

列舉
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	未指定危害封鎖門檻。
`BLOCK_LOW_AND_ABOVE`	封鎖低閾值以上的內容 (即封鎖更多內容)。
`BLOCK_MEDIUM_AND_ABOVE`	封鎖有害機率中等以上的內容。
`BLOCK_ONLY_HIGH`	僅封鎖有害機率高的內容 (即減少封鎖)。
`BLOCK_NONE`	不封鎖任何內容。
`OFF`	關閉安全篩選器。

SearchSpec

搜尋規格。

欄位

聯集欄位 input。控制搜尋行為的搜尋參數。或提供搜尋結果清單來生成答案。input 只能是下列其中一項：

search_params

SearchParams

搜尋參數。

search_result_list

SearchResultList

搜尋結果清單。

SearchParams

搜尋參數。

欄位
`max_return_results`	`int32` 要傳回的搜尋結果數量。預設值為 10。
`filter`	`string` 篩選器語法包含運算式語言，可從要篩選的文件的一或多個欄位建構述詞。篩選運算式會區分大小寫。系統會使用這項資訊篩選搜尋結果，這可能會影響答案回覆。如果無法辨識這個欄位，系統會傳回 `INVALID_ARGUMENT`。如要在 Vertex AI Search 中進行篩選，請將左側的篩選鍵對應至 Vertex AI Search 後端定義的鍵屬性，這項對應是由客戶在結構定義中定義。舉例來說，媒體客戶的結構定義中可能會有「名稱」欄位。在本例中，篩選器會如下所示：filter --> name:'ANY("king kong")' 如要進一步瞭解篩選功能，包括語法和篩選運算子，請參閱「篩選」
`boost_spec`	`BoostSpec` 提升規格，在搜尋結果中提升特定文件，這可能會影響答案查詢的回覆。如要進一步瞭解加成，請參閱「加成」一文。
`order_by`	`string` 傳回文件的順序。文件可依 `Document` 物件中的欄位排序。如果依關聯性排序，請勿設定此值。`order_by` 運算式須區分大小寫。如要進一步瞭解訂購方式，請參閱訂購如果無法辨識這個欄位，系統會傳回 `INVALID_ARGUMENT`。
`search_result_mode`	`SearchResultMode` 指定搜尋結果模式。如未指定，搜尋結果模式預設為 `DOCUMENTS`。請參閱剖析文件及進行分塊
`data_store_specs[]`	`DataStoreSpec` 規格會定義要在搜尋呼叫中篩選的 dataStore，以及這些 dataStore 的設定。只有在引擎有多個資料儲存庫時，才會考慮這個做法。如果引擎內只有一個 dataStore，則應使用頂層規格。

SearchResultList

搜尋結果清單。

欄位

search_results[]

SearchResult

搜尋結果。

SearchResult

搜尋結果。

欄位

聯集欄位 content。搜尋結果內容。content 只能是下列其中一項：

unstructured_document_info

UnstructuredDocumentInfo

非結構化文件資訊。

chunk_info

ChunkInfo

區塊資訊。

ChunkInfo

區塊資訊。

欄位

chunk

string

區塊資源名稱。

content

string

將文字內容分塊。

document_metadata

目前區塊的文件中繼資料。

DocumentMetadata

文件的中繼資料包含目前區塊的文件資訊。

欄位

uri

string

文件 URI。

title

string

文件標題。

UnstructuredDocumentInfo

非結構化文件資訊。

欄位
`document`	`string` 文件資源名稱。
`uri`	`string` 文件的 URI。
`title`	`string` 標題：
`document_contexts[]`	`DocumentContext` 文件內容清單。系統會使用這項內容生成回覆。這應該是文件的主要內容，可以很長且詳盡。
`extractive_segments[]`	`ExtractiveSegment` 擷取區隔清單。
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` 這個項目已遭淘汰！已淘汰：這個欄位已淘汰，不會影響答案生成。請改用 document_contexts 和 extractive_segments 欄位。擷取答案清單。

DocumentContext

文件內容。

欄位

page_identifier

string

網頁 ID。

content

string

用於生成答案的文件內容。

ExtractiveAnswer

擷取式答案。指南

欄位

page_identifier

string

網頁 ID。

content

string

擷取的答案內容。

ExtractiveSegment

擷取式片段。指南：只有在 document_contexts 為空時，系統才會使用這項功能生成回覆。這應該是較短的程式碼片段。

欄位

page_identifier

string

網頁 ID。

content

string

擷取片段內容。

AnswerQueryResponse

ConversationalSearchService.AnswerQuery 方法的回應訊息。

欄位

answer

Answer

Answer 資源物件。如果 AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps 大於 1，請使用 Answer.name，透過 ConversationalSearchService.GetAnswer API 擷取答案資訊。

session

PolicyEnforcementResult

工作階段資源物件。只有在 AnswerQueryRequest 要求中設定有效的階段作業欄位時，才會提供這項功能。

answer_query_token

string

用於記錄的全域專屬 ID。

AssistAnswer

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

欄位
`name`	`string` 不可變動。ID。`AssistAnswer` 的資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` 這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
`state`	`State` 答案生成狀態。
`replies[]`	`Reply` Google 助理的回覆。
`assist_skipped_reasons[]`	`AssistSkippedReason` 未接聽輔助通話的原因。
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` (選用步驟) 這個欄位包含各種政策檢查的結果，例如遭禁用的詞組或 Model Armor 檢查。如果因違反政策而略過輔助通話，系統才會填入這個欄位。

AssistSkippedReason

可能無法接聽輔助通話的原因。

列舉
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	預設值。未指定略過原因。
`NON_ASSIST_SEEKING_QUERY_IGNORED`	助理忽略了查詢，因為查詢內容似乎不是要尋找答案。
`CUSTOMER_POLICY_VIOLATION`	由於違反顧客政策 (例如查詢或回覆含有禁用詞組)，AI 助理忽略查詢或拒絕回答。

CustomerPolicyEnforcementResult

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

欄位

verdict

Verdict

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

policy_results[]

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

BannedPhraseEnforcementResult

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

欄位

banned_phrases[]

string

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

ModelArmorEnforcementResult

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

欄位

聯集欄位 result。Model Armor 政策結果。result 只能是下列其中一項：

model_armor_violation

string

發現的 Model Armor 違規事項。

error

BannedPhraseEnforcementResult

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

PolicyEnforcementResult

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

欄位

聯集欄位 enforcement_result。特定政策類型的結果。可能是錯誤，也可能是政策違規處置結果的詳細資訊。enforcement_result 只能是下列其中一項：

banned_phrase_enforcement_result

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

model_armor_enforcement_result

ModelArmorEnforcementResult

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

判定結果

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

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

回覆

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

欄位

聯集欄位 reply。助理回覆的替代方案。reply 只能是下列其中一項：

grounded_content

AssistantGroundedContent

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

狀態

答案生成狀態。

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

AssistRequest

要求 AssistantService.Assist 方法。

欄位
`name`	`string` 這是必要旗標，`Assistant` 的資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` (選用步驟) 目前的使用者查詢。只有在提供 `file_ids` 時，系統才支援空白查詢。在這種情況下，系統會根據這些情境檔案生成答案。
`session`	`string` (選用步驟) 要求使用的工作階段。如果指定，助理就能存取工作階段記錄，並將查詢和答案儲存在該處。如果將 `-` 指定為工作階段 ID，或將其留空，系統就會建立新的工作階段，並自動產生 ID。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` (選用步驟) 決定助理不會回覆查詢的案例。如果略過回答，系統會在 `AssistResponse.answer` 中列出原因。`AssistAnswer.assist_skipped_reasons`
`file_ids[]`	`string` (選用步驟) 用於回答要求的檔案 ID。上傳檔案時，系統會在 `AddContextFileResponse.file_id` 中傳回檔案 ID。
`user_metadata`	`AssistUserMetadata` (選用步驟) 啟動查詢的使用者相關資訊。

AssistSkippingMode

可略過的輔助要求行為。

列舉
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	預設值。如果查詢並非尋求協助，可以略過回答。
`REQUEST_ASSIST`	要求 Google 助理回答。如果查詢未通過政策檢查，系統仍可能會略過答案。

AssistResponse

AssistantService.Assist 方法的回應。

欄位

answer

AssistAnswer

系統會根據查詢產生 AssistAnswer 資源。

session_info

SessionInfo

工作階段資訊。

assist_token

string

全域不重複 ID，用於識別目前的要求/回應配對。用於意見回饋和支援服務。

SessionInfo

工作階段相關資訊。

欄位

session

string

新生成或繼續的工作階段名稱。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

query_id

string

與這項輔助 API 呼叫相應的查詢 ID。一個工作階段可以有多個輪次，每個輪次都有專屬的查詢 ID。

在 Assist API 呼叫中指定工作階段名稱和這個查詢 ID，即可在這次搜尋呼叫的搜尋結果環境中提出輔助要求。

AssistUserMetadata

要求的使用者中繼資料。

欄位

time_zone

string

(選用步驟) IANA 時區，例如 Europe/Budapest。

preferred_language_code

string

(選用步驟) 如果語言偵測失敗，系統會使用偏好語言回覆。無論語言偵測結果為何，動作建立的錯誤訊息都會使用這個語言。

助理

Discovery Engine Assistant 資源。

欄位
`name`	`string` 不可變動。助理的資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` 必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
`display_name`	`string` 這是必要旗標，助理的顯示名稱。必須是 UTF-8 編碼的字串，長度上限為 128 個字元。
`description`	`string` (選用步驟) Description for additional information. 預計會顯示在設定使用者介面，而非助理使用者。
`generation_config`	`GenerationConfig` (選用步驟) 生成助理回覆的設定。
`google_search_grounding_enabled (deprecated)`	`bool` 這個項目已遭淘汰！ (選用步驟) 已淘汰，請改用 `web_grounding_type`。
`web_grounding_type`	`WebGroundingType` (選用步驟) 要使用的網頁基準類型。
`enabled_actions (deprecated)`	`map<string, ActionList>` 這個項目已遭淘汰！ (選用步驟) 已淘汰：將改為使用 `enabled_tools`。這個助理已啟用的動作。索引鍵為連接器名稱，例如「projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector」。值包含管理員對連接器執行個體啟用的動作。管理員可以選擇性地在專案中建立的任何連接器執行個體上啟用多項動作。例如：{"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` (選用步驟) 注意：這項功能尚未推出。請改用 `enabled_actions`。這項助理已啟用的工具。索引鍵為連接器名稱，例如「projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector」。值為管理員針對連接器執行個體啟用的工具。管理員可以在專案中建立的任何連接器執行個體上，選擇性啟用多項工具。例如 {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` (選用步驟) 助理的客戶政策。

ActionInfo

已淘汰：將改用 ToolInfo。用於識別動作的資訊。

欄位

action_name

string

動作名稱，由 DataConnectorService.QueryAvailableActions 定義。

action_display_name

string

動作的顯示名稱。

ActionList

已淘汰：將改用 ToolList。連接器上啟用的動作

欄位

action_info[]

ActionInfo

動作清單和對應的動作資訊。

CustomerPolicy

助理的客戶定義政策。

欄位

banned_phrases[]

BannedPhrase

(選用步驟) 禁用詞組清單。

model_armor_config

ModelArmorConfig

(選用步驟) 用於清理使用者提示和助理回覆的 Model Armor 設定。

BannedPhrase

客戶定義的違規片語定義。使用者查詢或 LLM 回應中不得出現遭禁用的片語，否則系統會拒絕提供答案。

欄位

phrase

string

這是必要旗標，要禁止的原始字串內容。

match_type

BannedPhraseMatchType

(選用步驟) 遭禁詞組的比對類型。

ignore_diacritics

bool

(選用步驟) 如果設為 true，系統在比對違規詞組時會忽略變音符號 (例如重音符號、雙點)。舉例來說，「cafe」會與「café」相符。

BannedPhraseMatchType

禁用詞組的比對方法。

列舉
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	預設為 SIMPLE_STRING_MATCH。
`SIMPLE_STRING_MATCH`	如果文字中任何位置出現完全相符的子字串，就會視為違規。
`WORD_BOUNDARY_STRING_MATCH`	只有在文字中的模式前後有字詞分隔符時，系統才會將其視為違規片語。但片語本身仍可能包含字詞分隔符。

ModelArmorConfig

客戶定義的 Model Armor 範本設定，用於清理使用者提示和助理回覆。

欄位

user_prompt_template

string

(選用步驟) 用於清除使用者提示的 Model Armor 範本資源名稱。格式：projects/{project}/locations/{location}/templates/{template_id}

如未指定，系統不會對使用者提示進行清理。

response_template

string

(選用步驟) 用於清理助理回覆的 Model Armor 範本資源名稱。格式：projects/{project}/locations/{location}/templates/{template_id}

如未指定，系統就不會對 AI 助理回覆套用清除程序。

failure_mode

FailureMode

(選用步驟) 定義 Model Armor 消毒程序的失敗模式。

FailureMode

決定 Model Armor 無法處理要求時的行為。

列舉
`FAILURE_MODE_UNSPECIFIED`	未指定失敗模式，預設行為為 `FAIL_CLOSED`。
`FAIL_OPEN`	即便 Model Armor 處理失敗，要求還是可以執行，不必進行任何變更。
`FAIL_CLOSED`	如果 Model Armor 處理失敗，要求就會遭拒。

GenerationConfig

生成助理回覆的設定。

欄位

system_instruction

SystemInstruction

系統指令，也稱為 LLM 呼叫的提示前言。另請參閱 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

生成 Google 助理回覆時使用的預設語言。請使用 ISO 639-1 語言代碼，例如 en。如未指定，系統會自動偵測語言。

SystemInstruction

系統指令，也稱為 LLM 呼叫的提示前言。

欄位

additional_system_instruction

string

(選用步驟) 要新增至預設系統指令的其他系統指令。

ToolInfo

用來識別工具的資訊。

欄位

tool_name

string

工具名稱，由 DataConnectorService.QueryAvailableActions 定義。注意：DataConnectorService API 中使用 action，但與這裡的 tool 相同。

tool_display_name

string

工具的顯示名稱。

ToolList

連接器上啟用的工具

欄位

tool_info[]

ToolInfo

工具清單和對應的工具資訊。

WebGroundingType

要使用的網頁基準類型。

列舉
`WEB_GROUNDING_TYPE_UNSPECIFIED`	預設設定，未指定。這與停用相同。
`WEB_GROUNDING_TYPE_DISABLED`	網路資料來源已停用。
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	已啟用「以 Google 搜尋建立基準」功能。
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	已啟用 Enterprise Web Search 基礎功能。

AssistantContent

多模態內容。

欄位
`role`	`string` 內容製作人。可以是「model」或「user」。
`thought`	`bool` (選用步驟) 指出該部分是否為模型所想。
聯集欄位 `data`。包含的資料。`data` 只能是下列其中一項：
`text`	`string` 內嵌文字。
`inline_data`	`Blob` 內嵌二進位資料。
`file`	`File` 檔案，例如語音摘要。
`executable_code`	`ExecutableCode` 模型生成的程式碼，用於執行作業。
`code_execution_result`	`CodeExecutionResult` 執行 ExecutableCode 的結果。

Blob

內嵌 blob。

欄位

mime_type

string

這是必要旗標，所產生資料的媒體類型 (MIME 類型)。

data

bytes

這是必要旗標，原始位元組。

CodeExecutionResult

執行 ExecutableCode 的結果。

欄位

outcome

Outcome

這是必要旗標，程式碼執行結果。

output

string

(選用步驟) 如果程式碼執行成功，則包含 stdout；否則包含 stderr 或其他說明。

結果

列舉程式碼執行的可能結果。

列舉
`OUTCOME_UNSPECIFIED`	未指定狀態。請勿使用此值。
`OUTCOME_OK`	程式碼已順利執行完畢。
`OUTCOME_FAILED`	程式碼執行完畢，但發生錯誤。`stderr` 應包含原因。
`OUTCOME_DEADLINE_EXCEEDED`	程式碼執行時間過長，因此已取消。可能會有部分輸出內容。

ExecutableCode

模型生成的程式碼，可供模型執行。

欄位

code

string

這是必要旗標，程式碼內容。目前僅支援 Python。

檔案

檔案，例如語音摘要。

欄位

mime_type

string

這是必要旗標，檔案的媒體類型 (MIME 類型)。

file_id

string

這是必要旗標，檔案 ID。

AssistantGroundedContent

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

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

欄位
`content`	`AssistantContent` 內容。
`citation_metadata`	`CitationMetadata` 生成內容的來源出處。另請參閱 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
`content_metadata`	`ContentMetadata` (選用步驟) 內容的中繼資料。目前僅適用於研究助理的答案。
聯集欄位 `metadata`。各種模態的基礎中繼資料。目前僅支援文字。`metadata` 只能是下列其中一項：
`text_grounding_metadata`	`TextGroundingMetadata` 根據文字來源建立基礎的中繼資料。

ContentMetadata

內容的中繼資料。

欄位

content_kind

ContentKind

內容類型。顯示這項內容屬於研究助理回覆的哪個部分。

content_id

string

內容的 ID。這項功能可將研究問題與答案連結。舉例來說，研究問題的答案部分會與問題具有相同的 content_id。

ContentKind

可能的內容種類。目前僅用於區分研究助理完整回覆中的各個部分。

列舉
`CONTENT_KIND_UNSPECIFIED`	不明。
`RESEARCH_PLAN`	研究計畫。
`RESEARCH_QUESTION`	研究問題。
`RESEARCH_ANSWER`	研究答案。
`RESEARCH_REPORT`	研究報告。
`RESEARCH_AUDIO_SUMMARY`	研究音訊摘要。

TextGroundingMetadata

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

欄位

segments[]

Segment

文字部分的基礎資訊。

references[]

Reference

基礎文字的參照。

參考資料

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

欄位

content

string

參照的文字內容。

document_metadata

文件相關中繼資料。

DocumentMetadata

文件相關中繼資料。

欄位
`document`	`string` 文件資源名稱。
`uri`	`string` 文件的 URI。其中可能包含重新導向至實際網站的網址。
`title`	`string` 標題：
`page_identifier`	`string` 網頁 ID。
`domain`	`string` 文件 URI 中的網域名稱。請注意，「`uri`」欄位可能包含重新導向至實際網站的網址，在這種情況下，該欄位會包含目標網站的網域名稱。
`mime_type`	`string` 文件的 MIME 類型。https://www.iana.org/assignments/media-types/media-types.xhtml。

區隔

文字片段的基礎資訊。

欄位
`start_index`	`int64` 從零開始的索引，表示區隔的開頭，以 UTF-8 字串的位元組為單位 (也就是說，以多個位元組編碼的字元長度超過一)。
`end_index`	`int64` 區段的結束時間 (不包含在內)。
`reference_indices[]`	`int32` 區隔的參照。
`grounding_score`	`float` 區隔的分數。
`text`	`string` 文字片段本身。

BAPConfig

BAP 連接器的設定。

欄位

supported_connector_modes[]

ConnectorMode

這是必要旗標，相關聯 BAP 連線支援的連接器模式。

enabled_actions[]

string

(選用步驟) 在相關 BAP 連線中啟用的動作。

ConnectorMode

這個 BAP 連接器支援的使用情境。

列舉
`CONNECTOR_MODE_UNSPECIFIED`	未指定連接器模式。
`DATA_INGESTION`	用於擷取資料的連接器。
`ACTIONS`	用於動作的連接器
`END_USER_AUTHENTICATION`	用於使用者驗證的連接器。

BatchCreateTargetSiteMetadata

與 SiteSearchEngineService.BatchCreateTargetSites 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

CreateTargetSiteRequest

作業上次更新時間。如果作業已完成，這也是完成時間。

BatchCreateTargetSitesRequest

SiteSearchEngineService.BatchCreateTargetSites 方法的要求訊息。

欄位

parent

string

這是必要旗標，所有要建立的 TargetSite 共用的父項資源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。CreateBookRequest 訊息中的父項欄位必須留空或與這個欄位相符。

requests[]

這是必要旗標，要求訊息，指定要建立的資源。您最多可以一次建立 20 個 TargetSite。

BatchCreateTargetSitesResponse

SiteSearchEngineService.BatchCreateTargetSites 方法的回應訊息。

欄位

target_sites[]

已建立 TargetSites。

BatchGetDocumentsMetadataRequest

DocumentService.BatchGetDocumentsMetadata 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項分支資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。

matcher

Matcher

這是必要旗標，Document 的比對工具。

FhirMatcher

依據 FHIR 資源名稱比對 Document。

欄位

fhir_resources[]

string

這是必要旗標，要比對的 FHIR 資源。格式：projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Document 的比對工具。目前支援依確切 URI 比對。

欄位

聯集欄位 matcher。Document 的比對工具。matcher 只能是下列其中一項：

uris_matcher

UrisMatcher

依確切 URI 比對。

fhir_matcher

FhirMatcher

依 FHIR 資源名稱比對。

UrisMatcher

依據確切 URI 比對 Document。

欄位

uris[]

string

要比對的確切 URI。

BatchGetDocumentsMetadataResponse

DocumentService.BatchGetDocumentsMetadata 方法的回應訊息。

欄位

documents_metadata[]

Document 的中繼資料。

DocumentMetadata

Document 的中繼資料。

欄位
`matcher_value`	`MatcherValue` 用於比對 `Document` 的比對器值。
`state`	`State` 文件狀態。
`last_refreshed_time`	`Timestamp` 上次為 `Document`建立索引的時間戳記。
`data_ingestion_source`	`string` `Document`的資料擷取來源。允許的值包括： `batch`：透過 Batch API 擷取的資料，例如 ImportDocuments。 `streaming` 透過 Streaming API 擷取的資料，例如 FHIR 串流。

MatcherValue

用於比對 Document 的比對器值。

欄位

聯集欄位 matcher_value。用於比對 Document 的比對器值。matcher_value 只能是下列其中一項：

uri

string

如果依 URI 比對，則為 Document 的 URI。

fhir_resource

string

格式：projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

狀態

Document 的狀態。

列舉
`STATE_UNSPECIFIED`	不應設定。
`INDEXED`	「`Document`」已編入索引。
`NOT_IN_TARGET_SITE`	`Document` 未建立索引，因為其 URI 不在 `TargetSite` 中。
`NOT_IN_INDEX`	「`Document`」未編入索引。

BatchUpdateUserLicensesMetadata

與 UserLicenseService.BatchUpdateUserLicenses 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功更新的使用者授權數量。
`failure_count`	`int64` 無法更新的使用者授權數量。

BatchUpdateUserLicensesRequest

UserLicenseService.BatchUpdateUserLicenses 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項 [UserStore][] 資源名稱，格式為 `projects/{project}/locations/{location}/userStores/{user_store_id}`。
`delete_unassigned_user_licenses`	`bool` (選用步驟) 如果設為 true，使用者授權移除相關聯的授權設定時，系統會刪除使用者授權。根據預設，這項值為 false，使用者授權會更新為未指派狀態。
聯集欄位 `source`。這是必要旗標，輸入內容的來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` 文件嵌入內容的輸入內容內嵌來源。

InlineSource

BatchUpdateUserLicenses 方法的輸入設定內嵌來源。

欄位

user_licenses[]

UserLicense

這是必要旗標，要更新的使用者授權清單。每個使用者授權都必須有有效的 UserLicense.user_principal。

update_mask

(選用步驟) 要更新的欄位清單。

BatchUpdateUserLicensesResponse

UserLicenseService.BatchUpdateUserLicenses 方法的回應訊息。

欄位

user_licenses[]

UserLicense

已成功更新 UserLicenses。

error_samples[]

處理要求時發生的錯誤範例。

BatchVerifyTargetSitesMetadata

與 SiteSearchEngineService.BatchVerifyTargetSites 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

BatchVerifyTargetSitesRequest

SiteSearchEngineService.BatchVerifyTargetSites 方法的要求訊息。

欄位

parent

string

這是必要旗標，所有待驗證 TargetSite 共用的父項資源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

BatchVerifyTargetSitesResponse

這個類型沒有任何欄位。

SiteSearchEngineService.BatchVerifyTargetSites 方法的回應訊息。

BigQuerySource

要從中匯入資料的 BigQuery 來源。

欄位
`project_id`	`string` 包含 BigQuery 來源的專案 ID 或專案編號。長度上限為 128 個半形字元。如未指定，則會沿用父項要求的專案 ID。
`dataset_id`	`string` 這是必要旗標，要從中複製資料的 BigQuery 資料集，長度上限為 1,024 個字元。
`table_id`	`string` 這是必要旗標，要複製資料的 BigQuery 資料表，長度上限為 1,024 個字元。
`gcs_staging_dir`	`string` 要用於匯入作業的中介 Cloud Storage 目錄，長度上限為 2,000 個字元。如要將 BigQuery 匯出內容匯入特定 Cloud Storage 目錄，即可指定這項設定。
`data_schema`	`string` 從來源剖析資料時所用的結構定義。使用者事件匯入作業支援的值： `user_event` (預設)：每列一個 `UserEvent`。支援的文件匯入值： `document` (預設)：每列一個 `Document` 格式。每個文件都必須有有效的 `Document.id`，以及 `Document.json_data` 或 `Document.struct_data` 其中之一。 `custom`：每列一筆自訂資料，格式任意，但須符合資料儲存空間的 `Schema` 定義。這項功能僅適用於「一般資料儲存庫」類別。
聯集欄位 `partition`。BigQuery 資料表分區資訊。如果 BigQuery 資料表未分區，請將此欄位留空。`partition` 只能是下列其中一項：
`partition_date`	`Date` BigQuery 時間分區資料表的 _PARTITIONDATE，格式為 YYYY-MM-DD。

BigtableOptions

Bigtable 選項物件，內含支援匯入作業的資訊。

欄位

key_field_name

string

用於在文件中儲存資料列索引鍵值的欄位名稱。名稱必須符合 [a-zA-Z0-9][a-zA-Z0-9-_]* 模式。

families

map<string, BigtableColumnFamily>

從系列名稱到物件的對應，該物件包含指定資料欄系列的資料欄系列層級資訊。如果地圖中沒有家庭，系統會忽略這項設定。

BigtableColumn

Bigtable 的資料欄。

欄位
`qualifier`	`bytes` 這是必要旗標，資料欄的限定詞。如果無法使用 utf-8 解碼，請改用 base-64 編碼字串。
`field_name`	`string` 要在文件中用於這個資料欄的欄位名稱。名稱必須符合 `[a-zA-Z0-9][a-zA-Z0-9-_]*` 模式。如未設定，系統會盡量從限定詞位元組剖析。不過，由於命名模式不同，可能會發生欄位名稱衝突，導致剖析行為未定義。
`encoding`	`Encoding` 類型不是 `STRING` 時的值編碼模式。可接受的編碼值如下： `TEXT`：表示值為英數字元文字字串。 `BINARY`：表示值是使用 `HBase Bytes.toBytes` 系列函式編碼。如要覆寫特定資料欄的編碼，請在 `columns` 中列出該資料欄，並指定編碼。
`type`	`Type` 這個資料欄系列中的值類型。如果編碼值設為 `BINARY`，系統會使用 `HBase Bytes.toBytes` 函式編碼這些值。

BigtableColumnFamily

Bigtable 的資料欄系列。

欄位
`field_name`	`string` 要在文件中用於這個資料欄系列的欄位名稱。名稱必須符合 `[a-zA-Z0-9][a-zA-Z0-9-_]*` 模式。如果未設定，系統會盡量從家庭名稱剖析。不過，由於命名模式不同，可能會發生欄位名稱衝突，導致剖析行為未定義。
`encoding`	`Encoding` 類型不是 STRING 時的值編碼模式。可接受的編碼值如下： `TEXT`：表示值為英數字元文字字串。 `BINARY`：表示值是使用 `HBase Bytes.toBytes` 系列函式編碼。如要覆寫特定資料欄的編碼，請在 `columns` 中列出該資料欄，並指定編碼。
`type`	`Type` 這個資料欄系列中的值類型。如果編碼值設為 `BINARY`，系統會使用 `HBase Bytes.toBytes` 函式編碼這些值。
`columns[]`	`BigtableColumn` 物件清單，內含每個資料欄的資料欄層級資訊。如果資料欄不在清單中，系統會忽略該資料欄。

編碼

Bigtable 資料欄或資料欄系列的編碼模式。

列舉
`ENCODING_UNSPECIFIED`	未指定編碼。
`TEXT`	文字編碼。
`BINARY`	二進位編碼。

類型

Bigtable 資料欄或資料欄系列中的值類型。如果編碼值設為 BINARY，值應使用 HBase Bytes.toBytes 函式編碼。

列舉
`TYPE_UNSPECIFIED`	未指定類型。
`STRING`	字串類型。
`NUMBER`	數值類型。
`INTEGER`	整數類型。
`VAR_INTEGER`	可變長度的整數型別。
`BIG_NUMERIC`	BigDecimal 型別。
`BOOLEAN`	布林類型。
`JSON`	JSON 類型。

BigtableSource

用於匯入資料的 Cloud Bigtable 來源。

欄位
`project_id`	`string` 包含 Bigtable 來源的專案 ID。長度上限為 128 個半形字元。如未指定，則會沿用父項要求的專案 ID。
`instance_id`	`string` 這是必要旗標，需要匯入的 Cloud Bigtable 執行個體 ID。
`table_id`	`string` 這是必要旗標，需要匯入的 Cloud Bigtable 資料表 ID。
`bigtable_options`	`BigtableOptions` 這是必要旗標，Bigtable 選項，包含將資料剖析為型別結構時所需的資訊。例如資料欄類型註解。

CheckGroundingRequest

GroundedGenerationService.CheckGrounding 方法的要求訊息。

欄位
`grounding_config`	`string` 這是必要旗標，基礎設定的資源名稱，例如 `projects/*/locations/global/groundingConfigs/default_grounding_config`。
`answer_candidate`	`string` 請候選人回答問題，確認是否符合資格。長度上限為 4096 個權杖。
`facts[]`	`GroundingFact` 用於基礎事實檢查的事實清單。最多可支援 200 個事實。
`grounding_spec`	`CheckGroundingSpec` 基礎檢查的設定。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 文件。

CheckGroundingResponse

GroundedGenerationService.CheckGrounding 方法的回應訊息。

欄位
`cited_chunks[]`	`FactChunk` 答案候選人所有聲明中引用的事實清單。這些資訊是根據要求中提供的資訊推導而來。
`cited_facts[]`	`CheckGroundingFactChunk` 答案候選人所有聲明中引用的事實清單。這些資訊是根據要求中提供的資訊推導而來。
`claims[]`	`Claim` 答案候選項目中所有聲明的聲明文字和引用資訊。
`support_score`	`float` 輸入答案候選項的支援分數。分數越高，代表提供的事實可佐證的聲明比例越高。傳回回應時，系統一律會設定這項屬性。

CheckGroundingFactChunk

用於基礎檢查的事實區塊。

欄位

chunk_text

string

事實區塊的文字內容。長度上限為 1 萬個字元。

權杖附加資訊

候選答案中聲明的文字和引文資訊。

欄位
`claim_text`	`string` 候選答案中的聲明文字。無論是否找到引文或反引文，一律會提供這項資訊。
`citation_indices[]`	`int32` 索引清單 (進入「cited_chunks」)，指定與聲明相關的引文。舉例來說，[1,3,4] 表示 cited_chunks[1]、cited_chunks[3]、cited_chunks[4] 是用來佐證聲明的事實。如果聲明附有事實出處，表示該聲明有事實根據。
`start_pos`	`int32` 以位元組為單位，指出候選答案中聲明的開始位置。請注意，這不是以字元為單位，因此在使用者介面中顯示時，必須考量到部分字元可能佔用超過一個位元組。舉例來說，如果聲明文字含有非 ASCII 字元，以字元 (取決於程式設計語言) 和位元組 (不取決於程式設計語言) 測量時，開始和結束位置會有所不同。
`end_pos`	`int32` 以位元組為單位，指出候選答案中聲明結尾的位置 (不含該位置)。請注意，這項指標是以像素為單位，因此必須以像素為單位呈現。舉例來說，如果聲明文字含有非 ASCII 字元，以字元 (取決於程式設計語言) 和位元組 (不取決於程式設計語言) 測量時，開始和結束位置會有所不同。
`grounding_check_required`	`bool` 表示這項聲明需要進行基礎事實檢查。如果系統判定這項聲明不需要出處/根據檢查，這個欄位就會設為 false。在這種情況下，系統不會對該聲明進行事實根據檢查，因此不應傳回 `citation_indices`。
`score`	`double` 答案候選項目中聲明的信賴度分數，範圍為 [0, 1]。只有在 `CheckGroundingRequest.grounding_spec.enable_claim_level_score` 為 true 時，才會設定這項屬性。

CheckGroundingSpec

基礎檢查的規格。

欄位

citation_threshold

double

門檻 (介於 [0,1] 之間)，用於判斷答案候選項目中的主張是否必須引用事實。選擇較高的門檻會導致引用次數較少，但引用強度較高；選擇較低的門檻則可能導致引用次數較多，但引用強度較低。如未設定，門檻預設為 0.6。

enable_claim_level_score

bool

控制項標記，可在回應中啟用聲明層級的基礎分數。

Chunk

區塊會擷取項目所有原始中繼資料資訊，以便在區塊模式中推薦或搜尋項目。

欄位
`name`	`string` 區塊的完整資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
`id`	`string` 目前區塊的專屬區塊 ID。
`content`	`string` 內容是文件中的字串 (已剖析的內容)。
`document_metadata`	`DocumentMetadata` 目前區塊的文件中繼資料。
`derived_struct_data`	`Struct` 僅供輸出。這個欄位為 OUTPUT_ONLY。當中包含原始輸入文件中沒有的衍生資料。
`page_span`	`PageSpan` 區塊的頁面範圍。
`chunk_metadata`	`ChunkMetadata` 僅供輸出。目前區塊的中繼資料。
`data_urls[]`	`string` 僅供輸出。如果目前的區塊包含圖片，則為圖片資料網址。資料 URL 由四個部分組成：前置字元 (data:)、指出資料類型的 MIME 類型、非文字資料的選用 base64 權杖，以及資料本身：data:[][;base64],
`annotation_contents[]`	`string` 僅供輸出。如果目前的區塊包含註解，則為註解內容。
`annotation_metadata[]`	`AnnotationMetadata` 僅供輸出。註解中繼資料包含目前區塊中的結構化內容。
`relevance_score`	`double` 僅供輸出。代表根據相似度計算出的關聯性分數。分數越高，表示區塊關聯性越高。分數範圍為 [-1.0, 1.0]。只會在 `SearchResponse` 上填入。

AnnotationMetadata

註解中繼資料包含目前區塊中的結構化內容。

欄位

structured_content

StructuredContent

僅供輸出。結構化內容資訊。

image_id

string

僅供輸出。如果結構化內容是以圖片為基礎，系統會提供圖片 ID。

ChunkMetadata

目前區塊的中繼資料。這個欄位只會在 SearchService.Search API 中填入。

欄位

previous_chunks[]

Chunk

目前區塊的前幾個區塊。這項數字是由 SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks 控制。這個欄位只會在 SearchService.Search API 中填入。

next_chunks[]

Chunk

目前區塊的下一個區塊。這項數字是由 SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks 控制。這個欄位只會在 SearchService.Search API 中填入。

DocumentMetadata

文件的中繼資料包含目前區塊的文件資訊。

欄位
`uri`	`string` 文件 URI。
`title`	`string` 文件標題。
`mime_type`	`string` 文件的 MIME 類型。https://www.iana.org/assignments/media-types/media-types.xhtml。
`struct_data`	`Struct` 資料顯示。文件的結構化 JSON 資料。這項屬性應符合已註冊的 `Schema`，否則會擲回 `INVALID_ARGUMENT` 錯誤。

PageSpan

區塊的頁面範圍。

欄位

page_start

int32

區塊的起始頁面。

page_end

int32

區塊的結尾頁面。

StructureType

定義可擷取的結構化內容類型。

列舉
`STRUCTURE_TYPE_UNSPECIFIED`	預設值。
`SHAREHOLDER_STRUCTURE`	股東結構。
`SIGNATURE_STRUCTURE`	簽章結構。
`CHECKBOX_STRUCTURE`	核取方塊結構。

StructuredContent

結構化內容資訊。

欄位

structure_type

StructureType

僅供輸出。結構化內容的結構類型。

content

string

僅供輸出。結構化內容的內容。

引用內容

內容的來源出處。

欄位
`start_index`	`int32` 僅供輸出。內容的起始索引。
`end_index`	`int32` 僅供輸出。內容的結尾索引。
`uri`	`string` 僅供輸出。歸因的網址參照。
`title`	`string` 僅供輸出。出處的標題。
`license`	`string` 僅供輸出。出處的授權。
`publication_date`	`Date` 僅供輸出。出處的發布日期。

CitationMetadata

內容的來源出處集合。

欄位

citations[]

Citation

僅供輸出。參考資料清單。

CloudSqlSource

要從中匯入資料的 Cloud SQL 來源。

欄位
`project_id`	`string` 含有 Cloud SQL 來源的專案 ID。長度上限為 128 個半形字元。如未指定，則會沿用父項要求的專案 ID。
`instance_id`	`string` 這是必要旗標，要從中複製資料的 Cloud SQL 執行個體，長度上限為 256 個字元。
`database_id`	`string` 這是必要旗標，要從中複製資料的 Cloud SQL 資料庫，長度上限為 256 個字元。
`table_id`	`string` 這是必要旗標，要複製資料的 Cloud SQL 資料表，長度上限為 256 個半形字元。
`gcs_staging_dir`	`string` 要用於匯入作業的中介 Cloud Storage 目錄，長度上限為 2,000 個字元。如要將 Cloud SQL 項目匯入特定 Cloud Storage 目錄，即可指定這項設定。請確認 Cloud SQL 服務帳戶具備必要的 Cloud Storage 管理員權限，可存取指定的 Cloud Storage 目錄。
`offload`	`bool` 無伺服器匯出選項。啟用這項選項會產生額外費用。如要瞭解詳情，請按這裡。

CmekConfig

用於啟用 CMEK 資料加密的設定，加密金鑰為 Cloud KMS 金鑰。

欄位
`name`	`string` 這是必要旗標，CmekConfig 的名稱，格式為 `projects/{project}/locations/{location}/cmekConfig` 或 `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`。
`kms_key`	`string` 這是必要旗標，用於加密資源 `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}` 的 KMS 金鑰資源名稱。
`kms_key_version`	`string` 僅供輸出。用於加密資源的 KMS 金鑰版本資源名稱 `<kms_key>/cryptoKeyVersions/{keyVersion}`。
`state`	`State` 僅供輸出。CmekConfig 的狀態。
`is_default`	`bool` 僅供輸出。客戶的預設 CmekConfig。
`last_rotation_timestamp_micros`	`int64` 僅供輸出。上次金鑰輪替的時間戳記。
`single_region_keys[]`	`SingleRegionKey` (選用步驟) 部分 VAIS 功能需要單一區域 CMEK。
`notebooklm_state`	`NotebookLMState` 僅供輸出。NotebookLM 語料庫是否已可使用。

NotebookLMState

NotebookLM 的狀態。

列舉
`NOTEBOOK_LM_STATE_UNSPECIFIED`	NotebookLM 狀態不明。
`NOTEBOOK_LM_NOT_READY`	NotebookLM 尚未準備就緒。
`NOTEBOOK_LM_READY`	NotebookLM 即可使用。
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM 未啟用。

狀態

CmekConfig 的狀態。

列舉
`STATE_UNSPECIFIED`	CmekConfig 狀態不明。
`CREATING`	正在建立 CmekConfig。
`ACTIVE`	CmekConfig 可與 DataStore 搭配使用。
`KEY_ISSUE`	CmekConfig 無法使用，最可能的原因是 KMS 金鑰遭到撤銷。
`DELETING`	正在刪除 CmekConfig。
`DELETE_FAILED`	無法刪除 CmekConfig。
`UNUSABLE`	CmekConfig 無法使用，可能是因為發生內部問題。
`ACTIVE_ROTATING`	KMS 金鑰版本正在輪替。
`DELETED`	KMS 金鑰已軟刪除。最終會套用部分清理政策。
`EXPIRED`	KMS 金鑰已過期，表示金鑰已停用 30 天以上。客戶可以呼叫 DeleteCmekConfig，將狀態變更為 DELETED。

CollectUserEventRequest

CollectUserEvent 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項資源名稱。如果是在 `DataStore` 層級套用收集使用者事件動作，格式為：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`。舉例來說，如果在 `Location` 層級套用收集使用者事件動作，且事件具有多個 `DataStore` 的 `Document`，格式為：`projects/{project}/locations/{location}`。
`user_event`	`string` 這是必要旗標，網址編碼的 UserEvent proto，長度限制為 2,000,000 個字元。
`uri`	`string` 網址 (包括 CGI 參數，但不包括雜湊片段)，長度上限為 5,000 個半形字元。相較於參照網址，這項資訊通常更有用，因為許多瀏覽器只會傳送第三方要求的網域。
`ets`	`int64` 事件時間戳記 (以毫秒為單位)。這樣可避免瀏覽器快取其他相同的 GET 要求。名稱會縮寫，以減少酬載位元組。

集合

集合是容器，用於設定資源和一組 DataStore 的存取權。

欄位

name

string

不可變動。集合的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection_id}。

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

display_name

string

這是必要旗標，集合顯示名稱。

這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個半形字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

create_time

僅供輸出。Collection 的建立時間戳記。

CompleteQueryRequest

CompletionService.CompleteQuery 方法的要求訊息。

欄位
`data_store`	`string` 這是必要旗標，要執行完成作業的父項資料儲存庫資源名稱，例如 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`。
`query`	`string` 這是必要旗標，用於擷取建議的自動完成輸入內容。長度上限為 128 個半形字元。
`query_model`	`string` 指定自動完成資料模型。這會覆寫 Cloud 控制台「設定」>「自動完成」部分中指定的任何模型。目前支援的值： `document` - 使用從使用者匯入文件生成的建議。 `search-history` - 使用根據 `SearchService.Search` API 呼叫記錄產生的建議。如果沒有 Search API 流量，請勿使用。 `user-event` - 使用從使用者匯入的搜尋事件產生的建議。 `document-completable` - 使用直接從使用者匯入的文件欄位取得的建議，這些欄位標示為可完成。預設值： `document` 是常規資料儲存區的預設模型。 `search-history` 是網站搜尋資料儲存區的預設模型。
`user_pseudo_id`	`string` 用於追蹤訪客的專屬 ID。舉例來說，這項功能可以透過 HTTP Cookie 實作，應能識別單一裝置上的訪客。訪客登入或登出網站時，這個專屬 ID 不應變更。這個欄位「不得」有固定值，例如 `unknown_visitor`。這個 ID 應與 `UserEvent.user_pseudo_id` 和 `SearchRequest.user_pseudo_id` 相同。這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個字元。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`include_tail_suggestions`	`bool` 指出在沒有與完整查詢相符的建議時，是否應傳回尾部建議。即使設為 true，如果系統找到與完整查詢相符的建議，就會傳回這些建議，不會傳回尾部建議。

CompleteQueryResponse

CompletionService.CompleteQuery 方法的回應訊息。

欄位

query_suggestions[]

QuerySuggestion

相符查詢建議的結果。結果清單會依序排列，第一個結果是熱門建議。

tail_match_triggered

bool

如果傳回的建議都是尾部建議，則為 True。

如要觸發尾部比對，要求中的 include_tail_suggestions 必須為 true，且不得有與完整查詢相符的建議。

QuerySuggestion

建議搜尋查詢。

欄位

suggestion

string

查詢的建議。

completable_field_paths[]

string

如果建議是從可完成的欄位產生，則為做為建議來源的專屬文件欄位路徑。

只有可完成文件的模型才會填入這個欄位。

CompletionInfo

詳細完成資訊，包括完成歸因權杖和點擊完成資訊。

欄位

selected_suggestion

string

已選取使用者 CompleteQueryResponse.QuerySuggestion.suggestion。

selected_position

int32

使用者選取的 CompleteQueryResponse.QuerySuggestion.suggestion 位置，從 0 開始。

CompletionSuggestion

從客戶匯入的自動完成建議。

欄位
`suggestion`	`string` 這是必要旗標，建議文字。
`language_code`	`string` 這項建議的 BCP-47 語言代碼。
`group_id`	`string` 如果兩個建議的 groupId 相同，系統就不會一併傳回。而是傳回排名較高的結果。這可用於刪除語意相同的建議。
`group_score`	`double` 這項建議在所屬群組中的分數。
`alternative_phrases[]`	`string` 這項建議的替代相符詞組。
聯集欄位 `ranking_info`。這項建議的排名指標。`ranking_info` 只能是下列其中一項：
`global_score`	`double` 這項建議的全球分數。控制這項建議的評分 / 排名方式。
`frequency`	`int64` 這項建議的頻率。如果沒有分數，系統會使用這項資料為建議排序。

條件

定義允許行為前要檢查的情況

欄位

query_terms[]

QueryTerm

只搜尋要比對查詢的字詞清單。如果已設定 Condition.query_regex，就無法設定這項屬性。

最多 10 個查詢字詞。

active_time_range[]

TimeRange

指定條件生效的時間範圍。

最多 10 個時間範圍。

query_regex

string

(選用步驟) 查詢規則運算式，可比對整個搜尋查詢。如果已設定 Condition.query_terms，就無法設定這項功能。僅支援基本網站搜尋宣傳放送控制選項。

QueryTerm

搜尋要求查詢的比對工具

欄位

value

string

要比對的特定查詢值

必須是小寫，且必須是 UTF-8 編碼。如果 full_match 為 true，最多可有 3 個以空格分隔的字詞。不得為空字串。長度上限為 5,000 個半形字元。

full_match

bool

搜尋查詢是否需要與查詢字詞完全相符。

TimeRange

用於時間相關條件。

欄位

start_time

時間範圍的開始時間。

範圍包含頭尾值。

end_time

時間範圍的結束時間。

範圍包含頭尾值。必須是未來的時間。

ConnectorType

連接器類型。

列舉
`CONNECTOR_TYPE_UNSPECIFIED`	預設值。
`THIRD_PARTY`	第三方連接器，可連接至第三方應用程式。
`GCP_FHIR`	資料連接器會連結 FHIR 儲存庫和 VAIS 資料儲存庫。
`BIG_QUERY`	BigQuery 連接器。
`GCS`	Google Cloud Storage 連接器。
`GOOGLE_MAIL`	Gmail 連接器。
`GOOGLE_CALENDAR`	Google Calendar 連接器。
`GOOGLE_DRIVE`	Google 雲端硬碟連接器。
`NATIVE_CLOUD_IDENTITY`	原生 Cloud Identity 連接器，可透過 People API 進行人員搜尋。
`THIRD_PARTY_FEDERATED`	聯合連接器：這類第三方連接器不會擷取資料，搜尋功能則由第三方應用程式的 API 提供。
`THIRD_PARTY_EUA`	用於使用者驗證功能的連接器。
`GCNV`	Google Cloud NetApp Volumes 連接器。

ContactDetails

儲存在資源層級的聯絡資訊。如果專案層級和資源層級都填寫了聯絡資訊，系統會優先採用資源層級的聯絡資訊。

欄位

email_address

string

(選用步驟) 聯絡人的電子郵件地址。

控制項

定義在服務期間採用的條件式行為。必須附加至 ServingConfig，才能在放送時納入考量。可執行的動作取決於 SolutionType。

欄位
`name`	`string` 不可變動。完整名稱 `projects//locations/global/dataStore//controls/*`
`display_name`	`string` 這是必要旗標，使用者可判讀的名稱。使用者介面檢視區塊中使用的 ID。必須是 UTF-8 編碼的字串。長度上限為 128 個字元。否則會擲回 INVALID ARGUMENT 錯誤。
`associated_serving_config_ids[]`	`string` 僅供輸出。這個控制項所連結的所有 `ServingConfig` ID 清單。變更後最多可能需要 10 分鐘才會更新。
`solution_type`	`SolutionType` 這是必要旗標，不可變動。控制項所屬的解決方案。必須與資源的類別相容。否則會擲回 INVALID ARGUMENT 錯誤。
`use_cases[]`	`SearchUseCase` 指定控制項的用途。影響可設定的條件欄位。僅適用於 `SOLUTION_TYPE_SEARCH`。目前每個控制項僅允許一個用途。如果 solution_type 為 `SolutionType.SOLUTION_TYPE_SEARCH`，則必須設定這項屬性。
`conditions[]`	`Condition` 決定何時觸發相關聯的動作。如要一律套用動作，請省略這項屬性。目前只能指定單一條件。否則會擲回 INVALID ARGUMENT 錯誤。
聯集欄位 `action`。動作受垂直產業和解決方案限制這是必要旗標，`action` 只能是下列其中一項：
`boost_action`	`BoostAction` 定義增幅類型控制項
`filter_action`	`FilterAction` 定義篩選器類型控制項，目前建議功能不支援
`redirect_action`	`RedirectAction` 定義重新導向類型的控制項。
`synonyms_action`	`SynonymsAction` 將一組字詞視為彼此的同義字。
`promote_action`	`PromoteAction` 根據預先定義的觸發查詢，宣傳特定連結。

BoostAction

調整傳回清單中產品的順序。

欄位
`boost (deprecated)`	`float` 這個項目已遭淘汰！增幅強度，應介於 [-1, 1] 之間。如果設為負值，即代表降低排名。預設值為 0.0 (無作業)。
`filter`	`string` 這是必要旗標，指定要套用升幅的產品。如未提供篩選器，系統會宣傳所有產品 (不執行任何作業)。語法文件：https://cloud.google.com/retail/docs/filter-and-order 最多 5000 個半形字元。否則會擲回 INVALID ARGUMENT 錯誤。
`data_store`	`string` 這是必要旗標，指定可使用這個控制項提高排名的資料儲存庫。完整資料儲存庫名稱，例如：projects/123/locations/global/collections/default_collection/dataStores/default_data_store
聯集欄位 `boost_spec`。常數值增幅或根據自訂排名增幅規格。`boost_spec` 只能是下列其中一項：
`fixed_boost`	`float` (選用步驟) 增幅強度，應介於 [-1, 1] 之間。如果設為負值，即代表降低排名。預設值為 0.0 (無作業)。
`interpolation_boost_spec`	`InterpolationBoostSpec` (選用步驟) 根據客戶定義的屬性值，為自訂排名設定複雜規格。

InterpolationBoostSpec

根據顧客指定的屬性值自訂排序的規格。與上述簡單的 (條件、加成) 組合相比，這項功能提供更多控制選項，可自訂排名。

欄位
`field_name`	`string` (選用步驟) 系統會根據這個欄位的值決定加成金額。
`attribute_type`	`AttributeType` (選用步驟) 用來決定加成金額的屬性類型。屬性值可從指定 field_name 的欄位值衍生而來。如果是數值，則很簡單，也就是 attribute_value = numerical_field_value。不過，如果是新鮮度，attribute_value = (time.now() - datetime_field_value)。
`interpolation_type`	`InterpolationType` (選用步驟) 要套用的插補類型，用於連結下列控制點。
`control_points[]`	`ControlPoint` (選用步驟) 用來定義曲線的控制點。單調函式 (透過上述 interpolation_type 定義) 會通過這裡列出的控制點。

AttributeType

要套用自訂排序的屬性(或函式)。

列舉
`ATTRIBUTE_TYPE_UNSPECIFIED`	未指定的 AttributeType。
`NUMERICAL`	系統會根據數值欄位的值，動態更新加成金額。在本例中，控制點的 attribute_value (x 值) 會是指定 boost_amount 的數值欄位實際值。
`FRESHNESS`	如果是新鮮度用途，屬性值會是目前時間與指定 datetime 欄位中日期之間的時間長度。這個值的格式必須為 XSD `dayTimeDuration` 值 (ISO 8601 時間長度值的受限子集)。此模式為：`[nD][T[nH][nM][nS]]`。例如：`5D`、`3DT12H30M`、`T24H`。

ControlPoint

用來定義曲線的控制點。透過這些控制點定義的曲線只能單調遞增或遞減(可接受常數值)。

欄位

attribute_value

string

(選用步驟) 可以是下列任一值：1. 數值欄位值。2. 新鮮度時間長度規格：值必須採用 XSD dayTimeDuration 值格式 (ISO 8601 時間長度值的受限子集)。此模式為：[nD][T[nH][nM][nS]]。

boost_amount

float

(選用步驟) 如果 attribute_value 評估結果為上述指定值，則分數的提升值介於 -1 到 1 之間。

InterpolationType

要套用的插補類型。預設值為線性 (分段線性)。

列舉
`INTERPOLATION_TYPE_UNSPECIFIED`	未指定插補類型。在本例中，預設值為「線性」。
`LINEAR`	系統會套用分段線性插值。

FilterAction

指定哪些產品可納入結果。使用與加成相同的篩選條件。

欄位

filter

string

這是必要旗標，要套用至相符條件結果的篩選器。

必要語法文件：https://cloud.google.com/retail/docs/filter-and-order。長度上限為 5,000 個半形字元。否則會擲回 INVALID ARGUMENT 錯誤。

data_store

string

這是必要旗標，指定可使用這個控制項篩選的文件所屬資料儲存庫。完整資料儲存庫名稱，例如：projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

根據某些觸發查詢，宣傳特定連結。

範例：在搜尋 shoe 關鍵字時，宣傳鞋店連結。連結可以位於相關聯的資料儲存庫外部。

欄位

data_store

string

這是必要旗標，這個促銷活動所連結的資料儲存庫。

search_link_promotion

SearchLinkPromotion

這是必要旗標，附加至這項動作的宣傳活動。

RedirectAction

將購物者重新導向至提供的 URI。

欄位

redirect_uri

string

這是必要旗標，購物者將重新導向至此 URI。

這是必要旗標，URI 長度不得超過 2,000 個字元。否則會擲回 INVALID ARGUMENT 錯誤。

SynonymsAction

建立一組互為同義詞的字詞。

舉例來說，「開心」也會視為「高興」，「高興」也會視為「開心」。

欄位

synonyms[]

string

定義一組同義詞。最多可指定 100 個同義字。至少須指定 2 個同義詞。否則會擲回 INVALID ARGUMENT 錯誤。

對話

外部對話的 proto 定義。

欄位
`name`	`string` 不可變動。完整名稱 `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` 或 `projects/{project}/locations/global/collections/{collection}/engines//conversations/`。
`state`	`State` 對話狀態。
`user_pseudo_id`	`string` 用於追蹤使用者的專屬 ID。
`messages[]`	`ConversationMessage` 對話訊息。
`start_time`	`Timestamp` 僅供輸出。對話開始時間。
`end_time`	`Timestamp` 僅供輸出。對話結束的時間。

狀態

對話狀態的列舉。

列舉
`STATE_UNSPECIFIED`	不明。
`IN_PROGRESS`	目前已開啟對話。
`COMPLETED`	對話已完成。

ConversationContext

定義對話情境

欄位

context_documents[]

string

使用者目前看到的檔案清單。其中包含文件資源參照。

active_document

string

使用者目前開啟的現用文件。內含文件資源參照。

ConversationMessage

定義對話訊息。

欄位
`create_time`	`Timestamp` 僅供輸出。訊息建立時間戳記。
聯集欄位 `message`。 `message` 只能是下列其中一項：
`user_input`	`TextInput` 使用者輸入文字。
`reply`	`Reply` 搜尋回覆。

ConverseConversationRequest

ConversationalSearchService.ConverseConversation 方法的要求訊息。

欄位
`name`	`string` 這是必要旗標，要取得的對話資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`。使用 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` 啟用自動工作階段模式，系統會在 ConverseConversation 工作階段中自動建立新對話。
`query`	`TextInput` 這是必要旗標，目前的使用者輸入內容。
`serving_config`	`string` 要使用的供應設定資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`。如未設定，系統會使用預設的供應設定。
`conversation`	`Conversation` 自動工作階段只能使用這項對話。系統會忽略名稱欄位，因為在自動工作階段中，系統會自動為對話指派新名稱。
`safe_search`	`bool` 是否開啟安全搜尋。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 文件。
`summary_spec`	`SummarySpec` 用於設定回應中傳回摘要的規格。
`filter`	`string` 篩選器語法包含運算式語言，可從要篩選的文件的一或多個欄位建構述詞。篩選運算式會區分大小寫。這項資訊會用於篩選搜尋結果，可能會影響摘要回覆。如果無法辨識這個欄位，系統會傳回 `INVALID_ARGUMENT`。如要在 Vertex AI Search 中進行篩選，請將左側的篩選鍵對應至 Vertex AI Search 後端定義的鍵屬性，這項對應是由客戶在結構定義中定義。舉例來說，媒體客戶的結構定義中可能會有「name」欄位。在本例中，篩選器會如下所示：filter --> name:'ANY("king kong")' 如要進一步瞭解篩選功能，包括語法和篩選運算子，請參閱「篩選」
`boost_spec`	`BoostSpec` 提升規格可提高搜尋結果中特定文件的排名，這可能會影響對話回覆。如要進一步瞭解加成，請參閱「加成」一文。

ConverseConversationResponse

ConversationalSearchService.ConverseConversation 方法的回應訊息。

欄位

reply

Reply

目前查詢的答案。

conversation

更新後的對話，包括答案。

search_results[]

SearchResult

搜尋結果。

CreateAssistantRequest

要求 AssistantService.CreateAssistant 方法。

欄位

parent

string

這是必要旗標，父項資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

這是必要旗標，要建立的 Assistant。

assistant_id

string

這是必要旗標，用於 Assistant 的 ID，會成為 Assistant 資源名稱的最終元件。

這個欄位必須符合 RFC-1034，長度上限為 63 個字元。

CreateControlRequest

要求 CreateControl 方法。

欄位

parent

string

這是必要旗標，父項資料儲存庫的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} 或 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。

control

Control

這是必要旗標，要建立的控制項。

control_id

string

這是必要旗標，用於控制項的 ID，會成為控制項資源名稱的最終元件。

這個值必須介於 1 到 63 個字元之間。有效半形字元為 /[a-z][0-9]-_/.

CreateConversationRequest

要求 CreateConversation 方法。

欄位

parent

string

這是必要旗標，父項資料儲存庫的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

這是必要旗標，要建立的對話。

CreateDataStoreMetadata

與 DataStoreService.CreateDataStore 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

CreateDataStoreRequest

要求 DataStoreService.CreateDataStore 方法。

欄位
`parent`	`string` 這是必要旗標，父項資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection}`。
`data_store`	`DataStore` 這是必要旗標，要建立的 `DataStore`。
`data_store_id`	`string` 這是必要旗標，用於 `DataStore` 的 ID，會成為 `DataStore` 資源名稱的最終元件。這個欄位必須符合 RFC-1034 標準，長度上限為 63 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`create_advanced_site_search`	`bool` 布林值旗標，指出使用者是否要直接為網站搜尋建立進階資料儲存庫。如果資料儲存庫未設為網站搜尋 (GENERIC 垂直和 PUBLIC_WEBSITE content_config)，系統會忽略這個標記。
`skip_default_schema_creation`	`bool` 布林值標記，表示是否要略過資料儲存庫的預設結構定義建立作業。請務必確定預設結構定義與您的用途不相容，再啟用這個旗標。如果設為 true，您必須先手動建立資料儲存庫的結構定義，才能擷取任何文件。如果已指定 `data_store.starting_schema`，則無法指定這個旗標。
聯集欄位 `cmek_options`。DataStore 的 CMEK 選項。如果專案已設定預設 CmekConfig，設定這個欄位會覆寫該設定。`cmek_options` 只能是下列其中一項：
`cmek_config_name`	`string` 用於保護這個 DataStore 的 CmekConfig 資源名稱。
`disable_cmek`	`bool` 沒有 CMEK 保護機制的 DataStore。如果專案已設定預設 CmekConfig，設定這個欄位也會覆寫預設 CmekConfig。

CreateDocumentRequest

DocumentService.CreateDocument 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。

document

這是必要旗標，要建立的 Document。

document_id

string

這是必要旗標，用於 Document 的 ID，會成為 Document.name 的最終元件。

如果呼叫者沒有建立 Document 的權限，無論該 Document 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

這個欄位在所有具有相同 parent 的 Document 中不得重複。否則，系統會傳回 ALREADY_EXISTS 錯誤。

這個欄位必須符合 RFC-1034 標準，長度上限為 128 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

CreateEngineMetadata

與 EngineService.CreateEngine 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

CreateEngineRequest

要求 EngineService.CreateEngine 方法。

欄位

parent

string

這是必要旗標，父項資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}。

engine

Engine

這是必要旗標，要建立的 Engine。

engine_id

string

這是必要旗標，用於 Engine 的 ID，會成為 Engine 資源名稱的最終元件。

這個欄位必須符合 RFC-1034 標準，長度上限為 63 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

CreateIdentityMappingStoreRequest

IdentityMappingStoreService.CreateIdentityMappingStore 的要求訊息

欄位
`parent`	`string` 這是必要旗標，父項集合資源名稱，例如 `projects/{project}/locations/{location}`。
`identity_mapping_store_id`	`string` 這是必要旗標，要建立的識別資訊對應儲存空間 ID。 ID 只能包含英文字母 (a-z、A-Z)、數字 (0-9)、底線 (_) 和連字號 (-)，長度上限為 63 個字元。
`identity_mapping_store`	`IdentityMappingStore` 這是必要旗標，要建立的 ID 對應儲存空間。
聯集欄位 `cmek_options`。身分對應儲存庫的 CMEK 選項。如果專案已設定預設 CmekConfig，設定這個欄位會覆寫該設定。`cmek_options` 只能是下列其中一項：
`cmek_config_name`	`string` 用於保護這個身分對應商店的 CmekConfig 資源名稱。
`disable_cmek`	`bool` 沒有 CMEK 保護的識別資訊對應檔儲存庫。如果專案已設定預設 CmekConfig，設定這個欄位也會覆寫預設 CmekConfig。

CreateLicenseConfigRequest

LicenseConfigService.CreateLicenseConfig 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項資源名稱，例如 projects/{project}/locations/{location}。

license_config

LicenseConfig

這是必要旗標，要建立的 LicenseConfig。

license_config_id

string

(選用步驟) 要用於 LicenseConfig 的 ID，會成為 LicenseConfig 資源名稱的最終元件。我們使用層級 (產品版本) 名稱做為授權設定 ID，例如 search 或 search_and_assistant。

CreateSchemaMetadata

建立結構定義長時間執行作業的中繼資料。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

CreateSchemaRequest

SchemaService.CreateSchema 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項資料儲存庫資源名稱，格式為 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。

schema

Schema

這是必要旗標，要建立的 Schema。

schema_id

string

這是必要旗標，用於 Schema 的 ID，會成為 Schema.name 的最終元件。

這個欄位應符合 RFC-1034 標準，長度上限為 63 個字元。

CreateSessionRequest

CreateSession 方法的要求。

欄位

parent

string

這是必要旗標，父項資料儲存庫的完整資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

這是必要旗標，要建立的工作階段。

CreateSitemapMetadata

與 SiteSearchEngineService.CreateSitemap 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

CreateSitemapRequest

SiteSearchEngineService.CreateSitemap 方法的要求訊息。

欄位

parent

string

這是必要旗標，SiteSearchEngine 的父項資源名稱，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。

sitemap

Sitemap

這是必要旗標，要建立的 Sitemap。

CreateTargetSiteMetadata

與 SiteSearchEngineService.CreateTargetSite 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

CreateTargetSiteRequest

SiteSearchEngineService.CreateTargetSite 方法的要求訊息。

欄位

parent

string

這是必要旗標，TargetSite 的父項資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

target_site

這是必要旗標，要建立的 TargetSite。

CustomAttribute

資源中未明確建立模型的自訂屬性，例如 UserEvent。

欄位

text[]

string

這項自訂屬性的文字值。例如，當索引鍵為「color」時，["yellow", "green"]。

不得留空。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

請務必設定 CustomAttribute.text 或 CustomAttribute.numbers 其中之一。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

numbers[]

double

這個自訂屬性的數值。舉例來說，如果鍵是「lengths_cm」，則值為 [2.3, 15.4]。

請務必設定 CustomAttribute.text 或 CustomAttribute.numbers 其中之一。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

CustomTuningModel

描述自訂微調模型的中繼資料。

欄位
`name`	`string` 這是必要旗標，模型的完整資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`。型號必須是英數字元字串，最多 40 個字元。
`display_name`	`string` 模型的顯示名稱。
`model_version`	`int64` 模型版本。
`model_state`	`ModelState` 模型所處的狀態 (例如 `TRAINING` 或 `TRAINING_FAILED`)。
`create_time (deprecated)`	`Timestamp` 這個項目已遭淘汰！已淘汰：模型建立時間的時間戳記。
`training_start_time`	`Timestamp` 模型訓練的啟動時間戳記。
`metrics`	`map<string, double>` 訓練後模型的指標。
`error_message`	`string` 目前只有在模型狀態為 `INPUT_VALIDATION_FAILED` 時，才會填入這個欄位。

ModelState

模型的狀態。

列舉
`MODEL_STATE_UNSPECIFIED`	預設值。
`TRAINING_PAUSED`	模型處於暫停訓練狀態。
`TRAINING`	模型目前正在訓練中。
`TRAINING_COMPLETE`	模型已順利完成訓練。
`READY_FOR_SERVING`	模型已可供放送。
`TRAINING_FAILED`	模型訓練失敗。
`NO_IMPROVEMENT`	模型訓練已順利完成，但指標並未改善。
`INPUT_VALIDATION_FAILED`	輸入資料驗證失敗。模型訓練未開始。

DataConnector

管理所有資料儲存庫 (歸類在 Collection 下) 與外部資料來源的連線。這是 Collection 的單例資源。初始化作業僅支援透過 DataConnectorService.SetUpDataConnector 方法進行，該方法會建立新的 Collection 並初始化其 DataConnector。

欄位
`name`	`string` 僅供輸出。資料連接器的完整資源名稱。格式：`projects//locations//collections/*/dataConnector`。
`state`	`State` 僅供輸出。連接器狀態。
`data_source`	`string` 這是必要旗標，資料來源的名稱。支援的值：`salesforce`、`jira`、`confluence`、`bigquery`。
`remove_param_keys[]`	`string` (選用步驟) 指定要從「params」欄位移除的鍵。只有在 UpdateDataConnectorRequest 的「update_mask」中包含「params」時，這個欄位才會有效。如果某個鍵同時位於「remove_param_keys」中，且存在於要求的「params」欄位，系統會優先刪除該鍵。
`refresh_interval`	`Duration` 這是必要旗標，資料同步的重新整理間隔。如果將時間長度設為 0，系統會即時同步處理資料。目前還不支援串流功能。最短為 30 分鐘，最長為 7 天。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步。
`next_sync_time`	`DateTime` 定義下次資料同步處理的排定時間。這個欄位需要 IANA 時區資料庫中的小時、分鐘和時區。如果資料連接器的重新整理間隔超過 1 天，系統就會使用這項功能。如未指定小時或分鐘，系統會假設同步時間為 0:00。使用者必須提供時區，以免產生誤解。
`entities[]`	`SourceEntity` 要從連結的資料來源擷取的實體清單。
`create_time`	`Timestamp` 僅供輸出。`DataConnector` 的建立時間戳記。
`latest_pause_time`	`Timestamp` 僅供輸出。這個 `DataConnector` 最近一次暫停的時間戳記，會影響資料同步等所有功能。暫停連接器會產生下列影響： - 所有功能都會停止運作，包括資料同步。 - 系統會取消所有進行中的資料同步處理作業。- 系統不會排定或觸發日後的資料同步處理作業。
`last_sync_time`	`Timestamp` 僅供輸出。僅適用於定期連接器，顯示上次完成資料同步的時間。
`update_time`	`Timestamp` 僅供輸出。上次更新 `DataConnector` 的時間戳記。
`errors[]`	`Status` 僅供輸出。初始化或最新連接器執行作業時發生的錯誤。
`sync_mode`	`SyncMode` 資料連接器支援的資料同步模式。
`kms_key_name`	`string` 僅限輸入。用來保護這個連接器所管理資料儲存庫的 KMS 金鑰。如果要求必須遵守 CMEK 機構政策保護措施，則必須設定這項參數。如果設定這個欄位並成功處理，這個連接器建立的 DataStore 就會受到 KMS 金鑰保護。
`destination_configs[]`	`DestinationConfig` (選用步驟) 用來連結第三方服務的任何目標目的地。
`action_state`	`State` 僅供輸出。動作連接器的狀態。這會反映動作連接器是否正在初始化、處於有效狀態或發生錯誤。
`action_config`	`ActionConfig` (選用步驟) 設定動作，讓連接器支援動作。
`end_user_config`	`EndUserConfig` (選用步驟) 專門用於 EUA 連接器的任何參數和憑證。
`federated_config`	`FederatedConfig` (選用步驟) 專為支援「FEDERATED」模式的混合式連接器使用的任何參數和憑證。只有在連接器為混合式連接器，且我們想啟用 FEDERATED 模式時，才需要設定這個欄位。
`connector_modes[]`	`ConnectorMode` (選用步驟) 為這個連接器啟用的模式。預設狀態為 CONNECTOR_MODE_UNSPECIFIED。
`static_ip_enabled`	`bool` (選用步驟) 客戶是否已為這個連接器啟用靜態 IP 位址。
`static_ip_addresses[]`	`string` 僅供輸出。這個連接器使用的靜態 IP 位址。
`blocking_reasons[]`	`BlockingReason` 僅供輸出。連接器必須先完成使用者動作，才能開始同步處理資料。
`identity_refresh_interval (deprecated)`	`Duration` 這個項目已遭淘汰！這個連接器擷取的文件會以這個間隔時間同步處理存取控制清單資訊。如未設定，存取控制清單會以 30 分鐘的預設間隔重新整理。身分識別資訊的重新整理間隔最短為 30 分鐘，最長為 7 天。
`identity_schedule_config`	`IdentityScheduleConfig` 身分資料同步處理作業的設定。其中包含重新整理間隔，可同步處理這個連接器擷取文件的存取控制清單資訊。
`private_connectivity_project_id`	`string` 僅供輸出。與私人連線連接器相關聯的用戶端專案 ID。專案必須加入許可清單，連接器才能運作。
`bap_config`	`BAPConfig` (選用步驟) 建立 BAP 連線的設定。
`connector_type`	`ConnectorType` 僅供輸出。連接器類型。每個來源只能對應至一種型別。舉例來說，salesforce、confluence 和 jira 的連接器類型為 THIRD_PARTY。系統設定後即無法變更。
`realtime_state`	`State` 僅供輸出。即時同步處理狀態
`alert_policy_configs[]`	`AlertPolicyConfig` (選用步驟) 連接器層級的快訊設定。
`realtime_sync_config`	`RealtimeSyncConfig` (選用步驟) 即時同步處理的設定。
`acl_enabled`	`bool` (選用步驟) 是否要使用 ACL 設定建立連接器。目前這個欄位只會影響 Cloud Storage 和 BigQuery 連接器。
`create_eua_saas`	`bool` (選用步驟) 是否在 SaaS 中建立 END USER AUTHENTICATION 連接器。
`auto_run_disabled`	`bool` (選用步驟) 指出是否已停用連接器的自動執行功能。這項功能可用於暫停定期和即時同步作業。更新：隨著 incremental_sync_disabled 的推出，auto_run_disabled 僅用於暫停/停用完整同步作業
`incremental_sync_disabled`	`bool` (選用步驟) 指出這個連接器是否已暫停增量同步。這與 auto_run_disabled 無關。僅適用於第三方連接器。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步，也就是設為 true。
`incremental_refresh_interval`	`Duration` (選用步驟) 專為增量資料同步設定的重新整理間隔。如未設定，增量同步會使用環境的預設值 (設為 3 小時)。最短為 30 分鐘，最長為 7 天。僅適用於第三方連接器。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步。
`hybrid_ingestion_disabled`	`bool` (選用步驟) 如果連接器是混合式連接器，系統會在建立連接器時判斷是否啟用擷取功能，並佈建適當的資源。如果連接器不是混合式連接器，系統會忽略這個欄位。
聯集欄位 `data_connector_params`。以 (Key, Value) 組合格式存取來源所需的參數。系統會從 Secret Manager 讀取格式為 `projects//[locations//]secrets//versions/` 的字串值。所有資料來源的必要參數：鍵：`instance_uri` 值：STRING 類型。存取資料來源的 URI。支援 OAuth 的來源 (即 `salesforce`) 的必要參數：鍵：`client_id` 值：STRING 類型。第三方服務供應商用來識別應用程式的用戶端 ID。鍵：`client_secret` 值：STRING 類型。第三方授權伺服器產生的用戶端密鑰。鍵：`access_token` 值：STRING 類型。UCS 存取受保護資源的 OAuth 權杖。鍵：`refresh_token` 值：STRING 類型。UCS 的 OAuth 更新權杖，可取得新的存取權杖，不需使用者互動。支援基本 API 權杖驗證的來源 (即 `jira`、`confluence`) 必填參數：鍵：`user_account` 值：STRING 類型。來源的使用者名稱或電子郵件地址。鍵：`api_token` 值：STRING 類型。為來源帳戶產生的 API 權杖，可用於需要密碼的任何驗證程序。範例： `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` 選用參數，用於指定要使用的授權類型 (支援多種授權類型)：鍵：`auth_type` 值：STRING 類型。資料來源的授權類型。支援的值：`BASIC_AUTH`、`OAUTH`、`OAUTH_ACCESS_TOKEN`、`OAUTH_TWO_LEGGED`、`OAUTH_JWT_BEARER`、`OAUTH_PASSWORD_GRANT`、`JWT`、`API_TOKEN`、`FEDERATED_CREDENTIAL`。`data_connector_params` 只能是下列其中一項：
`params`	`Struct` 結構化 JSON 格式的必要資料連結器參數。
`json_params`	`string` JSON 字串格式的必要資料連接器參數。

BlockingReason

連接器必須先完成使用者動作，才能開始同步處理資料。

列舉
`BLOCKING_REASON_UNSPECIFIED`	預設值。
`ALLOWLIST_STATIC_IP`	客戶必須將靜態 IP 列入許可清單，才能使用連接器。
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	連接器需要客戶在服務附件中將我們的專案加入許可清單。
`ALLOWLIST_SERVICE_ACCOUNT`	客戶必須在專案中將服務帳戶加入允許清單，才能使用連結器。

ConnectorMode

為這個連接器啟用的模式。擷取、動作、聯盟或 EUA

列舉
`CONNECTOR_MODE_UNSPECIFIED`	未指定連接器模式。
`DATA_INGESTION`	用於擷取資料的連接器。
`ACTIONS`	用於動作的連接器。
`FEDERATED`	用於聯合搜尋的連接器。
`EUA`	用於使用者驗證的連接器。
`FEDERATED_AND_EUA`	用於聯合搜尋和使用者驗證的混合式連接器。

EndUserConfig

專門用於 EUA 連接器的任何參數和憑證。

欄位
`additional_params`	`Struct` (選用步驟) EUA 要求的任何其他參數。
`tenant`	`Tenant` (選用步驟) 連接器連結的用戶端專案。
聯集欄位 `auth_config`。EUA 連接器的驗證設定。`auth_config` 只能是下列其中一項：
`auth_params`	`Struct` (選用步驟) EUA 連接器專屬的任何驗證參數。
`json_auth_params`	`string` (選用步驟) 以 JSON 字串格式表示的 EUA 連接器專屬驗證參數。

FederatedConfig

專為支援「FEDERATED」模式的混合式連接器使用的任何參數和憑證。

欄位
`additional_params`	`Struct` (選用步驟) FEDERATED 要求的任何其他參數。
聯集欄位 `auth_config`。適用於 FEDERATED 連接器的驗證設定。`auth_config` 只能是下列其中一項：
`auth_params`	`Struct` (選用步驟) FEDERATED 連接器專屬的任何驗證參數。
`json_auth_params`	`string` (選用步驟) 以 JSON 字串格式表示的 FEDERATED 連接器專屬驗證參數。

RealtimeSyncConfig

即時同步處理的設定，可儲存即時同步處理的其他參數。

欄位

webhook_uri

string

(選用步驟) 連結器的 Webhook 網址，用於指定即時同步處理的其他參數。

realtime_sync_secret

string

(選用步驟) 用於 Webhook 密鑰的 Secret Manager 密鑰 ID。

streaming_error

StreamingError

(選用步驟) 串流錯誤詳細資料。

StreamingError

串流錯誤詳細資料。

欄位

streaming_error_reason

StreamingErrorReason

(選用步驟) 串流錯誤。

error

(選用步驟) 錯誤詳細資料。

StreamingErrorReason

廣泛的串流錯誤類型。

列舉
`STREAMING_ERROR_REASON_UNSPECIFIED`	未指定串流錯誤原因。
`STREAMING_SETUP_ERROR`	設定即時同步資源時發生錯誤。
`STREAMING_SYNC_ERROR`	執行連接器的即時同步時發生錯誤。
`INGRESS_ENDPOINT_REQUIRED`	在私人連線中設定即時同步處理功能時，必須提供 Ingress 端點。

SourceEntity

代表資料來源中的實體。例如 Salesforce 中的 Account 物件。

欄位
`entity_name`	`string` 實體的名稱。各資料來源支援的值： Salesforce：`Lead`、`Opportunity`、`Contact`、`Account`、`Case`、`Contract`、`Campaign` Jira：`Issue` Confluence：`Content`、`Space`
`key_property_mappings`	`map<string, string>` 用於建立索引的屬性。鍵：欄位名稱。值：要將欄位對應到的主要屬性，例如 `title` 和 `description`。支援的重要屬性： `title`：資料記錄的標題。這項資訊會顯示在搜尋結果中。 `description`：資料記錄的說明。這項資訊會顯示在搜尋結果中。
`data_store`	`string` 僅供輸出。來源實體相關聯資料儲存庫的完整資源名稱。格式：`projects//locations//collections//dataStores/`。當連接器由 `DataConnectorService.SetUpDataConnector` 方法初始化時，系統會自動為每個來源實體建立 `DataStore`。
`starting_schema`	`Schema` (選用步驟) 用於從這個 SourceEntity 建立 `DataStore` 的開始架構。如未設定，系統會使用預設的垂直領域專用結構定義。這個欄位僅供 [SetUpDataConnector][] API 使用，如果用於其他 API，系統會忽略這個欄位。所有 API 回應 (包括 [GetDataConnector][] API) 都會省略這個欄位。如要擷取 `DataStore` 的結構定義，請改用 `SchemaService.GetSchema` API。系統會根據結構定義的特定規則驗證提供的結構定義。詳情請參閱這份文件。
`healthcare_fhir_config`	`HealthcareFhirConfig` (選用步驟) `HEALTHCARE_FHIR` 直向的設定。
聯集欄位 `entity_params`。實體的參數，方便擷取資料。例如，BigQuery 連接器：鍵：`document_id_column` 值：STRING 類型。資料欄 ID 的值。`entity_params` 只能是下列其中一項：
`params`	`Struct` 實體的參數，方便以結構化 JSON 格式擷取資料。
`json_params`	`string` 實體的參數，方便以 JSON 字串格式擷取資料。

狀態

連接器狀態。

列舉
`STATE_UNSPECIFIED`	預設值。
`CREATING`	正在設定連接器。
`ACTIVE`	連接器已成功設定，正在等待下次同步處理。
`FAILED`	連接器發生錯誤。錯誤詳細資料位於 `DataConnector.errors`。如果無法修正錯誤，可以使用 [CollectionService.DeleteCollection] API 刪除 `DataConnector`。
`RUNNING`	連接器正在從資料來源同步處理記錄。
`WARNING`	連接器已完成同步處理作業，但發生非致命錯誤。
`INITIALIZATION_FAILED`	連接器初始化失敗。可能原因包括執行階段錯誤或非同步管道問題，導致要求無法送達下游服務 (部分連結器類型除外)。
`UPDATING`	連接器正在更新。

SyncMode

定義資料連接器支援的資料同步模式。

列舉
`PERIODIC`	連接器會根據 refresh_interval 定期同步處理資料。搭配 auto_run_disabled 使用，可暫停定期同步處理，或指出一次性同步處理。
`STREAMING`	系統會即時同步處理資料。
`UNSPECIFIED`	如果連接器未擷取資料，就會有這個值

DataStore

DataStore 會在 DataStore 層級擷取全域設定和設定檔。

欄位
`name`	`string` 不可變動。ID。資料儲存庫的完整資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
`display_name`	`string` 這是必要旗標，資料儲存庫顯示名稱。這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個半形字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`industry_vertical`	`IndustryVertical` 不可變動。資料儲存庫註冊的產業類別。
`solution_types[]`	`SolutionType` 資料儲存庫註冊的解決方案。各`industry_vertical`適用的解決方案： `MEDIA`：`SOLUTION_TYPE_RECOMMENDATION` 和 `SOLUTION_TYPE_SEARCH`。 `SITE_SEARCH`：`SOLUTION_TYPE_SEARCH`會自動註冊。其他解決方案無法註冊。
`default_schema_id`	`string` 僅供輸出。與這個資料儲存庫相關聯的預設 `Schema` ID。
`content_config`	`ContentConfig` 不可變動。資料儲存庫的內容設定。如未設定這個欄位，伺服器行為會預設為 `ContentConfig.NO_CONTENT`。
`create_time`	`Timestamp` 僅供輸出。`DataStore` 的建立時間戳記。
`advanced_site_search_config`	`AdvancedSiteSearchConfig` (選用步驟) 進階站內搜尋的設定。
`kms_key_name`	`string` 僅限輸入。建立這個 DataStore 時，用來保護資料的 KMS 金鑰。如果要求必須遵守 CMEK 機構政策保護措施，則必須設定這項參數。如果這個欄位已設定且處理成功，DataStore 就會受到 KMS 金鑰保護，如 cmek_config 欄位所示。
`cmek_config`	`CmekConfig` 僅供輸出。DataStore 的 CMEK 相關資訊。
`billing_estimation`	`BillingEstimation` 僅供輸出。預估帳單的資料量。
`acl_enabled`	`bool` 不可變動。`DataStore` 中的資料是否含有 ACL 資訊。如果設為 `true`，來源資料必須有存取控制清單。當資料由 `DocumentService.ImportDocuments` 方法擷取時，ACL 也會一併擷取。為 `DataStore` 啟用 ACL 後，就無法透過呼叫 `DocumentService.GetDocument` 或 `DocumentService.ListDocuments` 存取 `Document`。目前 ACL 僅支援 `GENERIC` 產業，且內容設定不含 `PUBLIC_WEBSITE`。
`workspace_config`	`WorkspaceConfig` 設定檔，用於儲存工作區資料的資料儲存庫類型設定。如果 `DataStore.content_config` 設為 `DataStore.ContentConfig.GOOGLE_WORKSPACE`，就必須設定這個屬性。
`document_processing_config`	`DocumentProcessingConfig` 設定文件解讀和擴充功能。
`starting_schema`	`Schema` 佈建這個 `DataStore` 時要使用的開始結構定義。如未設定，系統會使用預設的垂直領域專用結構定義。這個欄位僅供 `CreateDataStore` API 使用，如果用於其他 API，系統會忽略這個欄位。所有 API 回應 (包括 `CreateDataStore` API) 都會省略這個欄位。如要擷取 `DataStore` 的結構定義，請改用 `SchemaService.GetSchema` API。系統會根據結構定義的特定規則驗證提供的結構定義。詳情請參閱這份文件。
`healthcare_fhir_config`	`HealthcareFhirConfig` (選用步驟) `HEALTHCARE_FHIR` 直向的設定。
`serving_config_data_store`	`ServingConfigDataStore` (選用步驟) 在 DataStore 層級儲存服務設定。
`identity_mapping_store`	`string` 不可變動。相關聯 `IdentityMappingStore` 的完整資源名稱。這個欄位只能為 acl_enabled DataStore 設定 `THIRD_PARTY` 或 `GSUITE` IdP。格式：`projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`。
`is_infobot_faq_data_store`	`bool` (選用步驟) 如果設定，這個 DataStore 就是 Infobot 常見問題 DataStore。
`configurable_billing_approach`	`ConfigurableBillingApproach` (選用步驟) 可設定的帳單方式設定。請參閱

BillingEstimation

預估每個資料儲存庫的資料大小。

欄位
`structured_data_size`	`int64` 結構化資料的大小 (以位元組為單位)。
`unstructured_data_size`	`int64` 非結構化資料的大小 (以位元組為單位)。
`website_data_size`	`int64` 網站的資料大小 (以位元組為單位)。
`structured_data_update_time`	`Timestamp` 結構化資料的上次更新時間戳記。
`unstructured_data_update_time`	`Timestamp` 非結構化資料的上次更新時間戳記。
`website_data_update_time`	`Timestamp` 網站的上次更新時間戳記。

ConfigurableBillingApproach

可設定的帳單方式設定。

列舉
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	預設值。適用於 Spark 和非 Spark 無法設定的計費方式。
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	針對非嵌入式儲存空間的索引核心，使用訂閱方案基本費用 + 超額費用計費。
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	嵌入式儲存空間外掛程式採用隨用隨付的計費方式。

ContentConfig

資料儲存庫的內容設定。

列舉
`CONTENT_CONFIG_UNSPECIFIED`	預設值。
`NO_CONTENT`	只包含沒有任何 `Document.content` 的文件。
`CONTENT_REQUIRED`	只包含含有 `Document.content` 的文件。
`PUBLIC_WEBSITE`	資料儲存庫用於搜尋公開網站。
`GOOGLE_WORKSPACE`	資料儲存庫用於工作區搜尋。工作區資料儲存區的詳細資料會指定在 `WorkspaceConfig` 中。

ServingConfigDataStore

儲存 DataStore 層級的放送設定相關資訊。

欄位

disabled_for_serving

bool

(選用步驟) 如果設為 true，DataStore 就無法處理搜尋要求。

DeleteAssistantRequest

AssistantService.DeleteAssistant 方法的要求訊息。

欄位

name

string

這是必要旗標，Assistant 的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

如果呼叫端沒有刪除 Assistant 的權限，無論該 Assistant 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果刪除的 Assistant 不存在，系統會傳回 NOT_FOUND 錯誤。

DeleteCmekConfigMetadata

與 CmekConfigService.DeleteCmekConfig 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteCmekConfigRequest

CmekConfigService.DeleteCmekConfig 方法的要求訊息。

欄位

name

string

這是必要旗標，要刪除的 CmekConfig 資源名稱，例如 projects/{project}/locations/{location}/cmekConfigs/{cmek_config}。

DeleteCollectionMetadata

與 [CollectionService.UpdateCollection][] 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteCollectionRequest

CollectionService.DeleteCollection 方法的要求訊息。

欄位

name

string

這是必要旗標，集合的完整資源名稱，格式為 projects/{project}/locations/{location}/collections/{collection}。

DeleteControlRequest

要求 DeleteControl 方法。

欄位

name

string

這是必要旗標，要刪除的控制項資源名稱。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

要求 DeleteConversation 方法。

欄位

name

string

這是必要旗標，要刪除的對話資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

與 DataStoreService.DeleteDataStore 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteDataStoreRequest

DataStoreService.DeleteDataStore 方法的要求訊息。

欄位

name

string

這是必要旗標，DataStore 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。

如果呼叫端沒有刪除 DataStore 的權限，無論該 DataStore 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果刪除的 DataStore 不存在，系統會傳回 NOT_FOUND 錯誤。

DeleteDocumentRequest

DocumentService.DeleteDocument 方法的要求訊息。

欄位

name

string

這是必要旗標，Document 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}。

如果呼叫端沒有刪除 Document 的權限，無論該 Document 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果刪除的 Document 不存在，系統會傳回 NOT_FOUND 錯誤。

DeleteEngineMetadata

與 EngineService.DeleteEngine 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteEngineRequest

EngineService.DeleteEngine 方法的要求訊息。

欄位

name

string

這是必要旗標，Engine 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。

如果呼叫端沒有刪除 Engine 的權限，無論該 Engine 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果刪除的 Engine 不存在，系統會傳回 NOT_FOUND 錯誤。

DeleteIdentityMappingStoreMetadata

與 IdentityMappingStoreService.DeleteIdentityMappingStore 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteIdentityMappingStoreRequest

IdentityMappingStoreService.DeleteIdentityMappingStore 的要求訊息

欄位

name

string

這是必要旗標，要刪除的 ID 對應商店名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

DeleteSchema LRO 的中繼資料。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteSchemaRequest

SchemaService.DeleteSchema 方法的要求訊息。

欄位

name

string

這是必要旗標，結構定義的完整資源名稱，格式為 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}。

DeleteSessionRequest

要求 DeleteSession 方法。

欄位

name

string

這是必要旗標，要刪除的 Session 資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

與 SiteSearchEngineService.DeleteSitemap 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteSitemapRequest

SiteSearchEngineService.DeleteSitemap 方法的要求訊息。

欄位

name

string

這是必要旗標，Sitemap 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}。

如果呼叫端沒有存取 Sitemap 的權限，無論該 Sitemap 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 Sitemap 不存在，系統會傳回 NOT_FOUND 錯誤。

DeleteTargetSiteMetadata

與 SiteSearchEngineService.DeleteTargetSite 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DeleteTargetSiteRequest

SiteSearchEngineService.DeleteTargetSite 方法的要求訊息。

欄位

name

string

這是必要旗標，TargetSite 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}。

如果呼叫端沒有存取 TargetSite 的權限，無論該 TargetSite 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 TargetSite 不存在，系統會傳回 NOT_FOUND 錯誤。

DestinationConfig

定義用於連線至第三方來源的目標端點。

欄位
`key`	`string` (選用步驟) 連接器支援的專屬目的地 ID。
`destinations[]`	`Destination` (選用步驟) 對應鍵的目的地。
聯集欄位 `destination_config_params`。這項目的地設定的其他參數。`destination_config_params` 只能是下列其中一項：
`params`	`Struct` (選用步驟) 這個目的地設定的額外參數，採用結構化 JSON 格式。
`json_params`	`string` 這個目的地設定的其他參數，格式為 JSON 字串。

目的地

定義目標端點

欄位

port

int32

(選用步驟) 目的地接受的目標通訊埠號碼。

聯集欄位 destination。端點目的地。destination 只能是下列其中一項：

host

string

可公開路由的主機。

DisableAdvancedSiteSearchMetadata

與 SiteSearchEngineService.DisableAdvancedSiteSearch 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

DisableAdvancedSiteSearchRequest

SiteSearchEngineService.DisableAdvancedSiteSearch 方法的要求訊息。

欄位

site_search_engine

string

這是必要旗標，SiteSearchEngine 的完整資源名稱，例如 projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine。

DisableAdvancedSiteSearchResponse

這個類型沒有任何欄位。

SiteSearchEngineService.DisableAdvancedSiteSearch 方法的回應訊息。

文件

文件會擷取要推薦或搜尋的項目所有原始中繼資料資訊。

欄位
`name`	`string` 不可變動。文件的完整資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
`id`	`string` 不可變動。文件的 ID。 ID 應符合 RFC-1034 標準，長度上限為 128 個字元。
`schema_id`	`string` 位於相同資料存放區的結構定義 ID。
`content`	`Content` 與這份文件連結的非結構化資料。如果這份文件位於 `CONTENT_REQUIRED` 資料儲存庫中，就只能設定內容，且必須設定內容。
`parent_document_id`	`string` 父項文件的 ID。目前最多支援兩層文件階層。 ID 應符合 RFC-1034 標準，長度上限為 63 個字元。
`derived_struct_data`	`Struct` 僅供輸出。這個欄位為 OUTPUT_ONLY。當中包含原始輸入文件中沒有的衍生資料。
`acl_info`	`AclInfo` 文件的存取權控管資訊。
`index_time`	`Timestamp` 僅供輸出。文件上次編入索引的時間。如果設定這個欄位，文件可能會顯示在搜尋結果中。這個欄位為 OUTPUT_ONLY。如果這個欄位未填入任何內容，表示文件從未編入索引。
`index_status`	`IndexStatus` 僅供輸出。文件的索引狀態。如果文件編入索引成功，系統會填入 index_time 欄位。否則，如果文件因錯誤而未編入索引，系統會填入 error_samples 欄位。否則，如果文件索引正在進行中，系統會填入 pending_message 欄位。
聯集欄位 `data`。資料顯示。請提供 `struct_data` 或 `json_data` 其中一個，否則系統會擲回 `INVALID_ARGUMENT` 錯誤。`data` 只能是下列其中一項：
`struct_data`	`Struct` 文件的結構化 JSON 資料。這項屬性應符合已註冊的 `Schema`，否則會擲回 `INVALID_ARGUMENT` 錯誤。
`json_data`	`string` 文件的 JSON 字串表示法。這項屬性應符合已註冊的 `Schema`，否則會擲回 `INVALID_ARGUMENT` 錯誤。

AclInfo

文件的 ACL 資訊。

欄位

readers[]

AccessRestriction

文件的讀取者。

AccessRestriction

AclRestriction，用於限制複雜的繼承限制。

範例：模擬「Both Permit」繼承，使用者必須有上層文件的存取權，才能存取子項文件。

文件階層 - Space_S --> Page_P。

讀者：Space_S：group_1、user_1；Page_P：group_2、group_3、user_2

Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

欄位

principals[]

Principal

主體清單。

idp_wide

bool

識別資訊提供者中的所有使用者。

內容

與這份文件連結的非結構化資料。

欄位
`mime_type`	`string` 內容的 MIME 類型。支援的類型： `application/pdf` (PDF，目前僅支援原生 PDF) `text/html` (HTML) `text/plain` (TXT) `application/xml` 或 `text/xml` (XML) `application/json` (JSON) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) 只有在資料儲存庫中啟用版面配置剖析器時，才支援下列類型： `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) 請參閱 https://www.iana.org/assignments/media-types/media-types.xhtml。
聯集欄位 `content`。非結構化文件的內容。`content` 只能是下列其中一項：
`raw_bytes`	`bytes` 以位元組串流表示的內容。長度上限為 1,000,000 個位元組 (1 MB / 約 0.95 MiB)。注意：與所有 `bytes` 欄位一樣，這個欄位在 Protocol Buffers 中會以純二進位表示，在 JSON 中則會以 Base64 編碼字串表示。舉例來說，`abc123!?$*&()'-=@~` 在 JSON 中應表示為 `YWJjMTIzIT8kKiYoKSctPUB+`。請參閱 https://developers.google.com/protocol-buffers/docs/proto3#json。
`uri`	`string` 內容的 URI。僅支援 Cloud Storage URI (例如 `gs://bucket-name/path/to/file`)。文字格式的檔案大小上限為 2.5 MB，其他格式則為 200 MB。

IndexStatus

文件的索引狀態。

欄位

index_time

文件編入索引的時間。如果這個欄位已填入資料，表示文件已編入索引。

error_samples[]

LayoutBasedChunkingConfig

索引文件時發生錯誤的範例。如果這個欄位已填入資料，表示文件因發生錯誤而未編入索引。

pending_message

string

不可變動。訊息會顯示文件索引正在建立中。如果填入這個欄位，表示文件索引尚待處理。

DocumentInfo

與使用者事件相關聯的詳細文件資訊。

欄位
`promotion_ids[]`	`string` 與這份文件相關聯的促銷活動 ID。目前這個欄位最多只能有一個 ID。
`joined`	`bool` 僅供輸出。參照的文件是否位於資料儲存庫中。
聯集欄位 `document_descriptor`。相關 `Document` 的必要描述元。如果指定 `id`，使用儲存的 Document 進行註解時，系統會使用 `{location}`、`{collection_id}`、`{data_store_id}` 和 `{branch_id}` 的預設值。如果指定 `name`，系統會在以儲存的 Document 進行註解時，使用 `{location}`、`{collection_id}`、`{data_store_id}` 和 `{branch_id}` 的提供值 (允許預設值)。`document_descriptor` 只能是下列其中一項：
`id`	`string` `Document` 資源 ID。
`name`	`string` `Document` 資源完整名稱，格式為：`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` `Document` URI - 僅適用於網站資料儲存庫。
`quantity`	`int32` 與使用者事件相關聯的文件數量。預設值為 1。舉例來說，如果 `add-to-cart` 事件涉及兩個相同文件的數量，這個欄位的值就是 2。下列事件類型必須提供這項資訊： `add-to-cart` `purchase`
`conversion_value`	`float` (選用步驟) 與這份文件相關聯的轉換價值。如果 `UserEvent.event_type` 為「conversion」，則必須設定。舉例來說，如果值為 1000，表示使用者觀看「文件」`watch`轉換類型所花的時間為 1000 秒。

DocumentProcessingConfig

DataStore 的單例資源。如果建立 DataStore 時為空白，且 DataStore 設為 DataStore.ContentConfig.CONTENT_REQUIRED，預設剖析器會預設為數位剖析器。

欄位
`name`	`string` Document Processing Config 的完整資源名稱。格式：`projects//locations//collections//dataStores//documentProcessingConfig`。
`chunking_config`	`ChunkingConfig` 是否啟用分塊模式。
`default_parsing_config`	`ParsingConfig` 預設文件剖析器的設定。如未指定，系統會將其設為預設的 DigitalParsingConfig，並將預設的剖析設定套用至文件剖析的所有檔案類型。
`parsing_config_overrides`	`map<string, ParsingConfig>` 根據檔案類型對應，覆寫預設的剖析設定。支援的索引鍵： `pdf`：覆寫 PDF 檔案的剖析設定，支援數位剖析、OCR 剖析或版面配置剖析。 `html`：覆寫 HTML 檔案的剖析設定，僅支援數位剖析和版面配置剖析。 `docx`：覆寫 DOCX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。 `pptx`：覆寫 PPTX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。 `xlsm`：覆寫 XLSM 檔案的剖析設定，僅支援數位剖析和版面配置剖析。 `xlsx`：覆寫 XLSX 檔案的剖析設定，僅支援數位剖析和版面配置剖析。

ChunkingConfig

區塊設定的設定。

欄位

聯集欄位 chunk_mode。定義分塊行為的其他設定。chunk_mode 只能是下列其中一項：

layout_based_chunking_config

根據版面配置分塊的設定。

LayoutBasedChunkingConfig

根據版面配置分塊的設定。

欄位

chunk_size

int32

每個區塊的權杖大小上限。

支援的值：100 到 500 (含)。預設值為 500。

include_ancestor_headings

bool

是否要將不同層級的標題附加至文件中間的分塊，以免遺失脈絡。

預設值為 False。

ParsingConfig

套用至特定類型文件剖析器的相關設定。

欄位
聯集欄位 `type_dedicated_config`。文件處理類型設定。`type_dedicated_config` 只能是下列其中一項：
`digital_parsing_config`	`DigitalParsingConfig` 套用至數位剖析器的設定。
`ocr_parsing_config`	`OcrParsingConfig` 已套用至 OCR 剖析器的設定。目前僅適用於 PDF 檔案。
`layout_parsing_config`	`LayoutParsingConfig` 套用至版面配置剖析器的設定。

DigitalParsingConfig

這個類型沒有任何欄位。

文件的數位剖析設定。

LayoutParsingConfig

文件的版面配置剖析設定。

欄位
`enable_table_annotation`	`bool` (選用步驟) 如果設為 true，系統會在剖析期間，將 LLM 註解加到表格。
`enable_image_annotation`	`bool` (選用步驟) 如果設為 true，系統會在剖析期間，將 LLM 註解加到圖片。
`structured_content_types[]`	`string` (選用步驟) 包含要從文件中擷取的必要結構類型。支援的值： `shareholder-structure`
`exclude_html_elements[]`	`string` (選用步驟) 要從剖析內容中排除的 HTML 元素清單。
`exclude_html_classes[]`	`string` (選用步驟) 要從剖析內容中排除的 HTML 類別清單。
`exclude_html_ids[]`	`string` (選用步驟) 要從剖析內容中排除的 HTML ID 清單。
`enable_get_processed_document`	`bool` (選用步驟) 如為 true，系統會透過 GetProcessedDocument API 提供處理後的文件。

OcrParsingConfig

文件的 OCR 剖析設定。

欄位

enhanced_document_elements[]
(deprecated)

string

[已淘汰] 這個欄位已淘汰，如要使用額外的強化文件元素處理功能，請切換至 layout_parsing_config。

use_native_text

bool

如果設為 true，系統會使用原生文字，而非含有原生文字的網頁上的 OCR 文字。

DoubleList

雙清單。

欄位

values[]

double

雙重值。

EnableAdvancedSiteSearchMetadata

與 SiteSearchEngineService.EnableAdvancedSiteSearch 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

RecommendedForYouFeatureConfig

作業上次更新時間。如果作業已完成，這也是完成時間。

EnableAdvancedSiteSearchRequest

SiteSearchEngineService.EnableAdvancedSiteSearch 方法的要求訊息。

欄位

site_search_engine

string

這是必要旗標，SiteSearchEngine 的完整資源名稱，例如 projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine。

EnableAdvancedSiteSearchResponse

這個類型沒有任何欄位。

SiteSearchEngineService.EnableAdvancedSiteSearch 方法的回應訊息。

引擎

描述 Engine 訓練和服務參數的中繼資料。

欄位
`name`	`string` 不可變動。ID。引擎的完整資源名稱。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` 引擎長度應為 1 至 63 個字元，有效字元為 /[a-z0-9][a-z0-9-_]*/。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`display_name`	`string` 這是必要旗標，引擎的顯示名稱。應為人類可讀的格式。採用 UTF-8 編碼的字串，最多 1024 個字元。
`create_time`	`Timestamp` 僅供輸出。建立建議引擎的時間戳記。
`update_time`	`Timestamp` 僅供輸出。上次更新 Recommendation Engine 的時間戳記。
`data_store_ids[]`	`string` (選用步驟) 與這個引擎相關聯的資料儲存庫。 `SOLUTION_TYPE_SEARCH` 和 `SOLUTION_TYPE_RECOMMENDATION` 類型的引擎最多只能與一個資料儲存庫建立關聯。如果 `solution_type` 為 `SOLUTION_TYPE_CHAT`，則可在此處建立同一 `Collection` 中多個 `DataStore` 的關聯。請注意，在 `CreateEngineRequest` 中使用時，必須提供一個 DataStore ID，系統會使用該 ID 進行必要的初始化作業。
`solution_type`	`SolutionType` 這是必要旗標，引擎的解決方案。
`industry_vertical`	`IndustryVertical` (選用步驟) 引擎註冊的產業別。引擎產業類別的限制依據 `DataStore` 而定：引擎上的產業類別必須與連結至引擎的 DataStore 產業類別相符。
`common_config`	`CommonConfig` 指定引擎中繼資料的通用設定規格。
`app_type`	`AppType` (選用步驟) 不可變動。這是這個引擎資源代表的應用程式類型。注意：這是與現有產業垂直或解決方案類型無關的新概念。
`disable_analytics`	`bool` (選用步驟) 是否要停用透過這個引擎執行的搜尋分析。
`features`	`map<string, FeatureState>` (選用步驟) 引擎的功能設定，可選擇啟用或停用功能。支援的索引鍵： `*`：所有功能 (如有)，系統會忽略所有其他功能狀態設定。 `agent-gallery` `no-code-agent-builder` `prompt-gallery` `model-selector` `notebook-lm` `people-search` `people-search-org-chart` `bi-directional-audio` `feedback` `session-sharing` `personalization-memory` `disable-agent-sharing` `disable-image-generation` `disable-video-generation` `disable-onedrive-upload` `disable-talk-to-content` `disable-google-drive-upload`
`configurable_billing_approach`	`ConfigurableBillingApproach` (選用步驟) 可設定的帳單方式設定。
聯集欄位 `engine_config`。定義引擎行為的其他設定規格。`engine_config` 只能是下列其中一項：
`chat_engine_config`	`ChatEngineConfig` Chat Engine 的設定。只有在 `solution_type` 為 `SOLUTION_TYPE_CHAT` 時才適用。
`search_engine_config`	`SearchEngineConfig` 搜尋引擎的設定。只有在 `solution_type` 為 `SOLUTION_TYPE_SEARCH` 時才適用。
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` 媒體引擎的設定。僅適用於具有 `solution_type` `SOLUTION_TYPE_RECOMMENDATION` 和 `IndustryVertical.MEDIA` 垂直的資料儲存庫。
聯集欄位 `engine_metadata`。引擎中繼資料，可監控引擎狀態。`engine_metadata` 只能是下列其中一項：
`chat_engine_metadata`	`ChatEngineMetadata` 僅供輸出。Chat Engine 的其他資訊。只有在 `solution_type` 為 `SOLUTION_TYPE_CHAT` 時才適用。

AppType

引擎的應用程式。

列舉
`APP_TYPE_UNSPECIFIED`	所有未指定的應用程式。
`APP_TYPE_INTRANET`	適用於內部網路搜尋和 Agentspace 的應用程式類型。

ChatEngineConfig

Chat Engine 的設定。

欄位

agent_creation_config

AgentCreationConfig

用來產生與這個引擎相關聯的 Dialogflow 虛擬服務專員。

請注意，這些設定只會由 Dialogflow 服務使用一次，並傳遞給該服務。也就是說，引擎建立後，就無法使用 EngineService.GetEngine 或 EngineService.ListEngines API 擷取這些資料。

dialogflow_agent_to_link

string

要連結至這個 Chat Engine 的現有 Dialogflow 虛擬服務專員資源名稱。客戶可以提供 agent_creation_config 來建立代理程式，也可以提供代理程式名稱，將代理程式連結至 Chat 引擎。

格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。

請注意，dialogflow_agent_to_link 會由 Dialogflow 服務一次性使用並傳遞。也就是說，引擎建立後，就無法使用 EngineService.GetEngine 或 EngineService.ListEngines API 擷取這些資料。建立引擎後，請使用 ChatEngineMetadata.dialogflow_agent 建立實際的代理關聯。

allow_cross_region

bool

(選用步驟) 如果旗標設為 true，我們允許代理程式和引擎位於不同位置，否則代理程式和引擎必須位於相同位置。這項標記預設為 false。

請注意，allow_cross_region 會由 EngineService.CreateEngine 消耗並傳遞至 EngineService.CreateEngine，且只能使用一次。也就是說，引擎建立後，就無法使用 EngineService.GetEngine 或 EngineService.ListEngines API 擷取這些資料。

AgentCreationConfig

生成 Dialogflow 虛擬服務專員的設定。

欄位
`business`	`string` 代理人代表的公司、機構或其他實體名稱。用於知識連接器 LLM 提示和知識搜尋。
`default_language_code`	`string` 這是必要旗標，代理程式的預設語言，以語言標記表示。如需目前支援的語言代碼清單，請參閱語言支援一文。
`time_zone`	`string` 這是必要旗標，代理程式的時區 (來自時區資料庫)，例如 America/New_York、Europe/Paris。
`location`	`string` 建立代理程式時的代理程式位置，支援的值為：global/us/eu。如未提供，美國引擎預設會使用 us-central-1 建立代理程式；歐盟引擎預設會使用 eu-west-1 建立代理程式。

ChatEngineMetadata

Chat Engine 的額外資訊。這個訊息中的欄位僅供輸出。

欄位

dialogflow_agent

string

Chat Engine 參照的 Dialogflow 虛擬服務專員資源名稱。

格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。

CommonConfig

引擎的常見設定。

欄位

company_name

string

與引擎相關聯的公司、商家或實體名稱。設定這項資訊有助於提升 LLM 相關功能。

ConfigurableBillingApproach

可設定的帳單方式設定。

列舉
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	預設值。適用於 Spark 和非 Spark 的不可設定帳單方式。一般定價模式。
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	帳單結算方式會依據客戶指定的設定。

FeatureState

引擎的特徵狀態。

列舉
`FEATURE_STATE_UNSPECIFIED`	未指定功能狀態。
`FEATURE_STATE_ON`	這項功能已開啟，因此可供存取。
`FEATURE_STATE_OFF`	這項功能已關閉，因此無法存取。

MediaRecommendationEngineConfig

媒體推薦引擎的其他設定規格。

欄位
`type`	`string` 這是必要旗標，引擎類型，例如`recommended-for-you`。這個欄位和 `optimization_objective` 會說明用來控管引擎訓練和服務的引擎中繼資料。目前支援的值：`recommended-for-you`、`others-you-may-like`、`more-like-this`、`most-popular-items`。
`optimization_objective`	`string` 最佳化目標，例如`cvr`。這個欄位和 `optimization_objective` 會說明用來控管引擎訓練和服務的引擎中繼資料。目前支援的值：`ctr`、`cvr`。如未指定，我們會根據引擎類型選擇預設值。預設值取決於最佳化建議類型： `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` 轉換率最佳化目標的自訂門檻名稱和值。如果是 target_field `watch-time`，target_field_value 必須是介於 (0, 86400] 之間的整數值，表示媒體進度時間 (以秒為單位)，例如 90)。如果是 target_field `watch-percentage`，target_field_value 必須是介於 (0, 1.0] 的有效浮點值 (不含 0，含 1.0)，例如 0.5)。
`training_state`	`TrainingState` 引擎的訓練狀態 (例如 `TRAINING` 或 `PAUSED`)。因為執行服務的部分費用取決於訓練頻率，因此可用於決定何時訓練引擎，以控管成本。如未指定：`CreateEngine` 方法的預設值為 `TRAINING`。`UpdateEngine` 方法的預設值是維持先前的狀態。
`engine_features_config`	`EngineFeaturesConfig` (選用步驟) 其他引擎功能設定。

EngineFeaturesConfig

所選引擎類型的更多功能設定。

欄位

聯集欄位 type_dedicated_config。套用至特定類型媒體建議引擎的功能相關設定。type_dedicated_config 只能是下列其中一項：

recommended_for_you_config

建議您使用引擎功能設定。

most_popular_config

MostPopularFeatureConfig

最熱門的引擎功能設定。

MostPopularFeatureConfig

建立「最受歡迎」引擎時必須進行的功能設定。

欄位

time_window_days

int64

引擎在訓練和預測期間接受查詢的時間範圍。只能使用正整數。這個值會轉換為過去 X 天的事件。目前是 most-popular-items 引擎的必要項目。

OptimizationObjectiveConfig

cvr 最佳化目標的自訂門檻。

欄位

target_field

string

這是必要旗標，要指定目標的欄位名稱。目前支援的值：watch-percentage、watch-time。

target_field_value_float

float

這是必要旗標，要套用至目標的門檻 (例如0.5)。

RecommendedForYouFeatureConfig

建立 recommended-for-you 引擎的其他功能設定。

欄位

context_event_type

string

引擎在預測時查詢的事件類型。如果設為 generic，則只會使用 view-item、media-play 和 media-complete 做為引擎訓練中的 context-event。如果設為 view-home-page，除了 view-item、media-play 和 media-complete 之外，view-home-page 也會做為 context-events 使用。目前支援 recommended-for-you 引擎。目前支援的值：view-home-page、generic。

TrainingState

引擎的訓練狀態。

列舉
`TRAINING_STATE_UNSPECIFIED`	未指定訓練狀態。
`PAUSED`	引擎訓練已暫停。
`TRAINING`	引擎正在訓練。

SearchEngineConfig

搜尋引擎的設定。

欄位

search_tier

SearchTier

這個引擎的搜尋功能層級。

不同層級的價格可能不同。詳情請參閱定價說明文件。

如未指定，則預設值為 SearchTier.SEARCH_TIER_STANDARD。

search_add_ons[]

SearchAddOn

這個搜尋引擎啟用的外掛程式。

FactChunk

事實區塊。

欄位
`chunk_text`	`string` 事實區塊的文字內容。長度上限為 1 萬個字元。
`source`	`string` 擷取事實區塊的來源。如果這是從要求中提供的 GroundingFacts 擷取，這個欄位會包含擷取這個區塊的特定事實索引。
`index`	`int32` 這個區塊的索引。目前僅適用於串流模式。
`source_metadata`	`map<string, string>` 來源參照的更精細資訊。
`uri`	`string` 來源的 URI。
`title`	`string` 來源的標題。
`domain`	`string` 來源網域。

FetchDomainVerificationStatusRequest

SiteSearchEngineService.FetchDomainVerificationStatus 方法的要求訊息。

欄位

site_search_engine

string

這是必要旗標，我們會從這個網站搜尋引擎資源擷取所有網域驗證狀態。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

page_size

int32

要求的頁面大小。伺服器傳回的項目數量可能會少於要求數量。如未指定，伺服器會挑選適當的預設值。許可的最大值為 1000；超出的數值將一律指定為 1000。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。

page_token

string

屬於接收自前一個 FetchDomainVerificationStatus 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 FetchDomainVerificationStatus 的所有其他參數須與提供網頁權杖的呼叫相符。

FetchDomainVerificationStatusResponse

SiteSearchEngineService.FetchDomainVerificationStatus 方法的回應訊息。

欄位

target_sites[]

TargetSite 清單，內含網站驗證狀態。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

total_size

int32

符合要求的項目總數。回覆中一律會填入這項資料。

FetchSitemapsRequest

SiteSearchEngineService.FetchSitemaps 方法的要求訊息。

欄位

parent

string

這是必要旗標，SiteSearchEngine 的父項資源名稱，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。

matcher

Matcher

(選用步驟) 如果指定，則會擷取相符的 Sitemap。如未指定，則會擷取 DataStore 中的所有 Sitemap。

Matcher

Sitemap 的比對工具。目前僅支援 URI 比對器。

欄位

聯集欄位 matcher。Sitemap 的比對工具。matcher 只能是下列其中一項：

uris_matcher

UrisMatcher

依 Sitemap URI 比對。

UrisMatcher

依 URI 比對 Sitemap。

欄位

uris[]

string

Sitemap URI。

FetchSitemapsResponse

SiteSearchEngineService.FetchSitemaps 方法的回應訊息。

欄位

sitemaps_metadata[]

SitemapMetadata

擷取的 Sitemap 清單。

SitemapMetadata

包含 Sitemap 和中繼資料。

欄位

sitemap

Sitemap

Sitemap。

FhirStoreSource

要從中匯入資料的 Cloud FhirStore 來源。

欄位
`fhir_store`	`string` 這是必要旗標，要匯入資料的 FHIR 儲存庫完整資源名稱，格式為 `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`。
`gcs_staging_dir`	`string` 要用於匯入作業的中介 Cloud Storage 目錄，長度上限為 2,000 個字元。如要將 FhirStore 內容匯出至特定 Cloud Storage 目錄，即可指定這項設定。
`resource_types[]`	`string` 要匯入的 FHIR 資源類型。資源類型應為所有支援的 FHIR 資源類型的子集。如果留空，預設為所有支援的 FHIR 資源類型。
`update_from_latest_predefined_schema`	`bool` (選用步驟) 是否將 DataStore 結構定義更新為最新的預先定義結構定義。如果為 true，DataStore 架構會更新，納入上次匯入後新增的任何 FHIR 欄位或資源類型，並從 FHIR 儲存庫匯入對應的 FHIR 資源。請注意，這個欄位無法與 `resource_types` 搭配使用。請在初次匯入後使用。

FirestoreSource

要從中匯入資料的 Firestore 來源。

欄位
`project_id`	`string` Cloud SQL 來源所在的專案 ID，長度限制為 128 個字元。如未指定，則會沿用父項要求的專案 ID。
`database_id`	`string` 這是必要旗標，要從中複製資料的 Firestore 資料庫，長度上限為 256 個半形字元。
`collection_id`	`string` 這是必要旗標，要複製資料的 Firestore 集合 (或實體)，長度上限為 1,500 個字元。
`gcs_staging_dir`	`string` 要用於匯入作業的中介 Cloud Storage 目錄，長度上限為 2,000 個字元。如要將 Firestore 內容匯入特定 Cloud Storage 目錄，即可指定這項設定。確認 Firestore 服務帳戶具備必要的 Cloud Storage 管理員權限，可存取指定的 Cloud Storage 目錄。

GcsSource

輸入內容的 Cloud Storage 位置。

欄位

input_uris[]

string

這是必要旗標，輸入檔案的 Cloud Storage URI。每個 URI 的長度上限為 2000 個半形字元。URI 可以比對完整物件路徑 (例如 gs://bucket/directory/object.json)，也可以比對符合一或多個檔案的模式，例如 gs://bucket/directory/*.json。

每項要求最多可包含 100 個檔案 (如果 data_schema 為 content，則為 10 萬個檔案)。每個檔案的大小上限為 2 GB (如果 data_schema 為 content，則為 100 MB)。

data_schema

string

從來源剖析資料時所用的結構定義。

支援的文件匯入值：

document (預設)：每行一個 JSON Document。每份文件都必須有有效的 Document.id。
content：非結構化資料 (例如 PDF、HTML)。input_uris 比對到的每個檔案都會成為文件，ID 則設為 SHA256(URI) 的前 128 位元，並編碼為十六進位字串。
custom：每列一個自訂資料 JSON，格式任意，但須符合資料存放區的定義 Schema。這項功能僅適用於「一般資料儲存庫」類別。
csv：包含標頭的 CSV 檔案，標頭符合資料存放區的定義 Schema。標題後的每個項目都會匯入為文件。這項功能僅適用於「一般」資料儲存庫類別。

使用者事件匯入作業支援的值：

user_event (預設)：每行一個 JSON UserEvent。

GetAclConfigRequest

GetAclConfigRequest 方法的要求訊息。

欄位

name

string

這是必要旗標，AclConfig 的資源名稱，例如 projects/*/locations/*/aclConfig。

如果呼叫端沒有存取 AclConfig 的權限，無論該 AclConfig 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

GetAnswerRequest

GetAnswer 方法的要求。

欄位

name

string

這是必要旗標，要取得的答案資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

AssistAnswerService.GetAssistAnswer 方法的要求訊息。

欄位

name

string

這是必要旗標，AssistAnswer 的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

AssistantService.GetAssistant 方法的要求訊息。

欄位

name

string

這是必要旗標，Assistant 的資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

GetCmekConfigRequest 方法的要求訊息。

欄位

name

string

這是必要旗標，CmekConfig 的資源名稱，例如 projects/*/locations/*/cmekConfig 或 projects/*/locations/*/cmekConfigs/*。

如果呼叫端沒有存取 CmekConfig 的權限，無論該 CmekConfig 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

GetControlRequest

GetControl 方法的要求。

欄位

name

string

這是必要旗標，要取得的控制項資源名稱。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

針對 GetConversation 方法的要求。

欄位

name

string

這是必要旗標，要取得的對話資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

要求 DataConnectorService.GetDataConnector 方法。

欄位

name

string

這是必要旗標，DataConnector 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataConnector。

如果呼叫端沒有存取 DataConnector 的權限，無論該 DataConnector 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 DataConnector 不存在，系統會傳回 NOT_FOUND 錯誤。

GetDataStoreRequest

DataStoreService.GetDataStore 方法的要求訊息。

欄位

name

string

這是必要旗標，DataStore 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。

如果呼叫端沒有存取 DataStore 的權限，無論該 DataStore 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 DataStore 不存在，系統會傳回 NOT_FOUND 錯誤。

GetDocumentRequest

DocumentService.GetDocument 方法的要求訊息。

欄位

name

string

這是必要旗標，Document 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}。

如果呼叫者沒有存取 Document 的權限 (無論該 Document 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 Document 不存在，系統會傳回 NOT_FOUND 錯誤。

GetEngineRequest

EngineService.GetEngine 方法的要求訊息。

欄位

name

string

這是必要旗標，Engine 的完整資源名稱，例如 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。

GetIdentityMappingStoreRequest

IdentityMappingStoreService.GetIdentityMappingStore 的要求訊息

欄位

name

string

這是必要旗標，要取得的 ID 對應商店名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

LicenseConfigService.GetLicenseConfig 方法的要求訊息。

欄位

name

string

這是必要旗標，LicenseConfig 的完整資源名稱，例如 projects/{project}/locations/{location}/licenseConfigs/*。

如果呼叫端沒有存取 LicenseConfig 的權限，無論該 LicenseConfig 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 LicenseConfig 不存在，系統會傳回 NOT_FOUND 錯誤。

GetSchemaRequest

SchemaService.GetSchema 方法的要求訊息。

欄位

name

string

這是必要旗標，結構定義的完整資源名稱，格式為 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}。

GetSessionRequest

GetSession 方法的要求。

欄位

name

string

這是必要旗標，要取得的 Session 資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

(選用步驟) 如果設為 True，系統會傳回完整工作階段，包括所有答案詳細資料。

GetSiteSearchEngineRequest

SiteSearchEngineService.GetSiteSearchEngine 方法的要求訊息。

欄位

name

string

這是必要旗標，SiteSearchEngine 的資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

如果呼叫端沒有權限存取 [SiteSearchEngine]，無論該項目是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

GetTargetSiteRequest

SiteSearchEngineService.GetTargetSite 方法的要求訊息。

欄位

name

string

如果呼叫端沒有存取 TargetSite 的權限，無論該 TargetSite 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要求的 TargetSite 不存在，系統會傳回 NOT_FOUND 錯誤。

GroundingFact

依據事實。

欄位

fact_text

string

事實的文字內容。長度上限為 1 萬個字元。

attributes

map<string, string>

與事實相關聯的屬性。常見屬性包括 source (指出事實的來源)、author (指出事實的作者) 等。

HarmCategory

會封鎖內容的危害類別。

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

HealthcareFhirConfig

設定 HEALTHCARE_FHIR 垂直領域的資料儲存庫。

欄位

enable_configurable_schema

bool

是否要為 HEALTHCARE_FHIR 垂直啟用可設定的結構定義。

如果設為 true，即可擴充預先定義的醫療照護 FHIR 結構定義，進一步自訂搜尋和篩選條件。

enable_static_indexing_for_batch_ingestion

bool

是否要為 HEALTHCARE_FHIR 批次擷取啟用靜態索引。

如果設為 true，系統會以靜態索引模式處理批次擷取作業，雖然速度較慢，但能處理較大的資料量。

IdentityMappingEntry

將外部身分對應至內部身分的識別資訊對應項目。

欄位
`external_identity`	`string` 這是必要旗標，客戶身分識別資訊提供者以外的身分。外部身分識別的長度上限為 100 個字元。
聯集欄位 `identity_provider_id`。聯集欄位 identity_provider_id。身分識別提供者 ID 可以是使用者或群組。`identity_provider_id` 只能是下列其中一項：
`user_id`	`string` 使用者 ID。如果是 Google Workspace 使用者帳戶，user_id 應為 Google Workspace 使用者電子郵件地址。如果是 Google 以外的識別資訊提供者，user_id 是在工作團隊集區設定期間設定的對應使用者 ID。
`group_id`	`string` 群組 ID。如果是 Google Workspace 使用者帳戶，group_id 應為 Google Workspace 群組電子郵件地址。如果是 Google 以外的識別資訊提供者，group_id 是在 workforcepool 設定期間設定的對應群組 ID。

IdentityMappingEntryOperationMetadata

IdentityMappingStoreService.ImportIdentityMappings 和 IdentityMappingStoreService.PurgeIdentityMappings 的 IdentityMappingEntry LongRunningOperation 中繼資料

欄位

success_count

int64

成功處理的 IdentityMappingEntry 數量。

failure_count

int64

無法處理的 IdentityMappingEntry 數量。

total_count

int64

已處理的 IdentityMappingEntry 總數。

IdentityMappingStore

識別資訊對應檔儲存區，內含識別資訊對應檔項目。

欄位

name

string

不可變動。身分對應商店的完整資源名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。

kms_key_name

string

僅限輸入。用於在建立時保護這個身分對應儲存區的 KMS 金鑰。

如果要求必須遵守 CMEK 機構政策保護措施，則必須設定這項參數。

如果這個欄位已設定並順利處理，身分對應儲存區就會受到 KMS 金鑰保護，如 cmek_config 欄位所示。

cmek_config

CmekConfig

僅供輸出。身分對應儲存區的 CMEK 相關資訊。

IdentityScheduleConfig

身分資料同步處理作業的設定。

欄位

refresh_interval

Duration

(選用步驟) 這個連接器擷取的文件會以這個間隔時間同步處理存取控制清單資訊。如未設定，存取控制清單會以 30 分鐘的預設間隔重新整理。身分識別資訊的重新整理間隔最短為 30 分鐘，最長為 7 天。

next_sync_time

DateTime

(選用步驟) 資料連接器預計開始下次資料同步處理作業的世界標準時間。客戶只能指定排定資料同步處理作業的小時和分鐘。如果資料連接器的重新整理間隔超過 1 天，系統就會使用這項功能。

IdpConfig

識別資訊提供者設定

欄位

idp_type

IdpType

已設定識別資訊提供者類型。

external_idp_config

ExternalIdpConfig

外部識別資訊提供者設定。

ExternalIdpConfig

第三方 IDP 設定。

欄位

workforce_pool_name

string

工作團隊集區名稱。範例：「locations/global/workforcePools/pool_id」

IdpType

識別資訊提供者類型。

列舉
`IDP_TYPE_UNSPECIFIED`	預設值。未啟用 ACL 搜尋功能。
`GSUITE`	Google 第一方供應商。
`THIRD_PARTY`	第三方供應商。

ImportCompletionSuggestionsMetadata

與 ImportCompletionSuggestions 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功匯入的 `CompletionSuggestion` 數量。
`failure_count`	`int64` 無法匯入的 `CompletionSuggestion` 數量。

ImportCompletionSuggestionsRequest

CompletionService.ImportCompletionSuggestions 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，要匯入客戶自動完成建議的父項資料儲存庫資源名稱。符合 `projects//locations//collections//dataStores/` 模式
`error_config`	`ImportErrorConfig` 匯入期間發生錯誤的所需位置。
聯集欄位 `source`。自動完成建議的來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` 建議項目的 Inline 來源。
`gcs_source`	`GcsSource` 輸入內容的 Cloud Storage 位置。
`bigquery_source`	`BigQuerySource` BigQuery 輸入來源。

InlineSource

CompletionSuggestions 的內嵌來源。

欄位

suggestions[]

CompletionSuggestion

這是必要旗標，要匯入的所有拒絕清單項目清單。最多 1,000 個項目。

ImportCompletionSuggestionsResponse

CompletionService.ImportCompletionSuggestions 方法的回應。如果長時間執行的作業完成，且作業成功，google.longrunning.Operations.response 欄位會傳回這則訊息。

欄位

error_samples[]

處理要求時發生的錯誤範例。

error_config

ImportErrorConfig

匯入期間發生錯誤的所需位置。

ImportDocumentsMetadata

與 ImportDocuments 作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功處理的項目數量。
`failure_count`	`int64` 處理時發生錯誤的項目數。
`total_count`	`int64` 處理的項目總數。

ImportDocumentsRequest

匯入方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項分支資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`。需要建立/更新權限。
`error_config`	`ImportErrorConfig` 匯入期間發生錯誤的所需位置。
`reconciliation_mode`	`ReconciliationMode` 現有文件與待匯入文件之間的對帳模式。預設值為 `ReconciliationMode.INCREMENTAL`。
`update_mask`	`FieldMask` 指出要更新所匯入文件中的哪些欄位。如未設定，預設為更新所有欄位。
`auto_generate_ids`	`bool` 是否要在文件 ID 不存在時自動產生 ID。如果設為 `true`，系統會根據酬載的雜湊自動產生 `Document.id`，因此多次匯入時 ID 可能不一致。在這種情況下，我們強烈建議使用 `ReconciliationMode.FULL`，以免內容重複。如未設定或設為 `false`，則必須使用 `id_field` 指定 `Document.id`，否則系統無法匯入沒有 ID 的文件。支援的資料來源： `GcsSource`。`GcsSource.data_schema` 必須為 `custom` 或 `csv`。否則會擲回 INVALID_ARGUMENT 錯誤。 `BigQuerySource`。`BigQuerySource.data_schema` 必須為 `custom` 或 `csv`。否則會擲回 INVALID_ARGUMENT 錯誤。 `SpannerSource`。 `CloudSqlSource`。 `FirestoreSource`。 `BigtableSource`。
`id_field`	`string` 這個欄位會指出要當做文件專屬 ID 的 ID 欄位或資料欄。如果是 `GcsSource`，則為 JSON 欄位的鍵。舉例來說，JSON `{"my_id": "some_uuid"}` 的 `my_id`。如果是其他資料來源，則可能是儲存專屬 ID 的資料表欄名。 JSON 欄位或表格資料欄的值會做為 `Document.id`。JSON 欄位或資料表資料欄必須為字串類型，且值必須設為符合 RFC-1034 的有效字串，長度為 1 至 63 個字元。否則，系統將無法匯入沒有有效 ID 的文件。只有在 `auto_generate_ids` 未設定或設為 `false` 時，才設定這個欄位。否則會擲回 INVALID_ARGUMENT 錯誤。如未設定，從允許的資料來源匯入時，系統會使用預設值 `_id`。支援的資料來源： `GcsSource`。`GcsSource.data_schema` 必須為 `custom` 或 `csv`。否則會擲回 INVALID_ARGUMENT 錯誤。 `BigQuerySource`。`BigQuerySource.data_schema` 必須為 `custom` 或 `csv`。否則會擲回 INVALID_ARGUMENT 錯誤。 `SpannerSource`。 `CloudSqlSource`。 `BigtableSource`。
`force_refresh_content`	`bool` (選用步驟) 是否強制重新整理文件的非結構化內容。如果設為 `true`，系統會重新整理文件內容部分，無論參照內容的更新狀態為何。
聯集欄位 `source`。這是必要旗標，輸入內容的來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` 文件的輸入內容內嵌來源。
`gcs_source`	`GcsSource` 輸入內容的 Cloud Storage 位置。
`bigquery_source`	`BigQuerySource` BigQuery 輸入來源。
`fhir_store_source`	`FhirStoreSource` FhirStore 輸入來源。
`spanner_source`	`SpannerSource` Spanner 輸入來源。
`cloud_sql_source`	`CloudSqlSource` Cloud SQL 輸入來源。
`firestore_source`	`FirestoreSource` Firestore 輸入來源。
`alloy_db_source`	`AlloyDbSource` AlloyDB 輸入來源。
`bigtable_source`	`BigtableSource` Cloud Bigtable 輸入來源。

InlineSource

ImportDocuments 方法的輸入設定內嵌來源。

欄位

documents[]

這是必要旗標，要更新/建立的文件清單。每份文件都必須有有效的 Document.id。建議最多 100 個項目。

ReconciliationMode

指出如何將匯入的文件與先前建立或匯入的文件進行比對。

列舉
`RECONCILIATION_MODE_UNSPECIFIED`	預設值為 `INCREMENTAL`。
`INCREMENTAL`	插入新文件或更新現有文件。
`FULL`	計算差異並取代整個文件資料集。如果來源位置沒有現有文件，系統可能會刪除這些文件。使用這個模式時，目標資料集不會有任何停機時間。作業執行期間，所有應維持不變或應更新的文件都會繼續放送。

ImportDocumentsResponse

ImportDocumentsRequest 的回應。如果長時間執行的作業完成，且作業成功，則 google.longrunning.Operations.response 欄位會傳回這則訊息。

欄位

error_samples[]

處理要求時發生的錯誤範例。

error_config

ImportErrorConfig

如果已設定，則會將要求中的完整錯誤回傳至目的地。

ImportErrorConfig

設定匯入相關錯誤的目的地。

欄位

聯集欄位 destination。這是必要旗標，錯誤目的地。destination 只能是下列其中一項：

gcs_prefix

string

匯入錯誤的 Cloud Storage 前置字串。這個目錄必須是現有的空白 Cloud Storage 目錄。匯入錯誤會寫入這個目錄中的分片檔案，每行一個，並以 JSON 編碼的 google.rpc.Status 訊息形式呈現。

ImportIdentityMappingsRequest

IdentityMappingStoreService.ImportIdentityMappings 的要求訊息

欄位

identity_mapping_store

string

這是必要旗標，要匯入身分識別對應項目的身分識別對應商店名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

聯集欄位 source。輸入內容的來源。source 只能是下列其中一項：

inline_source

InlineSource

要從中匯入身分對應項目的內嵌來源。

InlineSource

要從中匯入身分對應項目的內嵌來源。

欄位

identity_mapping_entries[]

IdentityMappingEntry

一次最多可匯入 10,000 個項目

ImportIdentityMappingsResponse

對 IdentityMappingStoreService.ImportIdentityMappings 的回應訊息

欄位

error_samples[]

處理要求時發生的錯誤範例。

ImportSuggestionDenyListEntriesMetadata

與 ImportSuggestionDenyListEntries 作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

SuggestionDenyListEntry

作業上次更新時間。如果作業已完成，這也是完成時間。

ImportSuggestionDenyListEntriesRequest

CompletionService.ImportSuggestionDenyListEntries 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，要匯入拒絕清單項目的父項資料儲存庫資源名稱。格式為 projects//locations//collections//dataStores/。
聯集欄位 `source`。更新的 SuggestionDenyList 來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` 建議拒絕清單項目的輸入內容內嵌來源。
`gcs_source`	`GcsSource` 輸入內容的 Cloud Storage 位置。您只能指定 1 個檔案，其中包含要匯入的所有項目。自動完成建議拒絕清單項目匯入作業支援的值 `gcs_source.schema`： `suggestion_deny_list` (預設)：每行一個 JSON [SuggestionDenyListEntry]。

InlineSource

SuggestionDenyListEntry 的內嵌來源。

欄位

entries[]

這是必要旗標，要匯入的所有拒絕清單項目清單。最多 1,000 個項目。

ImportSuggestionDenyListEntriesResponse

CompletionService.ImportSuggestionDenyListEntries 方法的回應訊息。

欄位

error_samples[]

處理要求時發生的錯誤範例。

imported_entries_count

int64

成功匯入的拒絕清單項目數量。

failed_entries_count

int64

無法匯入的拒絕清單項目數量。

ImportUserEventsMetadata

與匯入作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功處理的項目數量。
`failure_count`	`int64` 處理時發生錯誤的項目數。

ImportUserEventsRequest

ImportUserEvents 要求的請求訊息。

欄位
`parent`	`string` 這是必要旗標，父項資料儲存庫資源名稱，格式為 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` 匯入期間發生錯誤的所需位置。無法為內嵌使用者事件匯入作業設定。
聯集欄位 `source`。必要 - 使用者事件資料的所需輸入來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` UserEvents 輸入內容的內嵌來源。
`gcs_source`	`GcsSource` 輸入內容的 Cloud Storage 位置。
`bigquery_source`	`BigQuerySource` BigQuery 輸入來源。

InlineSource

ImportUserEvents 方法的輸入設定內嵌來源。

欄位

user_events[]

UserEvent

這是必要旗標，要匯入的使用者事件清單。建議最多 1 萬個項目。

ImportUserEventsResponse

ImportUserEventsRequest 的回應。如果長時間執行的作業順利完成，google.longrunning.Operations.response 欄位會傳回這則訊息。

欄位
`error_samples[]`	`Status` 處理要求時發生的錯誤範例。
`error_config`	`ImportErrorConfig` 如果要求中已設定這個欄位，系統會將完整錯誤的目標回傳。
`joined_events_count`	`int64` 使用完整現有文件匯入的使用者事件計數。
`unjoined_events_count`	`int64` 匯入的使用者事件數量，但現有分支版本中找不到文件資訊。

IndustryVertical

與 DataStore 相關聯的產業別。

列舉
`INDUSTRY_VERTICAL_UNSPECIFIED`	未設定時使用的值。
`GENERIC`	適用於不屬於任何產業類別的文件。
`MEDIA`	媒體產業別。
`HEALTHCARE_FHIR`	醫療照護 FHIR 垂直領域。

時間間隔

浮點間隔。

欄位

聯集欄位 min。間隔的下限。如果未設定任何 min 欄位，下限為負無限大。

這個欄位不得大於最大值。否則，系統會傳回 INVALID_ARGUMENT 錯誤。min 只能是下列其中一項：

minimum

double

包含下限。

exclusive_minimum

double

不含下限。

聯集欄位 max。間隔的上限。如果未設定任一上限欄位，則上限為正無限大。

這個欄位不得小於最小值。否則，系統會傳回 INVALID_ARGUMENT 錯誤。max 只能是下列其中一項：

maximum

double

包含上限。

exclusive_maximum

double

上限 (不含)。

LicenseConfig

使用者的授權相關資訊。

欄位
`name`	`string` 不可變動。ID。授權設定的完整資源名稱。格式：`projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` 這是必要旗標，購買的授權數量。
`subscription_tier`	`SubscriptionTier` 這是必要旗標，授權設定的訂閱級別資訊。
`state`	`State` 僅供輸出。授權設定的狀態。
`auto_renew`	`bool` (選用步驟) 授權設定是否應在到期時自動續訂。
`start_date`	`Date` 這是必要旗標，開始日期。
`end_date`	`Date` (選用步驟) 預定結束日期。
`subscription_term`	`SubscriptionTerm` 這是必要旗標，訂閱約期。
`free_trial`	`bool` (選用步驟) 授權設定是否適用於免費試用。
`alert_policy_resource_config`	`AlertPolicyResourceConfig` (選用步驟) 這項授權設定的警告政策設定。
`gemini_bundle`	`bool` 僅供輸出。授權設定是否適用於 Gemini 套裝組合。

狀態

授權設定狀態列舉。

列舉
`STATE_UNSPECIFIED`	預設值。授權設定不存在。
`ACTIVE`	授權設定有效且正在使用中。
`EXPIRED`	授權設定已過期。
`NOT_STARTED`	授權設定尚未開始，開始日期為未來的時間。

ListAssistantsRequest

AssistantService.ListAssistants 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項資源名稱。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

要傳回的 Assistant 數量上限。如未指定，則預設為 100。允許的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

屬於接收自前一個 AssistantService.ListAssistants 呼叫的網頁權杖 ListAssistantsResponse.next_page_token。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListAssistants 的所有其他參數須與提供網頁權杖的呼叫相符。

ListAssistantsResponse

AssistantService.ListAssistants 方法的回應訊息。

欄位

assistants[]

Assistant

客戶的所有 Assistant。

next_page_token

string

可做為 ListAssistantsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListCmekConfigsRequest

CmekConfigService.ListCmekConfigs 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項位置資源名稱，例如 projects/{project}/locations/{location}。

如果呼叫者沒有列出這個位置下方 CmekConfig 的權限，無論 CmekConfig 是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

ListCmekConfigsResponse

CmekConfigService.ListCmekConfigs 方法的回應訊息。

欄位

cmek_configs[]

CmekConfig

客戶的所有 CmekConfig。

ListControlsRequest

ListControls 方法的要求。

欄位
`parent`	`string` 這是必要旗標，資料儲存庫資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` 或 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`。
`page_size`	`int32` (選用步驟) 一頁的結果數上限，如未指定，預設值為 50。允許的最大值為 1000。
`page_token`	`string` (選用步驟) 屬於接收自前一個 `ListControls` 呼叫的網頁權杖。提供此項目即可擷取後續網頁。
`filter`	`string` (選用步驟) 要套用至清單結果的篩選器。支援的功能：如果未設定 `filter`，則列出父項分支下的所有產品。目前不支援這個欄位。

ListControlsResponse

ListControls 方法的回應。

欄位

controls[]

Control

指定資料儲存庫的所有控制項。

next_page_token

string

分頁符記，如果未傳回，表示這是最後一頁。

ListConversationsRequest

ListConversations 方法的要求。

欄位
`parent`	`string` 這是必要旗標，資料儲存庫資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` 一頁的結果數上限，如未指定，預設值為 50。允許的最大值為 1000。
`page_token`	`string` 屬於接收自前一個 `ListConversations` 呼叫的網頁權杖。提供此項目即可擷取後續網頁。
`filter`	`string` 要套用至清單結果的篩選器。支援的功能包括：user_pseudo_id、state。範例：「user_pseudo_id = some_id」
`order_by`	`string` 以半形逗號分隔的欄位清單，用於排序 (遞增順序)。在欄位名稱後方使用「desc」表示遞減。支援的欄位： * `update_time` * `create_time` * `conversation_name` 例如：「update_time desc」、「create_time」

ListConversationsResponse

ListConversations 方法的回應。

欄位

conversations[]

特定資料儲存庫的所有對話。

next_page_token

string

分頁符記，如果未傳回，表示這是最後一頁。

ListCustomModelsRequest

SearchTuningService.ListCustomModels 方法的要求訊息。

欄位

data_store

string

這是必要旗標，父項資料儲存庫的資源名稱，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。這個欄位用於識別要從哪個資料儲存庫擷取模型。

ListCustomModelsResponse

SearchTuningService.ListCustomModels 方法的回應訊息。

欄位

models[]

CustomTuningModel

自訂調整後模型清單。

ListDataStoresRequest

DataStoreService.ListDataStores 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項分支資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection_id}`。如果呼叫者沒有權限列出這個位置下的 `DataStore`，無論這個資料儲存庫是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。
`page_size`	`int32` 要傳回的 `DataStore` 數量上限。如未指定，則預設值為 10。允許的最大值為 50。超過 50 的值會強制設為 50。如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT。
`page_token`	`string` 屬於接收自前一個 `DataStoreService.ListDataStores` 呼叫的網頁權杖 `ListDataStoresResponse.next_page_token`。提供此項目即可擷取後續網頁。進行分頁時，提供至 `DataStoreService.ListDataStores` 的所有其他參數須與提供網頁權杖的呼叫相符。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`filter`	`string` 依解決方案類型篩選。例如：`filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

DataStoreService.ListDataStores 方法的回應訊息。

欄位

data_stores[]

DataStore

客戶的所有 DataStore。

next_page_token

string

可做為 ListDataStoresRequest.page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListDocumentsRequest

DocumentService.ListDocuments 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項分支資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。使用 default_branch 做為分支 ID，列出預設分支下的文件。

如果呼叫者沒有權限列出這個分支下的 Document，無論這個分支是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

page_size

int32

要傳回的 Document 數量上限。如未指定，則預設為 100。允許的最大值為 1000。如果值超過 1000，系統會設為 1000。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。

page_token

string

屬於接收自前一個 DocumentService.ListDocuments 呼叫的網頁權杖 ListDocumentsResponse.next_page_token。提供此項目即可擷取後續網頁。

進行分頁時，提供至 DocumentService.ListDocuments 的所有其他參數須與提供網頁權杖的呼叫相符。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

ListDocumentsResponse

DocumentService.ListDocuments 方法的回應訊息。

欄位

documents[]

Document。

next_page_token

string

可做為 ListDocumentsRequest.page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListEnginesRequest

EngineService.ListEngines 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection_id}`。
`page_size`	`int32` (選用步驟) 不支援。
`page_token`	`string` (選用步驟) 不支援。
`filter`	`string` (選用步驟) 依解決方案類型篩選。例如：solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

EngineService.ListEngines 方法的回應訊息。

欄位

engines[]

Engine

客戶的所有 Engine。

next_page_token

string

不支援。

ListIdentityMappingStoresRequest

IdentityMappingStoreService.ListIdentityMappingStores 的要求訊息

欄位

parent

string

這是必要旗標，要列出的身分識別對應商店的上層項目。格式：projects/{project}/locations/{location}。

page_size

int32

要傳回的 IdentityMappingStore 數量上限。如未指定，則預設為 100。允許的最大值為 1000。超出的數值將一律指定為 1000。

page_token

string

屬於接收自前一個 ListIdentityMappingStores 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListIdentityMappingStores 的所有其他參數須與提供網頁權杖的呼叫相符。

ListIdentityMappingStoresResponse

對 IdentityMappingStoreService.ListIdentityMappingStores 的回應訊息

欄位

identity_mapping_stores[]

IdentityMappingStore

識別資訊對應檔商店。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListIdentityMappingsRequest

IdentityMappingStoreService.ListIdentityMappings 的要求訊息

欄位

identity_mapping_store

string

這是必要旗標，要列出識別資訊對應項目的識別資訊對應檔名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

要傳回的 IdentityMapping 數量上限。如未指定，則預設為 2000。允許的最大值為 10000。如果值超過 10000，系統會強制設為 10000。

page_token

string

屬於接收自前一個 ListIdentityMappings 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListIdentityMappings 的所有其他參數須與提供網頁權杖的呼叫相符。

ListIdentityMappingsResponse

對 IdentityMappingStoreService.ListIdentityMappings 的回應訊息

欄位

identity_mapping_entries[]

IdentityMappingEntry

識別資訊對應項目。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListSchemasRequest

SchemaService.ListSchemas 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項資料儲存庫資源名稱，格式為 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。

page_size

int32

要傳回的 Schema 數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個 Schema。

許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

屬於接收自前一個 SchemaService.ListSchemas 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 SchemaService.ListSchemas 的所有其他參數須與提供網頁權杖的呼叫相符。

ListSchemasResponse

SchemaService.ListSchemas 方法的回應訊息。

欄位

schemas[]

Schema

Schema。

next_page_token

string

可做為 ListSchemasRequest.page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListSessionsRequest

要求 ListSessions 方法。

欄位
`parent`	`string` 這是必要旗標，資料儲存庫資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` 一頁的結果數上限，如未指定，預設值為 50。允許的最大值為 1000。
`page_token`	`string` 屬於接收自前一個 `ListSessions` 呼叫的網頁權杖。提供此項目即可擷取後續網頁。
`filter`	`string` 以半形逗號分隔的欄位清單，用於依 EBNF 文法篩選。支援的欄位如下： `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` 範例： `user_pseudo_id = some_id` `display_name = "some_name"` `starred = true` `is_pinned=true AND (NOT labels:hidden)` `create_time > "1970-01-01T12:00:00Z"`
`order_by`	`string` 以半形逗號分隔的欄位清單，用於排序 (遞增順序)。在欄位名稱後方使用「desc」表示遞減。支援的欄位： `update_time` `create_time` `session_name` `is_pinned` 範例： `update_time desc` `create_time` `is_pinned desc,update_time desc`：先依 is_pinned 列出工作階段，再依 update_time 列出工作階段。

ListSessionsResponse

ListSessions 方法的回應。

欄位

sessions[]

特定資料儲存庫的所有工作階段。

next_page_token

string

分頁符記，如果未傳回，表示這是最後一頁。

ListTargetSitesRequest

SiteSearchEngineService.ListTargetSites 方法的要求訊息。

欄位

parent

string

這是必要旗標，父項網站搜尋引擎資源名稱，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

如果呼叫者沒有權限列出這個網站搜尋引擎下的 TargetSite，無論這個分支是否存在，系統都會傳回 PERMISSION_DENIED 錯誤。

page_size

int32

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。

page_token

string

屬於接收自前一個 ListTargetSites 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 ListTargetSites 的所有其他參數須與提供網頁權杖的呼叫相符。

ListTargetSitesResponse

SiteSearchEngineService.ListTargetSites 方法的回應訊息。

欄位

target_sites[]

TargetSite 清單。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

total_size

int32

符合要求的項目總數。回覆中一律會填入這項資料。

ListUserLicensesRequest

UserLicenseService.ListUserLicenses 的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項 [UserStore][] 資源名稱，格式為 `projects/{project}/locations/{location}/userStores/{user_store_id}`。
`page_size`	`int32` (選用步驟) 要求的頁面大小。伺服器傳回的項目數量可能會少於要求數量。如未指定，則預設值為 10。許可的最大值為 50；超出的數值將一律指定為 50。如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。
`page_token`	`string` (選用步驟) 屬於接收自前一個 `ListUserLicenses` 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時，提供至 `ListUserLicenses` 的所有其他參數須與提供網頁權杖的呼叫相符。
`filter`	`string` (選用步驟) 清單要求的篩選條件。支援的欄位： `license_assignment_state` 範例： `license_assignment_state = ASSIGNED`，列出指派的使用者授權。 `license_assignment_state = NO_LICENSE`，列出未取得授權的使用者。 `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN`，列出嘗試登入但未獲指派授權的使用者。 `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN`，篩除嘗試登入但未獲指派授權的使用者。

ListUserLicensesResponse

UserLicenseService.ListUserLicenses 的回應訊息。

欄位

user_licenses[]

UserLicense

客戶的所有 UserLicense。

next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

MediaInfo

媒體專屬的使用者事件資訊。

欄位

media_progress_duration

Duration

媒體進度時間 (以秒為單位，如適用)。舉例來說，如果使用者已播放影片 90 秒，則 MediaInfo.media_progress_duration.seconds 應設為 90。

media_progress_percentage

float

媒體進度應只使用 media_progress_duration 相對於媒體總長度的值計算。

這個值必須介於 [0, 1.0] 之間 (含首尾)。

如果不是播放內容或無法計算進度 (例如進行中的直播)，則應取消設定這個欄位。

PageInfo

詳細的頁面資訊。

欄位
`pageview_id`	`string` 網頁瀏覽的專屬 ID。對於從相同網頁瀏覽觸發的所有使用者事件，這項值應保持不變。舉例來說，使用者瀏覽商品詳細資料頁面時，可能會觸發多個事件。所有這些事件的 `pageview_id` 屬性應保持相同，才能正確分組。使用 JavaScript 像素和 Google 代碼管理工具回報用戶端事件時，系統會自動填入這個值。
`page_category`	`string` 與類別頁面相關的最明確類別。如要表示類別的完整路徑，請使用「>」符號分隔不同層級。如果類別名稱包含「>」，請替換成其他字元。類別頁面包括特價或促銷活動等特殊頁面。舉例來說，特賣頁面的類別階層可能為 `"pageCategory" : "Sales > 2017 Black Friday Deals"`。 `view-category-page` 事件的必要屬性。其他事件類型不應設定這個欄位。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`uri`	`string` 使用者目前頁面的完整網址 (window.location.href)。使用 JavaScript 像素和 Google 代碼管理工具回報用戶端事件時，系統會自動填入這個值。長度上限為 5,000 個半形字元。
`referrer_uri`	`string` 目前網頁的參照網址。使用 JavaScript 像素和 Google 代碼管理工具回報用戶端事件時，系統會自動填入這個值。不過，部分瀏覽器的隱私權限制可能會導致這個欄位空白。

PanelInfo

與使用者事件相關的詳細面板資訊。

欄位
`panel_id`	`string` 這是必要旗標，面板 ID。
`display_name`	`string` 面板的顯示名稱。
`documents[]`	`DocumentInfo` (選用步驟) 與這個面板相關聯的文件 ID。
`panel_position`	`int32` 如果面板與其他面板一起向使用者顯示，則為面板的排序位置。如果設定這項政策，就必須一併設定 `total_panels`。
`total_panels`	`int32` 向使用者顯示的面板總數 (包括這個面板)。如果已設定 `panel_position`，則必須設定此欄位。

主體

使用者或群組的主體 ID。

欄位
聯集欄位 `principal`。聯集欄位 principal。主體可以是使用者或群組。`principal` 只能是下列其中一項：
`user_id`	`string` 使用者 ID。如果是 Google Workspace 使用者帳戶，user_id 應為 Google Workspace 使用者電子郵件地址。如果是非 Google 識別資訊提供者使用者帳戶，user_id 是在 workforcepool 設定期間設定的對應使用者 ID。
`group_id`	`string` 群組 ID。如果是 Google Workspace 使用者帳戶，group_id 應為 Google Workspace 群組電子郵件地址。如果是非 Google 識別資訊提供者使用者帳戶，group_id 是在 workforcepool 設定期間設定的對應群組 ID。
`external_entity_id`	`string` 適用於客戶身分識別提供者中沒有的第三方應用程式 ID。

專案

服務中 Google Cloud 專案的中繼資料和設定。

欄位
`name`	`string` 僅供輸出。專案的完整資源名稱，例如 `projects/{project}`。請注意，提出要求時，專案編號和專案 ID 皆可接受，但伺服器一律會以專案編號回應。
`create_time`	`Timestamp` 僅供輸出。這個專案的建立時間戳記。
`provision_completion_time`	`Timestamp` 僅供輸出。成功佈建此專案的時間戳記。如果值為空，表示專案仍在佈建中，尚未準備就緒。
`service_terms_map`	`map<string, ServiceTerms>` 僅供輸出。服務條款地圖。金鑰是 `ServiceTerms` 的 `id`。
`customer_provided_config`	`CustomerProvidedConfig` (選用步驟) 客戶提供的設定。

CustomerProvidedConfig

客戶提供的設定。

欄位

notebooklm_config

NotebooklmConfig

(選用步驟) 設定 NotebookLM。

NotebooklmConfig

NotebookLM 的設定。

欄位

model_armor_config

ModelArmorConfig

用於清理使用者提示和 LLM 回覆的 Model Armor 設定。

ModelArmorConfig

客戶定義的 Model Armor 範本設定，用於清理使用者提示和 LLM 回覆。

欄位

user_prompt_template

string

(選用步驟) 用於清除使用者提示詞的 Model Armor 範本資源名稱。格式：projects/{project}/locations/{location}/templates/{template_id} 如未指定，系統不會對使用者提示進行清理。

response_template

string

(選用步驟) 用於清理 LLM 回覆的 Model Armor 範本資源名稱。格式：projects/{project}/locations/{location}/templates/{template_id} 如未指定，系統不會對 LLM 回覆套用任何清除作業。

ServiceTerms

服務條款的中繼資料。

欄位
`id`	`string` 這項服務條款的專屬 ID。可用的字詞： `GA_DATA_USE_TERMS`：資料使用條款。如果使用 `id`，可接受的 `version` 值為 `2022-11-23`。
`version`	`string` 服務條款的版本字串。如需可接受的值，請參閱上方的 `id` 註解。
`state`	`State` 專案是否已接受/拒絕服務條款，或仍在等待處理。
`accept_time`	`Timestamp` 專案上次同意服務條款的時間。
`decline_time`	`Timestamp` 專案上次拒絕或撤銷服務條款協議的時間。

狀態

協議中載明瞭這項服務條款。

列舉
`STATE_UNSPECIFIED`	列舉的預設值。這個值不會實際使用。
`TERMS_ACCEPTED`	專案已同意《服務條款》。
`TERMS_PENDING`	專案尚待審查，請詳閱並接受服務條款。
`TERMS_DECLINED`	專案已拒絕或撤銷服務條款協議。

ProvisionProjectMetadata

這個類型沒有任何欄位。

與專案佈建作業相關聯的中繼資料。

ProvisionProjectRequest

要求 ProjectService.ProvisionProject 方法。

欄位
`name`	`string` 這是必要旗標，`Project` 的完整資源名稱，例如 `projects/{project_id_or_number}`。
`accept_data_use_terms`	`bool` 這是必要旗標，設為 `true`，表示呼叫端已詳閱並同意資料使用條款。
`data_use_terms_version`	`string` 這是必要旗標，來電者已詳閱並同意的資料使用條款版本。可接受的版本為 `2022-11-23`，這項規定可能會隨時間變更。
`saas_params`	`SaasParams` (選用步驟) Agentspace 的參數。

SaasParams

Agentspace 的參數。

欄位

accept_biz_qos

bool

(選用步驟) 設為 true，指定通話者已詳閱並同意《[Terms for Agent Space quality of service]》。

is_biz

bool

(選用步驟) 指出目前的要求是否適用於 Biz 版本 (true) 或不適用 (false)。

PurgeCompletionSuggestionsMetadata

與 PurgeCompletionSuggestions 作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

PurgeCompletionSuggestionsRequest

CompletionService.PurgeCompletionSuggestions 方法的要求訊息。

欄位

parent

string

這是必要旗標，要清除完成建議的父項資料儲存庫資源名稱。格式為 projects/*/locations/*/collections/*/dataStores/*。

PurgeCompletionSuggestionsResponse

CompletionService.PurgeCompletionSuggestions 方法的回應訊息。

欄位

purge_succeeded

bool

是否已成功清除完成建議。

error_samples[]

處理要求時發生的錯誤範例。

PurgeDocumentsMetadata

與 PurgeDocuments 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功刪除的項目數量。
`failure_count`	`int64` 處理時發生錯誤的項目數。
`ignored_count`	`int64` 因找不到項目而遭忽略的項目數。

PurgeDocumentsRequest

DocumentService.PurgeDocuments 方法的要求訊息。

欄位
`parent`	`string` 這是必要旗標，父項資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`。
`filter`	`string` 這是必要旗標，篩選要清除的相符文件。目前唯一支援的值是 `*` (所有項目)。
`error_config`	`PurgeErrorConfig` 清除期間發生錯誤時，您希望錯誤記錄的位置。
`force`	`bool` 實際執行清除作業。如果 `force` 設為 false，則傳回預估的清除次數，但不會刪除任何文件。
聯集欄位 `source`。根據文件 ID 清除文件時，所需的輸入來源。`source` 只能是下列其中一項：
`gcs_source`	`GcsSource` 輸入內容的 Cloud Storage 位置。支援的 `data_schema`：* `document_id`：每行一個有效 `Document.id`。
`inline_source`	`InlineSource` 要清除的輸入內容內嵌來源。

InlineSource

DocumentService.PurgeDocuments 方法的輸入設定內嵌來源。

欄位

documents[]

string

這是必要旗標，要清除的文件完整資源名稱清單。格式為 projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*。建議最多 100 個項目。

PurgeDocumentsResponse

DocumentService.PurgeDocuments 方法的回應訊息。如果長時間執行的作業順利完成，google.longrunning.Operations.response 欄位會傳回這則訊息。

欄位

purge_count

int64

因這項作業而清除的文件總數。

purge_sample[]

string

系統將刪除的文件名稱範例。只有在 force 設為 false 時，才會填入這個欄位。系統最多會傳回 100 個名稱，且名稱是隨機選擇。

PurgeErrorConfig

設定清除相關錯誤的目的地。

欄位

聯集欄位 destination。這是必要旗標，錯誤目的地。destination 只能是下列其中一項：

gcs_prefix

string

清除錯誤的 Cloud Storage 前置字串。這個目錄必須是現有的空白 Cloud Storage 目錄。系統會將清除錯誤寫入這個目錄中的分片檔案，每行一個，並以 JSON 編碼的 google.rpc.Status 訊息形式呈現。

PurgeIdentityMappingsRequest

IdentityMappingStoreService.PurgeIdentityMappings 的要求訊息

欄位
`identity_mapping_store`	`string` 這是必要旗標，要從中清除識別資訊對應項目的識別資訊對應商店名稱。格式：`projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` 篩選要清除的相符識別資訊對應檔。適用篩選功能的欄位如下：* `update_time`：採用 ISO 8601 的「zulu」格式。* `external_id` 範例：刪除在某個時間範圍內更新的所有身分識別對應：`update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` 刪除特定 external_id 的所有身分對應：`external_id = "id1"` 刪除識別資訊對應檔儲存區中的所有識別資訊對應檔：`*` 篩選欄位會預設為隱含的 AND 條件。請勿與來源搭配使用。如果同時提供這兩項資訊，系統會擲回錯誤。
聯集欄位 `source`。輸入內容的來源。`source` 只能是下列其中一項：
`inline_source`	`InlineSource` 要從中清除身分對應項目的內嵌來源。
`force`	`bool` 實際執行清除作業。如果 `force` 設為 false，則會傳回預估的清除次數，但不會刪除任何身分對應。這個欄位僅支援使用篩選器清除。如果是輸入來源，系統會忽略這個欄位，並清除資料，不論這個欄位的值為何。

InlineSource

要從中清除身分對應項目的內嵌來源。

欄位

identity_mapping_entries[]

IdentityMappingEntry

一次最多可清除 10000 個項目

PurgeSuggestionDenyListEntriesMetadata

與 PurgeSuggestionDenyListEntries 作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

PurgeSuggestionDenyListEntriesRequest

CompletionService.PurgeSuggestionDenyListEntries 方法的要求訊息。

欄位

parent

string

這是必要旗標，要匯入拒絕清單項目的父項資料儲存庫資源名稱。格式為 projects/*/locations/*/collections/*/dataStores/*。

PurgeSuggestionDenyListEntriesResponse

CompletionService.PurgeSuggestionDenyListEntries 方法的回應訊息。

欄位

purge_count

int64

已清除的建議拒絕清單項目數量。

error_samples[]

處理要求時發生的錯誤範例。

PurgeUserEventsMetadata

與 PurgeUserEvents 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`success_count`	`int64` 成功刪除的項目數量。
`failure_count`	`int64` 處理時發生錯誤的項目數。

PurgeUserEventsRequest

PurgeUserEvents 方法的要求訊息。

欄位

parent

string

這是必要旗標，建立事件的目錄資源名稱。格式為 projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}。

filter

string

這是必要旗標，請提供篩選條件字串，用以指定要刪除的事件，長度上限為 5,000 個字元，適用篩選功能的欄位如下：

eventType：以雙引號括住的 UserEvent.event_type 字串。
eventTime：採用 ISO 8601 的「zulu」格式。
userPseudoId：以雙引號括住的字串。指定這個欄位即可刪除與特定訪客相關的所有事件。
userId：以雙引號括住的字串。指定這個欄位即可刪除與相關使用者有關的所有事件。

注意：這個 API 最多只支援清除 30 天內的資料。

範例：

刪除特定時間範圍內的所有活動：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
刪除特定時間範圍內的特定 eventType：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
刪除特定訪客在某個時間範圍內的所有事件：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
刪除 DataStore 中過去 30 天的事件：*

篩選欄位會假設有隱含的 AND。

force

bool

目前不支援「force」欄位。清除使用者事件要求會永久刪除所有可清除的事件。開發完成後：如果 force 設為 false，這個方法會傳回預估的清除次數，但不會刪除任何使用者事件。如果要求中未包含這個欄位，系統預設會設為 false。

PurgeUserEventsResponse

PurgeUserEventsRequest 的回應。如果長時間執行的作業順利完成，google.longrunning.Operations.response 欄位會傳回這則訊息。

欄位

purge_count

int64

因這項作業而清除的事件總數。

查詢

定義使用者輸入的查詢。

欄位

query_id

string

僅供輸出。查詢的專屬 ID。

聯集欄位 content。查詢內容。content 只能是下列其中一項：

text

string

純文字。

RankRequest

RankService.Rank 方法的要求訊息。

欄位
`ranking_config`	`string` 這是必要旗標，排序服務設定的資源名稱，例如 `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`。
`model`	`string` 要使用的模型 ID。可以是下列其中一個值： `semantic-ranker-512@latest`：語意排名模型，輸入權杖大小上限為 512。如未指定，則預設為 `semantic-ranker-512@latest`。
`top_n`	`int32` 要傳回的結果數。如果未設定或不超過零，則會傳回所有結果。
`query`	`string` 要使用的查詢。
`records[]`	`RankingRecord` 這是必要旗標，要排序的記錄清單。
`ignore_record_details_in_response`	`bool` 如果為 true，回應只會包含記錄 ID 和分數。預設值為 false，回應會包含記錄詳細資料。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 文件。

RankResponse

RankService.Rank 方法的回應訊息。

欄位

records[]

RankingRecord

依分數遞減排序的記錄清單。

RankingRecord

錄製要傳送給 RankService.Rank 方法的訊息。

欄位
`id`	`string` 代表記錄的專屬 ID。
`title`	`string` 記錄的標題。預設為空白。請至少設定 `title` 或 `content` 其中一個，否則會擲回 INVALID_ARGUMENT 錯誤。
`content`	`string` 記錄的內容。預設為空白。請至少設定 `title` 或 `content` 其中一個，否則會擲回 INVALID_ARGUMENT 錯誤。
`score`	`float` 這項記錄的分數，是根據指定查詢和所選模型計算得出。分數會四捨五入到小數點第 2 位。如果分數接近 0，系統會將分數四捨五入為 0.0001，避免傳回未設定的值。

RecommendRequest

Recommend 方法的要求訊息。

欄位
`serving_config`	`string` 這是必要旗標，`ServingConfig` 的完整資源名稱：`projects//locations/global/collections//engines//servingConfigs/` 或 `projects//locations/global/collections//dataStores//servingConfigs/` 建立推薦引擎時，系統會一併建立一個預設供應設定。引擎 ID 會做為預設放送設定的 ID。舉例來說，如果是引擎 `projects//locations/global/collections//engines/my-engine`，您可以將 `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` 用於 `RecommendationService.Recommend` 要求。
`user_event`	`UserEvent` 這是必要旗標，使用者相關背景資訊、使用者正在查看的內容，以及使用者觸發「推薦」要求所採取的動作。請注意，這項使用者事件詳細資料不會擷取至 userEvent 記錄。因此，記錄事件時必須另外提出 userEvent 寫入要求。請勿為不同使用者將 `UserEvent.user_pseudo_id` 或 `UserEvent.user_info.user_id` 設為相同的固定 ID。如要接收非個人化推薦內容 (不建議，這可能會對模型效能造成負面影響)，請將 `UserEvent.user_pseudo_id` 設為隨機的專屬 ID，並將 `UserEvent.user_info.user_id` 設為未設定。
`page_size`	`int32` 一頁的結果數上限，將這項屬性設為所需建議結果的數量。如果為零，服務會選擇合理的預設值。允許的最大值為 100。如果值大於 100，系統會將值設為 100。
`filter`	`string` 篩選條件，可限制建議結果，長度上限為 5,000 個字元。目前僅支援 `filter_tags` 屬性的篩選運算式。範例： `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` 如果 `params` 欄位下的 `attributeFilteringSyntax` 設為 true，則系統會預期使用屬性運算式，而非上述以標記為基礎的語法。範例： (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) 如果篩選器封鎖所有結果，API 會傳回一般 (未經篩選) 熱門文件。如果只希望搜尋結果完全符合篩選條件，請在 `RecommendRequest.params` 中將 `strictFiltering` 設為 `true`，這樣就會收到空白結果。請注意，無論篩選條件為何，API 一律不會傳回 `Document` 含有 `storageStatus` 做為 `EXPIRED` 或 `DELETED` 的 `EXPIRED`。
`validate_only`	`bool` 請使用僅驗證模式查詢這項建議。如果設為 `true`，系統會使用傳回任意文件 ID 的偽模型。請注意，驗證模式僅適用於測試 API，或模型尚未準備就緒的情況。
`params`	`map<string, Value>` 建議的其他網域專屬參數。接受的值： `returnDocument`：布林值，如果設為 `true`，相關聯的 Document 物件會傳回 `RecommendResponse.RecommendationResult.document`。 `returnScore`：布林值，如果設為 true，系統會在 `RecommendResponse.RecommendationResult.metadata` 中設定與每個傳回的 Document 對應的建議分數。這個分數代表在特定使用者情境和記錄下，文件轉換的機率。 `strictFiltering`：布林值，預設為 True。如果設為 `false`，當篩選器封鎖所有建議結果時，服務會傳回一般 (未篩選) 熱門文件，而非空白結果。 `diversityLevel`：字串。預設為空白。如果設為非空白，則必須是下列其中一項： `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` 這項功能可提供要求層級的控制權，並根據文件類別調整建議結果。 `attributeFilteringSyntax`：布林值，預設為 False。如果設為 true，系統會根據新的屬性式語法解讀 `filter` 欄位。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱標籤規定。

RecommendResponse

Recommend 方法的回應訊息。

欄位
`results[]`	`RecommendationResult` 建議文件清單。順序代表排名 (從最相關的文件到最不相關的文件)。
`attribution_token`	`string` 專屬歸因符記。這項資訊應包含在建議產生的 `UserEvent` 記錄中，以便準確歸因建議模型成效。
`missing_ids[]`	`string` 要求中缺少的文件 ID，這些文件與所要求 ServingConfig 相關聯的預設 Branch 中沒有。
`validate_only`	`bool` 如果已設定 `RecommendRequest.validate_only`，則為「true」。

RecommendationResult

RecommendationResult 代表一般建議結果，以及相關聯的中繼資料。

欄位

id

string

建議文件的資源 ID。

document

MatchHighlightingCondition

如果 RecommendRequest.params 中的 returnDocument 設為 true，請設定這個值。

metadata

map<string, Value>

其他文件的中繼資料或註解。

可能的值包括：

score：建議分數 (雙精度值)。如果 RecommendRequest.params 中的 returnScore 設為 true，則會設定這個值。

RecrawlUrisMetadata

與 SiteSearchEngineService.RecrawlUris 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位
`create_time`	`Timestamp` 作業建立時間。
`update_time`	`Timestamp` 作業上次更新時間。如果作業已完成，這也是完成時間。
`invalid_uris[]`	`string` 要求中格式無效的專屬 URI。最多只能取樣 1,000 筆資料。
`invalid_uris_count`	`int32` 要求中格式無效的不重複 URI 總數。
`noindex_uris[]`	`string` 沒有索引中繼標記的 URI。最多只能取樣 1,000 筆資料。
`noindex_uris_count`	`int32` 沒有索引中繼標記的 URI 總數。
`uris_not_matching_target_sites[]`	`string` 要求中的不重複 URI 不符合 DataStore 中的任何 TargetSite，只符合尚未完全建立索引的 TargetSite，或是符合類型為 EXCLUDE 的 TargetSite。最多只能取樣 1,000 筆資料。
`uris_not_matching_target_sites_count`	`int32` 不符合任何 TargetSites 的 URI 總數。
`valid_uris_count`	`int32` 要求中不在 invalid_uris 的不重複 URI 總數。
`success_count`	`int32` 目前為止已檢索的 URI 總數。
`pending_count`	`int32` 尚未檢索的 URI 總數。
`quota_exceeded_count`	`int32` 因索引資源不足而遭拒的 URI 總數。

RecrawlUrisRequest

SiteSearchEngineService.RecrawlUris 方法的要求訊息。

欄位

site_search_engine

string

這是必要旗標，SiteSearchEngine 的完整資源名稱，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。

uris[]

string

這是必要旗標，要檢索的 URI 清單。最多支援 1 萬個 URI，否則會擲回 INVALID_ARGUMENT 錯誤。每個 URI 都應與 site_search_engine 中的至少一個 TargetSite 相符。

site_credential

string

(選用步驟) 用於檢索的憑證 ID。

RecrawlUrisResponse

SiteSearchEngineService.RecrawlUris 方法的回應訊息。

欄位

failure_samples[]

FailureInfo

最多 10 個 failed_uris 的詳細資料樣本。

failed_uris[]

string

在 LRO 終止前未檢索的 URI。

FailureInfo

特定 URI 無法檢索的詳細原因。每個 FailureInfo 都包含每個 CorpusType 的一個 FailureReason。

欄位

uri

string

無法檢索的 URI。

failure_reasons[]

FailureReason

依字詞類型 (例如電腦、行動裝置) 列出的失敗原因。

FailureReason

詳細說明特定 CorpusType 檢索失敗的原因，例如桌機和行動裝置檢索可能會因為不同原因而失敗。

欄位

corpus_type

CorpusType

DESKTOP、MOBILE 或 CORPUS_TYPE_UNSPECIFIED。

error_message

string

URI 未遭到檢索的原因。

CorpusType

失敗的檢索作業的 CorpusType。

列舉
`CORPUS_TYPE_UNSPECIFIED`	預設值。
`DESKTOP`	表示系統嘗試檢索網頁的電腦版。
`MOBILE`	表示系統嘗試檢索網頁的行動版。

回覆

定義要回覆使用者的訊息。

欄位

summary

Summary

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

SafetyRating

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

欄位
`category`	`HarmCategory` 僅供輸出。危害類別。
`probability`	`HarmProbability` 僅供輸出。內容中的危害機率等級。
`probability_score`	`float` 僅供輸出。危害機率分數。
`severity`	`HarmSeverity` 僅供輸出。內容中的危害嚴重程度。
`severity_score`	`float` 僅供輸出。危害嚴重程度分數。
`blocked`	`bool` 僅供輸出。指出內容是否因這個分級而遭到篩除。

HarmProbability

內容中的危害機率等級。

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

HarmSeverity

危害嚴重程度。

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

結構定義

定義文件資料類型的結構和版面配置。

欄位
`name`	`string` 不可變動。結構定義的完整資源名稱，格式為 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`。這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。
聯集欄位 `schema`。結構定義表示方式。請提供 `struct_schema` 或 `json_schema` 其中一個，否則系統會擲回 `INVALID_ARGUMENT` 錯誤。`schema` 只能是下列其中一項：
`struct_schema`	`Struct` 結構定義的結構化表示法。
`json_schema`	`string` 結構定義的 JSON 表示法。

SearchAddOn

外掛程式，可提供額外的搜尋功能。

列舉
`SEARCH_ADD_ON_UNSPECIFIED`	未指定列舉時的預設值。無法使用。
`SEARCH_ADD_ON_LLM`	大型語言模型外掛程式。

SearchInfo

詳細搜尋資訊。

欄位

search_query

string

使用者的搜尋查詢。

如需定義，請參閱 SearchRequest.query。

值必須是 UTF-8 編碼的字串，長度上限為 5,000 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

search 事件至少需要 search_query 或 PageInfo.page_category。其他事件類型不應設定這個欄位。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

order_by

string

產品退貨的順序 (如適用)。

如需定義和語法，請參閱 SearchRequest.order_by。

這個值必須是 UTF-8 編碼的字串，長度上限為 1,000 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

這項設定只能用於 search 活動。其他事件類型不應設定這個欄位。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

offset

int32

指定分頁目前偏移量的整數 (API 視為相關產品中的起始位置，以 0 為索引)。

如需定義，請參閱 SearchRequest.offset。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT。

這項設定只能用於 search 活動。其他事件類型不應設定這個欄位。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

SearchLinkPromotion

宣傳活動原型包含 URI 和其他輔助資訊，可顯示宣傳活動。

欄位
`title`	`string` 這是必要旗標，促銷活動的名稱。長度上限：160 個半形字元。
`uri`	`string` (選用步驟) 使用者要宣傳的頁面網址。必須為網站搜尋設定。其他產業則為選填屬性。
`document`	`string` (選用步驟) `Document` 使用者想宣傳的內容。如果是網站搜尋，請保留未設定的狀態，只填入 URI。可與 URI 一併設定。
`image_uri`	`string` (選用步驟) 促銷活動縮圖網址。
`description`	`string` (選用步驟) 宣傳活動說明。長度上限：200 個半形字元。
`enabled`	`bool` (選用步驟) 如果供應設定與附加促銷活動的控制項上層相關聯，系統就會傳回已啟用的促銷活動。這個旗標僅適用於基本網站搜尋。

SearchRequest

SearchService.Search 方法的要求訊息。

欄位
`serving_config`	`string` 這是必要旗標，搜尋供應設定的資源名稱，例如 `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` 或 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`。這個欄位用於識別供應設定名稱，也就是用於進行搜尋的一組模型。
`branch`	`string` 分支版本的資源名稱，例如 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`。使用 `default_branch` 做為分支 ID，或將這個欄位留空，即可搜尋預設分支下的文件。
`query`	`string` 原始搜尋查詢。
`image_query`	`ImageQuery` 原始圖片查詢。
`page_size`	`int32` 要傳回的 `Document` 數量上限。允許的最大值取決於資料類型。如果值超過上限，系統會強制設為上限值。基本索引網站：預設 `10`、最多 `25`。進階索引網站：預設 `25`、最多 `50`。其他：預設 `50`、最大 `100`。如果這個欄位為負數，系統會傳回 `INVALID_ARGUMENT`。
`page_token`	`string` 接收自前一個 `SearchService.Search` 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時，提供至 `SearchService.Search` 的所有其他參數須與提供網頁權杖的呼叫相符。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`offset`	`int32` 以 0 為索引的整數，用來指定搜尋結果中目前的偏移量 (也就是 API 視為相關的`Document`中的起始結果位置)。只有在未設定 `page_token` 時，才會考慮使用此欄位。如果這個欄位為負數，系統會傳回 `INVALID_ARGUMENT`。如果偏移量過大，系統可能會將其限制在合理範圍內。
`one_box_page_size`	`int32` OneBox 傳回的結果數上限。這項規定適用於各個 OneBox 類型。預設值為 10。
`data_store_specs[]`	`DataStoreSpec` 定義要搜尋的特定 `DataStore`，以及這些資料儲存區的設定。只有在`Engine`有多個資料儲存庫時，系統才會考量這項因素。如果引擎只有一個資料存放區，請使用 `SearchRequest` 下方的規格。
`filter`	`string` 篩選器語法包含運算式語言，可從要篩選的文件的一或多個欄位建構述詞。篩選運算式會區分大小寫。如果無法辨識這個欄位，系統會傳回 `INVALID_ARGUMENT`。如要在 Vertex AI Search 中進行篩選，請將左側的篩選鍵對應至 Vertex AI Search 後端定義的鍵屬性，這項對應是由客戶在結構定義中定義。舉例來說，媒體客戶的結構定義中可能會有「name」欄位。在本例中，篩選器會如下所示：filter --> name:'ANY("king kong")' 如要進一步瞭解篩選功能，包括語法和篩選運算子，請參閱「篩選」
`canonical_filter`	`string` 使用者在搜尋頁面上未勾選任何篩選器時，系統套用的預設篩選器。需要查詢擴展等品質改善措施時，套用至每個搜尋要求的篩選器。如果查詢結果數量不足，系統會使用這個篩選器判斷是否要啟用查詢擴充流程。查詢擴大搜尋時，系統仍會使用原始篩選器。強烈建議填寫這個欄位，以確保搜尋品質。如要進一步瞭解篩選器語法，請參閱 `SearchRequest.filter`。
`order_by`	`string` 傳回文件的順序。文件可依 `Document` 物件中的欄位排序。如果依關聯性排序，請勿設定此值。`order_by` 運算式須區分大小寫。如要進一步瞭解如何排序網站搜尋結果，請參閱「排序網頁搜尋結果」。如要進一步瞭解如何排序醫療保健搜尋結果，請參閱「排序醫療保健搜尋結果」。如果無法辨識這個欄位，系統會傳回 `INVALID_ARGUMENT`。
`user_info`	`UserInfo` 使用者的相關資訊。強烈建議用於數據分析和個人化。`UserInfo.user_agent` 用於推斷 `device_type` 以進行分析。
`language_code`	`string` BCP-47 語言代碼，例如「en-US」或「sr-Latn」。詳情請參閱「標準欄位」。這個欄位有助於更準確地解讀查詢。如未指定值，系統會自動偵測查詢語言代碼，但可能不準確。
`facet_specs[]`	`FacetSpec` 多面向搜尋的 facet 規格。如果留空，就不會傳回任何構面。最多可輸入 100 個值。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`boost_spec`	`BoostSpec` 提高特定文件的規格。如要進一步瞭解加成，請參閱「加成」一文。
`params`	`map<string, Value>` 其他搜尋參數。僅限公開網站搜尋，支援的值如下： `user_country_code`：字串。預設為空白。如果設為非空白，系統會根據提供的地點限制或提升結果。例如：`user_country_code: "au"` 如要查看可用代碼，請參閱「國家/地區代碼」。 `search_type`：雙精度浮點數。預設為空白。視值而定，啟用非網頁搜尋功能。唯一有效的非預設值為 1，可啟用圖片搜尋功能。例如：`search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` 查詢擴充規格，指定查詢擴充的發生條件。
`spell_correction_spec`	`SpellCorrectionSpec` 拼字校正規格，指定拼字校正生效的模式。
`user_pseudo_id`	`string` 用於追蹤訪客的專屬 ID。舉例來說，這項功能可以透過 HTTP Cookie 實作，應能識別單一裝置上的訪客。訪客登入或登出網站時，這個專屬 ID 不應變更。這個欄位「不得」有固定值，例如 `unknown_visitor`。這個 ID 應與 `UserEvent.user_pseudo_id` 和 `CompleteQueryRequest.user_pseudo_id` 相同這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個字元。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`content_search_spec`	`ContentSearchSpec` 用於設定內容搜尋行為的規格。
`ranking_expression`	`string` (選用步驟) 排名運算式可控管擷取文件的自訂排名。這會覆寫 `ServingConfig.ranking_expression`。語法和支援的功能取決於 `ranking_expression_backend` 值。如未提供 `ranking_expression_backend`，系統會預設為 `RANK_BY_EMBEDDING`。如果未提供 `ranking_expression_backend` 或設為 `RANK_BY_EMBEDDING`，則應為單一函式或以「+」聯結的多個函式。 ranking_expression = function, { " + ", function }; 支援的函式： double * relevance_score double * dotProduct(embedding_field_path) 函式變數： `relevance_score`：預先定義的關鍵字，用於評估查詢和文件之間的關聯性。 `embedding_field_path`：與查詢嵌入向量搭配使用的文件嵌入欄位。 `dotProduct`：`embedding_field_path` 和查詢嵌入向量之間的嵌入函式。排名運算式範例：如果文件含有嵌入欄位 doc_embedding，則排名運算式可能是 `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`。如果 `ranking_expression_backend` 設為 `RANK_BY_FORMULA`，系統支援下列運算式類型 (以及使用 + 或 * 運算子鏈結的類型組合)： `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. `is_nan(signal)`：如果信號為 NaN，則傳回 0，否則傳回 1。 `fill_nan(signal1, signal2 \| double)` - 如果 signal1 為 NaN，則傳回 signal2 \| double，否則傳回 signal1。以下列舉幾個使用支援的排名運算式類型的排名公式： `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of with slight adjustment.`keyword_similarity_scoresemantic_smilarity_score` `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` - 依 `semantic_similarity_score` 的指數排序，如果值為 NaN，則填入 0，如果 `semantic_similarity_score` 為 NaN，則在最終分數中加入常數 0.3 的調整值。 `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` - 大多是依據 `keyword_similarity_score` 的倒數排名，並稍微調整 `semantic_smilarity_score` 的倒數排名。系統支援下列信號： `semantic_similarity_score`：語意相似度調整值，是使用 Google 專有模型生成的嵌入計算而得。這個分數會決定搜尋查詢與文件的語意相似程度。 `keyword_similarity_score`：關鍵字比對調整項使用 Best Match 25 (BM25) 排名函式。這項分數是使用機率模型計算，用來估算文件與特定查詢的相關機率。 `relevance_score`：語意關聯性調整，使用 Google 專有模型，根據文件內容判斷使用者查詢的意義和意圖。 `pctr_rank`：預測轉換率調整值，做為排名用途。預測點閱率 (pCTR) 可從使用者角度評估搜尋結果的關聯性和吸引力。預估點擊率越高，表示結果越有可能滿足使用者的查詢和意圖，因此是排名時的重要信號。 `freshness_rank`：以排名形式呈現的新鮮度調整 `document_age`：文件上次更新後經過的小時數，以浮點數表示 (例如 0.25 代表 15 分鐘)。 `topicality_rank`：主題調整值 (以排名表示)。使用 Google 專屬模型判斷查詢和文件之間基於關鍵字的重疊程度。 `base_rank`：結果的預設排名
`ranking_expression_backend`	`RankingExpressionBackend` (選用步驟) 用於排名運算式評估的後端。
`safe_search`	`bool` 是否開啟安全搜尋功能。這項功能僅適用於網站搜尋。
`user_labels`	`map<string, string>` 套用於資源的使用者標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個字元。鍵和值只能使用小寫字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 文件。
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` (選用步驟) 自然語言查詢理解功能設定，例如從查詢中擷取結構化欄位篩選器。詳情請參閱這份說明文件。如果未指定 `naturalLanguageQueryUnderstandingSpec`，系統就不會進行額外的自然語言查詢理解作業。
`search_as_you_type_spec`	`SearchAsYouTypeSpec` 即時搜尋設定。僅支援 `IndustryVertical.MEDIA` 垂直。
`display_spec`	`DisplaySpec` (選用步驟) 設定顯示功能，例如在搜尋結果中醒目顯示相符項目。
`session`	`string` 工作階段資源名稱。選填。使用者可透過工作階段執行多輪 /search API 呼叫，或協調 /search API 呼叫和 /answer API 呼叫。範例 1 (多輪 /search API 呼叫)：使用在第一次呼叫中產生的工作階段 ID 呼叫 /search API。系統會將先前的搜尋查詢納入查詢狀態考量。也就是說，如果第一個查詢是「Alphabet 在 2022 年的表現如何？」，而目前的查詢是「2023 年的表現如何？」，系統會將目前的查詢解讀為「Alphabet 在 2023 年的表現如何？」。範例 2 (在 /search API 呼叫和 /answer API 呼叫之間協調)：使用第一次呼叫中產生的工作階段 ID 呼叫 /answer API。在這裡，答案生成作業會在第一次搜尋呼叫的搜尋結果脈絡中進行。多輪搜尋功能目前處於不公開正式發布階段。在公開發布這項功能前，請改用 v1alpha 或 v1beta 版。您也可以透過 Google 支援團隊申請加入允許清單。
`session_spec`	`SessionSpec` 工作階段規格。只有在設定 `session` 時才能使用。
`relevance_threshold`	`RelevanceThreshold` 搜尋結果的關聯性門檻。預設為 Google 定義的門檻，可兼顧準確度和召回率，提供高度準確的結果，並全面涵蓋相關資訊。這項功能不支援醫療保健搜尋。
`relevance_score_spec`	`RelevanceScoreSpec` (選用步驟) 傳回關聯性分數的規格。

BoostSpec

提升規格，以提升特定文件。

欄位

condition_boost_specs[]

ConditionBoostSpec

條件提升規格。如果文件符合規格中的多項條件，系統會套用這些規格的加分，並以非線性方式合併。最多只能有 20 項規格。

ConditionBoostSpec

系統會對符合條件的文件套用升級。

欄位

condition

string

指定提升條件的運算式。語法和支援的欄位與篩選運算式相同。如需詳細語法和限制，請參閱 SearchRequest.filter。

範例：

如要提升文件 ID 為「doc_1」或「doc_2」，且顏色為「紅色」或「藍色」的文件，請使用以下查詢：(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

條件的增強程度，範圍應介於 [-1, 1]。如果設為負值，即代表降低排名。預設值為 0.0。

設為 1.0 可大幅提高文件排名。不過，這並不代表經過增強的文件一定會顯示在搜尋結果頂端，也不代表其他文件會遭到排除。即便沒有任何項目符合條件，系統還是有可能會顯示結果。另外，相較於增強程度非常大卻與搜尋查詢不相關的文件，關聯性明顯更高的文件還是有可能獲得較高的排名。

設為 -1.0 會大幅降低文件排名。不過，系統仍可能會顯示高度相關的結果。該文件仍有機會獲得相當高的排名，但會面臨上游競爭。

設為 0.0 表示不套用任何增幅。系統會忽略提升條件。只能設定 (條件、增幅) 組合或下列 boost_control_spec 其中之一。如果兩者都已設定，系統會忽略全域提升幅度，並套用更精細的 boost_control_spec。

boost_control_spec

BoostControlSpec

根據客戶定義的屬性值，為自訂排名設定複雜規格。

BoostControlSpec

根據顧客指定的屬性值自訂排序的規格。與上述簡單的 (條件、加成) 組合相比，這項功能提供更多控制選項，可自訂排名。

欄位
`field_name`	`string` 系統會根據這個欄位的值決定加成金額。
`attribute_type`	`AttributeType` 用來決定加成金額的屬性類型。屬性值可從指定 field_name 的欄位值衍生而來。如果是數值，則很簡單，也就是 attribute_value = numerical_field_value。不過，如果是新鮮度，attribute_value = (time.now() - datetime_field_value)。
`interpolation_type`	`InterpolationType` 要套用的插補類型，用於連結下列控制點。
`control_points[]`	`ControlPoint` 用來定義曲線的控制點。單調函式 (透過上述 interpolation_type 定義) 會通過這裡列出的控制點。

AttributeType

要套用自訂排序的屬性(或函式)。

列舉
`ATTRIBUTE_TYPE_UNSPECIFIED`	未指定的 AttributeType。
`NUMERICAL`	系統會根據數值欄位的值，動態更新加成金額。在本例中，控制點的 attribute_value (x 值) 會是指定 boost_amount 的數值欄位實際值。
`FRESHNESS`	如果是新鮮度用途，屬性值會是目前時間與指定 datetime 欄位中日期之間的時間長度。這個值的格式必須為 XSD `dayTimeDuration` 值 (ISO 8601 時間長度值的受限子集)。此模式為：`[nD][T[nH][nM][nS]]`。例如：`5D`、`3DT12H30M`、`T24H`。

ControlPoint

用來定義曲線的控制點。透過這些控制點定義的曲線只能單調遞增或遞減(可接受常數值)。

欄位

attribute_value

string

可以是下列任一值：1. 數值欄位值。2. 新鮮度時間長度規格：值必須採用 XSD dayTimeDuration 值格式 (ISO 8601 時間長度值的受限子集)。此模式為：[nD][T[nH][nM][nS]]。

boost_amount

float

如果 attribute_value 評估結果為上述指定值，則分數的提升值介於 -1 到 1 之間。

InterpolationType

要套用的插補類型。預設值為線性 (分段線性)。

列舉
`INTERPOLATION_TYPE_UNSPECIFIED`	未指定插補類型。在本例中，預設值為「線性」。
`LINEAR`	系統會套用分段線性插值。

ContentSearchSpec

用於設定內容搜尋行為的規格。

欄位
`snippet_spec`	`SnippetSpec` 如果未指定 `snippetSpec`，搜尋回應就不會包含摘要。
`summary_spec`	`SummarySpec` 如果未指定 `summarySpec`，搜尋回應就不會包含摘要。
`extractive_content_spec`	`ExtractiveContentSpec` 如果沒有提供 extractive_content_spec，搜尋回應就不會包含擷取式答案。
`search_result_mode`	`SearchResultMode` 指定搜尋結果模式。如未指定，搜尋結果模式預設為 `DOCUMENTS`。
`chunk_spec`	`ChunkSpec` 指定要從搜尋回應傳回的區塊規格。只有在 `SearchRequest.ContentSearchSpec.search_result_mode` 設為 `CHUNKS` 時，才能使用這個選項。

ChunkSpec

指定要從搜尋回應傳回的區塊規格。只有在 SearchRequest.ContentSearchSpec.search_result_mode 設為 CHUNKS 時，才能使用這個選項。

欄位

num_previous_chunks

int32

要傳回目前區塊的前幾個區塊數量。允許的最大值為 3。如未指定，系統不會傳回先前的任何區塊。

num_next_chunks

int32

目前區塊要傳回的下一個區塊數。允許的最大值為 3。如未指定，系統不會傳回任何後續區塊。

ExtractiveContentSpec

用於設定搜尋回應中擷取內容的規格。

欄位
`max_extractive_answer_count`	`int32` 每個搜尋結果中傳回的擷取式答案數量上限。擷取式答案是從原始文件中擷取的逐字答案，可針對搜尋查詢提供準確且相關的答案。如果相符答案的數量少於 `max_extractive_answer_count`，則傳回所有答案。否則，請傳回 `max_extractive_answer_count`。每個 `SearchResult` 最多會傳回五個答案。
`max_extractive_segment_count`	`int32` 每個搜尋結果中傳回的擷取片段數量上限。只有在 `DataStore` 設為 `DataStore.ContentConfig.CONTENT_REQUIRED` 或 `DataStore.solution_types` 為 `SOLUTION_TYPE_CHAT` 時，才會套用這項設定。擷取片段是從原始文件中擷取的文字片段，與搜尋查詢相關，且通常比擷取答案更詳細。然後，LLM 就能以這段內容做為輸入內容，生成摘要和答案。如果相符的區隔數量少於 `max_extractive_segment_count`，則傳回所有區隔。否則，請傳回 `max_extractive_segment_count`。
`return_extractive_segment_score`	`bool` 指定是否要從每個搜尋結果的擷取片段傳回信賴度分數。這項功能僅適用於新的資料儲存庫或已加入許可清單的資料儲存庫。如要將資料存放區列入許可清單，請與客戶工程師聯絡。預設值為 `false`。
`num_previous_segments`	`int32` 指定是否也要納入所選區隔的相鄰區隔。在每個所選區隔前，最多傳回 `num_previous_segments` 個區隔。
`num_next_segments`	`int32` 在每個選取的區隔後，最多傳回 `num_next_segments` 個區隔。

SearchResultMode

指定搜尋結果模式。如未指定，搜尋結果模式預設為 DOCUMENTS。

列舉
`SEARCH_RESULT_MODE_UNSPECIFIED`	預設值。
`DOCUMENTS`	傳回搜尋結果中的文件。
`CHUNKS`	傳回搜尋結果中的區塊。只有在指定 `DocumentProcessingConfig.chunking_config` 時才能使用。

SnippetSpec

用於設定搜尋回應中摘要的規格。

欄位

max_snippet_count
(deprecated)

int32

[已淘汰] 這個欄位已淘汰，如要控制程式碼片段的回傳，請使用 return_snippet 欄位。為確保回溯相容性，如果 max_snippet_count > 0，我們會傳回程式碼片段。

reference_only
(deprecated)

bool

[已淘汰] 這個欄位已淘汰，不會對程式碼片段造成影響。

return_snippet

bool

如果 true，則傳回程式碼片段。如果無法產生摘要，我們會傳回「這個網頁沒有摘要」。系統也會傳回含有 SUCCESS 或 NO_SNIPPET_AVAILABLE 的 snippet_status。

SummarySpec

用於設定搜尋回應中傳回摘要的規格。

欄位
`summary_result_count`	`int32` 要產生摘要的最相關結果數量。如果傳回的結果數量少於 `summaryResultCount`，系統會根據所有結果產生摘要。文件模式最多可使用 10 個結果，區塊模式則最多可使用 50 個結果來生成摘要。如果 `SearchRequest.ContentSearchSpec.search_result_mode` 設為 `CHUNKS`，系統就會使用區塊模式。
`include_citations`	`bool` 指定是否要在摘要中加入引文。預設值為 `false`。如果這個欄位設為 `true`，摘要會包含內文引用編號。包含引文的摘要範例： BigQuery 是 Google Cloud 的全代管無伺服器企業資料倉儲 [1]。這個整合式平台支援所有資料類型、可跨雲端運作，且內建機器學習和商業智慧功能 [2, 3]。引文編號是指傳回的搜尋結果，並以 1 為索引。舉例來說，[1] 表示該句子歸因於第一個搜尋結果。[2, 3] 表示該句子歸因於第二和第三個搜尋結果。
`ignore_adversarial_query`	`bool` 指定是否要篩除對抗查詢。預設值為 `false`。 Google 會採用搜尋查詢分類技術，偵測惡意查詢。如果搜尋查詢歸類為對抗性查詢，系統就不會傳回摘要。舉例來說，使用者可能會詢問有關公司負面評論的問題，或提交旨在生成不安全或違反政策內容的查詢。如果此欄位設為 `true`，我們會略過對抗性查詢的摘要生成作業，改為傳回備用訊息。
`ignore_non_summary_seeking_query`	`bool` 指定是否要篩除並非尋求摘要的查詢。預設值為 `false`。 Google 會採用搜尋查詢分類技術，偵測尋找摘要的查詢。如果搜尋查詢歸類為非摘要查詢，系統就不會傳回摘要。舉例來說，`why is the sky blue` 和 `Who is the best soccer player in the world?` 是尋求摘要的查詢，但 `SFO airport` 和 `world cup 2026` 不是。這類查詢最有可能屬於導覽查詢。如果這個欄位設為 `true`，系統會略過非摘要搜尋查詢的摘要生成作業，並改為傳回備用訊息。
`ignore_low_relevant_content`	`bool` 指定是否要篩除相關性偏低的查詢。預設值為 `false`。如果將這個欄位設為 `false`，系統會使用所有搜尋結果 (無論是否相關) 生成答案。如果設為 `true`，只有查詢結果關聯性高的查詢才會產生答案。
`ignore_jail_breaking_query`	`bool` (選用步驟) 指定是否要篩除越獄查詢。預設值為 `false`。 Google 會採用搜尋查詢分類技術，偵測越獄查詢。如果搜尋查詢歸類為越獄查詢，系統不會傳回摘要。使用者可能會在查詢中加入指令，變更回覆的語氣、風格、語言、內容，或要求模型扮演不同實體，例如「以競爭對手公司執行長的語氣回覆」。如果此欄位設為 `true`，我們會略過生成越獄查詢的摘要，改為傳回備用訊息。
`model_prompt_spec`	`ModelPromptSpec` 如果指定，系統會使用規格修改提供給 LLM 的提示。
`language_code`	`string` 摘要的語言代碼。請使用 BCP47 定義的語言標記。注意：這項功能仍在實驗階段。
`model_spec`	`ModelSpec` 如果指定規格，系統會使用該規格修改提供給 LLM 的模型規格。
`use_semantic_chunks`	`bool` 如果為 true，系統會根據最相關的搜尋結果生成答案。這項功能可提升摘要品質。請注意，啟用這項功能後，系統不會參考所有熱門搜尋結果，也不會將這些結果納入參考資料清單，因此引用來源索引只會指向參考資料清單中列出的搜尋結果。

ModelPromptSpec

要搭配模型使用的提示規格。

欄位

preamble

string

提示開頭的文字，用於指示助理。使用手冊中提供範例。

ModelSpec

模型規格。

欄位

version

string

用於生成摘要的模型版本。

支援的值如下：

stable：字串。如果未指定任何值，則為預設值。使用一般可用的微調模型。詳情請參閱「答案生成模型版本和生命週期」。
preview：字串。(公開測試版) 使用預先發布模型。詳情請參閱「答案生成模型版本和生命週期」。

DataStoreSpec

這個結構體用於定義要在搜尋呼叫中篩選的資料儲存庫，以及這些資料儲存庫的設定。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

欄位
`data_store`	`string` 這是必要旗標，`DataStore` 的完整資源名稱，例如 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`。路徑必須包含專案編號，這個欄位不支援專案 ID。
`filter`	`string` (選用步驟) 篩選器規格，用於篩選 data_store 欄位指定的資料儲存庫中的文件。如要進一步瞭解篩選功能，請參閱「篩選」
`boost_spec`	`BoostSpec` (選用步驟) 提高特定文件的規格。如要進一步瞭解加成，請參閱「加成」一文。
`custom_search_operators`	`string` (選用步驟) 自訂搜尋運算子 (如有指定)，可用於篩選工作區資料儲存庫的結果。如要進一步瞭解自訂搜尋運算子，請參閱 SearchOperators。

DisplaySpec

指定顯示功能，例如相符項目醒目顯示。

欄位

match_highlighting_condition

應醒目顯示相符項目的條件。

MatchHighlightingCondition

列舉項目，說明在何種條件下應醒目顯示相符項目。

列舉
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	伺服器行為與 `MATCH_HIGHLIGHTING_DISABLED` 相同。
`MATCH_HIGHLIGHTING_DISABLED`	停用所有文件的相符內容醒目顯示功能。
`MATCH_HIGHLIGHTING_ENABLED`	在所有文件中醒目顯示相符內容。

FacetSpec

執行多面向搜尋的 facet 規格。

欄位
`facet_key`	`FacetKey` 這是必要旗標，構面鍵規格。
`limit`	`int32` 這個 Facet 傳回的 Facet 值數量上限。如未指定，則預設值為 20。允許的最大值為 300。如果值超過 300，系統會強制設為 300。在醫療照護搜尋中進行匯總時，如果 [FacetKey.key] 是「healthcare_aggregation_key」，系統會將限制內部覆寫為 10,000，無論您在此設定的值為何。如果這個欄位為負數，系統會傳回 `INVALID_ARGUMENT`。
`excluded_filter_keys[]`	`string` 分層檢索時要排除的金鑰清單。根據預設，除非 `FacetKey.key` 列在這個欄位中，否則不會從篩選器中排除。在這個欄位中列出 Facet 鍵，即使 Facet 值已從搜尋結果中篩除，仍會顯示為 Facet 結果。使用這個欄位不會影響傳回的搜尋結果。舉例來說，假設有 100 份文件的顏色 Facet 為「紅色」，200 份文件的顏色 Facet 為「藍色」。如果查詢包含「color:ANY("Red")」篩選器，且「color」為 `FacetKey.key`，則預設只會在搜尋結果中傳回「Red」文件，並只傳回「Red」和計數 100 做為顏色 Facet。雖然也有藍色文件，但「藍色」不會顯示為可用的 Facet 值。如果「color」列在「excludedFilterKeys」中，查詢會傳回 Facet 值「Red」(計數為 100) 和「Blue」(計數為 200)，因為「color」鍵現在已從篩選器中排除。由於這個欄位不會影響搜尋結果，因此搜尋結果仍會正確篩選，只傳回「紅色」文件。最多可輸入 100 個值。否則，系統會傳回 `INVALID_ARGUMENT` 錯誤。
`enable_dynamic_position`	`bool` 啟用這個 facet 的動態位置。如設為 true，系統會自動決定這個側面的位置，以及回應中的所有側面。如果啟用動態 facet，系統會一併排序。如果設為 false，回應中這個 facet 的位置會與要求中的位置相同，且會排在啟用動態位置的 facet 和所有動態 facet 之前。舉例來說，您可能希望一律在回應中傳回評分層面，但不一定會一律在頂端顯示評分層面。在這種情況下，您可以將 enable_dynamic_position 設為 true，讓系統自動決定回應中評分構面的位置。再舉一例，假設要求中包含下列構面： "rating", enable_dynamic_position = true "price", enable_dynamic_position = false 「brands」，enable_dynamic_position = false 此外，您也啟用了動態 facet，這會產生 facet `gender`。然後，回應中構面最終順序可以是 ("price", "brands", "rating", "gender") 或 ("price", "brands", "gender", "rating")，取決於 API 如何排序「gender」和「rating」構面。不過請注意，「price」和「brands」一律會排在第一和第二位，因為 enable_dynamic_position 為 false。

FacetKey

指定如何計算側邊。

欄位
`key`	`string` 這是必要旗標，`Document` 物件中支援的文字和數值層面鍵，系統會根據這些鍵計算層面值。分頁鍵須區分大小寫。
`intervals[]`	`Interval` 只有在值應分組到間隔時才設定。必須為具有數值的 facet 設定。不得為含有文字值的 facet 設定。間隔數上限為 30。
`restricted_values[]`	`string` 只取得指定受限值的 facet。僅支援文字欄位。舉例來說，假設「類別」有三個值：「動作 > 2022」、「動作 > 2021」和「科幻 > 2022」。如果將「restricted_values」設為「Action > 2022」，則「category」層面只會包含「Action > 2022」。僅支援文字欄位。最多 10 個。
`prefixes[]`	`string` 只取得以指定字串前置字元開頭的側欄值。舉例來說，假設「類別」有三個值：「動作 > 2022」、「動作 > 2021」和「科幻 > 2022」。如果將「前置字元」設為「動作」，則「類別」層面只會包含「動作 > 2022」和「動作 > 2021」。僅支援文字欄位。最多 10 個。
`contains[]`	`string` 只取得包含指定字串的側滑選單值。舉例來說，假設「類別」有三個值：「動作 > 2022」、「動作 > 2021」和「科幻 > 2022」。如果將「包含」設為「2022」，則「類別」層面只會包含「動作 > 2022」和「科幻 > 2022」。僅支援文字欄位。最多 10 個。
`case_insensitive`	`bool` 如果使用前置字元或包含字元取得分面值時，分面鍵不區分大小寫，則為 True；否則為 False。
`order_by`	`string` 傳回文件的順序。允許的值包括：「count desc」，表示依 `SearchResponse.Facet.values.count` 遞減排序。「value desc」，表示依 `SearchResponse.Facet.values.value` 遞減排序。僅適用於文字構面。如未設定，文字值會以自然順序排序；數值間隔則會以 `FacetSpec.FacetKey.intervals` 指定的順序排序。

ImageQuery

指定圖片查詢輸入內容。

欄位

聯集欄位 image。

image 只能是下列其中一項：

image_bytes

string

Base64 編碼的圖片位元組。支援的圖片格式：JPEG、PNG 和 BMP。

NaturalLanguageQueryUnderstandingSpec

規格：為搜尋要求啟用自然語言理解功能。

欄位
`filter_extraction_condition`	`FilterExtractionCondition` 篩選器擷取作業的發生條件。伺服器行為預設為 `DISABLED`。
`geo_search_query_detection_field_names[]`	`string` 用於位置篩選的欄位名稱，系統會在自然語言搜尋查詢中偵測到地理位置篩選條件。只有在 FilterExtractionCondition 設為 `ENABLED` 時才有效。如果設定此欄位，系統會覆寫 `ServingConfig.geo_search_query_detection_field_names` 中設定的欄位名稱。
`extracted_filter_behavior`	`ExtractedFilterBehavior` (選用步驟) 控制如何將擷取的篩選器套用至搜尋。預設行為取決於要求。如果是單一資料儲存庫結構化搜尋，預設值為 `HARD_FILTER`。如果是多資料存放區搜尋，預設行為為 `SOFT_BOOST`。系統一律會將位置篩選器套用為硬性篩選器，且 `SOFT_BOOST` 設定不會影響這類篩選器。只有在 [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] 設為 `FilterExtractionCondition.ENABLED` 時，才會使用此欄位。
`allowed_field_names[]`	`string` (選用步驟) 可用於擷取自然語言篩選條件的欄位許可清單。如果未指定，所有可建立索引的欄位預設都會符合自然語言篩選器擷取條件 (但不保證會使用)。如果 allowed_field_names 中指定了任何欄位，只有在結構定義中標示為可建立索引，且指定於允許清單中的欄位，才符合自然語言篩選器擷取資格。注意：目前不支援多資料存放區搜尋，系統會忽略這項設定。

ExtractedFilterBehavior

列舉說明如何將擷取的篩選器套用至搜尋。

列舉
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` 會使用預設行為擷取篩選器。如果是單一資料儲存區搜尋，預設會套用硬性篩選器。如果是多資料儲存庫搜尋，預設會套用為軟性加成。
`HARD_FILTER`	將所有擷取的篩選條件套用至結果，做為硬性篩選條件。如果結果未通過擷取的篩選條件，就不會傳回結果集。
`SOFT_BOOST`	將所有擷取的篩選條件套用為軟性加成。通過篩選條件的結果會在結果集中獲得較高的排名。

FilterExtractionCondition

列舉，說明應在何種條件下擷取篩選器。

列舉
`CONDITION_UNSPECIFIED`	伺服器行為預設為 `DISABLED`。
`DISABLED`	停用 NL 篩選器擷取作業。
`ENABLED`	啟用 NL 篩選器擷取功能。

QueryExpansionSpec

規格，用於判斷查詢擴展的條件。

欄位

condition

Condition

查詢擴充的條件。預設值為 Condition.DISABLED。

pin_unexpanded_results

bool

是否要固定未展開的結果。如果將這個欄位設為 true，搜尋結果一律會先顯示未使用擴充功能的產品，再顯示擴充結果。

條件

列舉，說明查詢擴展應在何種條件下發生。

列舉
`CONDITION_UNSPECIFIED`	未指定查詢擴充條件。在此情況下，伺服器行為預設為 `Condition.DISABLED`。
`DISABLED`	已停用查詢擴充功能。即使 `SearchResponse.total_size` 為零，系統還是只會使用完全相符的搜尋查詢。
`AUTO`	由 Search API 建立的自動查詢擴充。

RankingExpressionBackend

用於排名運算式評估的後端。

列舉
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	未指定/不明值的預設選項。
`BYOE`	已淘汰：請改用 `RANK_BY_EMBEDDING`。依自訂嵌入模型排序，這是評估排序運算式的預設方式。舊版列舉選項，請改用 `RANK_BY_EMBEDDING`。這個項目已遭淘汰！
`CLEARBOX`	已淘汰：請改用 `RANK_BY_FORMULA`。依自訂公式排名。舊版列舉選項，請改用 `RANK_BY_FORMULA`。這個項目已遭淘汰！
`RANK_BY_EMBEDDING`	使用自訂嵌入模型排序，這是評估排序運算式的預設方式。
`RANK_BY_FORMULA`	依自訂公式排名。

RelevanceScoreSpec

傳回文件關聯分數的規格。

欄位

return_relevance_score

bool

(選用步驟) 是否要傳回搜尋結果的關聯性分數。分數越高，表示文件與查詢的關聯性越高。

RelevanceThreshold

搜尋結果的關聯性門檻。關聯性門檻越高，顯示的相關結果就越多，但傳回的結果數會減少。

列舉
`RELEVANCE_THRESHOLD_UNSPECIFIED`	預設值。在這種情況下，伺服器行為會預設為 Google 定義的門檻。
`LOWEST`	最低關聯性門檻。
`LOW`	關聯性門檻較低。
`MEDIUM`	中等關聯性門檻。
`HIGH`	高關聯性門檻。

SearchAsYouTypeSpec

在搜尋要求中輸入搜尋內容時的規格。

欄位

condition

Condition

即時搜尋功能應執行的條件。預設值為 Condition.DISABLED。

條件

列舉，說明應在何種條件下進行輸入時搜尋。

列舉
`CONDITION_UNSPECIFIED`	伺服器行為預設為 `Condition.DISABLED`。
`DISABLED`	停用即時搜尋功能。
`ENABLED`	啟用即時搜尋功能。
`AUTO`	自動在「邊打邊搜尋」和標準搜尋模式之間切換，非常適合單一 API 實作 (例如去抖動)。

SessionSpec

工作階段規格。

多輪搜尋功能目前處於不公開正式發布階段。在公開發布這項功能前，請改用 v1alpha 或 v1beta 版。您也可以透過 Google 支援團隊申請加入允許清單。

欄位

query_id

string

如果已設定，搜尋結果會儲存在這個查詢 ID 指定的「回合」。

舉例來說，假設工作階段如下： session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }

使用者可以透過類似下列要求的形式呼叫 /search API：

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

接著，API 會儲存搜尋結果，並與最後一輪對話建立關聯。後續的 /answer API 呼叫 (指定工作階段 ID 和查詢 ID) 可以使用儲存的搜尋結果。此外，您也可以使用相同的會期 ID 和查詢 ID，平行呼叫 /search 和 /answer。

search_result_persistence_count

int32

要保留的最相關搜尋結果數量。後續的 /answer API 呼叫可使用保存的搜尋結果。

這個欄位與 SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count 中的 summary_result_count 欄位類似。

文件模式最多 10 個結果，區塊模式最多 50 個結果。

SpellCorrectionSpec

查詢拼字校正的規格。

欄位

mode

Mode

拼字修正取代原始搜尋查詢的模式。預設值為 Mode.AUTO。

模式

列舉，說明應以哪種模式進行拼字修正。

列舉
`MODE_UNSPECIFIED`	未指定拼字校正模式。在此情況下，伺服器行為預設為 `Mode.AUTO`。
`SUGGESTION_ONLY`	搜尋 API 會嘗試提供拼字建議。如果找到建議，就會放在 `SearchResponse.corrected_query` 中。系統不會將拼字建議做為搜尋查詢。
`AUTO`	由 Search API 提供的自動拼寫校正功能。如果系統找到修正後的查詢，就會根據該查詢進行搜尋。

SearchResponse

SearchService.Search 方法的回應訊息。

欄位
`results[]`	`SearchResult` 相符文件清單。順序代表排名。
`facets[]`	`Facet` 使用者要求的構面結果。
`total_size`	`int32` 相符項目的預估總數，與分頁無關。分頁傳回的 `results` 數量可能少於相符的 `total_size` 數量。
`attribution_token`	`string` 不重複的搜尋符記。這應包含在這次搜尋產生的 `UserEvent` 記錄中，以便準確歸因搜尋模型成效。這也有助於在客戶服務情境中識別要求。
`redirect_uri`	`string` 客戶定義的重新導向頁面 URI。如果觸發重新導向動作，系統不會執行搜尋，只會在回應中設定 `redirect_uri` 和 `attribution_token`。
`next_page_token`	`string` 可做為 `SearchRequest.page_token` 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。
`corrected_query`	`string` 如果找到拼字修正後的查詢，就會顯示在這裡。如果拼字修正類型為 AUTOMATIC，搜尋結果會以 corrected_query 為準。否則系統會使用原始查詢進行搜尋。
`summary`	`Summary` 摘要會顯示在搜尋結果中。只有在設定 `SearchRequest.ContentSearchSpec.summary_spec` 時，才會傳回這個欄位。
`query_expansion_info`	`QueryExpansionInfo` 傳回結果的查詢擴展資訊。
`session_info`	`SessionInfo` 工作階段資訊。只有在提供 `SearchRequest.session` 時才需要設定。詳情請參閱說明。
`search_link_promotions[]`	`SearchLinkPromotion` 站內搜尋的促銷活動。

Facet 結果。

欄位

key

string

這個 Facet 的鍵。例如 "colors" 或 "price"。與 SearchRequest.FacetSpec.FacetKey.key 相符。

values[]

FacetValue

這個欄位的刻面值。

dynamic_facet

bool

該層面是否為動態產生。

FacetValue

包含值名稱和計數的 Facet 值。

欄位
`count`	`int64` 具有這個 Facet 值的項目數量。
聯集欄位 `facet_value`。包含值的 facet 值。`facet_value` 只能是下列其中一項：
`value`	`string` 商情項目的文字值，例如商情項目「colors」的「Black」。
`interval`	`Interval` 商情項目的間隔值，例如商情項目「價格」的 [10, 20)。與 `SearchRequest.FacetSpec.FacetKey.intervals` 相符。

QueryExpansionInfo

說明查詢擴充的資訊，包括是否已擴充。

欄位

expanded_query

bool

說明是否發生查詢擴充的布林值。

pinned_result_count

int64

釘選結果的數量。只有在擴展發生且 SearchRequest.QueryExpansionSpec.pin_unexpanded_results 設為 true 時，才會設定這個欄位。

SearchResult

代表搜尋結果。

欄位
`id`	`string` `Document.id` 的搜尋結果`Document`。
`document`	`Document` 搜尋回應中的文件資料摘要。系統只會填入標示為 `retrievable` 的欄位。
`chunk`	`Chunk` 如果 `SearchRequest.ContentSearchSpec.search_result_mode` 設為 `CHUNKS`，搜尋回應中的區塊資料。
`model_scores`	`map<string, DoubleList>` 僅供輸出。Google 提供可用的分數。
`rank_signals`	`RankSignals` (選用步驟) 與結果相關的一組排名信號。

RankSignals

一組排名信號。

欄位
`default_rank`	`float` (選用步驟) 結果的預設排名。
`custom_signals[]`	`CustomSignal` (選用步驟) 自訂 Clearbox 信號清單。
`keyword_similarity_score`	`float` (選用步驟) 調整關鍵字比對。
`relevance_score`	`float` (選用步驟) 調整語意相關性。
`semantic_similarity_score`	`float` (選用步驟) 調整語意相似度。
`pctr_rank`	`float` (選用步驟) 預測轉換率調整幅度 (以等級表示)。
`topicality_rank`	`float` (選用步驟) 主題性調整幅度 (以等級表示)。
`document_age`	`float` (選用步驟) 文件建立時間長度 (小時)。
`boosting_factor`	`float` (選用步驟) 文件的整合自訂提升。

CustomSignal

以名稱和值組合表示的自訂 Clearbox 信號。

欄位

name

string

(選用步驟) 信號名稱。

value

float

(選用步驟) 代表排名信號的浮點值 (例如 BM25 的 1.25)。

SessionInfo

工作階段相關資訊。

欄位

name

string

工作階段名稱。如果使用自動工作階段模式 (SearchRequest.session 以「-」結尾)，這個欄位會保留新產生的工作階段名稱。

query_id

string

與此搜尋 API 呼叫相應的查詢 ID。一個工作階段可以有多個輪次，每個輪次都有專屬的查詢 ID。

在 Answer API 呼叫中指定工作階段名稱和這個查詢 ID，系統就會根據這項搜尋呼叫的搜尋結果生成回覆。

摘要

摘要規格中指定的前 N 個搜尋結果摘要。

欄位
`summary_text`	`string` 摘要內容。
`summary_skipped_reasons[]`	`SummarySkippedReason` 其他摘要略過原因。這會提供忽略案例的原因。如果沒有略過任何項目，就不會設定這個欄位。
`safety_attributes`	`SafetyAttributes` 安全屬性類別的集合，以及相關聯的信心分數。
`summary_with_metadata`	`SummaryWithMetadata` 摘要和中繼資料資訊。

引用內容

區隔的引用資訊。

欄位

start_index

int64

索引代表區段的開頭，以位元組/Unicode 為單位。

end_index

int64

歸因區隔的結束時間 (不包含在內)。

sources[]

CitationSource

已歸因區隔的引用來源。

CitationMetadata

引用中繼資料。

欄位

citations[]

Citation

區隔的引用內容。

CitationSource

引用來源。

欄位

reference_index

int64

從 SummaryWithMetadata.references 建立文件參考索引。這是以 0 為索引的值，如果未明確設定 reference_index，則值為零。

參考資料

文件參照。

欄位
`title`	`string` 文件標題。
`document`	`string` 這是必要旗標，`Document.name`。所參照文件的完整資源名稱，格式為 `projects//locations//collections//dataStores//branches//documents/`。
`uri`	`string` 文件的 Cloud Storage 或 HTTP URI。
`chunk_contents[]`	`ChunkContent` 從文件內容衍生而來的引用區塊內容清單。

ChunkContent

將內容分塊。

欄位

content

string

將文字內容分塊。

page_identifier

string

網頁 ID。

SafetyAttributes

安全屬性類別和對應的信心分數。

欄位

categories[]

string

與生成內容相關聯的安全屬性類別顯示名稱。順序與分數相符。

scores[]

float

每個類別的可信度分數，分數越高表示可信度越高。順序與類別相符。

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 會略過摘要。

SummaryWithMetadata

摘要和中繼資料資訊。

欄位

summary

string

摘要文字，沒有引文資訊。

citation_metadata

CitationMetadata

指定摘要的引用中繼資料。

references[]

Reference

文件參考資料。

SearchTier

搜尋功能層級。不同層級的價格可能不同。詳情請參閱定價說明文件。

列舉
`SEARCH_TIER_UNSPECIFIED`	未指定列舉時的預設值。無法使用。
`SEARCH_TIER_STANDARD`	標準級。
`SEARCH_TIER_ENTERPRISE`	Enterprise 級別。

SearchUseCase

定義 SolutionType 的進一步細分。具體來說，這項功能適用於 SOLUTION_TYPE_SEARCH。

列舉
`SEARCH_USE_CASE_UNSPECIFIED`	未設定時使用的值。不會在 CSS 中發生。
`SEARCH_USE_CASE_SEARCH`	搜尋用途。預期流量具有非空白的 `query`。
`SEARCH_USE_CASE_BROWSE`	瀏覽用途。預期流量具有空白 `query`。

ServingConfig

設定用於產生供應時間結果 (例如搜尋結果或推薦預測) 的中繼資料。ServingConfig 會傳遞至搜尋和預測要求，並產生結果。

欄位
`name`	`string` 不可變動。完整名稱 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` 這是必要旗標，使用者可理解的供應設定顯示名稱。用於探索使用者介面。這個欄位必須是 UTF-8 編碼的字串，長度上限為 128 個半形字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`solution_type`	`SolutionType` 這是必要旗標，不可變動。指定供應設定可關聯的解決方案類型。
`model_id`	`string` 在服務時間使用的模型 ID。目前僅支援 RecommendationModel。可以變更，但只能變更為相容模型 (例如將「您可能喜歡的其他項目」點閱率變更為「您可能喜歡的其他項目」轉換率)。如果 `SolutionType` 為 `SOLUTION_TYPE_RECOMMENDATION`，則為必填屬性。
`diversity_level`	`string` 建議模型結果中要使用的多樣性程度，例如 `medium-diversity` 或 `high-diversity`。目前支援的值： `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` 如未指定，我們會根據建議模型類型選擇預設值。預設值為 `no-diversity`。只有在 `SolutionType` 為 `SOLUTION_TYPE_RECOMMENDATION` 時，才能設定。
`ranking_expression`	`string` 排名運算式可控管擷取文件的自訂排名。如要使用這項功能，必須先嵌入文件。ServingConfig 中的排名運算式設定適用於供應設定處理的所有搜尋要求。不過，如果指定 `SearchRequest.ranking_expression`，系統會覆寫 ServingConfig 排序運算式。排名運算式是單一函式或多個以「+」連結的函式。 ranking_expression = function, { " + ", function }; 支援的函式： double * relevance_score double * dotProduct(embedding_field_path) 函式變數： `relevance_score`：預先定義的關鍵字，用於評估查詢和文件之間的關聯性。 `embedding_field_path`：與查詢嵌入向量搭配使用的文件嵌入欄位。 `dotProduct`：embedding_field_path 和查詢嵌入向量之間的嵌入函式。排名運算式範例：如果文件含有嵌入欄位 doc_embedding，則排名運算式可能是 `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`。
`create_time`	`Timestamp` 僅供輸出。ServingConfig 建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。供應設定更新時間戳記。
`filter_control_ids[]`	`string` 在放送路徑中使用的篩選器控制項。系統會套用所有觸發的篩選器控制項。篩選器控制項必須與服務設定位於同一個資料存放區。最多 20 個篩選器控制項。
`boost_control_ids[]`	`string` 在放送路徑中使用的升幅控制項。系統會套用所有觸發的升級控制選項。提升控制項必須與服務設定位於相同的資料存放區。最多可設定 20 個提高排名控制項。
`redirect_control_ids[]`	`string` 重新導向控制項的 ID。即使有多個適用，系統也只會套用第一個觸發的重新導向動作。最多只能有 100 項規格。只有在 `SolutionType` 為 `SOLUTION_TYPE_SEARCH` 時，才能設定。
`synonyms_control_ids[]`	`string` 條件同義詞規格。如果符合多個同義字條件，系統會執行清單中所有相符的同義字控制項。最多只能有 100 項規格。只有在 `SolutionType` 為 `SOLUTION_TYPE_SEARCH` 時，才能設定。
`oneway_synonyms_control_ids[]`	`string` 單向同義詞的條件規格。如果符合多個單向同義字條件，系統會執行清單中所有相符的單向同義字控制選項。最多只能有 100 項規格。只有在 `SolutionType` 為 `SOLUTION_TYPE_SEARCH` 時，才能設定。
`dissociate_control_ids[]`	`string` 條件不會關聯規格。如果多個不關聯條件相符，系統會執行清單中所有相符的不關聯控制選項。順序沒有影響。最多只能有 100 項規格。只有在 `SolutionType` 為 `SOLUTION_TYPE_SEARCH` 時，才能設定。
`replacement_control_ids[]`	`string` 條件更換規格。系統會依清單中的順序套用規則。先前取代的字詞無法再次取代。最多只能有 100 項規格。只有在 `SolutionType` 為 `SOLUTION_TYPE_SEARCH` 時，才能設定。
`ignore_control_ids[]`	`string` 忽略條件規格。如果符合多個忽略條件，系統會執行清單中所有相符的忽略控制項。順序沒有影響。最多只能有 100 項規格。
`promote_control_ids[]`	`string` 條件促銷規格。最多只能有 100 項規格。
`answer_generation_spec`	`AnswerGenerationSpec` (選用步驟) 生成答案的規格。
聯集欄位 `vertical_config`。特定產業別的設定。`vertical_config` 只能是下列其中一項：
`media_config`	`MediaConfig` 供應設定的 MediaConfig。
`generic_config`	`GenericConfig` 供應設定的 GenericConfig。

GenericConfig

指定通用探索所需的設定。目前支援：

content_search_spec：一般內容搜尋的設定。

欄位

content_search_spec

ContentSearchSpec

指定內容搜尋的預期行為。僅適用於已啟用內容搜尋功能的資料儲存庫。

MediaConfig

指定媒體探索所需的設定。目前支援的項目如下：

demote_content_watched：觀看內容降級的門檻。顧客可以指定是否要使用看過內容降級或看過詳細資料頁面。使用觀看內容降級功能時，客戶必須指定觀看分鐘數或百分比超過門檻，系統就會在推薦結果中降級該內容。
promote_fresh_content：宣傳最新內容的截止日期。顧客可以指定是否使用內容新鮮度宣傳活動。如果內容是在截止日期前發布，系統會在推薦結果中宣傳該內容。只有在 SolutionType 為 SOLUTION_TYPE_RECOMMENDATION 時，才能設定。

欄位
`demotion_event_type`	`string` 指定用於降低建議結果優先順序的事件類型。目前支援的值： `view-item`：查看項目。 `media-play`：開始/繼續觀看影片、播放歌曲等。 `media-complete`：已看完或中途停止觀看影片、聽完或中途停止聆聽歌曲等。如未設定，系統不會套用觀看記錄降級。系統仍會套用內容更新降級處置。
`demote_content_watched_past_days`	`int32` (選用步驟) 指定要往回追溯的天數，系統會根據這項設定降級已觀看內容。如果設為零或未設定，預設為最多 365 天。
`content_freshness_cutoff_days`	`int32` 指定用於建議結果的內容新鮮度。如果內容發布時間超過內容更新截止天數，系統就會降低內容排名。
聯集欄位 `demote_content_watched`。指定降級已觀看內容的門檻，門檻可以是百分比或分鐘值。必須為 `media-complete` 事件類型設定此值。`demote_content_watched` 只能是下列其中一項：
`content_watched_percentage_threshold`	`float` 指定降級的觀看內容百分比門檻。門檻值必須介於 [0, 1.0] 之間 (含)。
`content_watched_seconds_threshold`	`float` 指定降級的觀看時數門檻。

工作階段

外部工作階段 Proto 定義。

欄位
`name`	`string` 不可變動。完整名稱 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` (選用步驟) 工作階段的顯示名稱。這個欄位用於在 UI 中識別工作階段。根據預設，顯示名稱是工作階段中的第一個查詢文字。
`state`	`State` 工作階段的狀態。
`user_pseudo_id`	`string` 用於追蹤使用者的專屬 ID。
`turns[]`	`Turn` 轉彎。
`labels[]`	`string` (選用步驟) 工作階段的標籤。可在 ListSessionsRequest 中設為篩選條件。
`start_time`	`Timestamp` 僅供輸出。工作階段開始時間。
`end_time`	`Timestamp` 僅供輸出。工作階段結束的時間。
`is_pinned`	`bool` (選用步驟) 工作階段是否已釘選，釘選的工作階段會顯示在工作階段清單頂端。

狀態

列舉工作階段的狀態。

列舉
`STATE_UNSPECIFIED`	未指定狀態。
`IN_PROGRESS`	目前工作階段已開啟。

Turn

代表一輪對話，包括使用者的查詢和服務的回覆。

欄位
`query`	`Query` (選用步驟) 使用者查詢。如果這輪對話只是重新生成另一輪對話的答案，可能不會設定這項屬性
`answer`	`string` (選用步驟) 使用者查詢的答案資源名稱。只有在這一輪中生成答案 (呼叫 /answer API) 時，才需要設定。
`assist_answer`	`string` 僅供輸出。使用者查詢的 Google 助理回覆資源名稱。只有在這一輪中發生輔助呼叫 (/assist API 呼叫) 時，才需要設定。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`。如要取得工作階段的所有 AssistAnswers，請將 GetSessionRequest.include_answer_details 設為 true。或者，如要取得個別的 AssistAnswer 資源，請使用 AssistAnswerService.GetAssistAnswer API。
`detailed_answer`	`Answer` 僅供輸出。在 `ConversationalSearchService.GetSession` API 中，如果 `GetSessionRequest.include_answer_details` 設為 true，系統會在取得答案查詢工作階段時填入這個欄位。
`detailed_assist_answer`	`AssistAnswer` 僅供輸出。在 `ConversationalSearchService.GetSession` API 中，如果 `GetSessionRequest.include_answer_details` 設為 true，這個欄位會在取得助理工作階段時填入。
`query_config`	`map<string, string>` (選用步驟) 代表與查詢設定相關的中繼資料，例如使用的 LLM 模型和版本、模型參數 (溫度、基礎參數等)。前置字串「google.」已預留給 Google 開發的功能。

SetUpDataConnectorMetadata

這個類型沒有任何欄位。

DataConnectorService.SetUpDataConnector 方法的中繼資料。

SetUpDataConnectorRequest

要求 DataConnectorService.SetUpDataConnector 方法。

欄位
`parent`	`string` 這是必要旗標，`Collection` 的父項，格式為 `projects/{project}/locations/{location}`。
`collection_id`	`string` 這是必要旗標，要用於 `Collection` 的 ID，會成為 `Collection` 資源名稱的最終元件。系統會在 `DataConnector` 設定程序中建立新的 `Collection`。`DataConnector` 是 `Collection` 下的單例資源，可管理 `Collection` 的所有 `DataStore`。這個欄位必須符合 RFC-1034 標準，長度上限為 63 個字元。否則，系統會傳回 INVALID_ARGUMENT 錯誤。
`collection_display_name`	`string` 這是必要旗標，`Collection` 的顯示名稱。應為使用者可理解的名稱，用於在管理中心資訊主頁中顯示集合。採用 UTF-8 編碼的字串，最多 1024 個字元。
`data_connector`	`DataConnector` 這是必要旗標，要在新建立的 `Collection` 中初始化的 `DataConnector`。

SingleRegionKey

單一區域 CMEK 的中繼資料。

欄位

kms_key

string

這是必要旗標，單一區域 kms 金鑰資源名稱，用於加密資源 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}。

SiteSearchEngine

SiteSearchEngine 會擷取資料儲存庫層級的網站搜尋持續設定。每個資料儲存庫都有一個單例值。

欄位

name

string

網站搜尋引擎的完整資源名稱。格式：projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

進階站內搜尋中目標網站的驗證資訊。

欄位

site_verification_state

SiteVerificationState

網站驗證狀態，指出擁有權和有效性。

verify_time

網站最近一次的驗證時間。

SiteVerificationState

網站驗證狀態。

列舉
`SITE_VERIFICATION_STATE_UNSPECIFIED`	預設值為「已驗證」。
`VERIFIED`	網站擁有權驗證完成。
`UNVERIFIED`	網站擁有權驗證待處理或驗證失敗。
`EXEMPTED`	網站可免除驗證，例如對外開放的公用網站。

Sitemap

SiteSearchEngine 的 Sitemap。

欄位
`name`	`string` 僅供輸出。網站地圖的完整資源名稱。`projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` `sitemap_id` 後置字串是由系統產生。
`create_time`	`Timestamp` 僅供輸出。Sitemap 的建立時間。
聯集欄位 `feed`。支援的動態饋給來源。`feed` 只能是下列其中一項：
`uri`	`string` Sitemap 的公開 URI，例如 `www.example.com/sitemap.xml`。

SolutionType

解決方案類型。

列舉
`SOLUTION_TYPE_UNSPECIFIED`	預設值。
`SOLUTION_TYPE_RECOMMENDATION`	用於 Recommendations AI。
`SOLUTION_TYPE_SEARCH`	用於探索搜尋。
`SOLUTION_TYPE_CHAT`	用於與生成式 AI 代理相關的用途。
`SOLUTION_TYPE_GENERATIVE_CHAT`	用於與生成式即時通訊代理程式相關的用途。這項功能僅適用於生成式聊天引擎，相關聯的資料儲存庫必須註冊 `SOLUTION_TYPE_CHAT` 解決方案。

SpannerSource

用來匯入資料的 Spanner 來源

欄位
`project_id`	`string` 包含 Spanner 來源的專案 ID。長度上限為 128 個半形字元。如未指定，則會沿用父項要求的專案 ID。
`instance_id`	`string` 這是必要旗標，來源 Spanner 資料表的執行個體 ID。
`database_id`	`string` 這是必要旗標，來源 Spanner 資料表的資料庫 ID。
`table_id`	`string` 這是必要旗標，需要匯入的 Spanner 資料庫資料表名稱。
`enable_data_boost`	`bool` 是否要在 Spanner 匯出作業中套用資料加速功能。啟用這項選項會產生額外費用。如要瞭解詳情，請按這裡。

StreamAssistRequest

要求 AssistantService.StreamAssist 方法。

欄位
`name`	`string` 這是必要旗標，`Assistant` 的資源名稱。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` (選用步驟) 目前的使用者查詢。只有在提供 `file_ids` 時，系統才支援空白查詢。在這種情況下，系統會根據這些情境檔案生成答案。
`session`	`string` (選用步驟) 要求使用的工作階段。如果指定，助理就能存取工作階段記錄，並將查詢和答案儲存在該處。如果將 `-` 指定為工作階段 ID，或將其留空，系統就會建立新的工作階段，並自動產生 ID。格式：`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` (選用步驟) 啟動查詢的使用者相關資訊。
`agents_spec`	`AgentsSpec` (選用步驟) 用於處理要求的代理程式規格。
`tools_spec`	`ToolsSpec` (選用步驟) 用於處理要求的工具規格。
`generation_spec`	`GenerationSpec` (選用步驟) 要求的生成設定規格。

AgentsSpec

用於處理要求的代理程式規格。

欄位

agent_specs[]

AgentSpec

(選用步驟) 用於處理要求的代理程式規格。

AgentSpec

代理程式規格。

欄位

agent_id

string

這是必要旗標，用於識別處理要求的代理程式資源。

這個欄位必須符合 RFC-1034，長度上限為 63 個字元。

GenerationSpec

要求的 Google 助理生成規格。這項功能可讓您在引擎層級覆寫預設生成設定。

欄位

model_id

string

(選用步驟) 用於生成模型的 Vertex AI model_id。如未設定，系統會使用預設的 Google 助理模型。

ToolsSpec

用於處理要求的工具規格。

欄位
`vertex_ai_search_spec`	`VertexAiSearchSpec` (選用步驟) Vertex AI Search 工具的規格。
`web_grounding_spec`	`WebGroundingSpec` (選用步驟) 網頁基準工具的規格。如有這個欄位，系統會啟用網頁搜尋功能，以建立回覆基準。只有在 `Assistant.web_grounding_type` 為 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 或 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] 時，這項功能才會運作。
`image_generation_spec`	`ImageGenerationSpec` (選用步驟) 圖像生成工具的規格。
`video_generation_spec`	`VideoGenerationSpec` (選用步驟) 影片生成工具的規格。

ImageGenerationSpec

這個類型沒有任何欄位。

圖像生成工具的規格。

VertexAiSearchSpec

Vertex AI Search 工具的規格。

欄位

data_store_specs[]

DataStoreSpec

(選用步驟) 定義 DataStore 的規格，可在搜尋呼叫中進行篩選，以及這些資料儲存庫的設定。只有在Engine有多個資料儲存庫時，系統才會考量這項因素。

filter

string

(選用步驟) 篩選器語法包含運算式語言，可從要篩選的文件的一或多個欄位建構述詞。篩選運算式會區分大小寫。

如果無法辨識這個欄位，系統會傳回 INVALID_ARGUMENT。

如要在 Vertex AI Search 中進行篩選，請將左側的篩選鍵對應至 Vertex AI Search 後端定義的鍵屬性，這項對應是由客戶在結構定義中定義。舉例來說，媒體客戶的結構定義中可能會有「name」欄位。在本例中，篩選器會如下所示：filter --> name:'ANY("king kong")'

如要進一步瞭解篩選功能，包括語法和篩選運算子，請參閱「篩選」

VideoGenerationSpec

這個類型沒有任何欄位。

影片生成工具的規格。

WebGroundingSpec

這個類型沒有任何欄位。

網頁基準工具的規格。

StreamAssistResponse

AssistantService.StreamAssist 方法的回應。

欄位

answer

AssistAnswer

Assist 回覆資源物件，內含 AI 助理對使用者查詢的最終回覆部分內容。

如果目前的回應未在先前傳送的 AssistAnswer.replies 中新增任何內容，則不會顯示這項資訊。

觀察 AssistAnswer.state，看看是否會出現更多部分。當狀態為 IN_PROGRESS 時，每個回應中的 AssistAnswer.replies 欄位都會包含回覆 (回覆片段)，這些回覆會附加至先前回應中收到的回覆。AssistAnswer.name不會填寫。

如果狀態為 SUCCEEDED、FAILED 或 SKIPPED，回應會是最後一個回應，且 AssistAnswer.name 會包含值。

session_info

SessionInfo

工作階段資訊。只會包含在回應串流的最終 StreamAssistResponse 中。

assist_token

string

全域不重複 ID，用於識別目前的要求和回應串流配對。用於意見回饋和支援服務。

SessionInfo

工作階段相關資訊。

欄位

session

string

新生成或繼續的工作階段名稱。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}。

SubscriptionTerm

訂閱約期。LINT.IfChange

列舉
`SUBSCRIPTION_TERM_UNSPECIFIED`	預設值，請勿使用。
`SUBSCRIPTION_TERM_ONE_MONTH`	1 個月。
`SUBSCRIPTION_TERM_ONE_YEAR`	1 年。
`SUBSCRIPTION_TERM_THREE_YEARS`	3 年。

SubscriptionTier

訂閱級別資訊。

列舉
`SUBSCRIPTION_TIER_UNSPECIFIED`	預設值。
`SUBSCRIPTION_TIER_SEARCH`	搜尋層級。搜尋層級可存取 VAIS 搜尋功能和 NotebookLM 功能。
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	「搜尋與助理」級別。搜尋 + 助理服務級別可存取 VAIS 搜尋功能、NotebookLM 功能和助理功能。
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	NotebookLM 方案。NotebookLM 訂閱方案只能存取 NotebookLM 功能。
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	前線員工層級。
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Agentspace Starter 級別。
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Agentspace Business 方案。
`SUBSCRIPTION_TIER_ENTERPRISE`	Enterprise 級別。
`SUBSCRIPTION_TIER_EDU`	教育機構層級。
`SUBSCRIPTION_TIER_EDU_PRO`	Education Pro 級別。
`SUBSCRIPTION_TIER_EDU_EMERGING`	EDU 新興市場等級。
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Education Pro 新興市場層級。

SuggestionDenyListEntry

建議拒絕清單項目，用於識別要從建議中封鎖的詞組，以及套用至該詞組的作業。

欄位

block_phrase

string

這是必要旗標，系統會封鎖建議中顯示的片語。最多 125 個字元。

match_operator

MatchOperator

這是必要旗標，要套用至這個片語的相符運算子。封鎖完全相符的詞組，還是封鎖含有該詞組的任何建議。

MatchOperator

用於比對生成建議的運算子。

列舉
`MATCH_OPERATOR_UNSPECIFIED`	預設值。不應使用
`EXACT_MATCH`	如果建議與 block_phrase 完全相符，則封鎖建議。
`CONTAINS`	如果建議包含 block_phrase，請封鎖建議。

TargetSite

SiteSearchEngine 的目標網站。

欄位
`name`	`string` 僅供輸出。目標網站的完整資源名稱。`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` `target_site_id` 是由系統產生。
`provided_uri_pattern`	`string` 這是必要旗標，僅限輸入。使用者提供的 URI 模式，`generated_uri_pattern` 是從這個模式產生。
`type`	`Type` 目標網站的類型，例如網站是要納入還是排除。
`exact_match`	`bool` 不可變動。如果設為 false，系統會產生 uri_pattern，涵蓋位址包含 provided_uri_pattern 的所有網頁。如果設為 true，系統會產生 uri_pattern，盡量與 provided_uri_pattern 完全相符，如果 provided_uri_pattern 是特定網頁，則 uri_pattern 會與該網頁相符。系統一律會將 provided_uri_pattern 正規化，產生搜尋引擎使用的 URI 模式。
`generated_uri_pattern`	`string` 僅供輸出。這是系統根據 provided_uri_pattern 產生的內容。
`root_domain_uri`	`string` 僅供輸出。provided_uri_pattern 的根網域。
`site_verification_info`	`SiteVerificationInfo` 僅供輸出。網站擁有權和有效性驗證狀態。
`indexing_status`	`IndexingStatus` 僅供輸出。索引狀態。
`update_time`	`Timestamp` 僅供輸出。目標網站的上次更新時間。
`failure_reason`	`FailureReason` 僅供輸出。失敗原因。

FailureReason

站內搜尋索引建立失敗的原因。

欄位

聯集欄位 failure。失敗原因。failure 只能是下列其中一項：

quota_failure

QuotaFailure

配額不足，因此無法執行這項操作。

QuotaFailure

配額不足，因此無法執行這項操作。

欄位

total_required_quota

int64

這個數字是預估值，代表專案成功完成建立索引所需的配額總量。

IndexingStatus

目標網站索引狀態列舉。

列舉
`INDEXING_STATUS_UNSPECIFIED`	預設值為 SUCCEEDED。
`PENDING`	目標網站已加入更新佇列，索引管道會擷取該網站。
`FAILED`	目標網站無法建立索引。
`SUCCEEDED`	目標網站已編入索引。
`DELETING`	先前已建立索引的目標網站已標示為待刪除。這是過渡狀態，結果可能是：1. 如果取消索引成功，目標網站就會遭到刪除；2. 如果取消索引失敗，狀態就會還原為「SUCCEEDED」。
`CANCELLABLE`	目標網站變更作業正在等待處理，但可以取消。
`CANCELLED`	已取消目標網站變更。

類型

可能的目標網站類型。

列舉
`TYPE_UNSPECIFIED`	這個值不會使用。在此情況下，伺服器行為預設為 `Type.INCLUDE`。
`INCLUDE`	納入目標網站。
`EXCLUDE`	排除目標網站。

用戶群

連接器來源的租戶資訊。這包括儲存在憑證訊息中的部分相同資訊，但僅限於向使用者提供可存取租戶清單所需的資訊。

欄位

id

string

租戶的執行個體 ID。例如：Jira (「8594f221-9797-5f78-1fa4-485e198d7cd0」)、Slack (「T123456」)。

uri

string

租戶的 URI (如適用)。舉例來說，Jira 執行個體的 URI 為 https://my-jira-instance.atlassian.net，而 Slack 租戶沒有 URI。

display_name

string

租戶的選填顯示名稱，例如「我的 Slack 團隊」。

TextInput

定義文字輸入內容。

欄位

input

string

輸入文字。

context

ConversationContext

輸入內容的對話情境。

TrainCustomModelMetadata

與 TrainCustomModel 作業進度相關的中繼資料。這是由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

TrainCustomModelRequest

SearchTuningService.TrainCustomModel 方法的要求訊息。

欄位
`data_store`	`string` 這是必要旗標，資料儲存庫的資源名稱，例如 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`。這個欄位用於識別訓練模型時使用的資料儲存庫。
`model_type`	`string` 要訓練的模型。支援的值如下： search-tuning：根據提供的資料微調搜尋系統。
`error_config`	`ImportErrorConfig` 資料擷取和訓練期間發生錯誤的所需位置。
`model_id`	`string` 如未提供，系統會產生 UUID。
聯集欄位 `training_input`。模型訓練輸入內容。`training_input` 只能是下列其中一項：
`gcs_training_input`	`GcsTrainingInput` Cloud Storage 訓練輸入內容。

GcsTrainingInput

Cloud Storage 訓練資料輸入。

欄位
`corpus_data_path`	`string` 可與訓練資料建立關聯的 Cloud Storage 語料庫資料。資料路徑格式為 `gs://<bucket_to_data>/<jsonl_file_name>`。以換行符號分隔的 jsonl/ndjson 檔案。如果是搜尋調整模型，每行都應包含 _id、title 和 text。範例：`{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` 可與訓練資料建立關聯的 gcs 查詢資料。資料路徑格式為 `gs://<bucket_to_data>/<jsonl_file_name>`。以換行符號分隔的 jsonl/ndjson 檔案。如果是搜尋微調模型，每行應包含 _id 和文字。範例：{"_id": "query1", "text": "example query"}
`train_data_path`	`string` Cloud Storage 訓練資料路徑，格式應為 `gs://<bucket_to_data>/<tsv_file_name>`。檔案必須是 TSV 格式。每行都應包含 doc_id、query_id 和分數 (數字)。如果是搜尋調整模型，則應以查詢 ID、語料庫 ID 和分數做為 TSV 檔案標頭。分數應為 `[0, inf+)` 中的數字。數字越大，表示該配對的關聯性越高。範例： `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Cloud Storage 測試資料。格式與 train_data_path 相同。如未提供，系統會對 train_data_path 執行隨機 80/20 的訓練/測試分割。

TrainCustomModelResponse

TrainCustomModelRequest 的回應。這則訊息是由 google.longrunning.Operations.response 欄位傳回。

欄位
`error_samples[]`	`Status` 處理資料時發生錯誤的範例。
`error_config`	`ImportErrorConfig` 如果已設定，則會將要求中的完整錯誤回傳至目的地。
`model_status`	`string` 訓練模型的狀態。可能的值包括： bad-data：訓練資料品質不佳。 no-improvement：調整後效能沒有提升。不會部署。 in-progress：正在建立模型訓練工作。訓練中：模型正在積極訓練。評估：模型正在評估訓練指標。建立索引：模型訓練指標正在建立索引。 ready：模型已準備好提供服務。
`metrics`	`map<string, double>` 訓練後模型的指標。
`model_name`	`string` CustomTuningModel 的完整名稱。

TransactionInfo

交易代表整個購買交易。

欄位
`currency`	`string` 這是必要旗標，幣別代碼。請使用三字元 ISO-4217 代碼。
`transaction_id`	`string` 交易 ID，長度上限為 128 個字元。
`value`	`float` 這是必要旗標，與交易相關聯的非零總價值。這個值可能包含運費、稅金，或您想納入的總值其他調整項。
`tax`	`float` 與交易相關的所有稅金。
`cost`	`float` 與產品相關的所有費用。這些費用可能是製造成本、非由使用者負擔的運費，或是任何其他費用，例如：利潤 = `value` - `tax` - `cost`
`discount_value`	`float` 這筆交易套用的折扣總額。這項數據應從 `TransactionInfo.value` 中排除舉例來說，如果使用者支付 `TransactionInfo.value` 金額，則交易的名義 (折扣前) 價值為 `TransactionInfo.value` 和 `TransactionInfo.discount_value` 的總和這表示無論折扣值為何，利潤的計算方式都相同，且 `TransactionInfo.discount_value` 可能大於 `TransactionInfo.value`：利潤 = `value` - `tax` - `cost`

UpdateAclConfigRequest

UpdateAclConfig 方法的要求訊息。

欄位
`acl_config`	`AclConfig`

UpdateAssistantRequest

AssistantService.UpdateAssistant 方法的要求訊息。

欄位

assistant

Assistant

這是必要旗標，更新「Assistant」。

Assistant 的 name 欄位用於識別要更新的 Assistant。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

如果呼叫端沒有更新 Assistant 的權限 (無論該 Assistant 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要更新的 Assistant 不存在，系統會傳回 NOT_FOUND 錯誤。

update_mask

要更新的欄位清單。

UpdateCmekConfigMetadata

與 CmekConfigService.UpdateCmekConfig 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

UpdateCmekConfigRequest

UpdateCmekConfig 方法的要求訊息。rpc。

欄位

config

CmekConfig

這是必要旗標，CmekConfig 資源。

set_default

bool

如果未指定，請將下列 CmekConfig 設為子項資源的預設設定。

UpdateControlRequest

要求 UpdateControl 方法。

欄位

control

Control

這是必要旗標，要更新的 Control。

update_mask

(選用步驟) 指出要更新所提供 Control 的哪些欄位。系統「不」支援下列項目：

Control.name
Control.solution_type

如未設定或留空，系統會更新所有支援的欄位。

UpdateConversationRequest

Request for UpdateConversation method.

欄位

conversation

這是必要旗標，要更新的對話。

update_mask

指出要更新所提供 Conversation 的哪些欄位。系統「不」支援下列項目：

Conversation.name

如未設定或留空，系統會更新所有支援的欄位。

UpdateDataConnectorRequest

DataConnectorService.UpdateDataConnector 方法的要求訊息。

欄位

data_connector

DataConnector

這是必要旗標，更新「DataConnector」。

如果呼叫端沒有更新 DataConnector 的權限 (無論該 DataConnector 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果 DataConnector 不存在，系統會傳回 NOT_FOUND 錯誤。

update_mask

指出要更新所提供 DataConnector 的哪些欄位。

支援的欄位路徑包括：

refresh_interval
params
auto_run_disabled
action_config
action_config.action_params
action_config.service_name
destination_configs
blocking_reasons
sync_mode
incremental_sync_disabled
incremental_refresh_interval

注意：支援的欄位可能因連接器類型而異。舉例來說，並非所有連接器都支援 destination_configs。

如果您提供的是不明或不支援的欄位路徑，要求會傳回 INVALID_ARGUMENT 錯誤。

UpdateDataStoreRequest

DataStoreService.UpdateDataStore 方法的要求訊息。

欄位

data_store

DataStore

這是必要旗標，更新「DataStore」。

如果呼叫端沒有更新 DataStore 的權限 (無論該 DataStore 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要更新的 DataStore 不存在，系統會傳回 NOT_FOUND 錯誤。

update_mask

指出要更新所提供 DataStore 的哪些欄位。

如果您提供的是不明或不支援的欄位，則會傳回 INVALID_ARGUMENT 錯誤。

UpdateDocumentRequest

DocumentService.UpdateDocument 方法的要求訊息。

欄位

document

這是必要旗標，要更新/建立的文件。

如果呼叫者沒有更新 Document 的權限 (無論該 Document 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果更新的 Document 不存在，且未設定 allow_missing，系統會傳回 NOT_FOUND 錯誤。

allow_missing

bool

如果設為 true，且系統找不到 Document，就會建立新的 Document。

update_mask

指出要更新所匯入「文件」的哪些欄位。如未設定，預設會更新所有欄位。

UpdateEngineRequest

EngineService.UpdateEngine 方法的要求訊息。

欄位

engine

Engine

這是必要旗標，更新「Engine」。

如果呼叫端沒有更新 Engine 的權限 (無論該 Engine 是否存在)，系統都會傳回 PERMISSION_DENIED 錯誤。

如果要更新的 Engine 不存在，系統會傳回 NOT_FOUND 錯誤。

update_mask

指出要更新所提供 Engine 的哪些欄位。

如果您提供的是不明或不支援的欄位，則會傳回 INVALID_ARGUMENT 錯誤。

UpdateLicenseConfigRequest

LicenseConfigService.UpdateLicenseConfig 方法的要求訊息。

欄位

license_config

LicenseConfig

這是必要旗標，更新「LicenseConfig」。

update_mask

(選用步驟) 指出要更新所提供 LicenseConfig 的哪些欄位。

如果您提供的是不明或不支援的欄位，則會傳回 INVALID_ARGUMENT 錯誤。

UpdateSchemaMetadata

UpdateSchema LRO 的中繼資料。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

UpdateSchemaRequest

SchemaService.UpdateSchema 方法的要求訊息。

欄位

schema

Schema

這是必要旗標，更新「Schema」。

allow_missing

bool

如果設為 true，且系統找不到 Schema，就會建立新的 Schema。在這種情況下，系統會忽略 update_mask。

UpdateServingConfigRequest

要求 UpdateServingConfig 方法。

欄位

serving_config

ServingConfig

這是必要旗標，要更新的 ServingConfig。

update_mask

指出要更新所提供 ServingConfig 的哪些欄位。系統「不」支援下列項目：

ServingConfig.name

如未設定，系統會更新所有支援的欄位。

UpdateSessionRequest

UpdateSession 方法的要求。

欄位

session

這是必要旗標，要更新的 Session。

update_mask

指出要更新所提供 Session 的哪些欄位。系統「不」支援下列項目：

Session.name

如未設定或留空，系統會更新所有支援的欄位。

UpdateTargetSiteMetadata

與 SiteSearchEngineService.UpdateTargetSite 作業進度相關的中繼資料。這會由 google.longrunning.Operation.metadata 欄位傳回。

欄位

create_time

作業建立時間。

update_time

作業上次更新時間。如果作業已完成，這也是完成時間。

UpdateTargetSiteRequest

SiteSearchEngineService.UpdateTargetSite 方法的要求訊息。

欄位

target_site