Package google.cloud.visionai.v1alpha1

インデックス

AppPlatform

リソースのハンドラを記述するサービス

AddApplicationStreamInput

rpc AddApplicationStreamInput(AddApplicationStreamInputRequest) returns (Operation)

ターゲット ストリーム入力をアプリケーションに追加します。アプリケーションがデプロイされている場合、対応する新しいアプリケーション インスタンスが作成されます。ストリームがすでにアプリケーションにある場合、RPC は失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateApplication

rpc CreateApplication(CreateApplicationRequest) returns (Operation)

指定されたプロジェクトとロケーションに新しいアプリケーションを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateApplicationInstances

rpc CreateApplicationInstances(CreateApplicationInstancesRequest) returns (Operation)

ターゲット ストリーム入力をアプリケーションに追加します。アプリケーションがデプロイされている場合、対応する新しいアプリケーション インスタンスが作成されます。ストリームがすでにアプリケーションにある場合、RPC は失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

下書きを作成する

rpc CreateDraft(CreateDraftRequest) returns (Operation)

指定されたプロジェクトとロケーションに新しいドラフトを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateProcessor

rpc CreateProcessor(CreateProcessorRequest) returns (Operation)

指定されたプロジェクトとロケーションに新しいプロセッサを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteApplication

rpc DeleteApplication(DeleteApplicationRequest) returns (Operation)

1 つのアプリケーションを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteApplicationInstances

rpc DeleteApplicationInstances(DeleteApplicationInstancesRequest) returns (Operation)

アプリケーションへのターゲット ストリーム入力を削除します。アプリケーションがデプロイされている場合は、対応するインスタンスベースが削除されます。ストリームがアプリケーションにない場合、RPC は失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteDraft

rpc DeleteDraft(DeleteDraftRequest) returns (Operation)

1 つの下書きを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteProcessor

rpc DeleteProcessor(DeleteProcessorRequest) returns (Operation)

1 つのプロセッサを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeployApplication

rpc DeployApplication(DeployApplicationRequest) returns (Operation)

単一のアプリケーションをデプロイします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetApplication

rpc GetApplication(GetApplicationRequest) returns (Application)

1 つのアプリケーションの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetDraft

rpc GetDraft(GetDraftRequest) returns (Draft)

1 つのドラフトの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

1 つのインスタンスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetProcessor

rpc GetProcessor(GetProcessorRequest) returns (Processor)

1 つのプロセッサの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListApplications

rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse)

指定されたプロジェクトとロケーションのアプリケーションを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListDrafts

rpc ListDrafts(ListDraftsRequest) returns (ListDraftsResponse)

指定されたプロジェクトとロケーションのドラフトを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

指定されたプロジェクトとロケーションでのインスタンスを一覧で表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListPrebuiltProcessors

rpc ListPrebuiltProcessors(ListPrebuiltProcessorsRequest) returns (ListPrebuiltProcessorsResponse)

ListPrebuiltProcessors は、ビルド済みプロセッサを一覧表示するカスタム パススルー動詞です。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListProcessors

rpc ListProcessors(ListProcessorsRequest) returns (ListProcessorsResponse)

指定されたプロジェクトとロケーションのプロセッサを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

RemoveApplicationStreamInput

rpc RemoveApplicationStreamInput(RemoveApplicationStreamInputRequest) returns (Operation)

アプリケーションへのターゲット ストリーム入力を削除します。アプリケーションがデプロイされている場合は、対応するインスタンスベースが削除されます。ストリームがアプリケーションにない場合、RPC は失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UndeployApplication

rpc UndeployApplication(UndeployApplicationRequest) returns (Operation)

単一のアプリケーションのデプロイを解除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateApplication

rpc UpdateApplication(UpdateApplicationRequest) returns (Operation)

単一の Application のパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateApplicationInstances

rpc UpdateApplicationInstances(UpdateApplicationInstancesRequest) returns (Operation)

ターゲット ストリーム入力をアプリケーションに追加します。アプリケーションがデプロイされている場合、対応する新しいアプリケーション インスタンスが作成されます。ストリームがすでにアプリケーションにある場合、RPC は失敗します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateApplicationStreamInput

rpc UpdateApplicationStreamInput(UpdateApplicationStreamInputRequest) returns (Operation)

ターゲット ストリーム入力をアプリケーションに更新します。アプリケーションがデプロイされている場合は、対応するインスタンスベースがデプロイされます。CreateOrUpdate 動作の場合は、allow_missing を true に設定します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateDraft

rpc UpdateDraft(UpdateDraftRequest) returns (Operation)

1 つのドラフトのパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateProcessor

rpc UpdateProcessor(UpdateProcessorRequest) returns (Operation)

単一のプロセッサのパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

EventDiscoveryService

新しいバージョンの Event Discovery Service は次のとおりです。すべての使用を新しい EventDiscoveryService に移行したら、EventWatcher を非推奨にします。これは、クライアントがストリームで発生したイベントの更新を検出するためのイベント検出 API です。

WatchEvents

rpc WatchEvents(WatchEventsRequest) returns (WatchEventsResponse)

指定したライブ配信で発生したイベントの最新情報を確認する。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

cluster リソースに対する次の IAM 権限が必要です。

  • visionai.clusters.watch

詳細については、IAM のドキュメントをご覧ください。

LiveVideoAnalytics

リソースのハンドラを記述するサービス。このサービスを使用すると、クライアントはストリーミング入力でライブ動画分析(LVA)を実行できます。

CreateAnalysis

rpc CreateAnalysis(CreateAnalysisRequest) returns (Operation)

指定されたプロジェクトとロケーションに新しい分析を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateProcess

rpc CreateProcess(CreateProcessRequest) returns (Operation)

指定されたプロジェクトとロケーションに新しいプロセスを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteAnalysis

rpc DeleteAnalysis(DeleteAnalysisRequest) returns (Operation)

1 つの分析を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteProcess

rpc DeleteProcess(DeleteProcessRequest) returns (Operation)

1 つのプロセスを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetAnalysis

rpc GetAnalysis(GetAnalysisRequest) returns (Analysis)

1 つの分析の詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetProcess

rpc GetProcess(GetProcessRequest) returns (Process)

1 つのプロセスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListAnalyses

rpc ListAnalyses(ListAnalysesRequest) returns (ListAnalysesResponse)

指定されたプロジェクトとロケーションの分析を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListProcesses

rpc ListProcesses(ListProcessesRequest) returns (ListProcessesResponse)

指定されたプロジェクトとロケーションの Process を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateAnalysis

rpc UpdateAnalysis(UpdateAnalysisRequest) returns (Operation)

単一の分析のパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateProcess

rpc UpdateProcess(UpdateProcessRequest) returns (Operation)

単一のプロセスのパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

RetailService

このサービスを使用すると、クライアントは Store Vision の小売リソースを管理できます。

SmartDeviceService

リソースのハンドラを記述するサービス

StreamingService

パケットの受信と送信を行うストリーミング サービス。

StreamsService

リソースのハンドラを記述するサービス。Vision API と Vision AI API は、同じチームによって開発された 2 つの独立した API です。Vision API はユーザーが画像にアノテーションを付けるためのものであり、Vision AI はユーザーが独自のコンピュータ ビジョン アプリケーションを構築するためのエンドツーエンド ソリューションです。

ウェアハウス

ストリーミング用のメディア コンテンツとメタデータを管理するサービス。

AddCollectionItem

rpc AddCollectionItem(AddCollectionItemRequest) returns (AddCollectionItemResponse)

コレクションにアイテムを追加します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

AnalyzeAsset

rpc AnalyzeAsset(AnalyzeAssetRequest) returns (Operation)

アセットを分析して検索機能を強化します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.analyze

詳細については、IAM のドキュメントをご覧ください。

AnalyzeCorpus

rpc AnalyzeCorpus(AnalyzeCorpusRequest) returns (Operation)

コーパスを分析します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.analyze

詳細については、IAM のドキュメントをご覧ください。

ClipAsset

rpc ClipAsset(ClipAssetRequest) returns (ClipAssetResponse)

ダウンロード用のクリップを生成します。この API は期間を受け取り、start_time の後に利用可能で end_time の前に利用可能な最初のコンテンツのクリップを生成します。このクリップは、これらの境界を超えてオーバーフローする可能性があります。クリップの合計サイズが 100 MB を超える場合、返されるクリップは切り捨てられます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.clip

詳細については、IAM のドキュメントをご覧ください。

CreateAnnotation

rpc CreateAnnotation(CreateAnnotationRequest) returns (Annotation)

アセット内にアノテーションを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.annotations.create

詳細については、IAM のドキュメントをご覧ください。

CreateAsset

rpc CreateAsset(CreateAssetRequest) returns (Asset)

コーパス内にアセットを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.assets.create

詳細については、IAM のドキュメントをご覧ください。

CreateCollection

rpc CreateCollection(CreateCollectionRequest) returns (Operation)

コレクションを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CreateCorpus

rpc CreateCorpus(CreateCorpusRequest) returns (Operation)

プロジェクト内にコーパスを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.create

詳細については、IAM のドキュメントをご覧ください。

CreateDataSchema

rpc CreateDataSchema(CreateDataSchemaRequest) returns (DataSchema)

コーパス内にデータスキーマを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.dataSchemas.create

詳細については、IAM のドキュメントをご覧ください。

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

コーパスの下にインデックスを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.create

詳細については、IAM のドキュメントをご覧ください。

CreateIndexEndpoint

rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (Operation)

IndexEndpoint を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.create

詳細については、IAM のドキュメントをご覧ください。

CreateSearchConfig

rpc CreateSearchConfig(CreateSearchConfigRequest) returns (SearchConfig)

コーパス内に検索構成を作成します。

有効な CreateSearchConfigRequest を作成するには、以下のルールに沿って操作してください。--- 一般規則 --- 1. Request.search_config_id は、既存の SearchConfig に関連付けられません。2. リクエストには、空でない search_criteria_property または facet_property が 1 つ以上含まれている必要があります。3. mapped_fields は空でないこと、および既存の UGA キーにマッピングされていること。4. mapped_fields はすべて同じ型である必要があります。5. すべての mapped_fields は同じ粒度を共有する必要があります。6. すべての mapped_fields は、同じセマンティック SearchConfig の一致オプションを共有する必要があります。プロパティ固有のルールについては、FacetProperty と SearchCriteriaProperty のコメントをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.searchConfigs.create

詳細については、IAM のドキュメントをご覧ください。

CreateSearchHypernym

rpc CreateSearchHypernym(CreateSearchHypernymRequest) returns (SearchHypernym)

コーパス内に SearchHypernym を作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteAnnotation

rpc DeleteAnnotation(DeleteAnnotationRequest) returns (Empty)

アセット内のアノテーションを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.annotations.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteAsset

rpc DeleteAsset(DeleteAssetRequest) returns (Operation)

コーパス内のアセットを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteCollection

rpc DeleteCollection(DeleteCollectionRequest) returns (Operation)

コレクションを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeleteCorpus

rpc DeleteCorpus(DeleteCorpusRequest) returns (Empty)

コーパスが空の場合にのみ削除します。空のレスポンスを返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteDataSchema

rpc DeleteDataSchema(DeleteDataSchemaRequest) returns (Empty)

コーパス内のデータスキーマを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.dataSchemas.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Operation)

1 つのインデックスを削除します。インデックスを削除するには、呼び出し元がインデックスがどのインデックス エンドポイントにもデプロイされていないことを確認する必要があります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteIndexEndpoint

rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (Operation)

IndexEndpoint を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteSearchConfig

rpc DeleteSearchConfig(DeleteSearchConfigRequest) returns (Empty)

コーパス内の検索構成を削除します。

DeleteSearchConfigRequest が有効になるには、Request.search_configuration.name がすでに存在している必要があります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.searchConfigs.delete

