Package google.cloud.visionai.v1

作業的開始時間。

update_time

作業的更新時間。

AnalysisStatus

各項搜尋功能的分析狀態。

欄位

state

status_message

string

search_capability

SearchCapability

要求的搜尋功能。

狀態

搜尋功能的狀態。

列舉
`STATE_UNSPECIFIED`	預設程序狀態不應發生。
`IN_PROGRESS`	這項功能正在開發中。
`SUCCEEDED`	程序已順利完成。
`FAILED`	程序失敗。

AnalyzeAssetRequest

AnalyzeAsset 的要求訊息。

欄位

name

string

這是必要旗標，要分析的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

AnalyzeAssetResponse

這個類型沒有任何欄位。

AnalyzeAsset 的回應訊息。

AnalyzeCorpusMetadata

AnalyzeCorpus LRO 的中繼資料訊息。

欄位

metadata

UserSpecifiedAnnotation

作業的中繼資料。

AnalyzeCorpusRequest

AnalyzeCorpus 的要求訊息。

欄位

name

string

這是必要旗標，素材資源將進行分析的父項字元集資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

AnalyzeCorpusResponse

這個類型沒有任何欄位。

AnalyzeCorpus LRO 的回應訊息。

AnalyzerDefinition

定義分析器。

分析器會使用代表運算子中定義的邏輯，處理輸入串流中的資料。當然，它會為運算子中宣告的輸出串流產生資料。

欄位
`analyzer`	`string` 這個分析器的名稱。暫時使用 [a-z][a-z0-9](_[a-z0-9]+)。
`operator`	`string` 這個分析器執行的運算子名稱。必須與支援的運算子名稱相符。
`inputs[]`	`StreamInput` 輸入串流。
`attrs`	`map<string, AttributeValue>` 這個分析器套用至運算子的屬性值。請提供屬性名稱與您要套用的實際值之間的對應關係。如果省略屬性名稱，系統會採用預先設定的預設值。
`debug_options`	`DebugOptions` 偵錯選項。
`operator_option`	`OperatorOption` 運算子選項。

DebugOptions

僅供偵錯用途的選項。

欄位

environment_variables

map<string, string>

環境變數。

OperatorOption

與運算子相關的選項。

欄位

tag

string

運算子的標記。

registry

string

運算子的註冊表，例如 public、dev。

StreamInput

這個分析器的輸入內容。

我們接受以下格式的輸入名稱參照：:

範例：

假設您有一個名為「SomeOp」的運算子，其中包含 2 個輸出引數，第一個引數名為「foo」，第二個引數名為「bar」，以及一個名為「MyOp」的運算子，可接受 2 個輸入內容。

另外，假設有一個名為「some-analyzer」的分析器正在執行「SomeOp」，而另一個名為「my-analyzer」的分析器則正在執行「MyOp」。

如要指出「my-analyzer」會將「some-analyzer」的「foo」輸出內容做為第一個輸入內容，並將「some-analyzer」的「bar」輸出內容做為第二個輸入內容，您可以將這個欄位設為以下內容：input = ["some-analyzer:foo", "some-analyzer:bar"]

欄位

input

string

串流輸入內容的名稱 (如上所述)。

註解

註解是素材資源中的資源。代表素材資源中內容的鍵/值對應。

欄位

name

string

註解的資源名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

user_specified_annotation

使用者提供的註解。

AnnotationCustomizedStruct

註解中的自訂結構表示法。

欄位

elements

map<string, AnnotationValue>

從元素索引鍵到元素註解值的對應。

AnnotationList

註解中的清單表示法。

欄位

values[]

AnnotationValue

LIST 資料類型註解的值。

AnnotationMatchingResult

儲存每個搜尋結果項目的條件註解比對結果。

欄位

criteria

Criteria

用於比對的條件。可以是輸入的搜尋條件，或是從切面選項轉換的條件。

matched_annotations[]

StructedInputAnnotation

符合條件的註解。

status

Status

比對結果的狀態。可能的值：FAILED_PRECONDITION - 條件不符合比對資格。完成 - 系統會進行比對。

AnnotationValue

註解的值，包括資料結構定義中可用的所有類型。

欄位
聯集欄位 `value`。 `value` 只能是下列其中一項：
`int_value`	`int64` int 類型註解的值。
`float_value`	`float` 浮點型註解的值。
`str_value`	`string` 字串類型註解的值。
`datetime_value`	`string` 日期時間類型註解的值。
`geo_coordinate`	`GeoCoordinate` 地理座標類型註解的值。
`proto_any_value`	`Any` 任何 proto 值的值。
`bool_value`	`bool` 布林型註解的值。
`list_value`	`AnnotationList` 清單類型註解的值。
`customized_struct_value`	`AnnotationCustomizedStruct` 自訂結構體類型註解的值。

AppPlatformCloudFunctionRequest

對於任何以雲端函式為基礎的客戶處理邏輯，客戶的雲端函式應會收到 AppPlatformCloudFunctionRequest 做為要求，並傳回 AppPlatformCloudFunctionResponse 做為回應。從 AppPlatform 傳送至 Cloud Function 的要求訊息。

欄位

app_platform_metadata

AppPlatformMetadata

AppPlatform 的中繼資料，可供客戶識別酬載來源。

annotations[]

實際註解，將由自訂 Cloud 函式處理。

StructedInputAnnotation

一般註解訊息，使用結構體格式代表不同的具體註解 protobuf。

欄位

ingestion_time_micros

int64

目前註解的擷取時間。

annotation

Struct

實際註解的結構格式。

AppPlatformCloudFunctionResponse

客戶的 Cloud Function 傳送給 AppPlatform 的回應訊息。

欄位

annotations[]

StructedOutputAnnotation

傳回至 AppPlatform 的修改後註解。如果註解欄位為空白，AppPlatform 就會捨棄這些註解。

annotation_passthrough

bool

如果設為 true，AppPlatform 會使用原始註解，而不是捨棄註解，即使註解檔案為空白也一樣。

events[]

AppPlatformEventBody

傳回至 AppPlatform 的事件通知。通常會將其設定為使用/轉送至處理事件的運算子，例如 Pub/Sub 運算子。

StructedOutputAnnotation

一般註解訊息，使用結構體格式代表不同的具體註解 protobuf。

欄位

annotation

Struct

實際註解的結構格式。

AppPlatformEventBody

appPlatform 事件的內容訊息

欄位

event_message

string

事件的易讀字串，例如「場景中有超過 6 個人」或「貨架空了！」。

payload

Struct

在 Pub/Sub 的情況下，會儲存在訊息屬性中。pubsub.proto

event_id

string

使用者定義的事件 ID，用於分類事件，在指定的放送間隔內，同一個應用程式執行個體的事件 ID 會去除重複項目，只會傳送第一個事件。空白的 event_id 會視為「""」。

AppPlatformMetadata

應用程式平台必要中繼資料的訊息。這則訊息通常會附加至特定處理器輸出註解，方便客戶識別資料來源。

欄位
`application`	`string` 應用程式資源名稱。
`instance_id`	`string` 執行個體資源 ID。執行個體是「instances」集合下應用程式的巢狀資源。
`node`	`string` 應用程式圖的節點名稱。
`processor`	`string` 應用程式節點的參照處理器資源名稱。

應用程式

說明 Application 物件的訊息

欄位
`name`	`string` 資源名稱
`create_time`	`Timestamp` 僅供輸出。[僅供輸出] 建立時間戳記
`update_time`	`Timestamp` 僅供輸出。[僅供輸出] 更新時間戳記
`labels`	`map<string, string>` 標籤為鍵/值組合
`display_name`	`string` 這是必要旗標，解決方案的使用者友善顯示名稱。
`description`	`string` 此應用程式的說明。
`application_configs`	`ApplicationConfigs` 應用程式圖表設定。
`runtime_info`	`ApplicationRuntimeInfo` 僅供輸出。應用程式圖表執行階段資訊。只有在應用程式狀態等於 DEPLOYED 時才會存在。
`state`	`State` 僅供輸出。應用程式的狀態。
`billing_mode`	`BillingMode` 應用程式的計費模式。

ApplicationRuntimeInfo

儲存應用程式執行階段資訊的訊息。

欄位

deploy_time

引擎部署時的時間戳記

global_output_resources[]

GlobalOutputResource

全球建立的資源，例如倉儲資料結構。

monitoring_config

MonitoringConfig

這個應用程式的監控相關設定。

GlobalOutputResource

關於應用程式輸出資源的訊息。

欄位

output_resource

string

輸出資源的完整資源名稱。

producer_node

string

產生輸出資源名稱的圖表節點名稱。例如：output_resource: /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema producer_node: occupancy-count

key

string

輸出資源的鍵，在同一個供應者節點中不得重複。一個產生節點可輸出多個輸出資源，鍵可用於比對相應的輸出資源。

MonitoringConfig

應用程式的監控相關設定。

欄位

enabled

bool

這個應用程式是否已啟用監控功能。

BillingMode

應用程式的結帳模式

列舉
`BILLING_MODE_UNSPECIFIED`	預設值。
`PAYG`	即付即用計費模式。
`MONTHLY`	按月付費模式。

狀態

應用程式狀態

列舉
`STATE_UNSPECIFIED`	預設值。如果省略狀態，系統會使用這個值。
`CREATED`	狀態為「CREATED」。
`DEPLOYING`	狀態 DEPLOYING。
`DEPLOYED`	狀態為「已部署」。
`UNDEPLOYING`	狀態為 UNDEPLOYING。
`DELETED`	狀態為「已刪除」。
`ERROR`	狀態為 ERROR。
`CREATING`	狀態為 CREATING。
`UPDATING`	狀態更新。
`DELETING`	狀態為「刪除中」。
`FIXING`	狀態修正。

ApplicationConfigs

儲存應用程式圖表的訊息。

欄位

nodes[]

Node

應用程式圖表中的節點清單。

ApplicationInstance

建立執行個體的訊息。

欄位

instance_id

string

這是必要旗標，要求物件的 ID。

instance

Instance

這是必要旗標，正在建立的資源。

ApplicationNodeAnnotation

說明應用程式節點專屬註解的訊息。這則訊息是 StreamWithAnnotation.NodeAnnotation 的複本。

欄位

node

string

應用程式圖的節點名稱。

annotations[]

節點專屬串流註解。

ApplicationStreamInput

單一串流輸入設定的訊息。

欄位
`stream_with_annotation`	`StreamWithAnnotation`

資產

資產是語料庫中的資源。它代表文件集內的媒體物件，包含中繼資料和其他資源註解。您可以將不同的功能套用至資產，產生註解。使用者可以指定與目標資產相關的註解。

欄位

name

string

資產的資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ttl

所有媒體素材資源、相關中繼資料和搜尋文件的有效時間。如果未設定，系統會使用上層字體庫資源中的預設 ttl。

asset_gcs_source

AssetGcsSource

僅供輸出。與此資產相關聯的原始 Cloud Storage 來源 URI。

AssetSource

素材資源來源。

欄位

聯集欄位 source_form。

source_form 只能是下列其中一項：

asset_gcs_source

AssetGcsSource

資產來源來自 Cloud Storage。

asset_content_data

AssetContentData

資產來源來自內容位元組。

AssetContentData

資產的內容。

欄位
`asset_content_data`	`bytes`

AssetGcsSource

資產來源來自 Cloud Storage。

欄位

gcs_uri

string

Cloud Storage URI。

AttributeValue

代表運算子屬性的實際值。

欄位
聯集欄位 `value`。屬性值。`value` 只能是下列其中一項：
`i`	`int64` int。
`f`	`float` 浮點。
`b`	`bool` 布林值。
`s`	`bytes` 字串。

AutoscalingMetricSpec

指標規格，定義用於計算所需複本數量的目標資源利用率 (CPU 利用率、加速器的占空比等)。

欄位

metric_name

string

這是必要旗標，資源指標名稱。支援的指標：

線上預測：
aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle
aiplatform.googleapis.com/prediction/online/cpu/utilization

target

int32

指定指標的目標資源使用率 (1% 至 100%)；一旦實際使用率與目標的差異超過一定百分比，機器副本就會變更。如未提供，預設值為 60 (代表 60%)。

BatchRunProcessRequest

要求訊息，用於以批次方式執行程序。

欄位
`parent`	`string` 這是必要旗標，所有建立程序共用的父項資源。
`requests[]`	`CreateProcessRequest` 這是必要旗標，建立程序要求。
`options`	`BatchRunProcessOptions` (非必要) 批次處理的選項。
`batch_id`	`string` 僅供輸出。批次 ID。

BatchRunProcessOptions

批次處理的選項。

欄位

retry_count

int32

每個程序的重試次數。預設為 3。

batch_size

int32

批量大小。預設值：5，上限：100。

BatchRunProcessResponse

回覆訊息，用於批次執行程序。

欄位

batch_id

string

批次 ID。

processes[]

Process

已建立程序。

BigQueryConfig

BigQuery 處理器的設定訊息。

欄位

table

string

Vision AI Platform 用來擷取註解的 BigQuery 資料表資源。

cloud_function_mapping

map<string, string>

資料結構定義：根據預設，Vision AI 應用程式會嘗試使用下列結構定義，將註解寫入目標 BigQuery 表格：

ingestion_time: TIMESTAMP，原始資料的擷取時間。

application：STRING，產生註解的應用程式名稱。

instance: STRING，產生註解的執行個體 ID。

node: STRING，產生註解的應用程式圖節點名稱。

annotation: 字串或 JSON，實際的註解 protobuf 會轉換為 JSON 字串，其中位元組欄位為 64 編碼字串。可寫入字串或 JSON 類型資料欄。

如要將註解資料轉送至現有的 BigQuery 資料表，客戶必須確保結構定義相容。這份對應會將應用程式節點名稱對應至相應的雲端函式端點，以便將註解直接轉換為 google.cloud.bigquery.storage.v1.AppendRowsRequest (應只設定 avro_rows 或 proto_rows)。如果已設定，則對應應用程式節點產生的註解會先傳送至 Cloud Function，再轉送至 BigQuery。

如果預設資料表結構定義不合適，客戶可以使用 CloudFunction 將 Vision AI 應用程式的註解輸出內容轉換為任意 BigQuery 資料表結構定義。* Cloud 函式會收到 AppPlatformCloudFunctionRequest，其中註解欄位會是 Vision AI 註解的 JSON 格式。* 雲端函式應傳回 AppPlatformCloudFunctionResponse，其中的附加資料要求儲存在註解欄位中。* 如要放棄註解，只要清除傳回的 AppPlatformCloudFunctionResponse 中的註解欄位即可。

create_default_table_if_not_exists

bool

如果為 true，如果指定的資料表不存在，App Platform 會建立 BigQuery 資料集和 BigQuery 資料表，並使用預設結構定義。如果指定了任何雲端函式自訂結構定義，這項做法就無法運作，因為系統不瞭解您想要的結構定義。在 App Platform 建立的預設資料表中，會使用 JSON 欄。

BoolValue

欄位
`value`	`bool`

管道

說明管道物件的訊息。

欄位
`name`	`string` 資源名稱。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。
`labels`	`map<string, string>` 標籤為鍵/值組合。
`annotations`	`map<string, string>` 註解可讓用戶端儲存少量任意資料。
`stream`	`string` 這是必要旗標，與這個系列相關的串流。
`event`	`string` 這是必要旗標，與此系列相關的事件。

CircleArea

圓形面積的表示法。

欄位

latitude

double

圓形區域中心的緯度。度數 [-90 .. 90]

longitude

double

圓形區域中心的經度。度數 [-180 .. 180]

radius_meter

double

圓形面積的半徑，以公尺為單位。

ClassificationPredictionResult

圖片和文字分類的預測輸出格式。

欄位

ids[]

int64

已識別的 AnnotationSpec 資源 ID。

display_names[]

string

已識別的 AnnotationSpec 顯示名稱，順序與 ID 相符。

confidences[]

float

模型對預測 ID 正確性的信心程度，值越高，信心越高。訂單與 ID 相符。

ClipAssetRequest

ClipAsset API 的要求訊息。

欄位

name

string

這是必要旗標，要要求片段的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

temporal_partition

這是必要旗標，要要求片段的時間範圍。

ClipAssetResponse

ClipAsset API 的回應訊息。

欄位

time_indexed_uris[]

TimeIndexedUri

下載涵蓋所要求時間範圍的影片片段，並依時間排序的已簽署 URI 清單。

TimeIndexedUri

已簽署的 URI 和對應的時間範圍。

欄位

temporal_partition

此 URI 所屬影片的時間範圍。

uri

string

用於下載影片片段的已簽署 URI。

叢集

說明 Cluster 物件的訊息。

欄位
`name`	`string` 僅供輸出。資源名稱。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。
`labels`	`map<string, string>` 標籤為鍵/值組合
`annotations`	`map<string, string>` 註解可讓用戶端儲存少量任意資料。
`dataplane_service_endpoint`	`string` 僅供輸出。資料層服務的 DNS 名稱
`state`	`State` 僅供輸出。叢集目前的狀態。
`psc_target`	`string` 僅供輸出。私人服務連線服務目標名稱。

狀態

叢集目前的狀態。

列舉
`STATE_UNSPECIFIED`	未設定。
`PROVISIONING`	PROVISIONING 狀態表示系統正在建立叢集。
`RUNNING`	RUNNING 狀態表示叢集已建立完成，可完全使用。
`STOPPING`	STOPPING 狀態表示叢集正在刪除。
`ERROR`	「ERROR」狀態表示叢集無法使用。系統會自動刪除該檔案。

ClusterInfo

欄位

streams_count

int32

叢集中的有效串流數。

processes_count

int32

叢集中的有效程序數量。

集合

集合是語料庫中的資源。它可做為原始資源參照的容器。

欄位

name

string

僅供輸出。集合的資源名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

display_name

string

(非必要) 要顯示的集合名稱。名稱的長度上限為 256 個半形字元。

description

string

(非必要) 系列叢書的說明。長度上限為 25,000 個半形字元。

CollectionItem

CollectionItem 是集合中的項目。每個項目都是對集合中原始資源的參照。

欄位

collection

string

這是必要旗標，此項目所屬的集合名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

type

Type

這是必要旗標，項目類型。

item_resource

string

這是必要旗標，CollectionItem 的名稱。格式取決於上述的 type。如果是 ASSET：projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

類型

CollectionItem 類型。

列舉
`TYPE_UNSPECIFIED`	預設項目類型不應出現。
`ASSET`	資產類型項目。

CommitRequest

用於明確提交讀取進度的訊息。

只有在初始設定要求中設定 ReceivePacketsControlledMode 時，才能使用這項功能。

欄位

offset

int64

要提交的偏移量。

ControlledMode

受控模式下接收器的選項。

欄位

fallback_starting_offset

string

這是在無法使用指定的起始偏移量時，回復的合理起點。

可為下列其中一個值：

「begin」：會從最早可用的訊息開始讀取。

「end」：只會讀取未來的訊息。

聯集欄位 starting_offset。這是開始接收的偏移量。starting_offset 只能是下列其中一項：

starting_logical_offset

string

您可以將此值設為下列邏輯起始點：

「begin」：會從最早可用的訊息開始讀取。

「most-recent」：會從最新的訊息讀取。

「end」：只會讀取未來的訊息。

「stored」：這會繼續讀取上次提交偏移量後的一個偏移量。這是唯一可讓進度恢復的選項，其他選項都會單方面跳過。

語料庫

詞彙庫是一組用於管理的媒體內容。在同一文獻集內，媒體會共用相同的資料結構定義。搜尋內容也僅限於單一語料庫。

欄位
`name`	`string` 語料庫的資源名稱。格式：`projects/{project_number}/locations/{location_id}/corpora/{corpus_id}`
`display_name`	`string` 這是必要旗標，在使用者介面中顯示的詞彙庫名稱。名稱的長度上限為 32 個半形字元。
`description`	`string` (非必要) 語料庫說明。長度上限為 25,000 個半形字元。
`default_ttl`	`Duration` (非必要) 在沒有素材資源層級使用者定義 TTL 的情況下，該字典庫中所有素材資源的預設 TTL 值。對於 STREAM_VIDEO 類型的字典，這是必要的，且允許的 default_ttl 上限為 10 年。
`type`	`Type` (非必要) 詞庫中的資產類型。
`search_capability_setting`	`SearchCapabilitySetting` 在語料庫層級設定預設的搜尋功能。

類型

詞彙庫中的資產類型。

列舉
`TYPE_UNSPECIFIED`	預設類型，不應使用。如果使用這個預設類型，就會建立 STREAM_VIDEO 字元串集。
`STREAM_VIDEO`	資產是即時串流影片資產。
`IMAGE`	素材資源是圖片。
`VIDEO_ON_DEMAND`	資產是指影片素材資源。

CreateAnalysisRequest

建立分析時顯示的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`analysis_id`	`string` 這是必要旗標，要求物件的 ID。
`analysis`	`Analysis` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateAnnotationRequest

CreateAnnotation 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這項註解的父項資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

annotation

這是必要旗標，要建立的註解。

annotation_id

string

(非必要) 用於註解的 ID，如果使用者選擇指定，這個 ID 會成為註解資源名稱的最終元件。否則，系統會產生註解 ID。

這個值的長度應為 63 個字元以下，有效字元為 /[a-z][0-9]-/。開頭須為英文字母，最後一個字元則可為英文字母或數字。

CreateApplicationInstancesRequest

訊息：將串流輸入內容新增至應用程式。

欄位

name

string

必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」

application_instances[]

ApplicationInstance

這是必要旗標，正在建立的資源。

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateApplicationInstancesResponse

這個類型沒有任何欄位。

CreateApplicationInstance 回應的訊息。

CreateApplicationRequest

建立應用程式的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`application_id`	`string` 這是必要旗標，要求物件的 ID。
`application`	`Application` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateAssetRequest

CreateAssetRequest 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這項資產的父項資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

asset

Asset

這是必要旗標，要建立的資產。

asset_id

string

(非必要) 素材資源使用的 ID，如果使用者選擇指定，則會成為素材資源名稱的最終元件。否則，系統會產生資產 ID。

這個值的長度應為 63 個字元以下，有效字元為 /[a-z][0-9]-/。開頭須為英文字母，最後一個字元則可為英文字母或數字。

建立叢集要求

建立叢集的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`cluster_id`	`string` 這是必要旗標，要求物件的 ID。
`cluster`	`Cluster` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateCollectionMetadata

CreateCollectionRequest 的中繼資料訊息

欄位

operation_metadata

長時間執行作業的常見中繼資料。

CreateCollectionRequest

CreateCollection 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這個集合的父項資源。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

collection

Collection

這是必要旗標，要建立的集合資源。

collection_id

string

(非必要) 要用於集合的 ID，如果使用者選擇指定，則會成為資源名稱的最終元件。否則，系統會產生收集 ID。

這個值的長度應為 55 個字元以下，有效字元為 /[a-z][0-9]-/。開頭須為英文字母，最後一個字元可以是英文字母或數字。

CreateCorpusMetadata

CreateCorpus API 的中繼資料。

欄位

create_time

建立字典作業的建立時間。

update_time

建立字典作業的更新時間。

CreateCorpusRequest

CreateCorpus API 的要求訊息。

欄位

parent

string

這是必要旗標，表單：projects/{project_number}/locations/{location_id}

corpus

Corpus

這是必要旗標，要建立的語料庫。

CreateDataSchemaRequest

CreateDataSchema 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這個資料結構定義的父項資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

data_schema

DataSchema

這是必要旗標，要建立的資料結構定義。

CreateDraftRequest

建立草稿的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`draft_id`	`string` 這是必要旗標，要求物件的 ID。
`draft`	`Draft` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateEventRequest

建立事件的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`event_id`	`string` 這是必要旗標，要求物件的 ID。
`event`	`Event` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateIndexEndpointMetadata

CreateIndexEndpoint 的中繼資料訊息。

欄位

operation_metadata

長時間執行作業的常見中繼資料。

CreateIndexEndpointRequest

CreateIndexEndpoint 的要求訊息。

欄位

parent

string

這是必要旗標，格式：projects/{project}/locations/{location}

index_endpoint_id

string

(非必要) 用於 IndexEndpoint 的 ID，如果使用者指定此 ID，就會成為 IndexEndpoint 資源名稱的最終元件。否則，系統會自動產生 IndexEndpoint ID。

這個值的長度應為 63 個半形字元，有效字元為 a-z、0-9 和連字號 (-)。第一個字元必須是英文字母，最後一個字元則須為英文字母或數字。

index_endpoint

IndexEndpoint

這是必要旗標，正在建立的資源。

CreateIndexMetadata

CreateIndexRequest 的中繼資料訊息

欄位

operation_metadata

長時間執行作業的常見中繼資料。

CreateIndexRequest

建立索引的訊息。

欄位

parent

string

這是必要旗標，父項的值。建立此索引的 Corpus 資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

index_id

string

(非必要) 索引的 ID。這會是索引的最終資源名稱。如果使用者未指定這個值，系統會產生這個值。

這個值的長度應為 63 個字元以下，有效字元為 /[a-z][0-9]-/。開頭須為英文字母，最後一個字元則可為英文字母或數字。

index

Index

這是必要旗標，正在建立的索引。

CreateOperatorRequest

建立 Operator 的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`operator_id`	`string` 這是必要旗標，要求物件的 ID。
`operator`	`Operator` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateProcessRequest

建立程序時顯示的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`process_id`	`string` 這是必要旗標，要求物件的 ID。
`process`	`Process` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateProcessorRequest

建立處理器的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`processor_id`	`string` 這是必要旗標，要求物件的 ID。
`processor`	`Processor` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateSearchConfigRequest

CreateSearchConfig 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這個搜尋設定的父項資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

search_config

SearchConfig

這是必要旗標，要建立的搜尋設定。

search_config_id

string

這是必要旗標，新搜尋設定要使用的 ID。將成為 SearchConfig 資源名稱的最後一個元件。這個值的長度應為 63 個半形字元，有效字元為 /[a-z][0-9]-_/。第一個字元必須是英文字母，最後一個字元可以是英文字母或數字。

CreateSearchHypernymRequest

建立 SearchHypernym 的要求訊息。

欄位

parent

string

這是必要旗標，表示將建立這個 SearchHypernym 的父項資源。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

search_hypernym

SearchHypernym

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

search_hypernym_id

string

(非必要) 搜尋同義字 ID。如果省略此參數，系統會產生隨機 UUID。

CreateSeriesRequest

建立系列叢書的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`series_id`	`string` 這是必要旗標，要求物件的 ID。
`series`	`Series` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

CreateStreamRequest

建立串流的訊息。

欄位
`parent`	`string` 這是必要旗標，父項的值。
`stream_id`	`string` 這是必要旗標，要求物件的 ID。
`stream`	`Stream` 這是必要旗標，正在建立的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

條件

套用至目前搜尋結果的篩選條件。

欄位
`field`	`string` 要套用篩選條件的 UGA 欄位或 ML 欄位。
`fetch_matched_annotations`	`bool` 如果為 true，則會傳回符合此條件的查詢標記。這個選項僅適用於包含條件 (即不包含排除條件)，且包含區隔層級註解。支援下列資料類型：- INTEGER - FLOAT - STRING (僅限 DataSchema.SearchStrategy.EXACT_SEARCH) - BOOLEAN
聯集欄位 `value`。 `value` 只能是下列其中一項：
`text_array`	`StringArray` 與欄位相關聯的文字值。
`int_range_array`	`IntRangeArray` 與欄位相關聯的整數範圍。
`float_range_array`	`FloatRangeArray` 與欄位相關聯的浮點範圍。
`date_time_range_array`	`DateTimeRangeArray` 與欄位相關聯的日期時間範圍。
`geo_location_array`	`GeoLocationArray` 地理位置陣列。
`bool_value`	`BoolValue` 布林值。

CustomProcessorSourceInfo

說明自訂處理器的來源資訊。

欄位
`source_type`	`SourceType` 原始產品，其中包含自訂處理器的功能。
`additional_info`	`map<string, string>` 僅供輸出。與匯入的自訂處理器相關的其他資訊。在建立處理器時，應用程式平台會填入資料。
`model_schema`	`ModelSchema` 指定模型簽名的模型結構定義檔案。對於 VERTEX_CUSTOM 模型，必須提供執行個體結構定義。如果在建立處理器時未指定執行個體結構定義，Vision AI Platform 會嘗試從 Vertex 取得該結構定義，如果不存在，建立作業就會失敗。
聯集欄位 `artifact_path`。App Platform 載入自訂處理器構件的位置路徑。`artifact_path` 只能是下列其中一項：
`vertex_model`	`string` 在 Vertex AI 平台中代管的原始模型資源名稱。
`product_recognizer_artifact`	`ProductRecognizerArtifact` 產品辨識器的構件。

ModelSchema

結構定義為 OpenAPI 3.0.2 結構定義物件。

欄位

instances_schema

GcsSource

YAML 檔案的 Cloud Storage 位置，這個檔案定義了用於預測和說明要求的單一執行個體格式。

parameters_schema

GcsSource

YAML 檔案的 Cloud Storage 位置，這個檔案定義了預測和說明參數。

predictions_schema

GcsSource

YAML 檔案的 Cloud Storage 位置，這個檔案定義了單一預測或說明的格式。

ProductRecognizerArtifact

訊息說明產品辨識工具的構件。

欄位

retail_product_recognition_index

string

這是必要旗標，RetailProductRecognitionIndex 的資源名稱。格式為「projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*」

vertex_model

string

(非必要) 在 Vertex AI Platform 中代管的嵌入模型資源名稱。

SourceType

匯入的自訂處理器來源類型。

列舉
`SOURCE_TYPE_UNSPECIFIED`	未指定來源類型。
`VERTEX_AUTOML`	來自 Vertex AutoML 產品的自訂處理器。
`VERTEX_CUSTOM`	來自 Vertex 一般自訂模型的自訂處理器。
`PRODUCT_RECOGNIZER`	產品辨識工具的來源。

DataSchema

資料結構定義會指出系統如何解讀使用者指定的註解。

欄位

name

string

資料結構定義的資源名稱，格式為：projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}，其中 {data_schema} 部分應與下方的 key 欄位相同。