詳細については、IAM のドキュメントをご覧ください。

DeleteSearchHypernym

rpc DeleteSearchHypernym(DeleteSearchHypernymRequest) returns (Empty)

コーパス内の SearchHypernym を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

DeployIndex

rpc DeployIndex(DeployIndexRequest) returns (Operation)

インデックスを IndexEndpoint にデプロイします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

indexEndpoint リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.deploy

詳細については、IAM のドキュメントをご覧ください。

GenerateHlsUri

rpc GenerateHlsUri(GenerateHlsUriRequest) returns (GenerateHlsUriResponse)

HLS マニフェストの URI を生成します。API は期間のコレクションを受け取り、リクエストされたすべての期間をカバーする HLS マニフェストの URI を生成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.generateHlsUri

詳細については、IAM のドキュメントをご覧ください。

GenerateRetrievalUrl

rpc GenerateRetrievalUrl(GenerateRetrievalUrlRequest) returns (GenerateRetrievalUrlResponse)

アセットをダウンロードするための署名付き URL を生成します。動画倉庫については、別のプロジェクトの Cloud Storage ファイルの取得を許可する方法について、UploadAsset のコメントをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetAnnotation

rpc GetAnnotation(GetAnnotationRequest) returns (Annotation)

アセット内のアノテーションを読み取ります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.annotations.get

詳細については、IAM のドキュメントをご覧ください。

GetAsset

rpc GetAsset(GetAssetRequest) returns (Asset)

コーパス内のアセットを読み取ります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.get

詳細については、IAM のドキュメントをご覧ください。

GetCollection

rpc GetCollection(GetCollectionRequest) returns (Collection)

コレクションを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

GetCorpus

rpc GetCorpus(GetCorpusRequest) returns (Corpus)

プロジェクト内のコーパスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.get

詳細については、IAM のドキュメントをご覧ください。

GetDataSchema

rpc GetDataSchema(GetDataSchemaRequest) returns (DataSchema)

コーパス内のデータスキーマを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.dataSchemas.get

詳細については、IAM のドキュメントをご覧ください。

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

コーパス内の単一のインデックスの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.get

詳細については、IAM のドキュメントをご覧ください。

GetIndexEndpoint

rpc GetIndexEndpoint(GetIndexEndpointRequest) returns (IndexEndpoint)

IndexEndpoint を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.get

詳細については、IAM のドキュメントをご覧ください。

GetSearchConfig

rpc GetSearchConfig(GetSearchConfigRequest) returns (SearchConfig)

コーパス内の検索構成を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.searchConfigs.get

詳細については、IAM のドキュメントをご覧ください。

GetSearchHypernym

rpc GetSearchHypernym(GetSearchHypernymRequest) returns (SearchHypernym)

コーパス内の SearchHypernym を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ImportAssets

rpc ImportAssets(ImportAssetsRequest) returns (Operation)

Cloud Storage のメタファイルからアセット(画像とアノテーション)をインポートします。メタファイルの各行は、画像(Cloud Storage URI で指定)とそのアノテーションに対応しています。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.import

詳細については、IAM のドキュメントをご覧ください。

IndexAsset

rpc IndexAsset(IndexAssetRequest) returns (Operation)

検索用に 1 つのアセットをインデックスに登録します。サポートされているコーパスタイプ: Corpus.Type.VIDEO_ON_DEMAND

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

index リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.update

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.index

詳細については、IAM のドキュメントをご覧ください。

IngestAsset

rpc IngestAsset(IngestAssetRequest) returns (IngestAssetResponse)

アセットのデータをインジェストします。TTL に従って期限切れになっているデータチャンクの取り込みは許可されません。このメソッドは、gRPC API を介してのみ使用できます(HTTP では双方向ストリーミングがサポートされていないため)。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

asset リソースに対する次の IAM 権限が必要です。

  • visionai.assets.ingest

詳細については、IAM のドキュメントをご覧ください。

ListAnnotations

rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse)

アセット内のアノテーションのリストを表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.annotations.list

詳細については、IAM のドキュメントをご覧ください。

ListAssets

rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse)

コーパス内のアセットのリストを表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.assets.list

詳細については、IAM のドキュメントをご覧ください。

ListCollections

rpc ListCollections(ListCollectionsRequest) returns (ListCollectionsResponse)

コーパス内のコレクションを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ListCorpora

rpc ListCorpora(ListCorporaRequest) returns (ListCorporaResponse)

プロジェクト内のすべてのコーパスを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.list

詳細については、IAM のドキュメントをご覧ください。

ListDataSchemas

rpc ListDataSchemas(ListDataSchemasRequest) returns (ListDataSchemasResponse)

コーパス内のデータスキーマのリストを表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.dataSchemas.list

詳細については、IAM のドキュメントをご覧ください。

ListIndexEndpoints

rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse)

プロジェクト内のすべての IndexEndpoints を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.list

詳細については、IAM のドキュメントをご覧ください。

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

指定されたコーパス内のすべてのインデックスを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.list

詳細については、IAM のドキュメントをご覧ください。

ListSearchConfigs

rpc ListSearchConfigs(ListSearchConfigsRequest) returns (ListSearchConfigsResponse)

コーパス内のすべての検索構成を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • visionai.searchConfigs.list

詳細については、IAM のドキュメントをご覧ください。

ListSearchHypernyms

rpc ListSearchHypernyms(ListSearchHypernymsRequest) returns (ListSearchHypernymsResponse)

コーパス内の SearchHypernym を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

RemoveCollectionItem

rpc RemoveCollectionItem(RemoveCollectionItemRequest) returns (RemoveCollectionItemResponse)

コレクションからアイテムを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

RemoveIndexAsset

rpc RemoveIndexAsset(RemoveIndexAssetRequest) returns (Operation)

検索用のアセットのインデックス データを 1 つ削除します。サポートされているコーパスタイプ: Corpus.Type.VIDEO_ON_DEMAND

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

index リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.update

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.removeIndex

詳細については、IAM のドキュメントをご覧ください。

SearchAssets

rpc SearchAssets(SearchAssetsRequest) returns (SearchAssetsResponse)

メディア アセットを検索します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

corpus リソースに対する次の IAM 権限が必要です。

  • visionai.assets.search

詳細については、IAM のドキュメントをご覧ください。

SearchIndexEndpoint

rpc SearchIndexEndpoint(SearchIndexEndpointRequest) returns (SearchIndexEndpointResponse)

デプロイされたインデックス エンドポイントを検索します(IMAGE コーパス タイプのみ)。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

indexEndpoint リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.search

詳細については、IAM のドキュメントをご覧ください。

UndeployIndex

rpc UndeployIndex(UndeployIndexRequest) returns (Operation)

IndexEndpoint からインデックスのデプロイを解除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

indexEndpoint リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.undeploy

詳細については、IAM のドキュメントをご覧ください。

UpdateAnnotation

rpc UpdateAnnotation(UpdateAnnotationRequest) returns (Annotation)

アセット内のアノテーションを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.annotations.update

詳細については、IAM のドキュメントをご覧ください。

UpdateAsset

rpc UpdateAsset(UpdateAssetRequest) returns (Asset)

コーパス内のアセットを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.update

詳細については、IAM のドキュメントをご覧ください。

UpdateCollection

rpc UpdateCollection(UpdateCollectionRequest) returns (Collection)

コレクションを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UpdateCorpus

rpc UpdateCorpus(UpdateCorpusRequest) returns (Corpus)

プロジェクト内のコーパスを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.corpora.update

詳細については、IAM のドキュメントをご覧ください。

UpdateDataSchema

rpc UpdateDataSchema(UpdateDataSchemaRequest) returns (DataSchema)

コーパス内のデータスキーマを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.dataSchemas.update

詳細については、IAM のドキュメントをご覧ください。

UpdateIndex

rpc UpdateIndex(UpdateIndexRequest) returns (Operation)

コーパスのインデックスを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.update

詳細については、IAM のドキュメントをご覧ください。

UpdateIndexEndpoint

rpc UpdateIndexEndpoint(UpdateIndexEndpointRequest) returns (Operation)

IndexEndpoint を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.indexEndpoints.update

詳細については、IAM のドキュメントをご覧ください。

UpdateSearchConfig

rpc UpdateSearchConfig(UpdateSearchConfigRequest) returns (SearchConfig)

コーパス内の検索構成を更新します。

有効な UpdateSearchConfigRequest を作成するには、以下のルールに従ってください。--- 一般規則 --- 1. Request.search_configuration.name はすでに存在している必要があります。2. リクエストには、空でない search_criteria_property または facet_property が 1 つ以上含まれている必要があります。3. mapped_fields は空にせず、既存の UGA キーにマッピングする必要があります。4. mapped_fields はすべて同じ型である必要があります。5. すべての mapped_fields は同じ粒度を共有する必要があります。6. すべての mapped_fields は、同じセマンティック SearchConfig の一致オプションを共有する必要があります。プロパティ固有のルールについては、FacetProperty と SearchCriteriaProperty のコメントをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.searchConfigs.update

詳細については、IAM のドキュメントをご覧ください。

UpdateSearchHypernym

rpc UpdateSearchHypernym(UpdateSearchHypernymRequest) returns (SearchHypernym)

コーパス内の SearchHypernym を更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

UploadAsset

rpc UploadAsset(UploadAssetRequest) returns (Operation)

アセットの Cloud Storage URI を指定してアセットをアップロードします。動画ウェアハウスの場合、この API を呼び出すユーザーに Cloud Storage ファイルへの読み取りアクセス権が必要です。アップロードされたファイルは、GenerateRetrievalUrl API によって取得できます。この API はデフォルトで、ウェアハウスと同じプロジェクトの Cloud Storage ファイルのみを取得できます。別のプロジェクトにある Cloud Storage ファイルを取得できるようにするには、Vision AI サービス アカウントを見つけて(IAM に移動し、[Google 提供のロール付与を含みます] チェックボックスをオンにして [Cloud Vision AI サービス エージェント] を検索)、そのサービス アカウントに Cloud Storage ファイルの読み取りアクセス権を付与する必要があります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • visionai.assets.upload

詳細については、IAM のドキュメントをご覧ください。

ViewCollectionItems

rpc ViewCollectionItems(ViewCollectionItemsRequest) returns (ViewCollectionItemsResponse)

コレクション内のアイテムを表示する。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

ViewIndexedAssets

rpc ViewIndexedAssets(ViewIndexedAssetsRequest) returns (ViewIndexedAssetsResponse)

インデックス内のアセットのリストを表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

IAM 権限

index リソースに対する次の IAM 権限が必要です。

  • visionai.indexes.viewAssets

詳細については、IAM のドキュメントをご覧ください。

AIEnabledDevicesInputConfig

AI 対応デバイスの入力構成を説明するメッセージ。

AcceleratorType

ハードウェア アクセラレータのタイプを表します。

列挙型
ACCELERATOR_TYPE_UNSPECIFIED 未指定のアクセラレータ タイプ(アクセラレータなし)。
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU.
NVIDIA_TESLA_P100 Nvidia Tesla P100 GPU.
NVIDIA_TESLA_V100 Nvidia Tesla V100 GPU.
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU.
NVIDIA_TESLA_T4 Nvidia Tesla T4 GPU.
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU。
TPU_V2 TPU v2.
TPU_V3 TPU v3.

AddApplicationStreamInputRequest

アプリケーションにストリーム入力を追加するためのメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

application_stream_inputs[]

ApplicationStreamInput

追加するストリーム入力。ストリーム リソース名は各 StreamInput のキーであり、各アプリケーション内で一意である必要があります。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

AddApplicationStreamInputResponse

AddApplicationStreamInput レスポンスのメッセージ。

AddCollectionItemRequest

AddCollectionItem に対するリクエスト メッセージです。

フィールド
item

CollectionItem

必須。追加する項目。