key

string

這是必要旗標，這個資料結構定義的索引鍵。這個鍵應與使用者指定的註解鍵相符，且在語料庫中不重複。這個值的長度上限為 63 個半形字元，有效字元為 /[a-z][0-9]-/。開頭須為英文字母，最後一個字元則可為英文字母或數字。

schema_details

DataSchemaDetails

與鍵對應的結構定義詳細資料。

DataSchemaDetails

資料結構定義詳細資料會指出資料類型，以及與使用者指定註解鍵對應的資料結構。

欄位
`type`	`DataType` 註解類型。
`proto_any_config`	`ProtoAnyConfig` 任何類型的 Protobuf 設定。
`list_config`	`ListConfig` 清單資料類型的設定。
`customized_struct_config`	`CustomizedStructConfig` CustomizedStruct 資料類型的設定。
`granularity`	`Granularity` 與此 DataSchema 相關聯的精細程度。
`search_strategy`	`SearchStrategy` 要套用至上述 `key` 的搜尋策略。

CustomizedStructConfig

CUSTOMIZED_STRUCT 資料類型的設定。

欄位

field_schemas

map<string, DataSchemaDetails>

直接子項元素資料結構定義。

DataType

註解的資料類型。

列舉
`DATA_TYPE_UNSPECIFIED`	未指定的類型。
`INTEGER`	整數類型。允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支援以 IntRangeArray 查詢。
`FLOAT`	浮點型。允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支援以 FloatRangeArray 查詢。
`STRING`	字串類型。允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH、- DataSchema.SearchStrategy.SMART_SEARCH。
`DATETIME`	支援的格式：%Y-%m-%dT%H:%M:%ES%Ez (absl::RFC3339_full) %Y-%m-%dT%H:%M:%ES %Y-%m-%dT%H:%M%Ez %Y-%m-%dT%H:%M %Y-%m-%dT%H%Ez %Y-%m-%dT%H %Y-%m-%d%Ez %Y-%m-%d %Y-%m %Y 允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. 支援以 DateTimeRangeArray 為依據的查詢。
`GEO_COORDINATE`	地理座標類型。允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支援以 GeoLocationArray 查詢。
`PROTO_ANY`	類型，可傳遞 annotations.proto 中提供的任何 proto。僅限內部使用。可用的原型類型及其對應的搜尋行為：- ImageObjectDetectionPredictionResult，可在 display_names 和 NO_SEARCH 上使用 SMART_SEARCH。- ClassificationPredictionResult，允許在 display_names 和 NO_SEARCH 上使用 SMART_SEARCH。- ImageSegmentationPredictionResult，允許 NO_SEARCH。- VideoActionRecognitionPredictionResult，允許在 display_name 和 NO_SEARCH 上使用 SMART_SEARCH。- VideoObjectTrackingPredictionResult，允許在 display_name 和 NO_SEARCH 上使用 SMART_SEARCH。- VideoClassificationPredictionResult，允許在 display_name 和 NO_SEARCH 上使用 SMART_SEARCH。- OccupancyCountingPredictionResult，允許在 stats.full_frame_count.count 和 NO_SEARCH 上使用 EXACT_SEARCH。- ObjectDetectionPredictionResult，允許在 identified_boxes.entity.label_string 和 NO_SEARCH 上使用 SMART_SEARCH。
`BOOLEAN`	布林值類型。允許的搜尋策略：- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。
`LIST`	清單類型。- 清單中的每個元素都必須採用完全相同的資料架構，否則就會成為無效的引數。- 清單層級無法設定搜尋策略。葉節點層級可以。 - 元素不得為另一個清單 (沒有清單的清單)。- 元素可以是 CUSTOMIZED_STRUCT，且層數上限為 10。
`CUSTOMIZED_STRUCT`	結構體類型。- SearchStrategy：* CUSTOMIZED_STRUCT 資料結構定義無法設定搜尋策略。* 葉節點元素可根據元素的 SearchStrategy 限制設定搜尋策略。- 巢狀層限制：* 資料結構定義為 CUSTOMIZED_STRUCT 時，其欄位也能是 CUSTOMIZED_STRUCT，但整體層限制為 10。

精細程度

這個 DataSchema 下方註解的精細程度。

列舉
`GRANULARITY_UNSPECIFIED`	未指定精細度。
`GRANULARITY_ASSET_LEVEL`	素材資源層級精細度 (註解不得包含分割區資訊)。
`GRANULARITY_PARTITION_LEVEL`	分區層級精細程度 (註解必須包含分區資訊)。

ListConfig

LIST 資料類型的設定。

欄位

value_schema

DataSchemaDetails

清單中值的資料結構定義。

ProtoAnyConfig

PROTO_ANY 資料類型的設定。

欄位

type_uri

string

Proto 訊息的類型 URI。

SearchStrategy

key 的註解值搜尋策略。

欄位

search_strategy_type

SearchStrategyType

要在上述 key 上套用的搜尋策略類型。允許的 search_strategy_type 會因資料類型而異，詳情請參閱 DataSchemaDetails.DataType。如果您為資料類型指定不支援的 search_strategy_type，系統會傳回 INVALID_ARGUMENT 錯誤。

SearchStrategyType

要套用至註解鍵的搜尋策略類型。

列舉
`NO_SEARCH`	上述 `key` 的註解值無法搜尋。
`EXACT_SEARCH`	使用 `key` 進行搜尋時，值必須與已攝入的註解值完全相同。
`SMART_SEARCH`	使用 `key` 進行搜尋時，Warehouse 會根據註解值的語意執行廣泛搜尋。

DataType

所有支援的資料類型。

列舉
`DATA_TYPE_UNSPECIFIED`	DataType 的預設值。
`VIDEO`	視訊資料類型，例如 H264。
`IMAGE`	圖片資料類型。
`PROTO`	Protobuf 資料類型，通常用於一般資料 blob。
`PLACEHOLDER`	預留位置資料類型，適用於支援任何資料類型的通用輸入處理器。這會在執行個體部署期間，以具體的基礎 `DataType` 進行例項化並取代。

DateTimeRange

日期時間範圍類型。

欄位

start

DateTime

開始日期時間。

end

DateTime

資料結束時間。

DateTimeRangeArray

日期時間範圍值清單。

欄位

date_time_ranges[]

DateTimeRange

日期時間範圍。

DedicatedResources

說明專屬於 DeployedModel 的資源，以及需要更高程度手動設定的資源。

欄位
`machine_spec`	`MachineSpec` 這是必要旗標，不可變動。預測作業使用的單一機器規格。
`min_replica_count`	`int32` 這是必要旗標，不可變動。無論何時，這個 DeployedModel 一律會部署於這個數量的機器備用資源。這個值必須大於或等於 1。如果 DeployedModel 的流量增加，系統可能會動態將其部署至更多副本，而隨著流量減少，部分額外副本可能會釋放。
`max_replica_count`	`int32` 不可變動。當 DeployedModel 的流量增加時，可部署於的備用資源數量上限。如果要求的值過大，部署作業就會發生錯誤，但如果部署成功，則可保證模型可擴充至該數量的複本 (除非服務中斷)。如果 DeployedModel 的流量超過副本可處理的最大值，系統就會捨棄部分流量。如果未提供這個值，系統會使用 `min_replica_count` 做為預設值。這個欄位的值會影響對 Vertex CPU 和 GPU 配額的收費。具體來說，您將須為 max_replica_count * 所選機器類型的核心數，以及 max_replica_count * 所選機器類型中每個備援機制中的 GPU 數量付費。
`autoscaling_metric_specs[]`	`AutoscalingMetricSpec` 不可變動。指標規格，用於覆寫資源使用率指標 (CPU 使用率、加速器的占空比等) 目標值 (如果未設定，預設為 60)。每個指標最多只能有一個項目。如果 `machine_spec.accelerator_count` 大於 0，自動調整大小功能會根據 CPU 使用率和加速器的占空比指標，並在任一指標超過目標值時擴大規模，如果兩個指標都低於目標值時則縮減規模。兩個指標的預設目標值皆為 60。如果 `machine_spec.accelerator_count` 為 0，則自動調度資源功能只會根據 CPU 使用率指標 (如果未明確設定，則預設目標值為 60) 進行自動調度資源。舉例來說，如果您要將線上預測的目標 CPU 使用率覆寫為 80，請將 `autoscaling_metric_specs.metric_name` 設為 `aiplatform.googleapis.com/prediction/online/cpu/utilization`，並將 `autoscaling_metric_specs.target` 設為 `80`。

DeleteAnalysisRequest

刪除分析時顯示的訊息。

欄位

name

string

這是必要旗標，資源名稱。

request_id

string

(非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後至少 60 分鐘。

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

DeleteAnnotationRequest

DeleteAnnotation API 的請求訊息。

欄位

name

string

這是必要旗標，要刪除的註解名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

DeleteApplicationInstancesRequest

從應用程式移除串流輸入的訊息。

欄位

name

string

必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」

instance_ids[]

string

這是必要旗標，要求物件的 ID。

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

DeleteApplicationInstancesResponse

這個類型沒有任何欄位。

DeleteApplicationInstance Response 的訊息。

DeleteApplicationRequest

刪除應用程式的訊息。

欄位

name

string

這是必要旗標，資源名稱。

request_id

string

這是必要旗標，要刪除的集合名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

DeleteCorpusRequest

DeleteCorpus 的要求訊息。

欄位

name

DeleteIndexEndpoint 的中繼資料訊息。

欄位

operation_metadata

DeleteSearchConfig 的要求訊息。

欄位

name

部署應用程式的訊息。

欄位
`name`	`string` 必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」
`validate_only`	`bool` 如果已設定，系統會驗證要求並預覽應用程式圖表，但不會實際部署。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。
`enable_monitoring`	`bool` (非必要) 是否要為部署的應用程式啟用監控功能。

DeployApplicationResponse

這個類型沒有任何欄位。

遠端程序呼叫 (RPC) 要求訊息。用於 DeployApplication Response 的訊息。

DeployIndexMetadata

DeployIndex 的中繼資料訊息。

欄位

operation_metadata

長時間執行作業的常見中繼資料。

deployed_index

string

僅供輸出。正在部署的索引。

DeployIndexRequest

DeployIndex 的要求訊息。

欄位

index_endpoint

string

這是必要旗標，要部署索引的 IndexEndpoint。格式：projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployed_index

DeployedIndex

這是必要旗標，要部署的索引。

DeployIndexResponse

這個類型沒有任何欄位。

作業完成後的 DeployIndex 回應。

DeployRetailProductRecognitionIndexResponse

這個類型沒有任何欄位。

DeployRetailProductRecognitionIndex 回應訊息。

DeployedIndex

索引的部署作業。

欄位

index

string

這是必要旗標，已部署索引的名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

DeployedIndexReference

指向 DeployedIndex。

欄位

index_endpoint

string

不可變動。IndexEndpoint 的資源名稱。

草稿

說明草稿物件的訊息

欄位
`name`	`string` 資源名稱
`create_time`	`Timestamp` 僅供輸出。[僅供輸出] 建立時間戳記
`update_time`	`Timestamp` 僅供輸出。[僅供輸出] 建立時間戳記
`labels`	`map<string, string>` 標籤為鍵/值組合
`display_name`	`string` 這是必要旗標，解決方案的使用者友善顯示名稱。
`description`	`string` 此應用程式的說明。
`draft_application_configs`	`ApplicationConfigs` 尚未更新為應用程式的草稿應用程式設定。

EagerMode

這個類型沒有任何欄位。

在急促模式下，接收器的選項。

活動

說明 Event 物件的訊息。

欄位
`name`	`string` 資源名稱。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。
`labels`	`map<string, string>` 標籤為鍵/值組合。
`annotations`	`map<string, string>` 註解可讓用戶端儲存少量任意資料。
`alignment_clock`	`Clock` 用於加入串流的時鐘。
`grace_period`	`Duration` 事件清理寬限期。這是控制器在刪除事件前等待的時間。在這個期間內，如果事件有任何有效管道，系統會忽略 grace_period 後的事件刪除作業。

時鐘

用於加入串流的時鐘。

列舉
`CLOCK_UNSPECIFIED`	未指定時鐘。
`CAPTURE`	請在擷取資料時使用時間戳記。用戶端需要同步時鐘。
`INGEST`	請在收到資料時使用時間戳記。

EventUpdate

事件更新訊息。

欄位
`stream`	`string` 事件所屬串流的名稱。
`event`	`string` 事件名稱。
`series`	`string` 系列名稱。
`update_time`	`Timestamp` 事件更新發生的時間戳記。
`offset`	`int64` 系統會使用這項屬性，確認訊息接收狀態。

EventUpdateFilter

EventUpdateFilter 是監控者可用來指定要接收哪些事件更新的篩選器。

欄位

聯集欄位 start_time。

start_time 只能是下列其中一項：

special_mode

SpecialMode

除了特定時間戳記以外的特殊模式。

specific_time

事件更新發生後的特定時間戳記。

SpecialMode

除了特定時間戳記以外的特殊模式。

列舉
`SPECIAL_MODE_UNSPECIFIED`	未指定特殊模式。
`BEGINNING`	特殊模式的 BEGINNING 表示所有目前可用的事件和即將到來的事件更新。
`LATEST`	LATEST 特殊模式：只顯示最新事件和即將發生的事件更新。

EventUpdateType

事件更新的類型。日後可擴充至其他用途，例如 EVENT_DETACHED_FROM_STREAM 等。

列舉
`EVENT_UPDATE_TYPE_UNSPECIFIED`	未指定事件更新類型。
`EVENT_AVAILABLE_ON_STREAM`	可從串流中讀取事件。
`EVENT_HEARTBEAT`	用於追蹤 gRPC 連線是否運作的心跳訊息。

ExportRetailProductRecognitionIndexCoverageResponse

這個類型沒有任何欄位。

回應匯出 RetailProductRecognitionIndex 涵蓋率檔案的訊息。

FacetBucket

保存切面值、選取狀態和中繼資料。

欄位
`selected`	`bool` 是否已選取一個切面值區。這個欄位代表使用者的面向選取項目。這是前端在 SearchVideosRequest 中設定的值。
聯集欄位 `bucket_value`。與切面相關的值區。舉例來說，如果「team」是「隊伍」，則可將「49ers」、「patriots」等納入桶中；如果「player」是「球員」，則可將「tom brady」、「drew brees」等納入桶中。`bucket_value` 只能是下列其中一個：
`value`	`FacetValue` 奇異值。
`range`	`Range` 範圍值。

範圍

要套用切面的值範圍 ([start, end])。

欄位

start

範圍的起始值。不存在表示某些邊界 (例如 -inf)。

end

範圍結束時間。不存在表示某些邊界 (例如 inf)。

FacetBucketType

切面值層的不同類型。

列舉
`FACET_BUCKET_TYPE_UNSPECIFIED`	未指定的類型。
`FACET_BUCKET_TYPE_VALUE`	值類型。
`FACET_BUCKET_TYPE_DATETIME`	日期時間類型。
`FACET_BUCKET_TYPE_FIXED_RANGE`	固定範圍類型。
`FACET_BUCKET_TYPE_CUSTOM_RANGE`	自訂範圍類型。

FacetGroup

一組要在後端和前端之間來回傳遞的面向切割值。

欄位
`facet_id`	`string` 切面群組的專屬 ID。
`display_name`	`string` 切面的顯示名稱。供 UI 用於多面向算繪。
`buckets[]`	`FacetBucket` 與切面相關聯的值區。例如「Team」(隊伍) 切面的值區可以是 49ers、patriots 等。
`bucket_type`	`FacetBucketType` Facet 值區類型。
`fetch_matched_annotations`	`bool` 如果為 true，則會傳回與此切面群組所選項目相符的註解查詢。這個選項僅適用於以分區層級註解為依據的切面。支援下列切面值：- INTEGER - STRING (僅限 DataSchema.SearchStrategy.EXACT_SEARCH)

FacetProperty

面向面的集中設定。

欄位
`mapped_fields[]`	`string` 商情項目名稱，也就是使用者想用來縮小搜尋結果範圍的維度。`mapped_fields` 會比對 UserSpecifiedDataSchema 鍵。舉例來說，使用者可以新增多個使用相同鍵的 UGA，例如 player:adam、player:bob、player:charles。如果指定多個 mapped_fields，系統會將這些值合併為最終面向值。例如：home_team: a, home_team:b, away_team:a, away_team:c，如果 facet_field = [home_team, away_team]，facet_value 會是 [a, b, c]。除非這是 1:1 切面維度 (mapped_fields.size() == 1)，且 mapped_field 等於父項 SearchConfig.name，否則父項也必須包含對應至相同欄位的 SearchCriteriaProperty。mapped_fields 不得為空白。
`display_name`	`string` 切面的顯示名稱。供 UI 用於多面向算繪。
`result_size`	`int64` 每個切面傳回的唯一值桶數上限。對於高基數的切面 (例如「玩家」)，值區數量可能會很大。我們只會向使用者傳回最相關的 n 個結果。如果 <= 0，伺服器會決定適當的 result_size。
`bucket_type`	`FacetBucketType` Facet 值類型，例如值、範圍。
聯集欄位 `range_facet_config`。 `range_facet_config` 只能是下列其中一項：
`fixed_range_bucket_spec`	`FixedRangeBucketSpec` 固定範圍切面值區設定。
`custom_range_bucket_spec`	`CustomRangeBucketSpec` 自訂範圍值區設定。
`datetime_bucket_spec`	`DateTimeBucketSpec` 日期時間範圍切面桶值設定。

CustomRangeBucketSpec

如果值區類型為 CUSTOM_RANGE，請指定值區的分布方式。以整數值區範圍為例，如果端點為 0、10、100 和 1000，我們會產生下列商情項目：[-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf)。特別注意：- 端點必須依遞增順序列出。否則，SearchConfig API 會拒絕面向設定。- < 1 個端點是無效的規格。

欄位

endpoints[]

目前這個欄位僅支援整數類型。

DateTimeBucketSpec

如果值區類型為 DATE，請指定日期值的值區分布方式。

欄位

granularity

Granularity

日期類型切面的精細程度。

精細程度

日期時間範圍的細目列舉。

列舉
`GRANULARITY_UNSPECIFIED`	未指定精細度。
`YEAR`	精細程度為年。
`MONTH`	精細程度為月。
`DAY`	精細程度為「日」。

FixedRangeBucketSpec

如果值區類型為 FIXED_RANGE，請指定值區的分布方式。如要建立多個精確度相同的桶，請使用 FixedRangeBucketSpec。以整數值區值為例，如果 bucket_start = 0、bucket_granularity = 10、bucket_count = 5，系統會透過下列值區匯總這個商情項目：[-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf)。請注意，bucket_count <= 1 是無效的規格。

欄位

bucket_start

值區的下限。注意：這個欄位目前僅支援整數類型。

bucket_granularity

值區精細程度。注意：這個欄位目前僅支援整數類型。

bucket_count

int32

值區總數。

FacetValue

定義具有泛型類型的單一值。

欄位
聯集欄位 `value`。 `value` 只能是下列其中一項：
`string_value`	`string` 字串類型值。
`integer_value`	`int64` 整數類型值。
`datetime_value`	`DateTime` 日期時間類型值。

FloatRange

浮點範圍類型。

欄位

start

float

浮點範圍的起始值。

end

float

浮點範圍的結束時間。

FloatRangeArray

浮點範圍值清單。

欄位

float_ranges[]

FloatRange

浮點範圍值。

GcsOutputConfig

說明 GcsOutputConfig 的訊息。

欄位

gcs_path

string

Vision AI Platform 用於擷取註解的 Cloud Storage 路徑。

GcsSource

輸入內容的 Google Cloud Storage 位置。

欄位

uris[]

string

這是必要旗標，Google Cloud Storage 路徑的參照項目。

GeneralObjectDetectionConfig

這個類型沒有任何欄位。

一般物件偵測處理器的設定訊息。

GenerateHlsUriRequest

GenerateHlsUri API 的要求訊息。

欄位

name

string

這是必要旗標，要要求片段的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

temporal_partitions[]

要要求片段的時間範圍。如果 get_live_view 設為 True，系統會忽略這項屬性。要求的總時間範圍應小於 24 小時。

live_view_enabled

bool

選項：僅顯示素材資源的直播內容，最多可追溯 3 分鐘的資料。

GenerateHlsUriResponse

GenerateHlsUri API 的回應訊息。

欄位

uri

string

已簽署的 URI，可下載與要求時間相對應的 HLS 資訊清單。

temporal_partitions[]

內容的暫時性區隔清單，以在串流中顯示的順序傳回。

GenerateRetrievalUrlRequest

GenerateRetrievalUrl API 的請求訊息。

欄位

name

string

這是必要旗標，要要求已簽署網址的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

GenerateRetrievalUrlResponse

GenerateRetrievalUrl API 的回應訊息。

欄位

signed_uri

string

用來下載資產內容的已簽署網址。

GenerateStreamHlsTokenRequest

要求訊息，用於取得授權權杖，以便存取串流 HLS 內容。

欄位

stream

string

這是必要旗標，串流的名稱。

GenerateStreamHlsTokenResponse

GenerateStreamHlsToken 的回應訊息。

欄位

token

string

產生的 JWT 權杖。

呼叫端應將此權杖插入 HTTP 要求的授權標頭，以取得 HLS 播放清單資訊清單和影片區塊。例如：curl -H "Authorization: Bearer $TOKEN" https://domain.com/test-stream.playback/master.m3u8

expiration_time

權杖的到期時間。

GeoCoordinate

位置座標表示法

欄位

latitude

取得 SearchHypernym 的要求訊息。

欄位

name

string

這是必要旗標，要擷取的 SearchHypernym 名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

ImageObjectDetectionPredictionResult

圖片物件偵測的預測輸出格式。

欄位
`ids[]`	`int64` 已識別的 AnnotationSpec 資源 ID，依信心分數由高至低排序。請使用 ID 區段，而非完整資源名稱。
`display_names[]`	`string` 已識別的 AnnotationSpec 顯示名稱，順序與 ID 相符。
`confidences[]`	`float` 模型對預測 ID 正確性的信心程度，值越高，信心程度越高。訂單與 ID 相符。
`bboxes[]`	`ListValue` 定界框 (即圖片上的長方形)，用於指出所找到的 AnnotationSpec。以符合 ID 的順序提供。每個定界框都是 4 個數字 `xMin`、`xMax`、`yMin` 和 `yMax` 的陣列，代表框架的極端座標。這些座標是相對於圖片大小，其中 0,0 點位於圖片左上方。

ImageQuery

搜尋端點要求的圖片查詢。

欄位

聯集欄位 image。

image 只能是下列其中一項：

input_image

bytes

以原始位元組輸入圖片。

asset

string

資產的資源名稱。僅支援圖片語料庫類型。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ImageSegmentationPredictionResult

圖片區隔的預測輸出格式。

欄位

category_mask

string

PNG 圖片，其中遮罩中的每個像素代表原始圖像中像素的預測類別。這張圖片的大小會與原始圖片相同。您可以在模型的中繼資料中找到 AnntoationSpec 和顏色之間的對應關係。模型會選擇最有可能的類別，如果沒有任何類別達到信心門檻，則會將像素標示為背景。

confidence_mask

string

以 8 位元無損 PNG 編碼的單一通道圖片。圖片大小會與原始圖片相同。對於特定像素，較深的顏色代表對應像素的 categoryMask 中類別正確性的信心程度較低。黑色代表沒有信心，白色代表完全有信心。

ImportAssetsMetadata

ImportAssets LRO 的中繼資料訊息。

欄位

metadata

作業的中繼資料。

ImportAssetsRequest

ImportAssets 的要求訊息。

欄位

parent

string

這是必要旗標，要匯入資產的父項字典資源。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

聯集欄位 source。來源。source 只能是下列其中一項：

assets_gcs_uri

string

這個檔案包含所有要匯入的素材資源資訊。* 檔案格式為 JSONL。* 每列對應一項資產。* 每行都會轉換為 InputImageAsset 原型。

ImportAssetsResponse

這個類型沒有任何欄位。

ImportAssets LRO 的回應訊息。

ImportRetailProductsResponse

這個類型沒有任何欄位。

匯入產品作業完成後的回應。

索引

索引是 Corpus 中的資源。其中包含索引版本的素材資源和註解。部署至端點後，使用者就能搜尋索引。

欄位
`name`	`string` 僅供輸出。索引資源的資源名稱。格式：`projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}`
`display_name`	`string` (非必要) 使用者指定的索引顯示名稱 (選用)。
`description`	`string` (非必要) 索引的選用說明。
`state`	`State` 僅供輸出。索引的狀態。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。
`deployed_indexes[]`	`DeployedIndexReference` 僅供輸出。已部署索引執行個體的參照。VIDEO_ON_DEMAND 叢集的索引最多只能有一個已部署的索引。IMAGE 語料庫的索引可以有多個已部署的索引。
聯集欄位 `asset_filter`。指定如何為這個索引選取素材資源。如未指定，預設值為 entire_corpus。UpdateIndex 中的行為：如果 update_mask 包含其中一個 asset_filter 欄位路徑，系統會使用最新的資產 (包括已分析的資料和註解) 重新建構索引。`asset_filter` 只能是下列其中一項：
`entire_corpus`	`bool` 納入語料庫中的所有資產。

狀態

列舉代表索引在生命週期中可能會循環的不同狀態。

列舉
`STATE_UNSPECIFIED`	預設值。請勿使用。
`CREATING`	狀態為 CREATING。
`CREATED`	狀態為「CREATED」。
`UPDATING`	狀態為「更新中」。

IndexAssetMetadata

IndexAsset 的中繼資料。

欄位
`indexing_status (deprecated)`	`IndexingStatus` 這個項目已遭淘汰！這個資產的索引狀態。
`status`	`IndexingStatus` 這個資產的索引狀態。
`start_time`	`Timestamp` 作業的開始時間。
`update_time`	`Timestamp` 作業的更新時間。

IndexingStatus

資產的索引狀態。

欄位

state

這個資產的索引狀態。

status_message

string

說明狀態的詳細訊息。

狀態

此資產索引的狀態列舉。

列舉
`STATE_UNSPECIFIED`	預設程序狀態不應發生。
`IN_PROGRESS`	正在建立索引。
`SUCCEEDED`	程序已順利完成。
`FAILED`	程序失敗。

IndexAssetRequest

IndexAsset 的要求訊息。

欄位

name

string

這是必要旗標，要建立索引的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

index

string

(非必要) 索引的名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

IndexAssetResponse

這個類型沒有任何欄位。

IndexAsset 的回應訊息。

IndexEndpoint

代表 IndexEndpoint 資源的訊息。並在其中部署 ImageIndexes。

欄位
`name`	`string` 僅供輸出。IndexEndpoint 的資源名稱。格式：`projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}`
`display_name`	`string` (非必要) IndexEndpoint 的顯示名稱。長度上限為 32 個半形字元。
`description`	`string` (非必要) IndexEndpoint 的說明。長度上限為 25,000 個半形字元。
`deployed_index`	`DeployedIndex` 僅供輸出。這個 IndexEndpoint 中部署的索引。
`state`	`State` 僅供輸出。IndexEndpoint 狀態。
`labels`	`map<string, string>` (非必要) 套用於資源的標籤必須符合下列規定：每項資源可以有多個標籤，上限為 64 個。每個標籤都必須是鍵/值組合。鍵的長度必須至少為 1 個字元，最多 63 個字元，且不能空白。值可以空白，長度上限為 63 個半形字元。鍵和值只能包含小寫英文字母、數字字元、底線和連字號。所有字元都必須使用 UTF-8 編碼，且可使用國際字元。標籤中的鍵部分不得重複，但可讓多個資源使用相同的鍵。鍵的開頭必須是小寫字母或國際字元。詳情請參閱 Google Cloud 說明文件。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。

狀態

IndexEndpoint 階段。

列舉
`STATE_UNSPECIFIED`	預設值。請勿使用。
`CREATING`	狀態為 CREATING。
`CREATED`	狀態為「CREATED」。
`UPDATING`	狀態為「更新中」。
`FAILED`	狀態為「FAILED」。

IndexedAsset

IndexedAsset 是建立索引的基礎資產。

欄位
`index`	`string` 這是必要旗標，這個索引資產所屬的索引。格式：`projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}`
`asset`	`string` 這是必要旗標，素材資源的資源名稱。格式：`projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。

IndexingStatus

資產的索引狀態。

欄位

state

僅供輸出。這個資產的索引狀態。

status_message

string

說明狀態的詳細訊息。

狀態

此資產索引的狀態列舉。

列舉
`STATE_UNSPECIFIED`	預設程序狀態不應發生。
`IN_PROGRESS`	正在建立索引。
`SUCCEEDED`	程序已順利完成。
`FAILED`	程序失敗。

IngestAssetRequest

IngestAsset API 的請求訊息。

欄位

聯集欄位 streaming_request。

streaming_request 只能是下列其中一項：

config

Config

提供資料的相關資訊，以及資料所屬的資產資源名稱。第一個 IngestAssetRequest 訊息必須只包含 Config 訊息。

time_indexed_data

TimeIndexedData

要擷取的資料。

設定

資料設定。

欄位

asset

string

這是必要旗標，擷取的資料所屬資產的資源名稱。

聯集欄位 data_type。

data_type 只能是下列其中一項：

video_type

VideoType

輸入影片資料的類型資訊。

VideoType

輸入影片資料的類型資訊。

欄位

container_format

ContainerFormat

影片資料的容器格式。

ContainerFormat

影片的容器格式。

列舉
`CONTAINER_FORMAT_UNSPECIFIED`	預設類型，不應使用。
`CONTAINER_FORMAT_MP4`	MP4 容器格式。

TimeIndexedData

包含資料和資料的對應時間範圍。

欄位

data

bytes

要擷取的資料。

temporal_partition

資料的時間範圍。

IngestAssetResponse

IngestAsset API 的回應訊息。

欄位

successfully_ingested_partition

已成功攝入的資料時間範圍。

執行個體

說明 Instance 物件的訊息

欄位
`name`	`string` 僅供輸出。資源名稱
`create_time`	`Timestamp` 僅供輸出。[僅供輸出] 建立時間戳記
`update_time`	`Timestamp` 僅供輸出。[僅供輸出] 更新時間戳記
`labels`	`map<string, string>` 標籤為鍵/值組合
`display_name`	`string` 這是必要旗標，解決方案的使用者友善顯示名稱。
`description`	`string` 這個執行個體的說明。
`instance_type`	`InstanceType` 目前執行個體的執行個體類型。
`input_resources[]`	`InputResource` 目前應用程式執行個體的輸入資源。例如：input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a
`output_resources[]`	`OutputResource` 與一個應用程式例項相關聯的所有輸出資源。
`state`	`State` 執行個體的狀態。

InputResource

在一個應用程式執行個體中使用的輸入資源訊息。

欄位
`consumer_node`	`string` 接收輸入資源的圖形節點名稱。例如：input_resource: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a consumer_node: stream-input
`input_resource_binding`	`string` 如果只有 1 個輸入繫結，則可以忽略會使用目前輸入資源的特定輸入資源繫結。
`annotations`	`ResourceAnnotations` 包含資源註解。
聯集欄位 `input_resource_information`。這是必要旗標，指定應用程式執行個體的輸入內容。`input_resource_information` 只能是下列其中一項：
`input_resource`	`string` 直接輸入資源名稱。如果執行個體類型為 STREAMING_PREDICTION，輸入資源的格式為「projects/123/locations/us-central1/clusters/456/streams/stream-a」。如果執行個體類型是 Cloud Storage 輸入容器中的 BATCH_PREDICTION，輸入資源的格式為「gs://bucket-a」。
`annotated_stream (deprecated)`	`StreamWithAnnotation` 這個項目已遭淘汰！如果輸入資源是 VisionAI 串流，則可改用 annotated_stream 指定相關註解。

OutputResource

在一個應用程式例項中使用的輸出資源訊息。

欄位
`output_resource`	`string` 目前應用程式例項的輸出資源名稱。
`producer_node`	`string` 產生輸出資源名稱的圖表節點名稱。例如：output_resource: /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting producer_node: occupancy-counting
`output_resource_binding`	`string` 產生目前 OutputResource 的特定輸出資源繫結。
`is_temporary`	`bool` 僅供輸出。輸出資源是否為暫時性資源，也就是在應用程式部署期間產生的資源。系統會在應用程式解除部署期間刪除暫時性資源。
`autogen`	`bool` 僅供輸出。輸出資源是否由 Vision AI App Platform 自動建立。

狀態

執行個體的狀態

列舉
`STATE_UNSPECIFIED`	預設值。如果省略狀態，系統會使用這個值。
`CREATING`	狀態為 CREATING。
`CREATED`	狀態為「CREATED」。
`DEPLOYING`	狀態 DEPLOYING。
`DEPLOYED`	狀態為「已部署」。
`UNDEPLOYING`	狀態為 UNDEPLOYING。
`DELETED`	狀態為「已刪除」。
`ERROR`	狀態為 ERROR。
`UPDATING`	狀態更新
`DELETING`	狀態為「刪除中」。
`FIXING`	狀態修正。

IntRange

整數範圍類型。

欄位

start

int64

int 範圍的起始值。

end

int64

int 範圍的結束值。

IntRangeArray

整數範圍值清單。

欄位

int_ranges[]

IntRange

Int 範圍值。

ListAnalysesRequest

要求分析清單的訊息

欄位
`parent`	`string` 這是必要旗標，ListAnalysesRequest 的父項值
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果
`order_by`	`string` 結果排序方式的提示

ListAnalysesResponse

回覆商家資訊分析的訊息

欄位

analyses[]

Analysis

數據分析清單

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListAnnotationsRequest

GetAnnotation API 的要求訊息。

欄位
`parent`	`string` 擁有此註解集合的父項。格式：`projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}`
`page_size`	`int32` 要傳回的註解數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個註解。許可的最大值為 1000；超出的數值將一律指定為 1000。
`page_token`	`string` 從先前 `ListAnnotations` 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時，提供至 `ListAnnotations` 的所有其他參數須與提供網頁權杖的呼叫相符。
`filter`	`string` 套用至傳回清單的篩選器。我們只支援篩選以下欄位：`partition.temporal_partition.start_time`、`partition.temporal_partition.end_time` 和 `key`。對於圖片類型的語料庫，系統僅支援 `key`。時間戳記以 RFC-3339 格式指定，且每個欄位只能套用一個限制，並以連接詞連接。格式：「partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

ListAnnotationsResponse

ListAnnotations API 的要求訊息。

欄位

annotations[]

指定素材資源的註解。

next_page_token

string

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

ListApplicationsRequest

要求應用程式清單的訊息。

欄位
`parent`	`string` 這是必要旗標，ListApplicationsRequest 的父項值。
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果。
`order_by`	`string` 提示如何排序結果。

ListApplicationsResponse

回覆商家資訊申請的訊息。

欄位

applications[]

Application

應用程式清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListAssetsRequest

ListAssets 的要求訊息。

欄位
`parent`	`string` 這是必要旗標，擁有此資產集合的父項。格式：`projects/{project_number}/locations/{location}/corpora/{corpus}`
`page_size`	`int32` 傳回的素材資源數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個資產。許可的最大值為 1000；超出的數值將一律指定為 1000。
`page_token`	`string` 從先前 `ListAssets` 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時，提供至 `ListAssets` 的所有其他參數須與提供網頁權杖的呼叫相符。
`filter`	`string` 套用至傳回清單的篩選器。系統僅支援下列篩選條件：「assets_with_contents = true」，會傳回已上傳內容的資產；「assets_with_contents = false」，會傳回沒有內容的資產。

ListAssetsResponse

ListAssets 的回應訊息。

欄位

assets[]

Asset

指定語料庫中的素材資源。

next_page_token

string

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

ListCollectionsRequest

ListCollections 的要求訊息。

欄位

parent

string

這是必要旗標，父項叢書。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

要傳回的集合數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個產品。許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

從先前 ListCollectionsRequest 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

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

ListCollectionsResponse

ListCollections 的回應訊息。

欄位

collections[]

Collection

指定語料庫中的珍藏內容。

next_page_token

string

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

ListCorporaRequest

ListCorpora 的要求訊息。

欄位
`parent`	`string` 這是必要旗標，要列出語料庫的專案資源名稱。
`page_size`	`int32` 請求的頁面大小。API 傳回的結果可能少於要求的結果。如果為負值，系統會傳回 INVALID_ARGUMENT 錯誤。如果未指定或為 0，API 會挑選預設大小，也就是 10。如果要求的頁面大小大於上限大小，API 會使用上限大小 (20)。
`page_token`	`string` 用來識別伺服器要傳回的結果頁面的符記。通常是透過先前 `Warehouse.ListCorpora` 呼叫的 `ListCorporaResponse.next_page_token` 取得。
`filter`	`string` 套用至傳回的字庫清單的篩選器。僅支援下列限制：`type=<Corpus.Type>`、`type!=<Corpus.Type>`。

ListCorporaResponse

ListCorpora 的回應訊息。

欄位

corpora[]

Corpus

專案中的語料庫。

next_page_token

string

用來擷取下一頁結果的符記。傳遞至 ListCorporaRequest.page_token 即可取得該頁面。

ListDataSchemasRequest

ListDataSchemas 的要求訊息。

欄位

parent

string

這是必要旗標，擁有此資料結構定義集合的父項。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

page_size

int32

要傳回的資料結構定義數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個資料結構定義。許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

從先前 ListDataSchemas 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

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

ListDataSchemasResponse

ListDataSchemas 的回應訊息。

欄位

data_schemas[]

DataSchema

指定語料庫的資料架構。

next_page_token

string

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

ListDraftsRequest

要求草稿清單的訊息。

欄位
`parent`	`string` 這是必要旗標，ListDrafts 要求的父項值。
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果。
`order_by`	`string` 提示如何排序結果。

ListDraftsResponse

回覆房源草稿的訊息。

欄位

drafts[]

Draft

草稿清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListIndexEndpointsRequest

ListIndexEndpoints 的要求訊息。

欄位
`parent`	`string` 這是必要旗標，格式：`projects/{project}/locations/{location}`
`page_size`	`int32` (非必要) 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。服務傳回的產品數量可能會少於這個值。如未指定，系統會使用 50 的頁面大小。許可的最大值為 1000；超出的數值將一律指定為 1000。
`page_token`	`string` (非必要) 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` (非必要) 套用至傳回清單的篩選器。我們只支援篩選 `deployed_image_index.image_index` 欄位。不過，如要依據字典而非圖像索引篩選，只要使用 `deployed_image_index.corpus` 即可，這會傳回指定字典中所有含有 `deployed_image_index.image_index` 的端點。圖片索引的基本篩選器如下：deployed_image_index.image_index = "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"。語料庫的基本篩選器如下：deployed_image_index.corpus = "projects/123/locations/us-central1/corpora/my_corpus"。