AddCollectionItemResponse

AddCollectionItem に対するレスポンス メッセージです。

フィールド
item

CollectionItem

すでに追加されている項目。

AddRetailProductsToRetailProductSetResponse

オペレーションが完了すると、AddRetailProductsToRetailProductSet レスポンスが返されます。

分析

Analysis オブジェクトについて説明するメッセージ。

フィールド
name

string

リソースの名前。

create_time

Timestamp

出力専用。作成タイムスタンプ。

update_time

Timestamp

出力専用。更新タイムスタンプ。

labels

map<string, string>

Key-Value ペアとしてのラベル。

analysis_definition

AnalysisDefinition

分析の定義。

input_streams_mapping

map<string, string>

定義の入力パラメータから実際のストリームにマッピングします。たとえば、「input-0」という名前のストリームソース オペレーターがあり、実際のストリーミング「stream-0」から受信しようとするとします。次のようなマッピングを追加できます。[input-0: stream-0]

output_streams_mapping

map<string, string>

定義の出力パラメータから実際のストリームにマッピングします。たとえば、「output-0」という名前のストリーム シンク オペレーターがあり、実際のストリームに「stream-0」を送信しようとするとします。次のようなマッピングを追加できます。[output-0: stream-0]

disable_event_watch

bool

入力ストリームで新しいイベントが発生したときにプロセスを自動的に開始する機能を無効にするかどうかを示すブール値フラグ。プロセスを手動で開始する場合は、このフィールドを true に設定する必要があります。

AnalysisDefinition

完全な分析を定義します。

以下は、ライブ分析パイプラインの全体像です。これは、マルチグラフのエッジリスト表現と考えることができます。

これは、人間が protobuf テキスト形式で直接作成することも、プログラミング API(コンテキストに応じて Python または JavaScript など)によって生成することもできます。

フィールド
analyzers[]

AnalyzerDefinition

アナライザーの定義。

AnalyzeAssetMetadata

AnalyzeAsset のメタデータ。

フィールド
analysis_status[]

AnalysisStatus

すべての検索機能の分析のステータス。

start_time

Timestamp

操作の開始時刻。

update_time

Timestamp

オペレーションの更新時間。

AnalysisStatus

各検索機能の分析のステータス。

フィールド
state

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

OperationMetadata

オペレーションのメタデータ。

AnalyzeCorpusRequest

AnalyzeCorpus のリクエスト メッセージ。

フィールド
name

string

必須。アセットが分析される親コーパス リソース。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

AnalyzeCorpusResponse

この型にはフィールドがありません。

AnalyzeCorpus LRO のレスポンス メッセージ。

AnalyzerDefinition

アナライザを定義します。

アナライザは、そのアナライザが表す演算子で定義されたロジックを使用して、入力ストリームからデータを処理します。もちろん、Operator で宣言された出力ストリームのデータが生成されます。

フィールド
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>

環境変数。

StreamInput

このアナライザへの入力。

入力名の参照は、次の形式で指定できます。:

例:

2 つの出力引数(最初の引数は「foo」、2 番目の引数は「bar」)を持つ「SomeOp」という名前の演算子と、2 つの入力を受け入れる「MyOp」という名前の演算子があるとします。

また、「SomeOp」を実行している「some-analyzer」という名前のアナライザと、「MyOp」を実行している「my-analyzer」という名前のアナライザがあるとします。

「my-analyzer」が「some-analyzer」の「foo」出力を最初の入力として、「some-analyzer」の「bar」出力を 2 番目の入力として使用することを示すには、このフィールドを次のように設定します。input = ["some-analyzer:foo", "some-analyzer:bar"]

フィールド
input

string

ストリーム入力の名前(上記を参照)。

アノテーション

アノテーションは、アセット内のリソースです。アセット内のコンテンツの Key-Value マッピングを表します。

フィールド
name

string

アノテーションのリソース名。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

user_specified_annotation

UserSpecifiedAnnotation

ユーザー提供のアノテーション。

AnnotationCustomizedStruct

アノテーションでカスタマイズされた構造体表現。

フィールド
elements

map<string, AnnotationValue>

要素のキーから要素のアノテーション値へのマップ。

AnnotationList

アノテーション内のリスト表現。

フィールド
values[]

AnnotationValue

LIST データ型アノテーションの値。

AnnotationMatchingResult

検索結果アイテムごとに、条件アノテーションの一致結果を格納します。

フィールド
criteria

Criteria

照合に使用される基準。入力検索条件またはファセット選択から変換された条件にすることができます。

matched_annotations[]

Annotation

条件に一致するアノテーション。

status

Status

一致結果のステータス。有効な値: FAILED_PRECONDITION - 条件が一致の対象外です。OK - 照合が実行されます。

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

Cloud Functions ベースのカスタマー処理ロジックの場合、カスタマーの Cloud Functions 関数は、AppPlatformCloudFunctionRequest をリクエストとして受け取り、AppPlatformCloudFunctionResponse をレスポンスとして返す必要があります。AppPlatform から Cloud Functions へのリクエスト メッセージ。

フィールド
app_platform_metadata

AppPlatformMetadata

お客様がペイロードのソースを特定できるようにする AppPlatform のメタデータ。

annotations[]

StructedInputAnnotation

カスタマイズされた Cloud Functions の関数によって処理される実際のアノテーション。

StructedInputAnnotation

構造体形式を使用してさまざまな具体的なアノテーション プロトブーブを表現する一般的なアノテーション メッセージ。

フィールド
ingestion_time_micros

int64

現在のアノテーションの取り込み時間。

annotation

Struct

実際のアノテーションの構造形式。

AppPlatformCloudFunctionResponse

お客様の Cloud Functions から AppPlatform へのレスポンスのメッセージ。

フィールド
annotations[]

StructedOutputAnnotation

AppPlatform に返される変更済みアノテーション。アノテーション フィールドが空の場合、それらのアノテーションは AppPlatform によって破棄されます。

annotation_passthrough

bool

true に設定すると、アノテーション フィールドが空の場合でも、AppPlatform は元のアノテーションを破棄せずに使用します。

events[]

AppPlatformEventBody

AppPlatform に返されるイベント通知。通常、イベントを処理する演算子(Pub/Sub 演算子など)に使用または転送されるように構成されます。

StructedOutputAnnotation

構造体形式を使用してさまざまな具体的なアノテーション プロトブーブを表現する一般的なアノテーション メッセージ。

フィールド
annotation

Struct

実際のアノテーションの構造形式。

AppPlatformEventBody

appPlatform イベントのコンテンツのメッセージ

フィールド
event_message

string

イベントの人間可読文字列(「シーンに 6 人以上いる」、「棚が空っぽです」など)。

payload

Struct

Pub/Sub の場合は、メッセージ属性に保存されます。pubsub.proto

event_id

string

イベントの分類に使用されるユーザー定義イベント ID。配信間隔内で、同じアプリケーション インスタンスから同じ ID のイベントが送信された場合は重複が排除され、最初のイベントのみが送信されます。空の event_id は「""」として扱われます。

AppPlatformMetadata

App Platform の重要なメタデータのメッセージ。このメッセージは通常、データのソースを特定できるように、特定のプロセッサ出力アノテーションに関連付けられます。

フィールド
application

string

アプリケーション リソース名。

instance_id

string

インスタンス リソース ID。インスタンスは、コレクション「instances」の下のアプリケーションのネストされたリソースです。

node

string

アプリケーション グラフのノード名。

processor

string

アプリケーション ノードの参照プロセッサ リソース名。

アプリケーション

Application オブジェクトについて説明するメッセージ

フィールド
name

string

リソースの名前

create_time

Timestamp

出力専用。[出力専用] 作成タイムスタンプ

update_time

Timestamp

出力専用。[出力専用] 更新タイムスタンプ

labels

map<string, string>

Key-Value ペアとしてのラベル。

display_name

string

必須。ソリューションのわかりやすい表示名。

description

string

このアプリケーションの説明。

application_configs

ApplicationConfigs

アプリケーション グラフの構成。

runtime_info

ApplicationRuntimeInfo

出力専用。アプリケーション グラフのランタイム情報。アプリケーションの状態が DEPLOYED の場合にのみ存在します。

state

State

出力専用。申請の状態。

billing_mode

BillingMode

アプリの課金モード。

ApplicationRuntimeInfo

アプリケーションのランタイム情報を格納するメッセージ。

フィールド
deploy_time

Timestamp

エンジンがデプロイされたときのタイムスタンプ

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

出力リソースのキー。同じプロデューサー ノード内で一意である必要があります。1 つのプロデューサー ノードは複数の出力リソースを出力できます。キーを使用して、対応する出力リソースを照合できます。

MonitoringConfig

アプリケーションのモニタリング関連の構成。

フィールド
enabled

bool

このアプリケーションでモニタリングが有効になっているかどうか。

BillingMode

アプリケーションの課金モード

列挙型
BILLING_MODE_UNSPECIFIED デフォルト値。
PAYG 従量課金制の課金モード。
MONTHLY 月単位の課金モード。

申請の状態

列挙型
STATE_UNSPECIFIED デフォルト値。この値は、状態を省略した場合に使用されます。
CREATED 状態は CREATED です。
DEPLOYING ステータス: DEPLOYING。
DEPLOYED 状態 DEPLOYED。
UNDEPLOYING ステータスは UNDEPLOYING です。
DELETED ステータス DELETED。
ERROR 状態が ERROR です。
CREATING 状態は CREATING。
UPDATING ステータスの更新。
DELETING 状態: 削除中。
FIXING 状態の修正。

ApplicationConfigs

アプリケーションのグラフを格納するメッセージ。

フィールド
nodes[]

Node

アプリケーション グラフ内のノードのリスト。

ApplicationInstance

インスタンスの作成に関するメッセージ。

フィールド
instance_id

string

必須。リクエスト元のオブジェクトの ID。

instance

Instance

必須。作成中のリソース。

ApplicationNodeAnnotation

アプリケーション ノードに固有のアノテーションを説明するメッセージ。このメッセージは StreamWithAnnotation.NodeAnnotation の重複です。

フィールド
node

string

アプリケーション グラフのノード名。

annotations[]

StreamAnnotation

ノード固有のストリームのアノテーション。

ApplicationStreamInput

単一ストリーム入力構成に関するメッセージ。

フィールド
stream_with_annotation

StreamWithAnnotation

アセット

アセットはコーパス内のリソースです。コーパス内のメディア オブジェクトを表し、メタデータと別のリソース アノテーションが含まれています。アセットに別の特徴量を適用して、アノテーションを生成できます。ユーザーは、ターゲット アセットに関連するアノテーションを指定できます。

フィールド
name

string

アセットのリソース名。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ttl

Duration

すべてのメディア アセット、関連メタデータ、検索ドキュメントが存在できる期間。設定しない場合、親コーパス リソースのデフォルトの 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

つまり int、decimal、floatなどです

b

bool

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% を表す)です。

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: STRING または JSON。実際のアノテーション プロトブーブは、バイトフィールドが 64 エンコード文字列として JSON 文字列に変換されます。String 型または Json 型の列の両方に書き込むことができます。

アノテーション データを既存の BigQuery テーブルに転送するには、スキーマの互換性を確認する必要があります。このマップは、アプリケーション ノード名を対応する Cloud Functions エンドポイントにマッピングし、アノテーションを google.cloud.bigquery.storage.v1.AppendRowsRequest に直接変換します(avro_rows または proto_rows のみを設定する必要があります)。構成されている場合、対応するアプリケーションノードで生成されたアノテーションは、BigQuery に転送される前に、まず Cloud Functions の関数に送信されます。