ListIndexEndpointsResponse

ListIndexEndpoints 的回應訊息。

欄位

index_endpoints[]

IndexEndpoint

IndexEndpoints 的清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

ListIndexesRequest

索引清單要求訊息。

欄位

parent

string

這是必要旗標，擁有這個索引集合的父項語料庫。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

要傳回的索引數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個索引。許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

從先前 ListIndexes 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

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

ListIndexesResponse

ListIndexes 的回應訊息。

欄位

indexes[]

Index

指定語料庫中的索引。

next_page_token

string

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

ListInstancesRequest

要求執行個體清單的訊息。

欄位
`parent`	`string` 這是必要旗標，ListInstancesRequest 的父項值。
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果。
`order_by`	`string` 提示如何排序結果。

ListInstancesResponse

回應清單執行個體的訊息。

欄位

instances[]

Instance

執行個體清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListPrebuiltProcessorsRequest

要求訊息：列出預先建構的處理器。

欄位

parent

string

這是必要旗標，上層路徑。

ListPrebuiltProcessorsResponse

列出預先建構的處理器的回應訊息。

欄位

processors[]

Processor

處理器清單。

ListProcessesRequest

要求程序清單的訊息。

欄位
`parent`	`string` 這是必要旗標，ListProcessesRequest 的父項值。
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果
`order_by`	`string` 結果排序方式的提示

ListProcessesResponse

回應列表程序的訊息。

欄位

processes[]

Process

程序清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListProcessorsRequest

要求處理器清單的訊息。

欄位
`parent`	`string` 這是必要旗標，ListProcessors 要求的父項值。
`page_size`	`int32` 請求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定，伺服器會挑選適當的預設值。
`page_token`	`string` 用來識別伺服器應傳回的結果頁面的符記。
`filter`	`string` 篩選結果。
`order_by`	`string` 提示如何排序結果。

ListProcessorsResponse

回覆商家資訊處理工具的訊息。

欄位

processors[]

Processor

處理器清單。

next_page_token

string

用來識別伺服器應傳回的結果頁面的符記。

unreachable[]

string

無法抵達的位置。

ListSearchConfigsRequest

ListSearchConfigs 的請求訊息。

欄位

parent

string

這是必要旗標，擁有此搜尋設定集合的父項。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

要傳回的搜尋設定數量上限。服務傳回的產品數量可能會少於這個值。如未指定，系統會使用 50 的頁面大小。許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

從先前 ListSearchConfigs 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

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

ListSearchConfigsResponse

ListSearchConfigs 的回應訊息。

欄位

search_configs[]

SearchConfig

指定語料庫的搜尋設定。

next_page_token

string

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

ListSearchHypernymsRequest

要求訊息，用於新增商家資訊的 SearchHypernyms。

欄位

parent

string

這是必要旗標，這個 SearchHypernym 集合的父項。格式：projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

傳回的 SearchHypernym 數量上限。服務傳回的產品數量可能會少於這個值。如未指定，系統會使用 50 的頁面大小。許可的最大值為 1000；超出的數值將一律指定為 1000。

page_token

string

從先前 SearchHypernym 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

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

ListSearchHypernymsResponse

列出 SearchHypernyms 的回應訊息。

欄位

search_hypernyms[]

SearchHypernym

指定語料庫中的 SearchHypernyms。

next_page_token

string

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

MachineSpec

單一機器的規格。

欄位

machine_type

string

不可變動。機器類型。

請參閱預測功能支援的機器類型清單

請參閱支援自訂訓練的機器類型清單。

對於 [DeployedModel][] 而言，這個欄位為選填，預設值為 n1-standard-2。這是 [BatchPredictionJob][] 或 [WorkerPoolSpec][] 的必填欄位。

accelerator_type

AcceleratorType

不可變動。根據 accelerator_count 附加至機器的加速器類型。

accelerator_count

int32

要附加至機器的加速器數量。

MediaWarehouseConfig

說明 MediaWarehouseConfig 的訊息。

欄位

corpus

string

媒體倉儲語料庫的資源名稱。格式：projects/${project_id}/locations/${location_id}/corpora/${corpus_id}

region
(deprecated)

string

已淘汰。

ttl

所有媒體素材資源、相關中繼資料和搜尋文件的有效時間。

ModelType

Vision AI App Platform 支援的所有模型類型。

列舉
`MODEL_TYPE_UNSPECIFIED`	處理器類型為「UNSPECIFIED」。
`IMAGE_CLASSIFICATION`	模型類型：圖片分類。
`OBJECT_DETECTION`	模型類型：物件偵測。
`VIDEO_CLASSIFICATION`	模型類型：影片分類。
`VIDEO_OBJECT_TRACKING`	模型類型：物件追蹤。
`VIDEO_ACTION_RECOGNITION`	模型類型：動作辨識。
`OCCUPANCY_COUNTING`	模型類型：人車計數。
`PERSON_BLUR`	模型類型：人像模糊處理。
`VERTEX_CUSTOM`	模型類型為 Vertex Custom。

節點

說明節點物件的訊息。

欄位
`name`	`string` 這是必要旗標，節點的專屬名稱。
`display_name`	`string` 節點的使用者友善顯示名稱。
`node_config`	`ProcessorConfig` 節點設定。
`processor`	`string` 處理器名稱是指所選處理器資源。
`parents[]`	`InputEdge` 父項節點。輸入節點不得有父項節點。在 V1 Alpha1/Beta 中，只有媒體倉儲節點可以有多個父項，其他類型的節點只能有一個父項。
聯集欄位 `stream_output_config`。 `stream_output_config` 只能是下列其中一項：
`output_all_output_channels_to_stream`	`bool` 根據預設，節點的輸出內容只會提供給下游節點。如要使用應用程式節點的直接輸出內容，輸出內容必須先傳送至 Vision AI Streams。將 output_all_output_channels_to_stream 設為 true 後，App Platform 會自動將目前節點的所有輸出內容傳送至 Vision AI 串流資源 (每個輸出管道一個串流)。在部署期間，App Platform 會自動建立輸出串流資源，並在應用程式取消部署後刪除。請注意，這項設定會套用至所有應用程式執行個體。您可以設定執行個體資源的 `output_resources` 區段，在執行個體層級覆寫輸出串流。`producer_node` 應為目前節點，`output_resource_binding` 應為輸出頻道名稱 (如果處理器只有 1 個輸出頻道，則留空即可)，而 `output_resource` 應為目標輸出串流。

InputEdge

說明指向節點的一個邊的訊息。

欄位

parent_node

string

父項節點的名稱。

parent_output_channel

string

父節點的已連結輸出構件。如果目標處理器只有 1 個輸出構件，則可省略。

connected_input_channel

string

目前節點處理器的已連結輸入管道。如果目標處理器只有 1 個輸入頻道，則可省略。

NormalizedPolygon

已正規化的多邊形。

欄位

normalized_vertices[]

已識別的方塊包含物件的地點和實體。

欄位
`box_id`	`int64` 這個方塊的專屬 ID。
`normalized_bounding_box`	`NormalizedBoundingBox` 經過正規化座標的邊界框。
`confidence_score`	`float` 與此方塊相關聯的信心分數。
`entity`	`Entity` 這個方塊的實體。

NormalizedBoundingBox

經過正規化座標的邊界框。

欄位
`xmin`	`float` x 座標的最小值。
`ymin`	`float` y 座標中的最小值。
`width`	`float` 邊界框的寬度。
`height`	`float` 定界框的高度。

OccupancyCountConfig

說明 OccupancyCountConfig 的訊息。

欄位

enable_people_counting

bool

是否要計算人物出現次數，輸出計數時的鍵為「people」。

enable_vehicle_counting

bool

是否要計算車輛的出現次數，輸出計數時的鍵為「vehicle」。

enable_dwelling_time_tracking

bool

是否要追蹤各個物體在場景或特定區域內逗留的時間。

OccupancyCountingPredictionResult

居住人數計數的預測結果原型檔。

欄位
`current_time`	`Timestamp` 目前的時間戳記。
`identified_boxes[]`	`IdentifiedBox` 已標示的方塊清單。
`stats`	`Stats` 偵測統計資料。
`track_info[]`	`TrackInfo` 追蹤相關資訊。在這個時間戳記時刻播放的所有音軌。只有在啟用追蹤功能時才會存在。
`dwell_time_info[]`	`DwellTimeInfo` 停留時間相關資訊。在特定區域內的所有軌跡，以及軌跡的開始和結束停留時間時間戳記

DwellTimeInfo

車輛乘載人數計數運算子註解的停留時間資訊。

欄位
`track_id`	`string` 用於識別曲目的專屬 ID。在各個影格中應保持一致。
`zone_id`	`string` 物件停留/等待的區域專屬 ID。
`dwell_start_time`	`Timestamp` 在某個區域中，住宅物件被辨識到的開始時間。
`dwell_end_time`	`Timestamp` 居家物件離開區域的結束時間。

實體

車輛乘載人數計算運算子的註解實體資訊。

欄位

label_id

int64

標籤 ID。

label_string

string

使用者容易理解的標籤字串。

IdentifiedBox

已識別的方塊包含物件的地點和實體。

欄位
`box_id`	`int64` 這個方塊的專屬 ID。
`normalized_bounding_box`	`NormalizedBoundingBox` 經過正規化座標的邊界框。
`score`	`float` 與此方塊相關聯的信心分數。
`entity`	`Entity` 這個方塊的實體。
`track_id`	`int64` 用於識別曲目的專屬 ID。在各個影格中應保持一致。只有在啟用追蹤功能時才會存在。

NormalizedBoundingBox

經過正規化座標的邊界框。

欄位
`xmin`	`float` x 座標的最小值。
`ymin`	`float` y 座標中的最小值。
`width`	`float` 邊界框的寬度。
`height`	`float` 定界框的高度。

統計資料

車輛乘載人數計算運算子註解的統計資訊。

欄位
`full_frame_count[]`	`ObjectCount` 全框計數。
`crossing_line_counts[]`	`CrossingLineCount` 跨越行數。
`active_zone_counts[]`	`ActiveZoneCount` 活動區次數。

AccumulatedObjectCount

物件資訊和占用率計數運算子註解的累積計數。

欄位
`start_time`	`Timestamp` 累積計數的開始時間。
`object_count`	`ObjectCount` 累積計數的物件數量。

ActiveZoneCount

活動區間計數訊息。

欄位
`annotation`	`StreamAnnotation` 使用者所標示的活動區域。
`counts[]`	`ObjectCount` 區間內的計數。

CrossingLineCount

跨越行數量的訊息。

欄位
`annotation`	`StreamAnnotation` 使用者繪製的線條註解。
`positive_direction_counts[]`	`ObjectCount` 遵循右手法則的方向。
`negative_direction_counts[]`	`ObjectCount` 與右手法則相反的方向。
`accumulated_positive_direction_counts[]`	`AccumulatedObjectCount` 累積的正面回應次數。
`accumulated_negative_direction_counts[]`	`AccumulatedObjectCount` 累積的負面評價數量。

ObjectCount

物件資訊和占用率計算運算子註解的即時計數。

欄位
`entity`	`Entity` 這個物件的實體。
`count`	`int32` 物件的計數。

TrackInfo

車輛乘載人數計算運算子註解的軌跡資訊。

欄位

track_id

string

用於識別曲目的專屬 ID。在各個影格中應保持一致。

start_time

這個曲目的開始時間戳記。

OperationMetadata

代表長時間執行作業的中繼資料。

欄位
`create_time`	`Timestamp` 僅供輸出。作業的建立時間。
`end_time`	`Timestamp` 僅供輸出。作業完成的時間。
`target`	`string` 僅供輸出。作業目標的伺服器定義資源路徑。
`verb`	`string` 僅供輸出。作業執行的動詞名稱。
`status_message`	`string` 僅供輸出。作業的狀態 (如果有)，以人類可讀的方式呈現。
`requested_cancellation`	`bool` 僅供輸出。指出使用者是否已要求取消作業。已成功取消的作業會具有 [Operation.error][] 值，且 `google.rpc.Status.code` 為 1 (也就是 `Code.CANCELLED`)。
`api_version`	`string` 僅供輸出。用於啟動作業的 API 版本。

分區

分割區，用於指定子資產層級註解的時間和空間分割區。

欄位

temporal_partition

RelativeTemporalPartition

時間上的資產區隔。

spatial_partition

SpatialPartition

在聊天室中分割素材資源。

relative_temporal_partition

時間上的資產區隔。

RelativeTemporalPartition

以相對時間分割資產。由 VIDEO_ON_DEMAND 字元集類型支援。

欄位

start_offset

分區的開始時間偏移量。

end_offset

分區的結束時間偏移量。

SpatialPartition

在聊天室中分割素材資源。

欄位
`x_min`	`int64` 最小 X 座標值。
`y_min`	`int64` 最小 Y 座標值。
`x_max`	`int64` 最大 X 座標值。
`y_max`	`int64` 最大 Y 座標值。

TemporalPartition

以世界標準時間紀元時間為準的資產區段。此參數支援 STREAM_VIDEO 字詞庫類型。

欄位

start_time

分區的開始時間。

end_time

個人防護裝備偵測運算子的輸出格式。

欄位

current_time

目前的時間戳記。

detected_persons[]

DetectedPerson

DetectedPerson 清單。

DetectedPerson

偵測到的人物包含偵測到的人物、相關的 pp 和保護資訊。

欄位
`person_id`	`int64` 偵測到的人物 ID。
`detected_person_identified_box`	`PersonIdentifiedBox` 已識別的人員資訊方塊。
`detected_ppe_identified_boxes[]`	`PPEIdentifiedBox` 與 PPE 相關聯的已偵測人員資訊。
`face_coverage_score`	`float` 每個身體部位的覆蓋率分數。臉部涵蓋率分數。
`eyes_coverage_score`	`float` 眼睛的覆蓋率分數。
`head_coverage_score`	`float` 標頭的涵蓋率分數。
`hands_coverage_score`	`float` 手部涵蓋率分數。
`body_coverage_score`	`float` 內文的涵蓋率分數。
`feet_coverage_score`	`float` 腳的涵蓋率分數。

NormalizedBoundingBox

經過正規化座標的邊界框。

欄位
`xmin`	`float` x 座標的最小值。
`ymin`	`float` y 座標中的最小值。
`width`	`float` 邊界框的寬度。
`height`	`float` 定界框的高度。

PPEEntity

PPE 偵測預測結果的註解實體資訊。

欄位
`ppe_label_id`	`int64` 標籤 ID。
`ppe_label_string`	`string` 使用者容易理解的標籤字串 (例如：頭盔、手套、面罩)。
`ppe_supercategory_label_string`	`string` 超級類別標籤的使用者可解讀字串 (例如：頭部防護裝置、手部防護裝置、臉部防護裝置)。
`ppe_entity_id`	`int64` 實體 ID。

PPEIdentifiedBox

PPEIdentified 方塊包含 PPE 的位置和實體資訊。

欄位
`box_id`	`int64` 這個方塊的專屬 ID。
`normalized_bounding_box`	`NormalizedBoundingBox` 經過正規化座標的邊界框。
`confidence_score`	`float` 與此方塊相關聯的信心分數。
`ppe_entity`	`PPEEntity` PPE 實體資訊。

PersonEntity

來自人物偵測預測結果的註解實體資訊。

欄位

person_entity_id

int64

實體 ID。

PersonIdentifiedBox

「PersonIdentified」方塊包含該人的地點和實體資訊。

欄位
`box_id`	`int64` 這個方塊的專屬 ID。
`normalized_bounding_box`	`NormalizedBoundingBox` 經過正規化座標的邊界框。
`confidence_score`	`float` 與此方塊相關聯的信心分數。
`person_entity`	`PersonEntity` 人員實體資訊。

程序

說明 Process 物件的訊息。

欄位
`name`	`string` 資源名稱。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。
`analysis`	`string` 這是必要旗標，參照現有的分析資源。
`attribute_overrides[]`	`string` (非必要) 分析器的屬性覆寫值。每個覆寫項目的格式：「{analyzer_name}:{attribute_key}={value}」
`run_status`	`RunStatus` (非必要) 程序狀態。
`run_mode`	`RunMode` (非必要) 程序的執行模式。
`event_id`	`string` (非必要) 輸入/輸出串流的事件 ID。在分析中使用 StreamSource/StreamSink 運算子時，如果您想手動指定要讀取/寫入的事件，這項功能就很實用。

處理器

說明 Processor 物件的訊息。下一個 ID：19

欄位
`name`	`string` 資源名稱。
`create_time`	`Timestamp` 僅供輸出。[僅供輸出] 建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。[僅供輸出] 更新時間戳記。
`labels`	`map<string, string>` 標籤為鍵/值組合。
`display_name`	`string` 這是必要旗標，處理器的易懂顯示名稱。
`description`	`string` 說明處理器功能的示例句子。
`processor_type`	`ProcessorType` 僅供輸出。處理器類型。
`model_type`	`ModelType` 模型類型。
`custom_processor_source_info`	`CustomProcessorSourceInfo` 客戶建立的處理器來源資訊。
`state`	`ProcessorState` 僅供輸出。處理器的狀態。
`processor_io_spec`	`ProcessorIOSpec` 僅供輸出。[僅限輸出] 處理器的輸入 / 輸出規格，每種處理器都有固定的輸入 / 輸出規格，客戶無法變更。
`configuration_typeurl`	`string` 僅供輸出。您可以在應用程式中使用對應的設定，自訂處理器的行為。
`supported_annotation_types[]`	`StreamAnnotationType`
`supports_post_processing`	`bool` 指出處理器是否支援後製。

ProcessorState

列舉
`PROCESSOR_STATE_UNSPECIFIED`	未指定的處理器狀態。
`CREATING`	處理器正在建立中 (尚未可供使用)。
`ACTIVE`	處理器已就緒，可以開始使用。
`DELETING`	處理器正在刪除中 (尚未可供使用)。
`FAILED`	處理器已刪除或建立失敗。

ProcessorType

類型

列舉
`PROCESSOR_TYPE_UNSPECIFIED`	處理器類型為「UNSPECIFIED」。
`PRETRAINED`	處理器類型為 PRETRAINED。預先訓練的處理器是由 Vision AI App Platform 開發，具備先進的視覺資料處理功能，例如人數計算或人物模糊處理。預先訓練的處理器通常是公開的。
`CUSTOM`	處理器類型為「自訂」。自訂處理器是指由客戶上傳或從其他 Google Cloud 平台 (例如 Vertex AI) 匯入的特殊處理器。只有創作者能查看自訂處理器。
`CONNECTOR`	處理器類型為 CONNECTOR。連接器處理器是為應用程式執行 I/O 的特殊處理器，不會處理資料，而是將資料傳送至其他處理器，或接收來自其他處理器的資料。

ProcessorConfig

下一個 ID：28

欄位
聯集欄位 `processor_config`。 `processor_config` 只能是下列其中一項：
`video_stream_input_config`	`VideoStreamInputConfig` 串流輸入處理器的設定。
`ai_enabled_devices_input_config`	`AIEnabledDevicesInputConfig` 支援 AI 技術的輸入裝置設定。
`media_warehouse_config`	`MediaWarehouseConfig` 媒體倉儲處理器的設定。
`person_blur_config`	`PersonBlurConfig` 人物模糊處理器的設定。
`occupancy_count_config`	`OccupancyCountConfig` 使用率計數器處理器的設定。
`person_vehicle_detection_config`	`PersonVehicleDetectionConfig` 人車偵測處理器的設定。
`vertex_automl_vision_config`	`VertexAutoMLVisionConfig` Vertex AutoML 視覺處理器的設定。
`vertex_automl_video_config`	`VertexAutoMLVideoConfig` Vertex AutoML 影片處理器的設定。
`vertex_custom_config`	`VertexCustomConfig` Vertex 自訂處理器的設定。
`general_object_detection_config`	`GeneralObjectDetectionConfig` 一般物件偵測處理器的設定。
`big_query_config`	`BigQueryConfig` BigQuery 處理器的設定。
`personal_protective_equipment_detection_config`	`PersonalProtectiveEquipmentDetectionConfig` personal_protective_equipment_detection_config 的設定

ProcessorIOSpec

說明處理器輸入 / 輸出規格的訊息。

欄位
`graph_input_channel_specs[]`	`GraphInputChannelSpec` 如果處理器有 input_channel_specs，則必須明確連結至其他處理器。
`graph_output_channel_specs[]`	`GraphOutputChannelSpec` 目前處理器的輸出構件規格。
`instance_resource_input_binding_specs[]`	`InstanceResourceInputBindingSpec` 需要從應用程式執行個體饋給的輸入資源。
`instance_resource_output_binding_specs[]`	`InstanceResourceOutputBindingSpec` 處理器會為每個執行個體產生的輸出資源。除了這裡明確列出的輸出繫結之外，所有處理器的 GraphOutputChannels 都可以繫結至串流資源。繫結名稱會與 GraphOutputChannel 的名稱相同。

GraphInputChannelSpec

輸入管道規格訊息。

欄位
`name`	`string` 目前輸入頻道的名稱。
`data_type`	`DataType` 目前輸入頻道的資料類型。如果這個欄位有超過 1 個值，表示這個輸入管道可以連結至這些不同資料類型中的任一類型。
`accepted_data_type_uris[]`	`string` 如果指定了這些資料類型，則只有這些詳細資料類型才能連結至處理器。例如，MEDIA 的 JPEG 串流，或 PROTO 類型的 PredictionResult 原型。如果未指定，系統會接受任何 proto。
`required`	`bool` 處理器是否需要目前的輸入頻道。舉例來說，如果處理器需要影片輸入和選用的音訊輸入，當影片輸入缺少時，應用程式就會遭到拒絕，但只要影片輸入存在，音訊輸入可以缺少。
`max_connection_allowed`	`int64` 這個輸入管道可連結多少個輸入邊。0 代表無限制。