デフォルトのテーブル スキーマが適合しない場合は、CloudFunction を使用して、Vision AI アプリケーションのアノテーション出力を任意の BigQuery テーブル スキーマに変換できます。* Cloud Functions の関数は AppPlatformCloudFunctionRequest を受信します。このリクエストの annotations フィールドは、Vision AI アノテーションの JSON 形式になります。* Cloud Functions 関数は、AppendRowsRequest が annotations フィールドに保存された AppPlatformCloudFunctionResponse を返す必要があります。* アノテーションを削除するには、返された AppPlatformCloudFunctionResponse の annotations フィールドをクリアします。

create_default_table_if_not_exists

bool

true の場合、指定されたテーブルが存在しない場合、App Platform は BigQuery データセットと BigQuery テーブルをデフォルトのスキーマで作成します。ただし、Cloud Functions の関数でカスタマイズされたスキーマが指定されている場合、システムは目的のスキーマを認識しないため、この方法は機能しません。JSON 列は、App Platform によって作成されたデフォルトのテーブルで使用されます。

BoolValue

フィールド
value

bool

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

TemporalPartition

必須。クリップをリクエストする期間。

ClipAssetResponse

ClipAsset API のレスポンス メッセージ。

フィールド
time_indexed_uris[]

TimeIndexedUri

リクエストされた期間をカバーする動画クリップをダウンロードするための署名付き URI のリスト(時刻順)。

TimeIndexedUri

対応する期間が指定された署名付き URI。

フィールド
temporal_partition

TemporalPartition

URI が指定する動画の時間範囲。

uri

string

動画クリップをダウンロードするための署名付き URI。

コレクション

コレクションはコーパス内のリソースです。元のリソースへの参照のコンテナとして機能します。

フィールド
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 アセットタイプの項目。

Corpus

コーパスは、管理対象のメディア コンテンツのセットです。コーパス内のメディアは同じデータスキーマを共有します。検索は 1 つのコーパス内でも制限されます。

フィールド
name

string

コーパスのリソース名。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

display_name

string

必須。UI に表示されるコーパス名。名前の長さは 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 で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

CreateAnnotationRequest

CreateAnnotation に対するリクエスト メッセージです。

フィールド
parent

string

必須。このアノテーションが作成される親リソース。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

annotation

Annotation

必須。作成するアノテーション。

annotation_id

string

省略可。アノテーションに使用する ID。ユーザーが指定した場合、アノテーションのリソース名の最終的なコンポーネントになります。それ以外の場合は、アノテーション ID がシステムによって生成されます。

この値は最大 63 文字で、有効な文字は /[a-z][0-9]-/ です。先頭の文字は英字にする必要があります。末尾の文字は英字または数字にできます。

CreateApplicationInstancesRequest

アプリケーションにストリーム入力を追加するためのメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

application_instances[]

ApplicationInstance

必須。作成中のリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

CreateApplicationInstancesResponse

CreateApplicationInstance レスポンスのメッセージ。

CreateApplicationRequest

アプリケーションの作成に関するメッセージ。

フィールド
parent

string

必須。親の値。

application_id

string

必須。リクエスト元のオブジェクトの ID。

application

Application

必須。作成中のリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

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]-/ です。先頭の文字は英字にする必要があります。末尾の文字は英字または数字にできます。

CreateCollectionMetadata

CreateCollectionRequest のメタデータ メッセージ

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

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

Timestamp

コーパス作成オペレーションの作成日時。

update_time

Timestamp

コーパス作成オペレーションの更新時間。

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 で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

CreateIndexEndpointMetadata

CreateIndexEndpoint のメタデータ メッセージ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

CreateIndexEndpointRequest

CreateIndexEndpoint に対するリクエスト メッセージ。

フィールド
parent

string

必須。形式: projects/{project}/locations/{location}

index_endpoint_id

string

省略可。IndexEndpoint に使用する ID。ユーザーが指定した場合は、IndexEndpoint のリソース名の最終的なコンポーネントになります。指定しない場合、IndexEndpoint ID は自動生成されます。

この値は最大 63 文字で、有効な文字は a ~ z、0 ~ 9、ダッシュ(-)です。先頭文字は英字、末尾は英字または数字にする必要があります。

index_endpoint

IndexEndpoint

必須。作成中のリソース。

CreateIndexMetadata

CreateIndexRequest のメタデータ メッセージ

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

CreateIndexRequest

インデックスの作成に関するメッセージ。

フィールド
parent

string

必須。親の値。このインデックスが作成されるコーパスのリソース名。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

index_id

string

省略可。インデックスの ID。これは、インデックスの最終的なリソース名になります。この値を指定しない場合、システムによって生成されます。

この値は最大 63 文字で、有効な文字は /[a-z][0-9]-/ です。先頭の文字は英字にする必要があります。末尾の文字は英字または数字にできます。

index

Index

必須。作成中のインデックス。

CreateProcessRequest

プロセスの作成に関するメッセージ。

フィールド
parent

string

必須。親の値。

process_id

string

必須。リクエスト元のオブジェクトの ID。

process

Process

必須。作成中のリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

CreateProcessorRequest

プロセッサの作成に関するメッセージ。

フィールド
parent

string

必須。親の値。

processor_id

string

必須。リクエスト元のオブジェクトの ID。

processor

Processor

必須。作成中のリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

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 が生成されます。

条件

現在の検索結果に適用されているフィルタ条件。

フィールド
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 モデルの場合、インスタンス スキーマが必要です。プロセッサの作成時にインスタンス スキーマが指定されていない場合、VisionAI Platform は Vertex からインスタンス スキーマを取得しようとします。インスタンス スキーマが存在しない場合、作成は失敗します。

共用体フィールド artifact_path。App Platform がカスタム プロセッサのアーティファクトを読み込むパス。artifact_path は次のいずれかになります。
vertex_model

string

Vertex AI プラットフォームでホストされている元のモデルのリソース名。

ModelSchema

スキーマは OpenAPI 3.0.2 のスキーマ オブジェクトとして定義されます。

フィールド
instances_schema

GcsSource

予測リクエストと説明リクエストで使用される単一インスタンスの形式を定義する YAML ファイルの Cloud Storage 内の場所。

parameters_schema

GcsSource

予測パラメータと説明パラメータを定義する YAML ファイルの Cloud Storage 内の場所。

predictions_schema

GcsSource

単一の予測または説明の形式を定義する YAML ファイルの Cloud Storage 内の場所。

SourceType

インポートされたカスタム プロセッサのソースタイプ。

列挙型
SOURCE_TYPE_UNSPECIFIED ソースタイプが指定されていません。
VERTEX_AUTOML Vertex AutoML プロダクトのカスタム プロセッサ。
VERTEX_CUSTOM Vertex の一般的なカスタムモデルから取得したカスタム プロセッサ。

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:%E*S%E*z(absl::RFC3339_full)%Y-%m-%dT%H:%M:%E*S %Y-%m-%dT%H:%M%E*z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E*z %Y-%m-%dT%H %Y-%m-%d%E*z %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

アノテーション キーに適用する検索戦略のタイプ。

列挙型

DataType

サポートされているすべてのデータ型。

列挙型
DATA_TYPE_UNSPECIFIED DataType のデフォルト値。
VIDEO H264 などの動画データタイプ。
IMAGE 画像データの種類。
PROTO Protobuf データ型。通常は一般的なデータ BLOB に使用されます。

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 をデプロイできるレプリカの最大数。リクエストされた値が大きすぎる場合、デプロイはエラーになりますが、デプロイが成功すると、モデルをその数のレプリカにスケーリングできることが保証されます(サービスの停止を除く)。DeployedModel に対するトラフィックが、レプリカが最大で処理できる量を超えると、トラフィックの一部がドロップされます。この値を指定しない場合、デフォルト値として min_replica_count が使用されます。

このフィールドの値は、Vertex CPU と GPU の割り当てに対する課金に影響します。具体的には、max_replica_count * 選択したマシンタイプのコア数と、max_replica_count * 選択したマシンタイプのレプリカあたりの GPU 数に対して課金されます。

autoscaling_metric_specs[]

AutoscalingMetricSpec

変更不可。リソース使用率の指標(CPU 使用率、アクセラレータのデューティ サイクルなど)のターゲット値(設定されていない場合はデフォルトで 60)をオーバーライドする指標仕様。指標ごとに許可されるエントリは 1 つまでです。

machine_spec.accelerator_count が 0 より大きい場合、自動スケーリングは CPU 使用率とアクセラレータのデューティ サイクルの両方の指標に基づいて行われ、いずれかの指標が目標値を超えるとスケールアップし、両方の指標が目標値を下回るとスケールダウンします。デフォルトのターゲット値は、どちらの指標でも 60 です。

machine_spec.accelerator_count が 0 の場合、自動スケーリングは CPU 使用率の指標のみに基づいて行われ、明示的に設定されていない場合はデフォルトのターゲット値 60 が使用されます。

たとえば、オンライン予測でターゲット CPU 使用率を 80 にオーバーライドする場合は、autoscaling_metric_specs.metric_nameaiplatform.googleapis.com/prediction/online/cpu/utilization に、autoscaling_metric_specs.target80 に設定する必要があります。

DeleteAnalysisRequest

分析を削除する際のメッセージ。

フィールド
name

string

必須。リソースの名前。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

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(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

DeleteApplicationInstancesResponse

この型にはフィールドがありません。

DeleteApplicationInstance Response のメッセージ。

DeleteApplicationRequest

アプリの削除に関するメッセージ。

フィールド
name

string

必須。リソースの名前。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

force

bool

省略可。true に設定すると、このアプリのインスタンスと下書きも削除されます。(それ以外の場合、リクエストは、アプリケーションにインスタンスと下書きがない場合にのみ機能します)。

DeleteAssetMetadata

この型にはフィールドがありません。

metadata フィールドに埋め込まれる DeleteAsset API のメタデータ。

DeleteAssetRequest

DeleteAsset に対するリクエスト メッセージ。

フィールド
name

string

必須。削除するアセットの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

DeleteCollectionMetadata

DeleteCollectionRequest のメタデータ メッセージ

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

DeleteCollectionRequest

DeleteCollectionRequest に対するリクエスト メッセージ。

フィールド
name

string

必須。削除するコレクションの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

DeleteCorpusRequest

DeleteCorpus に対するリクエスト メッセージ。

フィールド
name

string

必須。削除するコーパスのリソース名。

DeleteDataSchemaRequest

DeleteDataSchema に対するリクエスト メッセージ。

フィールド
name

string

必須。削除するデータスキーマの名前。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}

DeleteDraftRequest

下書きを削除するメッセージ。

フィールド
name

string

必須。リソースの名前。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

DeleteIndexEndpointMetadata

DeleteIndexEndpoint のメタデータ メッセージ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

DeleteIndexEndpointRequest

DeleteIndexEndpoint に対するリクエスト メッセージ。

フィールド
name

string

必須。リソースの名前。

DeleteIndexMetadata

この型にはフィールドがありません。

DeleteIndexRequest のメタデータ メッセージ

DeleteIndexRequest

DeleteIndex に対するリクエスト メッセージ。

フィールド
name

string

必須。削除するインデックスの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

DeleteProcessRequest

プロセスの削除に関するメッセージ。

フィールド
name

string

必須。リソースの名前。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

DeleteProcessorRequest

プロセッサを削除するためのメッセージ。

フィールド
name

string

必須。リソースの名前

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

DeleteSearchConfigRequest

DeleteSearchConfig に対するリクエスト メッセージ。

フィールド
name

string

必須。削除する検索構成の名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

DeleteSearchHypernymRequest

SearchHypernym の削除リクエスト メッセージ。

フィールド
name

string

必須。削除する SearchHypernym の名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

DeployApplicationRequest

アプリケーションのデプロイに関するメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

validate_only

bool

設定されている場合、リクエストを検証し、アプリケーション グラフをプレビューしますが、実際にデプロイは行いません。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

enable_monitoring

bool

省略可。デプロイ時にアプリケーションのモニタリングを有効にするかどうか。

DeployApplicationResponse

RPC リクエスト メッセージ。DeployApplication レスポンスのメッセージ。

DeployIndexMetadata

DeployIndex のメタデータ メッセージ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

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>

Key-Value ペアとしてのラベル。

display_name

string

必須。ソリューションのわかりやすい表示名。

description

string

このアプリケーションの説明。

draft_application_configs

ApplicationConfigs

アプリに更新されていないドラフト アプリ設定。

EventUpdateFilter

EventUpdateFilter は、ウォッチャーが受け取るイベント アップデートを指定するフィルタです。

フィールド

共用体フィールド start_time

start_time は次のいずれかになります。

special_mode

SpecialMode

特定のタイムスタンプ以外の特別なモード。

specific_time

Timestamp

イベントの更新が発生する特定のタイムスタンプ。

SpecialMode

特定のタイムスタンプ以外の特別なモード。

列挙型
SPECIAL_MODE_UNSPECIFIED 特殊モードが指定されていません。
BEGINNING 開始時の特別モードとは、現在利用可能なすべてのイベントと、受信するイベントの更新を意味します。
LATEST LATEST スペシャル モードは、最新のイベントと受信したイベントの最新情報のみを表示します。

EventUpdateType

イベントの更新のタイプ。将来、他のユースケース(EVENT_DETACHED_FROM_STREAM など)に拡張できます。

列挙型
EVENT_UPDATE_TYPE_UNSPECIFIED イベントの更新タイプが指定されていません。
EVENT_AVAILABLE_ON_STREAM イベントはストリームから読み取ることができます。
EVENT_HEARTBEAT gRPC 接続の存続を確認するために使用されるハートビート メッセージ。

ExportRetailProductRecognitionIndexCoverageResponse

RetailProductRecognitionIndex カバレッジ ファイルのエクスポートに対するレスポンスのメッセージ。

FacetBucket

ファセット値、選択状態、メタデータを保持します。

フィールド
selected

bool

1 つのファセット バケットが選択されているかどうか。このフィールドは、ユーザーが選択したファセットを表します。SearchVideosRequest のフロントエンドで設定されます。

共用体フィールド bucket_value。ファセットに関連付けられたバケット。たとえば、ファセット「チーム」のバケットは「49ers」、「patriots」など、ファセット「選手」のバケットは「tom brady」、「drew brees」などです。bucket_value は次のいずれかになります。
value

FacetValue

単一値。

range

Range

範囲値。

範囲

ファセットが適用される値の範囲([開始、終了])。

フィールド
start

FacetValue

範囲の開始日。存在しない場合は、なんらかの境界(-inf など)を示します。

end

FacetValue

範囲の終了。存在しない場合は、なんらかの上限(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

ファセットに関連付けられたバケット。たとえば、「チーム」ファセットの場合、バケットは 49ers、patriots などになります。

bucket_type

FacetBucketType

ファセットのバケットタイプ。

fetch_matched_annotations

bool

true の場合、このファセット グループの選択に対してクエリが一致したアノテーションを返します。このオプションは、パーティション レベルのアノテーションに基づくファセットにのみ適用されます。次のファセット値がサポートされています。- INTEGER - STRING(DataSchema.SearchStrategy.EXACT_SEARCH のみ)

FacetProperty

ファセットの一元的な構成。

フィールド
mapped_fields[]

string

ファセットの名前。これは、ユーザーが検索結果の絞り込みに使用するディメンションです。mapped_fields は UserSpecifiedDataSchema キーと一致します。

たとえば、ユーザーは同じキー(player:adam、player:bob、player:charles など)を使用して複数の UGA を追加できます。複数の 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

1 つのファセットで返される一意のバケットの最大数。バケット数は、「player」などの高基数ファセットでは大きくなります。ユーザーに返されるのは、最も関連性の高い上位 n 件のみです。0 以下の場合、サーバーは適切な result_size を決定します。

bucket_type

FacetBucketType

ファセットのバケットタイプ(値、範囲など)。

共用体フィールド 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[]

FacetValue

現在、このフィールドでは整数型のみがサポートされています。

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

FacetValue

バケットの下限。注: 現在、このフィールドでサポートされているのは整数型のみです。

bucket_granularity

FacetValue

バケットの粒度。注: 現在、このフィールドでサポートされているのは整数型のみです。

bucket_count

int32

バケットの合計数。

FacetValue

ジェネリック型の単一値の定義。

フィールド

共用体フィールド value

value は次のいずれかになります。

string_value

string

文字列型の値。

integer_value

int64

整数型の値。

datetime_value

DateTime

日時型の値。

FloatRange

浮動小数点範囲タイプ。

フィールド
start

float

浮動小数点数範囲の開始。

end

float

浮動小数点数範囲の終了。

FloatRangeArray

浮動小数点範囲値のリスト。

フィールド
float_ranges[]

FloatRange

浮動小数点数範囲の値。

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[]

TemporalPartition

クリップをリクエストする期間。get_live_view が True に設定されている場合、無視されます。リクエストする期間の合計は 24 時間未満にする必要があります。

live_view_enabled

bool

アセットのライブ配信のみを表示するオプション(最大 3 分間のバックログ データあり)。

GenerateHlsUriResponse

GenerateHlsUri API のレスポンス メッセージ。

フィールド
uri

string

リクエストされた時間に対応する HLS マニフェストをダウンロードするための署名付き URI。

temporal_partitions[]

TemporalPartition

ストリームに表示される順序で返されるコンテンツの期間パーティションのリスト。

UploadAssetRequest

UploadAsset のリクエスト メッセージ。

フィールド
name

string

必須。アップロードするアセットのリソース名。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

asset_source

AssetSource

アセットのソース。

GenerateRetrievalUrlResponse

GenerateRetrievalUrl API のレスポンス メッセージ。

フィールド
signed_uri

string

アセットのコンテンツをダウンロードするための署名付き URL。

GeoCoordinate

位置情報の座標表現

フィールド
latitude

double

緯度座標。度数 [-90 ~ 90]

longitude

double

経度の座標。度 [-180 ~ 180]

GeoLocationArray

ロケーションのリスト。

フィールド
circle_areas[]

CircleArea

円の面積のリスト。

GetAnalysisRequest

分析を取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。

GetAnnotationRequest

GetAnnotation API のリクエスト メッセージ。

フィールド
name

string

必須。取得するアノテーションの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

GetApplicationRequest

申請を取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。

GetAssetRequest

GetAsset のリクエスト メッセージ。

フィールド
name

string

必須。取得するアセットの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

GetCollectionRequest

GetCollectionRequest のリクエスト メッセージです。

フィールド
name

string

必須。取得するコレクションの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

GetCorpusRequest

GetCorpus のリクエスト メッセージです。

フィールド
name

string

必須。取得するコーパスのリソース名。

GetDataSchemaRequest

GetDataSchema のリクエスト メッセージ。

フィールド
name

string

必須。取得するデータスキーマの名前。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}

GetDraftRequest

下書きを取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。

GetIndexEndpointRequest

GetIndexEndpoint のリクエスト メッセージです。

フィールド
name

string

必須。IndexEndpoint リソースの名前。

GetIndexRequest

インデックスを取得するためのリクエスト メッセージ。

フィールド
name

string

必須。Index リソースの名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

GetInstanceRequest

インスタンスの取得に関するメッセージ。

フィールド
name

string

必須。リソースの名前。

GetProcessRequest

プロセスを取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。

GetProcessorRequest

プロセッサを取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。

GetSearchConfigRequest

GetSearchConfig に対するリクエスト メッセージです。

フィールド
name

string

必須。取得する検索構成の名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

GetSearchHypernymRequest

SearchHypernym の取得リクエスト メッセージ。

フィールド
name

string

必須。取得する SearchHypernym の名前。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

GetStreamThumbnailResponse

GetStreamThumbnail のレスポンス用のメッセージ。空のレスポンス メッセージは、サムネイル画像が Google Cloud Storage に正常にアップロードされたことを示します。

ImageObjectDetectionPredictionResult

画像オブジェクト検出の予測出力形式。

フィールド
ids[]

int64

検出された AnnotationSpec のリソース ID。信頼スコアが降順で並べられます。完全なリソース名ではなく、ID セグメントです。

display_names[]

string

識別された AnnotationSpec の表示名と順序が ID と一致しています。

confidences[]

float

予測された ID の正確さに対するモデルの信頼度。値が大きいほど、信頼度が高くなります。順序が ID と一致する。

bboxes[]

ListValue

検出された AnnotationSpec を特定する境界ボックス(画像上の長方形)。ID に一致する順序で指定します。各境界ボックスは、ボックスの極端な座標を表す 4 つの数値(xMinxMaxyMinyMax)の配列です。座標は画像サイズを基準とし、0,0 は画像の左上です。

ImageQuery

検索エンドポイント リクエストの画像クエリ。

フィールド

共用体フィールド image

image は次のいずれかになります。

input_image

bytes

未加工バイトでの入力画像。

asset

string

アセットのリソース名。IMAGE コーパス タイプでのみサポートされます。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ImageSegmentationPredictionResult

画像セグメンテーションの予測出力形式。

フィールド
category_mask

string

マスク内の各ピクセルが、元の画像のピクセルが属すると予測されたカテゴリを表す PNG 画像。この画像のサイズは元の画像と同じになります。AnntoationSpec と色のマッピングは、モデルのメタデータで確認できます。モデルは最も可能性の高いカテゴリを選択します。どのカテゴリも信頼度しきい値に達しなかった場合、ピクセルは背景としてマークされます。

confidence_mask

string

8 ビット非圧縮 PNG としてエンコードされた 1 チャンネルの画像。画像のサイズは元の画像と同じになります。特定のピクセルの場合、色が濃いほど、対応するピクセルの categoryMask 内のカテゴリの正確性に対する信頼度が低くなります。黒は信頼性が低く、白は信頼性が非常に高いことを意味します。

ImportAssetsMetadata

ImportAssets LRO のメタデータ メッセージ。

フィールド
metadata

OperationMetadata

オペレーションのメタデータ。

ImportAssetsRequest

ImportAssets のリクエスト メッセージ。

フィールド
parent

string

必須。アセットがインポートされる親コーパス リソース。形式: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

共用体フィールド source。ソース。source は次のいずれかになります。
assets_gcs_uri

string

このファイルには、インポートするすべてのアセット情報が含まれています。* ファイルは JSONL 形式です。* 各行は 1 つのアセットに対応しています。* 各行は InputImageAsset proto に変換されます。

ImportAssetsResponse

この型にはフィールドがありません。

ImportAssets LRO のレスポンス メッセージ。

ImportRetailProductsResponse

オペレーションが完了した後の ImportProducts レスポンス。

インデックス

インデックスは、コーパスのリソースです。アセットとアノテーションのインデックス付きバージョンが含まれています。エンドポイントにデプロイすると、ユーザーはインデックスを検索できるようになります。

フィールド
name

string

出力専用。Index リソースのリソース名。形式: 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 コーパスのインデックスにデプロイできるインデックスは 1 つだけです。IMAGE コーパスのインデックスには、複数のデプロイ済みインデックスを含めることができます。

共用体フィールド asset_filter。このインデックス用にアセットを選択する方法を指定する。指定しない場合のデフォルトは entire_corpus です。UpdateIndex での動作: update_mask に asset_filter フィールドパスのいずれかが含まれている場合、インデックスは、分析データやアノテーションを含む最新のアセットで再ビルドされます。asset_filter は次のいずれかになります。
entire_corpus

bool

コーパス内のすべてのアセットを含めます。

インデックスの存続期間中にインデックスが循環する可能性のあるさまざまな状態を表す列挙型。

列挙型
STATE_UNSPECIFIED デフォルト値。これは使用しないでください。
CREATING 状態は CREATING。
CREATED 状態は CREATED です。
UPDATING ステータスは UPDATING です。

IndexAssetMetadata