GraphOutputChannelSpec

輸出管道規格的訊息。

欄位

name

string

目前輸出管道的名稱。

data_type

DataType

目前輸出管道的資料類型。

data_type_uri

string

InstanceResourceInputBindingSpec

執行個體資源管道規格的訊息。外部資源是應用程式圖表中未顯示的虛擬節點。每個處理器都會提供其外部圖規格，因此客戶可以覆寫外部來源或目的地

欄位
`name`	`string` 輸入繫結的名稱，在處理器中不重複。
聯集欄位 `resource_type`。 `resource_type` 只能是下列其中一項：
`config_type_uri`	`string` 包含 Googleapis 資源的設定 proto。例如 type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation
`resource_type_uri`	`string` Googleapis 資源的直接類型網址，例如 type.googleapis.com/google.cloud.vision.v1.Asset

InstanceResourceOutputBindingSpec

欄位

name

string

輸出繫結的名稱，在處理器中不重複。

resource_type_uri

string

可接受的輸出資源的資源類型 URI。

explicit

bool

是否需要在例項中明確設定輸出資源。如果為 false，處理器會在需要時自動產生。

RemoveApplicationStreamInputRequest

從應用程式移除串流輸入的訊息。

欄位

name

string

必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」

target_stream_inputs[]

TargetStreamInput

要移除的目標串流。

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

TargetStreamInput

有關要移除的目標串流輸入內容的訊息。

欄位
`stream`	`string`

indexing_status

IndexingStatus

這個資產的索引狀態。

start_time

作業的開始時間。

update_time

作業的更新時間。

RemoveIndexAssetRequest

RemoveIndexAsset 的要求訊息。

欄位

name

string

這是必要旗標，要建立索引的資產資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

index

string

(非必要) 索引的名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

RemoveIndexAssetResponse

這個類型沒有任何欄位。

RemoveIndexAsset 的回應訊息。

RemoveRetailProductsFromRetailProductSetResponse

作業完成後的 RemoveRetailProductsFromRetailProductSet 回應。

ResourceAnnotations

說明資源一般註解的訊息。

欄位

application_annotations[]

ApplicationNodeAnnotation

將套用至整個應用程式的註解。

node_annotations[]

註解會套用至應用程式的特定節點。如果應用程式和節點都套用相同類型的註解，系統會在全域應用程式註解之外，新增節點註解。舉例來說，如果有一個用於整個應用程式的有效區域註解，以及一個用於 Occupancy Analytic 處理器的有效區域註解，則 Occupancy Analytic 處理器會定義兩個有效區域。

RetailBatchAnalyzeResponse

BatchAnalyze 的回應訊息。

RetailEntity

在標記文字中，實體可能是詞組或數字。這是已知的實體類型，例如產品名稱、一般價格或會員價格。

欄位
`type`	`string` 實體類型，例如「產品名稱」、「原價」、「會員價」。
`mention_text`	`string` 實體的文字值，例如「$2.99」。如果實體不在標記中，這個欄位會留空。
`confidence`	`float` 實體預測的可信度。
`region`	`RetailNormalizedBoundingBox` 實體在標記區域的位置區域。
`normalized_text_value`	`string` 實體類型的預先定義標準中的規格化文字值。如果無法轉換擷取的值，則不存在。

RetailNormalizedBoundingBox

定界框座標是相對於圖片的寬度和高度。舉例來說，如果圖片為 100x200，且 NormalizedBoundingBox 為 <xmin = 0.1 xmax = 0.5 ymin = 0.2 ymax = 0.9>，則定界框座標會是 (10, 40) 到 (50, 180)。請注意，邊界框的部分可能會超出圖片範圍。

欄位
`x_min`	`float` 左上角的水平座標。
`x_max`	`float` 右下角的水平座標。
`y_min`	`float` 左上角的垂直座標。
`y_max`	`float` 右下角的垂直座標。

RetailObjectDetectionAnnotation

描述圖片中的物件區域及其偵測註解。

欄位

bounding_box

RetailNormalizedBoundingBox

物件例項的標準化定界框。

confidence

float

可信度分數介於 0.0 和 1.0 之間。值越高，表示對結果越有信心。

RetailOperationMetadata

Reatil 服務的作業中繼資料。

欄位

operation_metadata

RetailProductRecognitionAnnotation

長時間執行作業的常見中繼資料。

partial_failures[]

Status

僅供輸出。部分失敗。例如無法讀取的單一圖片檔案。「狀態詳細資料」欄位會包含標準的 Google Cloud 錯誤詳細資料。

operation_metrics

OperationMetrics

僅供輸出。作業相關指標。

OperationMetrics

作業的記錄指標。

欄位

counters

map<string, int32>

從計數器名稱對應至計數。

RetailPredictResults

BatchAnalyze 的結果格式。

欄位

image_uri

string

輸入內容的圖片 URI。

product_recognition_annotations[]

產品辨識註解。

tag_recognition_annotations[]

RetailTagRecognitionAnnotation

標記辨識註解。

RetailProduct

代表 RetailProduct 資源的訊息。

欄位
`name`	`string` 僅供輸出。RetailProduct 資源的名稱。
`gtins[]`	`string` 產品的全球交易品項識別碼 (GTIN)。
`normalized_gtins[]`	`string` 僅供輸出。從輸入的全球交易品項識別碼轉換為標準 GTIN-14 格式的規格化版本。
`third_party_ids[]`	`RetailThirdPartyId` 零售商或製造商使用的第三方 ID。
`locale`	`string` 產品資訊的語言代碼，以 BCP-47 代碼表示，例如 en-US、de-DE。產品標籤和品牌的語言，應與語言代碼一致。
`brand`	`string` 產品的本地化品牌。
`title`	`string` 產品的本地化名稱。
`product_uri`	`string` 產品的到達網頁。
`resource_state`	`RetailResourceState` 僅供輸出。RetailProduct 的狀態。
`labels`	`map<string, string>` 標籤含有使用者定義的中繼資料，可用於整理 RetailProducts。標籤鍵/值的長度不得超過 64 個字元 (Unicode 代碼點)，只能包含小寫英文字母、數字、底線和破折號。可使用國際字元。
`create_time`	`Timestamp` 僅供輸出。建立時間戳記。
`update_time`	`Timestamp` 僅供輸出。更新時間戳記。

RetailProductImageSimilarity

與索引組合中的產品圖片的相似度分數。

欄位
`visual_similarity_score`	`float` 與此產品圖片的相似度分數。
`detected_text_similarity_score`	`float` 查詢產品圖片中偵測到的文字，與模型在這個產品圖片中偵測到的文字之間的相似度分數。
`product_title_text_similarity_score`	`float` 在查詢產品圖片中偵測到的文字與人工編輯的產品圖片標題之間的相似度分數。
`similarity_score`	`float` 與此產品圖片的最終綜合相似度分數。

RetailProductRecognitionAnnotation

說明圖片中的產品區域及其產品辨識註解。

欄位

product_region

RetailObjectDetectionAnnotation

這個產品例項的偵測資訊 (邊界框、信心等)。

recognition_results[]

RetailProductRecognitionResult

產品辨識結果。並依可信度遞減排序。

detected_text

string

模型在這個 product_region 中偵測到的文字。

RetailProductRecognitionResult

單一產品辨識結果。

欄位

product_metadata

RetailProduct

已辨識產品的中繼資料。

confidence

float

可信度分數介於 0.0 和 1.0 之間。值越高，表示對結果越有信心。

image_similarity[]

RetailProductImageSimilarity

這個結果中每張產品圖片的相似度分數詳細資料。

RetailResourceState

資源的狀態。

列舉
`RETAIL_RESOURCE_STATE_UNSPECIFIED`	預設值。請勿使用。
`RETAIL_RESOURCE_STATE_CREATING`	狀態為 CREATING。
`RETAIL_RESOURCE_STATE_CREATED`	狀態為「CREATED」。
`RETAIL_RESOURCE_STATE_UPDATING`	狀態為「更新中」。
`RETAIL_RESOURCE_STATE_DELETED`	狀態為「已刪除」。
`RETAIL_RESOURCE_STATE_ERROR`	狀態為 ERROR。

RetailTagRecognitionAnnotation

Proto 會說明標記的辨識結果，包括此標記例項所占用的圖片區域，以及擷取的文字資訊。

欄位

tag_region

RetailObjectDetectionAnnotation

這個標記例項的偵測資訊 (邊界框、置信度等)。

tag_text

string

這個標記例項上的文字。

entities[]

RetailEntity

在標記中偵測到的實體清單。

RetailThirdPartyId

代表零售商或製造商使用的第三方 ID (例如SKU 或製造商零件編號)。

欄位

id

string

零售商或製造商使用的第三方 ID (例如SKU 或製造商零件編號)。

owner

string

擁有第三方 ID 的實體，例如製造商或販售這項產品的零售商。

RunMode

RunMode 代表啟動程序的模式。

列舉
`RUN_MODE_UNSPECIFIED`	未指定模式。
`LIVE`	即時模式。也就是說，程序會啟動來處理直播影片來源，並預期可能會發生封包遺漏。
`SUBMISSION`	提交模式。這表示系統會啟動程序來處理有界限的影片檔案，且不會遺漏任何封包。追蹤完成狀態。

RunStatus

說明程序狀態的訊息。

欄位

state

程序的狀態。

reason

string

成為狀態的原因。

狀態

狀態代表程序的執行狀態。

列舉
`STATE_UNSPECIFIED`	未指定狀態。
`INITIALIZING`	INITIALIZING 表示程序已排定，但尚未準備好處理實際流量。
`RUNNING`	RUNNING 表示程序正在執行並處理流量。
`COMPLETED`	COMPLETED 表示程序已完成處理，特別是針對非串流用途。
`FAILED`	「FAILED」表示程序無法完成處理。

SchemaKeySortingStrategy

指定如何依據資料結構定義鍵排序的策略。

欄位

options[]

Option

優先順序為前面的選項高於後面的選項。

選項

一個資料架構鍵的選項。

欄位

data_schema_key

string

用於排序的資料。

sort_decreasing

bool

指定要以遞減或遞增順序排序。根據預設，結果會以遞增順序排列。

aggregate_method

AggregateMethod

目前資料結構定義鍵的匯總方法。

AggregateMethod

如果一個結果有多個值，且這些值的鍵相同，請指定要用來排序的值。根據預設，如果結果以遞減順序排序，系統會使用 AGGREGATE_METHOD_LARGEST；如果結果以遞增順序排序，則會使用 AGGREGATE_METHOD_SMALLEST。

列舉
`AGGREGATE_METHOD_UNSPECIFIED`	未指定的匯總方法會如上所述遭到覆寫。
`AGGREGATE_METHOD_LARGEST`	取得排序時的 (字典或數字) 最大值。
`AGGREGATE_METHOD_SMALLEST`	取得最小 (字典順序或數字) 值來排序。

SearchAssetsRequest

SearchAssets 的要求訊息。

欄位
`corpus`	`string` 這是必要旗標，要搜尋的主體字典。格式：`projects/{project_id}/locations/{location_id}/corpora/{corpus_id}`
`page_size`	`int32` 這個頁面中傳回的結果數量。如果為 0，伺服器會決定適當的 page_size。
`page_token`	`string` 用來擷取下一頁的接續符記。如果為空白，表示正在擷取第一頁。
`content_time_ranges`	`DateTimeRangeArray` 相符影片內容必須落在的時間範圍。如果未提供範圍，則沒有時間限制。這個欄位的處理方式與下列條件相同，但由於這個欄位經常使用，因此我們將其獨立定義。請注意，如果 end_time 是未來的時間，系統會將該值限制在收到要求的時間。
`criteria[]`	`Criteria` 套用至搜尋結果的條件。
`exclusion_criteria[]`	`Criteria` 從搜尋結果中排除的條件。請注意，系統會忽略 `fetch_matched_annotations`。
`facet_selections[]`	`FacetGroup` 儲存最近的切面選取狀態。這裡只會顯示使用者選取的切面群組。選取狀態為已選取或未選取。系統只會使用所選面向值區塊做為搜尋條件。
`result_annotation_keys[]`	`string` 註解鍵清單，用於指定要擷取的註解，並與每個搜尋結果一併傳回。註解精細度必須為 GRANULARITY_ASSET_LEVEL，且其搜尋策略不得為 NO_SEARCH。
`search_query`	`string` 全域搜尋查詢。允許使用者搜尋資產，不必指定值屬於哪個欄位。
聯集欄位 `sort_spec`。排序規格。如未指定這個欄位，系統會依預設：- STREAM_VIDEO：搜尋結果會依開始時間排序。`sort_spec` 只能是下列其中一項：
`schema_key_sorting_strategy`	`SchemaKeySortingStrategy` 依據資料結構定義鍵下的值排序。

SearchAssetsResponse

SearchAssets 的回應訊息。

欄位

search_result_items[]

SearchResultItem

傳回的搜尋結果。

next_page_token

string

下一頁的接續符記。

facet_results[]

FacetGroup

特定查詢的面向搜尋結果，其中包含使用者已選取的面向值和更新的面向搜尋結果。

SearchCapability

搜尋功能的功能和中繼資料。

欄位

type

Type

要啟用的搜尋功能。

類型

可對素材資源執行不同搜尋功能。

列舉
`TYPE_UNSPECIFIED`	不應使用未指定的搜尋功能。
`EMBEDDING_SEARCH`	嵌入搜尋。

SearchCapabilitySetting

要啟用的搜尋功能設定。

欄位

search_capabilities[]

SearchCapability

要啟用的搜尋功能的中繼資料。

SearchConfig

SearchConfig 會儲存會影響搜尋行為和搜尋結果的不同屬性。

欄位

name

string

搜尋設定的資源名稱。對於 CustomSearchCriteria，search_config 會是搜尋運算子名稱。對於商情項目，search_config 會是商情項目維度的名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

facet_property

FacetProperty

建立 FacetDimension 和相關規格。

search_criteria_property

SearchCriteriaProperty

建立自訂 SearchCriteria 和一或多個 UGA 鍵之間的對應關係。

SearchCriteriaProperty

自訂搜尋條件的集中設定。

欄位

mapped_fields[]

string

每個 mapped_field 都會對應至 UGA 鍵。如要瞭解這項屬性的運作方式，請參考以下範例。In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

現在，當使用者發出以下查詢時：條件 { 欄位: "person" 文字陣列 { txt_values: "Tom Brady" txt_values: "Bill Belichick" } }

MWH 搜尋會傳回搜尋文件，其中包含 (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick)。

SearchHypernym

搜尋資源：SearchHypernym。例如：{ hypernym: "vehicle" hyponyms: ["sedan", "truck"] } 這表示在 SMART_SEARCH 模式下，搜尋「vehicle」也會傳回「sedan」或「truck」做為註解的結果。

欄位

name

string

SearchHypernym 的資源名稱。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

hypernym

string

超字義詞。

hyponyms[]

string

上位詞對應的下位詞。

SearchIndexEndpointRequest

SearchIndexEndpoint 的要求訊息。

欄位
`index_endpoint`	`string` 這是必要旗標，要搜尋的索引端點。Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}'
`criteria[]`	`Criteria` 套用至搜尋結果的條件。
`exclusion_criteria[]`	`Criteria` 從搜尋結果中排除的條件。請注意，系統會忽略 `fetch_matched_annotations`。
`page_size`	`int32` 請求的頁面大小。API 傳回的結果可能少於要求的結果。如果為負值，系統會傳回 INVALID_ARGUMENT 錯誤。如果未指定或為 0，API 會挑選預設大小，也就是 10。如果要求的頁面大小超過上限，API 會選擇上限大小 (100)。
`page_token`	`string` 用於擷取下一頁的接續符記。如果為空白，表示正在擷取第一頁。
聯集欄位 `query`。全球搜尋查詢的其中一個。`query` 只能是下列其中一項：
`image_query`	`ImageQuery` 僅限圖片的查詢。
`text_query`	`string` 純文字查詢。

SearchIndexEndpointResponse

SearchIndexEndpoint 的回應訊息。

欄位

search_result_items[]

SearchResultItem

傳回的搜尋結果。

next_page_token

string

下一頁的接續符記。如果省略這個欄位，就不會有後續頁面。

SearchResultItem

搜尋結果包含資產名稱和對應的時間範圍。

欄位
`asset`	`string` 素材資源的資源名稱。格式：`projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}`
`segments[] (deprecated)`	`TemporalPartition` 這個項目已遭淘汰！相符的素材資源區隔。已淘汰：請使用單一 `segment` 欄位。
`segment`	`TemporalPartition` 相符的素材資源區隔。
`relevance`	`double` 此 `SearchResultItem` 與使用者搜尋要求的關聯性。目前僅適用於圖片倉庫，預設代表餘弦相似度。日後，我們可能會在搜尋要求中要求其他指標，例如「內積」或「主題性」。
`requested_annotations[]`	`Annotation` 搜尋請求中使用 result_annotation_keys 指定的搜尋結果註解。
`annotation_matching_results[]`	`AnnotationMatchingResult` 與這個搜尋結果項目相關的條件或面向選取註解相符結果。只包含 fetch_matched_annotations=true 的條件或 facet_selections 結果。

StreamAnnotation

有關 Vision AI 串流資源註解的訊息。

欄位
`id`	`string` 註解的 ID。在特定情境中使用時，此值不得重複。例如，Vision AI 應用程式中一個輸入串流的所有註解。
`display_name`	`string` 註解的易記名稱。
`source_stream`	`string` Vision AI 串流資源名稱。
`type`	`StreamAnnotationType` 實際的註解類型。
聯集欄位 `annotation_payload`。 `annotation_payload` 只能是下列其中一項：
`active_zone`	`NormalizedPolygon` ACTIVE_ZONE 類型的註解
`crossing_line`	`NormalizedPolyline` CROSSING_LINE 類型的註解

StreamAnnotationType

列舉，說明串流註解的所有可能類型。

列舉
`STREAM_ANNOTATION_TYPE_UNSPECIFIED`	輸入「UNSPECIFIED」。
`STREAM_ANNOTATION_TYPE_ACTIVE_ZONE`	active_zone 註解會在圖片/影片串流的內容上定義多邊形，後續處理作業只會著重於有效區域內的內容。
`STREAM_ANNOTATION_TYPE_CROSSING_LINE`	crossing_line 註解會在圖像/影片的 Vision AI 串流內容上定義多邊形線，並擷取在線條上發生的事件。例如，在車輛乘載人數分析處理器中，經過路線的人數。

StreamAnnotations

重複 StreamAnnotation 的包裝函式。

欄位

stream_annotations[]

多個註解。

StreamWithAnnotation

訊息說明 Vision AI 串流，並附上應用程式專屬註解。此訊息中的所有 StreamAnnotation 物件都必須具有專屬 ID。

欄位

stream

string

Vision AI 串流資源名稱。

application_annotations[]

將套用至整個應用程式的註解。

node_annotations[]

NodeAnnotation

NodeAnnotation

說明應用程式節點專屬註解的訊息。

欄位

node

string

應用程式圖的節點名稱。

annotations[]

節點專屬串流註解。

StringArray

字串型值清單。

欄位

txt_values[]

string

字串類型值。

UndeployApplicationRequest

應用程式解除部署訊息。

欄位

name

string

必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

UndeployApplicationResponse

UndeployApplication Response 的訊息。

UndeployIndexMetadata

UndeployIndex 的中繼資料訊息。

欄位

operation_metadata

長時間執行作業的常見中繼資料。

deployed_index

string

僅供輸出。正在取消部署的索引。

UndeployIndexRequest

要求訊息：UndeployIndexEndpoint。

欄位

index_endpoint

string

這是必要旗標，系統會在該資源上執行解除部署作業的 IndexEndpoint 資源名稱。格式：projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

UndeployIndexResponse

這個類型沒有任何欄位。

作業完成後的 UndeployIndex 回應。

UndeployRetailProductRecognitionIndexResponse

UndeployRetailProductRecognitionIndex 回應的訊息。

UpdateAnalysisRequest

更新分析資料的訊息。

欄位

update_mask

這是必要旗標，欄位遮罩用於指定更新作業在分析資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源，而非完整要求。如果欄位位於遮罩中，就會遭到覆寫。如果使用者未提供遮罩，則會覆寫所有欄位。

analysis

Analysis

這是必要旗標，正在更新的資源。

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

UpdateAnnotationRequest

UpdateAnnotation API 的要求訊息。

欄位

annotation

這是必要旗標，要更新的註解。註解的 name 欄位可用於識別要更新的註解。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

update_mask

要更新的欄位清單。

UpdateApplicationInstancesRequest

更新 ApplicationInstance 的訊息。

欄位
`name`	`string` 必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」
`application_instances[]`	`UpdateApplicationInstance`
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。
`allow_missing`	`bool` 如果為 true，如果目標資源不存在，更新要求就會建立一個資源，這時系統會忽略 field_mask。

UpdateApplicationInstance

欄位

update_mask

(非必要) 欄位遮罩用於指定更新作業在草稿資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源，而非完整要求。如果欄位位於遮罩中，就會遭到覆寫。如果使用者未提供遮罩，則會覆寫所有欄位。

instance

Instance

這是必要旗標，正在更新的資源。

instance_id

string

這是必要旗標，執行個體的 ID。

UpdateApplicationInstancesResponse

UpdateApplicationInstancesResponse 的訊息。

UpdateApplicationRequest

更新應用程式的訊息。

欄位

update_mask

(非必要) 欄位遮罩用於指定更新作業在應用程式資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源，而非完整要求。如果欄位位於遮罩中，就會遭到覆寫。如果使用者未提供遮罩，則會覆寫所有欄位。

application

Application

這是必要旗標，正在更新的資源。

request_id

string

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。

UpdateApplicationStreamInputRequest

用於更新應用程式串流輸入內容的訊息。

欄位
`name`	`string` 必填項目。要擷取的應用程式名稱。格式：「projects/{project}/locations/{location}/applications/{application}」
`application_stream_inputs[]`	`ApplicationStreamInput` 要更新的串流輸入內容，串流資源名稱是每個 StreamInput 的索引鍵，且在每個應用程式中不得重複。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。
`allow_missing`	`bool` 如果設為 true，即使應用程式不含目標串流，UpdateApplicationStreamInput 也會將串流輸入插入應用程式。

要更新的欄位清單。

UpdateDataSchemaRequest

UpdateDataSchema 的要求訊息。

欄位

data_schema

DataSchema

這是必要旗標，資料結構定義的 name 欄位用於識別要更新的資料結構定義。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}

update_mask

要更新的欄位清單。

UpdateDraftRequest

更新草稿的訊息。

欄位
`update_mask`	`FieldMask` (非必要) 欄位遮罩用於指定更新作業在草稿資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源，而非完整要求。如果欄位位於遮罩中，就會遭到覆寫。如果使用者未提供遮罩，則會覆寫所有欄位。
`draft`	`Draft` 這是必要旗標，正在更新的資源。
`request_id`	`string` (非必要) 用於識別要求的選用要求 ID。請指定專屬的請求 ID，這樣一來，如果您必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證在首次要求後的至少 60 分鐘內。舉例來說，假設您提出初始要求，但要求逾時，如果您再次使用相同的要求 ID 提出要求，伺服器會檢查是否已收到使用相同要求 ID 的原始作業，如果是的話，就會忽略第二項要求。這可避免客戶不小心建立重複的承諾。要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-0000000000000)。
`allow_missing`	`bool` 如果設為 true，UpdateDraftRequest 會在目標資源不存在時建立一個資源，這時系統會忽略 field_mask。

UpdateIndexEndpointMetadata

UpdateIndexEndpoint 的中繼資料訊息。

欄位

operation_metadata

長時間執行作業的常見中繼資料。

UpdateIndexEndpointRequest

UpdateIndexEndpoint 的要求訊息。

欄位

index_endpoint

IndexEndpoint

這是必要旗標，正在更新的資源。

update_mask

這是必要旗標，欄位遮罩用於指定更新作業在 IndexEndpoint 資源中要覆寫的欄位。update_mask 中指定的欄位是相對於資源，而非完整要求。如果資源的欄位位於遮罩中，就會遭到覆寫。欄位遮罩不得留空。如果遮罩為「*」，則表示這是對資源的完整取代作業。

UpdateIndexMetadata

UpdateIndexRequest 的中繼資料訊息

欄位

operation_metadata

UpdateSearchConfig 的要求訊息。

欄位

search_config

SearchConfig

這是必要旗標，要更新的搜尋設定。

搜尋設定的 name 欄位用於識別要更新的資源。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

update_mask

要更新的欄位清單。如果未設定，系統會更新/覆寫所有欄位路徑。

UpdateSearchHypernymRequest

更新 SearchHypernym 的要求訊息。

欄位

search_hypernym

SearchHypernym

這是必要旗標，要更新的 SearchHypernym。搜尋同義詞的 name 欄位用於識別要更新的搜尋同義詞。格式：projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

update_mask

要更新的欄位清單。如果未設定，系統會更新/覆寫所有欄位路徑。

UploadAssetMetadata

UploadAsset 的中繼資料。

欄位

start_time

作業的開始時間。

update_time

作業的更新時間。

UploadAssetRequest

UploadAsset 的要求訊息。

欄位

name

string

這是必要旗標，要上傳的素材資源資源名稱。格式：projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

asset_source

AssetSource

素材資源來源。

UploadAssetResponse

這個類型沒有任何欄位。

UploadAsset 的回應訊息。

UserSpecifiedAnnotation

使用者提供的註解。

欄位

key

string

這是必要旗標，註解的鍵。請務必使用 CreateDataSchema 為鍵設定類型。

value

AnnotationValue

註解的值。值必須能夠根據資料結構定義轉換為該類型。

partition

Partition

針對子資產層級註解，在時間和空間上劃分資訊。

VertexAutoMLVideoConfig

說明 VertexAutoMLVideoConfig 的訊息。

欄位
`confidence_threshold`	`float` 系統只會傳回分數高於閾值的實體。值為 0.0 表示會傳回所有偵測到的實體。
`blocked_labels[]`	`string` 系統不會傳回這個欄位中指定的標籤。
`max_predictions`	`int32` 每個輸出影格最多會傳回這麼多預測結果。值為 0 表示傳回所有偵測到的實體。
`bounding_box_size_limit`	`float` 系統只會傳回大小超過此限制的定界框。僅限物件追蹤。值 0.0 表示傳回所有偵測到的實體。

VertexAutoMLVisionConfig

Vertex AutoML Vision 處理器的設定訊息。

欄位

confidence_threshold

float

系統只會傳回分數高於閾值的實體。值 0.0 表示傳回所有偵測到的實體。

max_predictions

int32

每個輸出影格最多會傳回這麼多預測結果。值為 0 表示傳回所有偵測到的實體。

VertexCustomConfig

說明 VertexCustomConfig 的訊息。

欄位
`max_prediction_fps`	`int32` 每秒的最大預測影格數。這個屬性可設定運算子傳送預測要求至 Vertex AI 端點的速度。預設值為 0，表示未設有預測每秒影格數上限。運算子會以輸入 FPS 傳送預測要求。
`dedicated_resources`	`DedicatedResources` 說明專屬於 DeployedModel 的資源，以及需要更高程度手動設定的資源。
`post_processing_cloud_function`	`string` 如果不為空白，系統會將預測結果傳送至指定的雲端函式，以便後續處理。* Cloud 函式會收到 AppPlatformCloudFunctionRequest，其中註解欄位會是 proto PredictResponse 的 JSON 格式。* Cloud 函式應傳回 AppPlatformCloudFunctionResponse，並將 PredictResponse 儲存在註解欄位中。* 如要捨棄預測輸出內容，請在傳回的 AppPlatformCloudFunctionResponse 中清除酬載欄位。
`attach_application_metadata`	`bool` 如果為 true，自訂模型收到的預測要求也會包含以下結構描述的中繼資料：'appPlatformMetadata': { 'ingestionTime': DOUBLE; (UNIX 時間戳記) 'application': STRING; 'instanceId': STRING; 'node': STRING; 'processor': STRING; }

VideoActionRecognitionPredictionResult

影片動作辨識的預測輸出格式。

欄位

segment_start_time

影片片段的開始時間 (包含在內)，系統會在該片段中識別動作。

segment_end_time

影片片段的結束時間 (含結束時間)，系統會在該片段中識別動作。特別是，如果結束時間與開始時間相同，表示辨識是在特定影片影格中發生。

actions[]

IdentifiedAction

在指定時間範圍內識別的所有動作。

IdentifiedAction

每個 IdentifiedAction 都是使用 AnnotationSpec id、display_name 和相關信心分數指定的特定動作識別資訊。

欄位

id

string

已識別的 AnnotationSpec 資源 ID。

display_name

string

已識別的 AnnotationSpec 顯示名稱。

confidence

float

模型修正這項識別的信心程度，值越高，信心程度越高。

VideoClassificationPredictionResult

影片分類的預測輸出格式。

欄位

segment_start_time

影片片段的開始時間 (含)，系統已在該片段中識別出分類。

segment_end_time

IdentifiedClassification

影片時間片段的結束時間 (含結束時間)，系統會在該片段中識別分類。特別是，如果結束時間與開始時間相同，表示辨識是在特定影片影格中發生。

classifications[]

在指定時間範圍內識別的所有分類。

IdentifiedClassification

每個 IdentifiedClassification 都是一種特定的識別，使用 AnnotationSpec id 和 display_name 指定分類，並提供相關的信心分數。

欄位

id

string

已識別的 AnnotationSpec 資源 ID。

display_name

string

已識別的 AnnotationSpec 顯示名稱。

confidence

float

模型修正這項識別的信心程度，值越高，信心程度越高。

VideoObjectTrackingPredictionResult

影片物件追蹤的預測輸出格式。

欄位

segment_start_time

目前識別資訊出現的影片片段起始時間 (含)。

segment_end_time