IndexAsset のメタデータ。

フィールド
indexing_status
(deprecated)

IndexingStatus

このアセットのインデックス登録のステータス。

status

IndexingStatus

このアセットのインデックス登録のステータス。

start_time

Timestamp

操作の開始時刻。

update_time

Timestamp

オペレーションの更新時間。

IndexingStatus

アセットのインデックス登録のステータス。

フィールド
state

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 リソースを表すメッセージ。ImageIndex がデプロイされます。

フィールド
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>

省略可。リソースに適用するラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーは、小文字または国際文字で始める必要があります。

詳細については、Google Cloud のドキュメントをご覧ください。

create_time

Timestamp

出力専用。タイムスタンプを作成します。

update_time

Timestamp

出力専用。更新タイムスタンプ。

IndexEndpoint ステージ。

列挙型
STATE_UNSPECIFIED デフォルト値。これは使用しないでください。
CREATING 状態は CREATING。
CREATED 状態は CREATED です。
UPDATING ステータスは 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

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

TemporalPartition

データの時間範囲。

IngestAssetResponse

IngestAsset API のレスポンス メッセージ。

フィールド
successfully_ingested_partition

TemporalPartition

正常に取り込まれたデータの時間範囲。

インスタンス

Instance オブジェクトについて説明するメッセージ

フィールド
name

string

出力専用。リソースの名前

create_time

Timestamp

出力専用。[出力専用] 作成タイムスタンプ

update_time

Timestamp

出力専用。[出力専用] 更新タイムスタンプ

labels

map<string, string>

Key-Value ペアとしてのラベル。

display_name

string

必須。ソリューションのわかりやすい表示名。

description

string

このインスタンスの説明。

input_resources[]

InputResource

現在のアプリケーション インスタンスの入力リソース。例: input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a

output_resources[]

OutputResource

1 つのアプリケーション インスタンスに関連付けられているすべての出力リソース。

state

State

インスタンスの状態。

InputResource

1 つのアプリケーション インスタンスで使用される入力リソースのメッセージ。

フィールド
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

1 つのアプリケーション インスタンスで使用される出力リソースのメッセージ。

フィールド
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 状態 DEPLOYED。
UNDEPLOYING ステータスは UNDEPLOYING です。
DELETED ステータス DELETED。
ERROR 状態が ERROR です。
UPDATING ステータスの更新
DELETING 状態: 削除中。
FIXING 状態の修正。

IntRange

整数の範囲型。

フィールド
start

int64

int 範囲の開始。

end

int64

整数範囲の終了。

IntRangeArray

整数範囲値のリスト。

フィールド
int_ranges[]

IntRange

整数の範囲値。

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 個のアノテーションが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

前回の ListAnnotations 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListAnnotations に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

filter

string

返されたリストに適用されたフィルタ。フィルタリングがサポートされるのは、partition.temporal_partition.start_timepartition.temporal_partition.end_timekey の各フィールドのみです。IMAGE タイプのコーパスの場合、key のみがサポートされます。タイムスタンプは RFC-3339 形式で指定します。フィールドごとに適用できる制限は 1 つだけです。複数の制限を適用する場合は、連結子で結合します。形式: "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[]

Annotation

指定したアセットのアノテーション。

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 個のアセットが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

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 個のコレクションが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

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 個のデータスキーマが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

前回の ListDataSchemas 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListDataSchemas に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListDataSchemasResponse

ListDataSchemas に対するレスポンス メッセージです。

フィールド
data_schemas[]

DataSchema

指定されたコーパスのデータスキーマ。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDraftsRequest

下書きのリストをリクエストするメッセージ。

フィールド
parent

string

必須。ListDraftsRequest の親値。

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 になります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

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

IndexEndpoint のリスト。

next_page_token

string

サーバーが返す必要がある結果のページを特定するトークンです。

ListIndexesRequest

リスティング インデックスのリクエスト メッセージ。

フィールド
parent

string

必須。このインデックス コレクションを所有する親コーパス。形式: projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

返されるインデックスの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のインデックスが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

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

必須。ListProcessorsRequest の親値。

page_size

int32

リクエストされたページサイズです。 サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。

page_token

string

サーバーが返す必要がある結果のページを特定するトークンです。

filter

string

結果のフィルタリング。

order_by

string

結果の並べ替え方法に関するヒント。

ListProcessorsResponse

Processor の一覧表示に対するレスポンスのメッセージ。

フィールド
processors[]

Processor

プロセッサのリスト。

next_page_token

string

サーバーが返す必要がある結果のページを特定するトークンです。

unreachable[]

string

到達できなかった場所。

ListSearchConfigsRequest

ListSearchConfigs に対するリクエスト メッセージです。

フィールド
parent

string

必須。この検索構成のコレクションを所有する親。形式: projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

返される検索構成の最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、ページサイズは 50 になります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

前回の ListSearchConfigs 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListSearchConfigs に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListSearchConfigsResponse

ListSearchConfigs に対するレスポンス メッセージ。

フィールド
search_configs[]

SearchConfig

指定されたコーパスの検索構成。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSearchHypernymsRequest

リスティングの SearchHypernyms のリクエスト メッセージ。

フィールド
parent

string

必須。この SearchHypernyms コレクションを所有する親。形式: projects/{project_number}/locations/{location}/corpora/{corpus}

page_size

int32

返される SearchHypernym の最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、ページサイズは 50 になります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

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

Media Warehouse コーパスのリソース名。形式: projects/${project_id}/locations/${location_id}/corpora/${corpus_id}

region
(deprecated)

string

サポート終了。

ttl

Duration

すべてのメディア アセット、関連メタデータ、検索ドキュメントが存在できる期間。

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 では、メディア ウェアハウス ノードにのみ複数の親を設定できます。他のタイプのノードには親が 1 つだけ設定できます。

共用体フィールド 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 ストリーム リソースに自動的に送信します(出力チャネルごとに 1 つのストリーム)。出力ストリーム リソースは、デプロイ中に App Platform によって自動的に作成され、アプリケーションのデプロイ解除後に削除されます。この構成は、すべてのアプリケーション インスタンスに適用されます。

出力ストリームは、Instance リソースの output_resources セクションを構成することで、インスタンスレベルでオーバーライドできます。producer_node は現在のノード、output_resource_binding は出力チャンネル名(プロセッサの出力チャンネルが 1 つしかない場合は空白のまま)、output_resource はターゲット出力ストリームにする必要があります。

InputEdge

ノードを指す 1 つのエッジを記述するメッセージ。

フィールド
parent_node

string

親ノードの名前。

parent_output_channel

string

親ノードの接続された出力アーティファクト。ターゲット プロセッサに出力アーティファクトが 1 つしかない場合は省略できます。

connected_input_channel

string

現在のノードのプロセッサの接続された入力チャネル。ターゲット プロセッサに入力チャネルが 1 つしかない場合は省略できます。

NormalizedPolygon

正規化されたポリゴン。

フィールド
normalized_vertices[]

NormalizedVertex

境界ポリゴンの正規化された頂点。画像の左上隅は [0, 0] になります。

NormalizedPolyline

正規化されたポリライン。接続された直線セグメントで構成される曲線を表します。

フィールド
normalized_vertices[]

NormalizedVertex

直線で接続された一連の頂点。

NormalizedVertex

頂点は、画像上の 2D の点を表します。注: 正規化された頂点座標は、元の画像と相対しており、0~1 の範囲になります。

フィールド
x

float

X 座標。

y

float

Y 座標。

ObjectDetectionPredictionResult

汎用オブジェクト検出の予測出力形式。

フィールド
current_time

Timestamp

現在のタイムスタンプ。

identified_boxes[]

IdentifiedBox

検出されたボックスのリスト。

エンティティ

オブジェクト検出の予測結果から取得したアノテーションのエンティティ情報。

フィールド
label_id

int64

ラベル ID。

label_string

string

ラベルの人間が読める文字列。

IdentifiedBox

識別されたボックスには、オブジェクトの位置とエンティティが含まれます。

フィールド
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

滞留時間に関する情報。特定のゾーンでライブ配信されているすべてのトラック(開始時間と終了時間の滞在時間のタイムスタンプ付き)

pts

int64

フレームの表示タイムスタンプ。

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

Timestamp

このトラックの開始タイムスタンプ。

OperationMetadata

長時間実行されているオペレーションのメタデータを表します。

フィールド
create_time

Timestamp

出力専用。オペレーションが作成された時刻。

end_time

Timestamp

出力専用。オペレーションの実行が終了した時刻。

target

string

出力専用。オペレーションのターゲットに対応するサーバー定義のリソースパス。

verb

string

出力専用。オペレーションによって実行される動詞の名前。

status_message

string

出力専用。人が読める形式のオペレーションのステータス(存在する場合)。

requested_cancellation

bool

出力専用。ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の [Operation.error][] 値を持ちます。これは Code.CANCELLED に相当します。

api_version

string

出力専用。オペレーションを開始するために使用された API のバージョン。

パーティション

パーティショニング: サブアセット レベルのアノテーションの時間と空間のパーティションを指定します。

フィールド
temporal_partition

TemporalPartition

アセットの時間的な分割。

spatial_partition

SpatialPartition

空間内のアセットのパーティション。

relative_temporal_partition

RelativeTemporalPartition

アセットの時間的な分割。

RelativeTemporalPartition

アセットの相対時間でのパーティショニング。VIDEO_ON_DEMAND コーパスタイプでサポートされています。

フィールド
start_offset

Duration

パーティションの開始時間オフセット。

end_offset

Duration

パーティションの終了時刻オフセット。

SpatialPartition

空間内のアセットのパーティション。

フィールド
x_min

int64

最小 X 座標値。

y_min

int64

最小 Y 座標値。

x_max

int64

最大 X 座標値。

y_max

int64

最大 Y 座標値。

TemporalPartition

UTC エポック時間でのアセットのパーティション。STREAM_VIDEO コーパスタイプでサポートされています。

フィールド
start_time

Timestamp

パーティションの開始時間。

end_time

Timestamp

パーティションの終了時刻。

PersonBlurConfig

FaceBlurConfig について説明するメッセージ。

フィールド
person_blur_type

PersonBlurType

人のぼかしのタイプ。

faces_only

bool

プロセッサ内のオブジェクト全体ではなく、顔のみをぼかすかどうか。

PersonBlurType

人のぼかしの種類

列挙型
PERSON_BLUR_TYPE_UNSPECIFIED PersonBlur のタイプが UNSPECIFIED です。
FULL_OCCULUSION FaceBlur タイプ: 完全オクルージョン。
BLUR_FILTER FaceBlur タイプのぼかしフィルタ。

PersonVehicleDetectionConfig

PersonVehicleDetectionConfig について説明するメッセージ。

フィールド
enable_people_counting

bool

enable_people_counting フィールドと enable_vehicle_counting フィールドの少なくとも 1 つを true に設定する必要があります。人物の出現回数をカウントするかどうかにかかわらず、出力カウントのキーは「people」です。

enable_vehicle_counting

bool

車両の出現回数をカウントするかどうかにかかわらず、出力カウントのキーは「vehicle」になります。

PersonalProtectiveEquipmentDetectionConfig

PersonalProtectiveEquipmentDetectionConfig について説明するメッセージ。

フィールド
enable_face_coverage_detection

bool

顔の覆い被り検出を有効にするかどうか。

enable_head_coverage_detection

bool

ヘッドカバレッジ検出を有効にするかどうか。

enable_hands_coverage_detection

bool

手のひら覆い検出を有効にするかどうか。

PersonalProtectiveEquipmentDetectionOutput

個人用防護具検出オペレータの出力形式。

フィールド
current_time

Timestamp

現在のタイムスタンプ。

detected_persons[]

DetectedPerson

検出された人物のリスト。

DetectedPerson

検出された人物には、検出された人物とそれに関連付けられた PPE と保護情報があります。

フィールド
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

スーパーカテゴリラベルの人間が読める文字列(例: head_cover、hands_cover、face_cover)。

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>

Key-Value ペアとしてのラベル。

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: 36

フィールド

共用体フィールド 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

プロセッサがインスタンスごとに生成する出力リソース。ここで明示的にリストされている出力バインディングを除き、すべてのプロセッサの GraphOutputChannel をストリーム リソースにバインドできます。バインディング名は、GraphOutputChannel の名前と同じになります。

GraphInputChannelSpec

入力チャネルの仕様に関するメッセージ。

フィールド
name

string

現在の入力チャンネルの名前。

data_type

DataType

現在の入力チャネルのデータ型。このフィールドに複数の値が設定されている場合、この入力チャネルはこれらの異なるデータ型のいずれかに接続できます。

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 リソースを含む構成プロト。たとえば、type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation などです。

resource_type_uri

string

Googleapis リソースの直接型の URL(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(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

TargetStreamInput

削除するターゲット streamInput に関するメッセージ。

フィールド
stream

string

RemoveApplicationStreamInputResponse

RemoveApplicationStreamInput レスポンスのメッセージ。

RemoveCollectionItemRequest

RemoveCollectionItem に対するリクエスト メッセージ。

フィールド
item

CollectionItem

必須。削除するアイテム。

RemoveCollectionItemResponse

RemoveCollectionItem に対するリクエスト メッセージ。

フィールド
item

CollectionItem

すでに削除されている商品。

RemoveIndexAssetMetadata

RemoveIndexAsset のメタデータ。

フィールド
indexing_status

IndexingStatus

このアセットのインデックス登録のステータス。

start_time

Timestamp

操作の開始時刻。

update_time

Timestamp

オペレーションの更新時間。

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[]

StreamAnnotation

アプリケーション全体に適用されるアノテーション。

node_annotations[]

ApplicationNodeAnnotation

アプリケーションの特定のノードに適用されるアノテーション。アプリケーションとノードの両方に同じタイプのアノテーションが適用されている場合、グローバル アプリケーションのアノテーションに加えて、ノード アノテーションが追加されます。たとえば、アプリ全体に 1 つのアクティブ ゾーン アノテーションがあり、占有状況分析プロセッサに 1 つのアクティブ ゾーン アノテーションがある場合、占有状況分析プロセッサには 2 つのアクティブ ゾーンが定義されます。

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

小売サービスのオペレーション メタデータ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

partial_failures[]

Status

出力専用。発生した部分的な障害。たとえば、読み取れなかった単一の画像ファイルなどです。[ステータスの詳細] フィールドには、標準の Google Cloud エラーの詳細が含まれます。

operation_metrics

OperationMetrics

出力専用。オペレーションに関する指標。

OperationMetrics

オペレーションに関する記録された指標。

フィールド
counters

map<string, int32>

カウンタ名からカウントへのマッピング。

RetailPredictResults

BatchAnalyze の結果形式。

フィールド
image_uri

string

入力からの画像 URI。

product_recognition_annotations[]

RetailProductRecognitionAnnotation

商品認識のアノテーション。

tag_recognition_annotations[]

RetailTagRecognitionAnnotation

タグ認識アノテーション。

RetailProduct

RetailProduct リソースを表すメッセージ。

フィールド
name

string

出力専用。RetailProduct リソースの名前。

gtins[]

string

商品の国際取引商品番号(GTIN)。

normalized_gtins[]

string

出力専用。入力 GTIN から正規化されたバージョンを、正規の 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>

RetailProduct を整理するためのユーザー定義のメタデータを含むラベル。

ラベルのキーと値は 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 ステータスは UPDATING です。
RETAIL_RESOURCE_STATE_DELETED ステータス DELETED。
RETAIL_RESOURCE_STATE_ERROR 状態が ERROR です。

RetailTagRecognitionAnnotation

proto は、このタグ インスタンスが占有する画像領域や抽出されたテキスト情報など、タグの認識結果を記述します。

フィールド
tag_region

RetailObjectDetectionAnnotation

このタグ インスタンスの検出情報(境界ボックス、信頼度など)。

tag_text

string

このタグ インスタンスのテキスト。

entities[]

RetailEntity

タグで検出されたエンティティのリスト。

RetailThirdPartyId

販売店またはメーカーが使用するサードパーティ ID を表します(SKU または MPN)。

フィールド
id

string

小売業者またはメーカーが使用するサードパーティ ID(SKU または MPN)。

owner

string

サードパーティ ID を「所有」するエンティティ(この商品を販売するメーカーまたは小売店)。

RunMode

RunMode は、Process を起動するモードを表します。

列挙型
RUN_MODE_UNSPECIFIED モードは指定されていません。
LIVE ライブモード。つまり、ライブ動画ソースを処理するためにプロセスが起動され、パケットのドロップが発生する可能性があります。
SUBMISSION 送信モード。つまり、プロセスは、パケットのドロップなしで、境界付きの動画ファイルを処理するために起動されます。完了ステータスが追跡されます。

RunStatus

プロセスのステータスを説明するメッセージ。

フィールド
state

State

プロセスの状態。

reason

string

状態になった理由。

State は、プロセスの実行ステータスを表します。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
INITIALIZING INITIALIZING は、プロセスがスケジュールされているが、実際のトラフィックを処理する準備ができていることを意味します。
RUNNING RUNNING は、プロセスが実行されていてトラフィックを処理していることを意味します。
COMPLETED COMPLETED は、特にストリーミング以外のユースケースで、プロセスが処理を完了したことを意味します。
FAILED FAILED は、プロセスが処理を完了できなかったことを意味します。

SchemaKeySortingStrategy

データスキーマキーで並べ替える方法を指定する戦略。

フィールド
options[]

Option

前面のオプションは後面のオプションよりも優先度が高くなります。

オプション

1 つのデータスキーマ鍵のオプション。

フィールド
data_schema_key

string

並べ替えに使用するデータ。

sort_decreasing

bool

降順または昇順で並べ替えるか。デフォルトでは、結果は昇順で並べ替えられます。

aggregate_method

AggregateMethod

現在のデータスキーマキーの集計方法。

AggregateMethod

1 つの結果に同じキーを持つ複数の値がある場合は、並べ替えに使用する値を指定します。デフォルトでは、結果を降順で並べ替える場合は 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 未指定の検索機能。使用しないでください。

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 と 1 つ以上の UGA キーとのマッピングを作成します。

SearchCriteriaProperty

カスタム検索条件の一元管理。

フィールド
mapped_fields[]

string

各 mapped_field は UGA キーに対応しています。このプロパティの仕組みを理解するには、次の例をご覧ください。SearchConfig テーブルに、次のエントリを追加します。search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

ユーザーが次のようなクエリを実行すると、

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

必須。検索するインデックス エンドポイント。形式: `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。oneof グローバル検索クエリ。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 とユーザーの検索リクエストの関連性。現在は Image Warehouse でのみ使用でき、デフォルトではコサイン類似度を表します。今後は、検索リクエストで「ドット積」や「トピック性」などの他の指標をリクエストできるようになります。

requested_annotations[]

Annotation

検索リクエストの result_annotation_keys で指定された検索結果のアノテーション。

annotation_matching_results[]

AnnotationMatchingResult

この検索結果アイテムに関連付けられている、条件またはファセット選択に基づくアノテーションの一致結果。fetch_matched_annotations=true の条件またはファセット選択の結果のみが含まれます。

StreamAnnotation

メッセージは、Vision AI ストリーム リソースのアノテーションに関するものです。

フィールド
id

string

アノテーションの ID。特定のコンテキストで使用する場合、一意である必要があります。たとえば、Vision AI アプリケーションの 1 つの入力ストリームに対するすべてのアノテーションなどです。

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 ストリームのコンテンツの上にポリラインを定義します。線を越えて発生したイベントがキャプチャされます。たとえば、Occupancy Analytic Processor でラインを越えた人の数などです。

StreamAnnotations

繰り返しの StreamAnnotation のラッパー。

フィールド
stream_annotations[]

StreamAnnotation

複数のアノテーション。

StreamWithAnnotation

アプリケーション固有のアノテーションを含む Vision AI ストリームを記述するメッセージ。このメッセージ内のすべての StreamAnnotation オブジェクトに一意の ID が必要です。

フィールド
stream

string

Vision AI Stream リソース名。

application_annotations[]

StreamAnnotation

アプリケーション全体に適用されるアノテーション。

node_annotations[]

NodeAnnotation

アプリケーションの特定のノードに適用されるアノテーション。アプリケーションとノードの両方に同じタイプのアノテーションが適用されている場合、グローバル アプリケーションのアノテーションに加えて、ノード アノテーションが追加されます。たとえば、アプリ全体に 1 つのアクティブ ゾーン アノテーションがあり、占有状況分析プロセッサに 1 つのアクティブ ゾーン アノテーションがある場合、占有状況分析プロセッサには 2 つのアクティブ ゾーンが定義されます。

NodeAnnotation

アプリケーション ノードに固有のアノテーションを説明するメッセージ。

フィールド
node

string

アプリケーション グラフのノード名。

annotations[]

StreamAnnotation

ノード固有のストリームのアノテーション。

StringArray

文字列型の値のリスト。

フィールド
txt_values[]

string

文字列型の値。

UndeployApplicationRequest

アプリケーションのデプロイ解除に関するメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

UndeployApplicationResponse

この型にはフィールドがありません。

UndeployApplication レスポンスのメッセージ。

UndeployIndexMetadata

UndeployIndex のメタデータ メッセージ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

deployed_index

string

出力専用。デプロイ解除中のインデックス。

UndeployIndexRequest

UndeployIndexEndpoint のリクエスト メッセージ。

フィールド
index_endpoint

string

必須。デプロイ解除の対象となる IndexEndpoint リソースのリソース名。形式: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

UndeployIndexResponse

この型にはフィールドがありません。

オペレーションが完了した後の UndeployIndex レスポンス。

UndeployRetailProductRecognitionIndexResponse

UndeployRetailProductRecognitionIndex レスポンスのメッセージ。

UpdateAnalysisRequest

分析の更新に関するメッセージ。

フィールド
update_mask

FieldMask

必須。フィールド マスクは、更新によって Analysis リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

analysis

Analysis

必須。更新されるリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

UpdateAnnotationRequest

UpdateAnnotation API のリクエスト メッセージ。

フィールド
annotation

Annotation

必須。更新するアノテーション。アノテーションの name フィールドは、更新するアノテーションを識別するために使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

update_mask

FieldMask

更新するフィールドのリスト。

UpdateApplicationInstancesRequest

ApplicationInstance の更新に関するメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

application_instances[]

UpdateApplicationInstance

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

allow_missing

bool

true の場合、更新リクエストは、ターゲット リソースが存在しない場合、1 つのリソースを作成します。この場合、field_mask は無視されます。

UpdateApplicationInstance

フィールド
update_mask

FieldMask

省略可。フィールド マスクは、更新によって Draft リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

instance

Instance

必須。更新されるリソース。

instance_id

string

必須。インスタンスの ID。

UpdateApplicationInstancesResponse

UpdateApplicationInstances レスポンスのメッセージ。

UpdateApplicationRequest

アプリケーションの更新に関するメッセージ。

フィールド
update_mask

FieldMask

省略可。フィールド マスクは、更新によって Application リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

application

Application

必須。更新されるリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

UpdateApplicationStreamInputRequest

アプリケーションへのストリーム入力を更新するためのメッセージ。

フィールド
name

string

必須。取得するアプリケーションの名前。形式: "projects/{project}/locations/{location}/applications/{application}"

application_stream_inputs[]

ApplicationStreamInput

更新するストリーム入力。ストリーム リソース名は各 StreamInput のキーであり、各アプリケーション内で一意である必要があります。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

allow_missing

bool

true の場合、UpdateApplicationStreamInput は、ターゲット ストリームがアプリに含まれていなくても、ストリーム入力をアプリに挿入します。

UpdateApplicationStreamInputResponse

この型にはフィールドがありません。

AddApplicationStreamInput レスポンスのメッセージ。

UpdateAssetRequest

UpdateAsset に対するリクエスト メッセージです。

フィールド
asset

Asset

必須。更新するアセット。

アセットの name フィールドは、更新するアセットの識別に使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

update_mask

FieldMask

更新するフィールドのリスト。

UpdateCollectionRequest

UpdateCollectionRequest のリクエスト メッセージです。

フィールド
collection

Collection

必須。更新するコレクション。

コレクションの name フィールドは、更新するコレクションを識別するために使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

update_mask

FieldMask

更新するフィールドのリスト。- update_mask を設定解除するか、update_mask を単一の「*」に設定すると、更新可能なすべてのフィールドが collection で指定された値で更新されます。- display_name の値を空の文字列に更新するには、collection で空の文字列に設定し、update_mask を「display_name」に設定します。これは、collection 内の他の更新可能な文字列フィールドにも適用されます。

UpdateCorpusRequest

UpdateCorpus に対するリクエスト メッセージです。

フィールド
corpus

Corpus

必須。サーバー上のリソースを置き換えるコーパス。

update_mask

FieldMask

更新するフィールドのリスト。

UpdateDataSchemaRequest

UpdateDataSchema に対するリクエスト メッセージです。

フィールド
data_schema

DataSchema

必須。データスキーマの name フィールドは、更新するデータスキーマを識別するために使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}

update_mask

FieldMask

更新するフィールドのリスト。

UpdateDraftRequest

下書きを更新するためのメッセージ。

フィールド
update_mask

FieldMask

省略可。フィールド マスクは、更新によって Draft リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

draft

Draft

必須。更新されるリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

allow_missing

bool

true の場合、UpdateDraftRequest は、ターゲット リソースが存在しない場合、1 つのリソースを作成します。この場合、field_mask は無視されます。

UpdateIndexEndpointMetadata

UpdateIndexEndpoint のメタデータ メッセージ。

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

UpdateIndexEndpointRequest

UpdateIndexEndpoint のリクエスト メッセージ。

フィールド
index_endpoint

IndexEndpoint

必須。更新されるリソース。

update_mask

FieldMask

必須。フィールド マスクは、更新によって IndexEndpoint リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。リソースのフィールドは、マスク内にある場合、上書きされます。空のフィールド マスクは使用できません。マスクが「*」の場合、リソースが完全に置き換えられます。

UpdateIndexMetadata

UpdateIndexRequest のメタデータ メッセージ

フィールド
operation_metadata

OperationMetadata

長時間実行オペレーションの一般的なメタデータ。

UpdateIndexRequest

UpdateIndex に対するリクエスト メッセージです。

フィールド
index

Index

必須。更新されるリソース。

update_mask

FieldMask

必須。フィールド マスクは、更新によって Index リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。リソースのフィールドは、マスク内にある場合、上書きされます。空のフィールド マスクは使用できません。マスクが「*」の場合、インデックスの完全な更新とインデックス データの完全な再ビルドがトリガーされます。

UpdateProcessRequest

プロセスの更新に関するメッセージ。

フィールド
update_mask

FieldMask

必須。フィールド マスクは、更新によって Process リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

process

Process

必須。更新されるリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

UpdateProcessorRequest

プロセッサの更新に関するメッセージ。

フィールド
update_mask

FieldMask

省略可。フィールド マスクは、更新によって Processor リソースで上書きするフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。

processor

Processor

必須。更新されるリソース。

request_id

string

省略可。リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

UpdateSearchConfigRequest

UpdateSearchConfig に対するリクエスト メッセージです。

フィールド
search_config

SearchConfig

必須。更新する検索構成。

検索構成の name フィールドは、更新するリソースの識別に使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

update_mask

FieldMask

更新するフィールドのリスト。設定しない場合、すべてのフィールドパスが更新または上書きされます。

UpdateSearchHypernymRequest

SearchHypernym の更新リクエスト メッセージ。

フィールド
search_hypernym

SearchHypernym

必須。更新する SearchHypernym。検索ハイパーニムの name フィールドは、更新する検索ハイパーニムの識別に使用されます。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

update_mask

FieldMask

更新するフィールドのリスト。設定しない場合、すべてのフィールドパスが更新または上書きされます。

UploadAssetMetadata

UploadAsset のメタデータ。

フィールド
start_time

Timestamp

操作の開始時刻。

update_time

Timestamp

オペレーションの更新時間。

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

1 秒あたりの最大予測フレーム数。この属性は、オペレーターが Vertex AI エンドポイントに予測リクエストを送信する速度を設定します。デフォルト値は 0 で、最大予測 fps の制限がないことを意味します。オペレーターは、入力 fps で予測リクエストを送信します。

dedicated_resources

DedicatedResources

DeployedModel 専用で、高度な手動構成が必要なリソースの説明。

post_processing_cloud_function

string

空でない場合、予測結果は指定された Cloud Functions 関数に送信され、後処理が行われます。* Cloud Functions の関数は AppPlatformCloudFunctionRequest を受信します。この場合、annotations フィールドは proto PredictResponse の JSON 形式になります。* Cloud Functions の関数は、annotations フィールドに PredictResponse が保存された AppPlatformCloudFunctionResponse を返す必要があります。* 予測出力を破棄するには、返された AppPlatformCloudFunctionResponse のペイロード フィールドを消去します。

attach_application_metadata

bool

true の場合、カスタムモデルが受信した予測リクエストには、次のスキーマのメタデータも含まれます。'appPlatformMetadata': { 'ingestionTime': DOUBLE;(UNIX タイムスタンプ) 'application': STRING; 'instanceId': STRING; 'node': STRING; 'processor': STRING; }

VideoActionRecognitionPredictionResult

動画動作認識の予測出力形式。

フィールド
segment_start_time

Timestamp

アクションが特定された動画の時間セグメントの開始時間(その時間を含む)。

segment_end_time

Timestamp

アクションが特定された動画の時間セグメントの終了時間(その時間を含む)。特に、開始と終了が同じ場合は、特定の動画フレームで識別が行われることを意味します。

actions[]

IdentifiedAction

期間内で特定されたすべてのアクション。

IdentifiedAction

各 IdentifiedAction は、AnnotationSpec ID、display_name、関連する信頼スコアで指定されたアクションの特定の識別子です。

フィールド
id

string

識別された AnnotationSpec のリソース ID。

display_name

string

識別された AnnotationSpec の表示名。

confidence

float

この識別結果の修正に対するモデルの信頼度。値が大きいほど、信頼度が高くなります。

VideoClassificationPredictionResult

動画分類の予測出力形式。

フィールド
segment_start_time

Timestamp

分類が特定された動画の時間セグメントの開始時間(開始時間を含む)。

segment_end_time

Timestamp

分類が特定された動画の時間セグメントの終了時間(その時間を含む)。特に、開始と終了が同じ場合は、特定の動画フレームで識別が行われることを意味します。

classifications[]

IdentifiedClassification

期間内で特定されたすべての分類。

IdentifiedClassification

各 IdentifiedClassification は、AnnotationSpec ID と display_name で指定された分類の特定の識別と、関連する信頼スコアです。

フィールド
id

string

識別された AnnotationSpec のリソース ID。

display_name

string

識別された AnnotationSpec の表示名。

confidence

float

この識別結果の修正に対するモデルの信頼度。値が大きいほど、信頼度が高くなります。

VideoObjectTrackingPredictionResult

動画オブジェクト トラッキングの予測出力形式。

フィールド
segment_start_time

Timestamp

現在の識別が行われる動画の時間セグメントの開始時間(その時間を含む)。

segment_end_time

Timestamp

現在の識別が行われる動画の時間セグメントの終了時間(その時間を含む)。特に、開始と終了が同じ場合は、特定の動画フレームで識別が行われることを意味します。

objects[]

DetectedObject

指定した期間内に検出されたすべてのオブジェクト。

BoundingBox

検出されたオブジェクトの境界ボックス。つまり、検出された AnnotationSpec を特定する動画フレーム上の長方形です。座標はフレームサイズを基準とし、0,0 はフレームの左上です。

フィールド
x_min

float

境界ボックスの左端の座標。

x_max

float

境界ボックスの右端の座標。

y_min

float

境界ボックスの最上位の座標。

y_max

float

境界ボックスの一番下の座標。

DetectedObject

各 DetectedObject は、AnnotationSpec id と display_name、境界ボックス、関連する信頼スコア、対応する track_id で指定されたオブジェクトの特定の識別子です。

フィールド
id

string

識別された AnnotationSpec のリソース ID。

display_name

string

識別された AnnotationSpec の表示名。

bounding_box

BoundingBox

Boundingbox。

confidence

float

この識別結果の修正に対するモデルの信頼度。値が大きいほど、信頼度が高くなります。

track_id

int64

同じオブジェクトが、通常は隣接する複数のフレームで識別される場合があります。特定のオブジェクトが検出されたフレームのセットがトラックを形成します。この track_id を使用して、検出されたオブジェクトのすべてのフレームをトレースできます。

VideoStreamInputConfig

動画ストリーム入力構成を説明するメッセージ。このメッセージは、builtin:stream-input プロセッサのプレースホルダとしてのみ使用してください。実際のストリーム バインディングは、対応する API を使用して指定する必要があります。

フィールド
streams[]
(deprecated)

string

streams_with_annotation[]
(deprecated)

StreamWithAnnotation

ViewCollectionItemsRequest

ViewCollectionItems に対するリクエスト メッセージです。

フィールド
collection

string

必須。表示するコレクション。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

page_size

int32

返されるコレクションの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 50 個のコレクションが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

前回の ViewCollectionItemsRequest 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ViewCollectionItemsRequest に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ViewCollectionItemsResponse

ViewCollectionItems に対するレスポンス メッセージです。

フィールド
items[]

CollectionItem

指定されたコレクションのアイテム。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ViewIndexedAssetsRequest

ViewIndexedAssets に対するリクエスト メッセージです。

フィールド
index

string

必須。このアセット コレクションを所有するインデックス。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

page_size

int32

返されるアセット数の上限。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のアセットが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

前回の ViewIndexedAssets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ViewIndexedAssets に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

filter

string

返されたリストに適用されたフィルタ。サポートされているフィルタは、「asset_id = xxxx」のみです。指定した ID のアセットが返されます。「asset_id = xxxx, yyyy, zzzz」: 指定された ID のアセットを返します。

ViewIndexedAssetsResponse

ViewIndexedAssets に対するレスポンス メッセージ。

フィールド
indexed_assets[]

IndexedAsset

指定したインデックスのアセット。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

WatchEventsRequest

WatchEventsRequest には、ウォッチャーの ID と、ウォッチャーが関心を持っているイベントのフィルタが含まれます。

フィールド
cluster

string

リソースの親。

watcher_id

string

一意の ID により、ストリームの視聴者が識別されます。

streams[]

string

視聴するストリームの名前またはストリームのセット。

event_update_filter

EventUpdateFilter

ウォッチャーが受け取るイベントの更新を指定できるフィルタ。

heartbeat_interval_second

float

HeartbeatIntervalSecond は、gRPC ストリーミング サーバーから返されるハートビート レスポンスの間隔(秒単位)を定義します。デフォルトの 0 は、ハートビートなしを意味します。

WatchEventsResponse

各レスポンス メッセージには、1 件のイベントの更新が含まれます。

フィールド
update_type

EventUpdateType

イベントの更新のタイプ。

stream

string

イベントが関連付けられているストリームの名前。

event

string

イベントの名前。

series

string

シリーズの名前。

update_time

Timestamp

イベントの更新が発生したタイムスタンプ。