Package google.cloud.visionai.v1

Index

AppPlatform

Service describing handlers for resources

AddApplicationStreamInput

rpc AddApplicationStreamInput(AddApplicationStreamInputRequest) returns (Operation)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateApplication

rpc CreateApplication(CreateApplicationRequest) returns (Operation)

Creates a new Application in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateApplicationInstances

rpc CreateApplicationInstances(CreateApplicationInstancesRequest) returns (Operation)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateDraft

rpc CreateDraft(CreateDraftRequest) returns (Operation)

Creates a new Draft in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateProcessor

rpc CreateProcessor(CreateProcessorRequest) returns (Operation)

Creates a new Processor in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteApplication

rpc DeleteApplication(DeleteApplicationRequest) returns (Operation)

Deletes a single Application.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteApplicationInstances

rpc DeleteApplicationInstances(DeleteApplicationInstancesRequest) returns (Operation)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteDraft

rpc DeleteDraft(DeleteDraftRequest) returns (Operation)

Deletes a single Draft.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteProcessor

rpc DeleteProcessor(DeleteProcessorRequest) returns (Operation)

Deletes a single Processor.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeployApplication

rpc DeployApplication(DeployApplicationRequest) returns (Operation)

Deploys a single Application.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetApplication

rpc GetApplication(GetApplicationRequest) returns (Application)

Gets details of a single Application.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetDraft

rpc GetDraft(GetDraftRequest) returns (Draft)

Gets details of a single Draft.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Gets details of a single Instance.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetProcessor

rpc GetProcessor(GetProcessorRequest) returns (Processor)

Gets details of a single Processor.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListApplications

rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse)

Lists Applications in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListDrafts

rpc ListDrafts(ListDraftsRequest) returns (ListDraftsResponse)

Lists Drafts in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Lists Instances in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListPrebuiltProcessors

rpc ListPrebuiltProcessors(ListPrebuiltProcessorsRequest) returns (ListPrebuiltProcessorsResponse)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListProcessors

rpc ListProcessors(ListProcessorsRequest) returns (ListProcessorsResponse)

Lists Processors in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

RemoveApplicationStreamInput

rpc RemoveApplicationStreamInput(RemoveApplicationStreamInputRequest) returns (Operation)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UndeployApplication

rpc UndeployApplication(UndeployApplicationRequest) returns (Operation)

Undeploys a single Application.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateApplication

rpc UpdateApplication(UpdateApplicationRequest) returns (Operation)

Updates the parameters of a single Application.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateApplicationInstances

rpc UpdateApplicationInstances(UpdateApplicationInstancesRequest) returns (Operation)

Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateApplicationStreamInput

rpc UpdateApplicationStreamInput(UpdateApplicationStreamInputRequest) returns (Operation)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateDraft

rpc UpdateDraft(UpdateDraftRequest) returns (Operation)

Updates the parameters of a single Draft.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateProcessor

rpc UpdateProcessor(UpdateProcessorRequest) returns (Operation)

Updates the parameters of a single Processor.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

EventDiscoveryService

Below is the new version of Event Discovery Service. Will deprecate the EventWatcher once we migrate all the usage to the new EventDiscoveryService. This is the event discovery APIs for clients to discover event updates happening on streams.

WatchEvents

rpc WatchEvents(WatchEventsRequest) returns (WatchEventsResponse)

Watch for event updates happening on the given streams.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the cluster resource:

  • visionai.clusters.watch

For more information, see the IAM documentation.

LiveVideoAnalytics

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

CreateAnalysis

rpc CreateAnalysis(CreateAnalysisRequest) returns (Operation)

Creates a new Analysis in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateProcess

rpc CreateProcess(CreateProcessRequest) returns (Operation)

Creates a new Process in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteAnalysis

rpc DeleteAnalysis(DeleteAnalysisRequest) returns (Operation)

Deletes a single Analysis.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteProcess

rpc DeleteProcess(DeleteProcessRequest) returns (Operation)

Deletes a single Process.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetAnalysis

rpc GetAnalysis(GetAnalysisRequest) returns (Analysis)

Gets details of a single Analysis.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetProcess

rpc GetProcess(GetProcessRequest) returns (Process)

Gets details of a single Process.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListAnalyses

rpc ListAnalyses(ListAnalysesRequest) returns (ListAnalysesResponse)

Lists Analyses in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListProcesses

rpc ListProcesses(ListProcessesRequest) returns (ListProcessesResponse)

Lists Processes in a given project and location.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateAnalysis

rpc UpdateAnalysis(UpdateAnalysisRequest) returns (Operation)

Updates the parameters of a single Analysis.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateProcess

rpc UpdateProcess(UpdateProcessRequest) returns (Operation)

Updates the parameters of a single Process.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

RetailService

Service enables clients to manage Store Vision retail resources.

SmartDeviceService

Service describing handlers for resources

StreamingService

Streaming service for receiving and sending packets.

StreamsService

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

Warehouse

Service that manages media content + metadata for streaming.

AddCollectionItem

rpc AddCollectionItem(AddCollectionItemRequest) returns (AddCollectionItemResponse)

Adds an item into a Collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AnalyzeAsset

rpc AnalyzeAsset(AnalyzeAssetRequest) returns (Operation)

Analyze asset to power search capability.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.analyze

For more information, see the IAM documentation.

AnalyzeCorpus

rpc AnalyzeCorpus(AnalyzeCorpusRequest) returns (Operation)

Analyzes a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.corpora.analyze

For more information, see the IAM documentation.

ClipAsset

rpc ClipAsset(ClipAssetRequest) returns (ClipAssetResponse)

Generates clips for downloading. The api takes in a time range, and generates a clip of the first content available after start_time and before end_time, which may overflow beyond these bounds. Returned clips are truncated if the total size of the clips are larger than 100MB.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.clip

For more information, see the IAM documentation.

CreateAnnotation

rpc CreateAnnotation(CreateAnnotationRequest) returns (Annotation)

Creates annotation inside asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.annotations.create

For more information, see the IAM documentation.

CreateAsset

rpc CreateAsset(CreateAssetRequest) returns (Asset)

Creates an asset inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.assets.create

For more information, see the IAM documentation.

CreateCollection

rpc CreateCollection(CreateCollectionRequest) returns (Operation)

Creates a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateCorpus

rpc CreateCorpus(CreateCorpusRequest) returns (Operation)

Creates a corpus inside a project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.corpora.create

For more information, see the IAM documentation.

CreateDataSchema

rpc CreateDataSchema(CreateDataSchemaRequest) returns (DataSchema)

Creates data schema inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.dataSchemas.create

For more information, see the IAM documentation.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Creates an Index under the corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.indexes.create

For more information, see the IAM documentation.

CreateIndexEndpoint

rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (Operation)

Creates an IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.indexEndpoints.create

For more information, see the IAM documentation.

CreateSearchConfig

rpc CreateSearchConfig(CreateSearchConfigRequest) returns (SearchConfig)

Creates a search configuration inside a corpus.

Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules --- 1. Request.search_config_id must not be associated with an existing SearchConfig. 2. Request must contain at least one non-empty search_criteria_property or facet_property. 3. mapped_fields must not be empty, and must map to existing UGA keys. 4. All mapped_fields must be of the same type. 5. All mapped_fields must share the same granularity. 6. All mapped_fields must share the same semantic SearchConfig match options. For property-specific rules, please reference the comments for FacetProperty and SearchCriteriaProperty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.searchConfigs.create

For more information, see the IAM documentation.

CreateSearchHypernym

rpc CreateSearchHypernym(CreateSearchHypernymRequest) returns (SearchHypernym)

Creates a SearchHypernym inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteAnnotation

rpc DeleteAnnotation(DeleteAnnotationRequest) returns (Empty)

Deletes annotation inside asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.annotations.delete

For more information, see the IAM documentation.

DeleteAsset

rpc DeleteAsset(DeleteAssetRequest) returns (Operation)

Deletes asset inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.delete

For more information, see the IAM documentation.

DeleteCollection

rpc DeleteCollection(DeleteCollectionRequest) returns (Operation)

Deletes a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteCorpus

rpc DeleteCorpus(DeleteCorpusRequest) returns (Empty)

Deletes a corpus only if its empty. Returns empty response.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.corpora.delete

For more information, see the IAM documentation.

DeleteDataSchema

rpc DeleteDataSchema(DeleteDataSchemaRequest) returns (Empty)

Deletes data schema inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.dataSchemas.delete

For more information, see the IAM documentation.

DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Operation)

Delete a single Index. In order to delete an index, the caller must make sure that it is not deployed to any index endpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexes.delete

For more information, see the IAM documentation.

DeleteIndexEndpoint

rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (Operation)

Deletes an IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexEndpoints.delete

For more information, see the IAM documentation.

DeleteSearchConfig

rpc DeleteSearchConfig(DeleteSearchConfigRequest) returns (Empty)

Deletes a search configuration inside a corpus.

For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.searchConfigs.delete

For more information, see the IAM documentation.

DeleteSearchHypernym

rpc DeleteSearchHypernym(DeleteSearchHypernymRequest) returns (Empty)

Deletes a SearchHypernym inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeployIndex

rpc DeployIndex(DeployIndexRequest) returns (Operation)

Deploys an Index to IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the indexEndpoint resource:

  • visionai.indexEndpoints.deploy

For more information, see the IAM documentation.

GenerateHlsUri

rpc GenerateHlsUri(GenerateHlsUriRequest) returns (GenerateHlsUriResponse)

Generates a uri for an HLS manifest. The api takes in a collection of time ranges, and generates a URI for an HLS manifest that covers all the requested time ranges.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.generateHlsUri

For more information, see the IAM documentation.

GenerateRetrievalUrl

rpc GenerateRetrievalUrl(GenerateRetrievalUrlRequest) returns (GenerateRetrievalUrlResponse)

Generates a signed url for downloading the asset. For video warehouse, please see comment of UploadAsset about how to allow retrieval of cloud storage files in a different project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetAnnotation

rpc GetAnnotation(GetAnnotationRequest) returns (Annotation)

Reads annotation inside asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.annotations.get

For more information, see the IAM documentation.

GetAsset

rpc GetAsset(GetAssetRequest) returns (Asset)

Reads an asset inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.get

For more information, see the IAM documentation.

GetCollection

rpc GetCollection(GetCollectionRequest) returns (Collection)

Gets a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetCorpus

rpc GetCorpus(GetCorpusRequest) returns (Corpus)

Gets corpus details inside a project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.corpora.get

For more information, see the IAM documentation.

GetDataSchema

rpc GetDataSchema(GetDataSchemaRequest) returns (DataSchema)

Gets data schema inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.dataSchemas.get

For more information, see the IAM documentation.

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Gets the details of a single Index under a Corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexes.get

For more information, see the IAM documentation.

GetIndexEndpoint

rpc GetIndexEndpoint(GetIndexEndpointRequest) returns (IndexEndpoint)

Gets an IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexEndpoints.get

For more information, see the IAM documentation.

GetSearchConfig

rpc GetSearchConfig(GetSearchConfigRequest) returns (SearchConfig)

Gets a search configuration inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.searchConfigs.get

For more information, see the IAM documentation.

GetSearchHypernym

rpc GetSearchHypernym(GetSearchHypernymRequest) returns (SearchHypernym)

Gets a SearchHypernym inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ImportAssets

rpc ImportAssets(ImportAssetsRequest) returns (Operation)

Imports assets (images plus annotations) from a meta file on cloud storage. Each row in the meta file is corresponding to an image (specified by a cloud storage uri) and its annotations.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.corpora.import

For more information, see the IAM documentation.

IndexAsset

rpc IndexAsset(IndexAssetRequest) returns (Operation)

Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the index resource:

  • visionai.indexes.update

Requires the following IAM permission on the name resource:

  • visionai.assets.index

For more information, see the IAM documentation.

IngestAsset

rpc IngestAsset(IngestAssetRequest) returns (IngestAssetResponse)

Ingests data for the asset. It is not allowed to ingest a data chunk which is already expired according to TTL. This method is only available via the gRPC API (not HTTP since bi-directional streaming is not supported via HTTP).

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the asset resource:

  • visionai.assets.ingest

For more information, see the IAM documentation.

ListAnnotations

rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse)

Lists a list of annotations inside asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.annotations.list

For more information, see the IAM documentation.

ListAssets

rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse)

Lists an list of assets inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.assets.list

For more information, see the IAM documentation.

ListCollections

rpc ListCollections(ListCollectionsRequest) returns (ListCollectionsResponse)

Lists collections inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListCorpora

rpc ListCorpora(ListCorporaRequest) returns (ListCorporaResponse)

Lists all corpora in a project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.corpora.list

For more information, see the IAM documentation.

ListDataSchemas

rpc ListDataSchemas(ListDataSchemasRequest) returns (ListDataSchemasResponse)

Lists a list of data schemas inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.dataSchemas.list

For more information, see the IAM documentation.

ListIndexEndpoints

rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse)

Lists all IndexEndpoints in a project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.indexEndpoints.list

For more information, see the IAM documentation.

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

List all Indexes in a given Corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.indexes.list

For more information, see the IAM documentation.

ListSearchConfigs

rpc ListSearchConfigs(ListSearchConfigsRequest) returns (ListSearchConfigsResponse)

Lists all search configurations inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.searchConfigs.list

For more information, see the IAM documentation.

ListSearchHypernyms

rpc ListSearchHypernyms(ListSearchHypernymsRequest) returns (ListSearchHypernymsResponse)

Lists SearchHypernyms inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

RemoveCollectionItem

rpc RemoveCollectionItem(RemoveCollectionItemRequest) returns (RemoveCollectionItemResponse)

Removes an item from a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

RemoveIndexAsset

rpc RemoveIndexAsset(RemoveIndexAssetRequest) returns (Operation)

Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the index resource:

  • visionai.indexes.update

Requires the following IAM permission on the name resource:

  • visionai.assets.removeIndex

For more information, see the IAM documentation.

SearchAssets

rpc SearchAssets(SearchAssetsRequest) returns (SearchAssetsResponse)

Search media asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the corpus resource:

  • visionai.assets.search

For more information, see the IAM documentation.

SearchIndexEndpoint

rpc SearchIndexEndpoint(SearchIndexEndpointRequest) returns (SearchIndexEndpointResponse)

Search a deployed index endpoint (IMAGE corpus type only).

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the indexEndpoint resource:

  • visionai.indexEndpoints.search

For more information, see the IAM documentation.

UndeployIndex

rpc UndeployIndex(UndeployIndexRequest) returns (Operation)

Undeploys an Index from IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the indexEndpoint resource:

  • visionai.indexEndpoints.undeploy

For more information, see the IAM documentation.

UpdateAnnotation

rpc UpdateAnnotation(UpdateAnnotationRequest) returns (Annotation)

Updates annotation inside asset.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.annotations.update

For more information, see the IAM documentation.

UpdateAsset

rpc UpdateAsset(UpdateAssetRequest) returns (Asset)

Updates an asset inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.update

For more information, see the IAM documentation.

UpdateCollection

rpc UpdateCollection(UpdateCollectionRequest) returns (Collection)

Updates a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateCorpus

rpc UpdateCorpus(UpdateCorpusRequest) returns (Corpus)

Updates a corpus in a project.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.corpora.update

For more information, see the IAM documentation.

UpdateDataSchema

rpc UpdateDataSchema(UpdateDataSchemaRequest) returns (DataSchema)

Updates data schema inside corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.dataSchemas.update

For more information, see the IAM documentation.

UpdateIndex

rpc UpdateIndex(UpdateIndexRequest) returns (Operation)

Updates an Index under the corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexes.update

For more information, see the IAM documentation.

UpdateIndexEndpoint

rpc UpdateIndexEndpoint(UpdateIndexEndpointRequest) returns (Operation)

Updates an IndexEndpoint.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexEndpoints.update

For more information, see the IAM documentation.

UpdateSearchConfig

rpc UpdateSearchConfig(UpdateSearchConfigRequest) returns (SearchConfig)

Updates a search configuration inside a corpus.

Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules --- 1. Request.search_configuration.name must already exist. 2. Request must contain at least one non-empty search_criteria_property or facet_property. 3. mapped_fields must not be empty, and must map to existing UGA keys. 4. All mapped_fields must be of the same type. 5. All mapped_fields must share the same granularity. 6. All mapped_fields must share the same semantic SearchConfig match options. For property-specific rules, please reference the comments for FacetProperty and SearchCriteriaProperty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.searchConfigs.update

For more information, see the IAM documentation.

UpdateSearchHypernym

rpc UpdateSearchHypernym(UpdateSearchHypernymRequest) returns (SearchHypernym)

Updates a SearchHypernym inside a corpus.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UploadAsset

rpc UploadAsset(UploadAssetRequest) returns (Operation)

Upload asset by specifing the asset Cloud Storage uri. For video warehouse, it requires users who call this API have read access to the cloud storage file. Once it is uploaded, it can be retrieved by GenerateRetrievalUrl API which by default, only can retrieve cloud storage files from the same project of the warehouse. To allow retrieval cloud storage files that are in a separate project, it requires to find the vision ai service account (Go to IAM, check checkbox to show "Include Google-provided role grants", search for "Cloud Vision AI Service Agent") and grant the read access of the cloud storage files to that service account.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.assets.upload

For more information, see the IAM documentation.

ViewCollectionItems

rpc ViewCollectionItems(ViewCollectionItemsRequest) returns (ViewCollectionItemsResponse)

View items inside a collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ViewIndexedAssets

rpc ViewIndexedAssets(ViewIndexedAssetsRequest) returns (ViewIndexedAssetsResponse)

Lists a list of assets inside an index.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the index resource:

  • visionai.indexes.viewAssets

For more information, see the IAM documentation.

AIEnabledDevicesInputConfig

This type has no fields.

Message describing AI-enabled Devices Input Config.

AcceleratorType

Represents a hardware accelerator type.

Enums
ACCELERATOR_TYPE_UNSPECIFIED Unspecified accelerator type, which means no accelerator.
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.

AcquireLeaseRequest

Request message for acquiring a lease.

Fields
series

string

The series name.

owner

string

The owner name.

term

Duration

The lease term.

lease_type

LeaseType

The lease type.

AddApplicationStreamInputRequest

Message for adding stream input to an Application.

Fields
name

string

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

application_stream_inputs[]

ApplicationStreamInput

The stream inputs to add, the stream resource name is the key of each StreamInput, and it must be unique within each application.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

AddApplicationStreamInputResponse

This type has no fields.

Message for AddApplicationStreamInput Response.

AddCollectionItemRequest

Request message for AddCollectionItem.

Fields
item

CollectionItem

Required. The item to be added.

AddCollectionItemResponse

Response message for AddCollectionItem.

Fields
item

CollectionItem

The item that has already been added.

AddRetailProductsToRetailProductSetResponse

This type has no fields.

AddRetailProductsToRetailProductSet response once the operation is done.

Analysis

Message describing the Analysis object.

Fields
name

string

The name of resource.

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

labels

map<string, string>

Labels as key value pairs.

analysis_definition

AnalysisDefinition

The definition of the analysis.

input_streams_mapping

map<string, string>

Map from the input parameter in the definition to the real stream. E.g., suppose you had a stream source operator named "input-0" and you try to receive from the real stream "stream-0". You can add the following mapping: [input-0: stream-0].

output_streams_mapping

map<string, string>

Map from the output parameter in the definition to the real stream. E.g., suppose you had a stream sink operator named "output-0" and you try to send to the real stream "stream-0". You can add the following mapping: [output-0: stream-0].

disable_event_watch

bool

Boolean flag to indicate whether you would like to disable the ability to automatically start a Process when new event happening in the input Stream. If you would like to start a Process manually, the field needs to be set to true.

AnalysisDefinition

Defines a full analysis.

This is a description of the overall live analytics pipeline. You may think of this as an edge list representation of a multigraph.

This may be directly authored by a human in protobuf textformat, or it may be generated by a programming API (perhaps Python or JavaScript depending on context).

Fields
analyzers[]

AnalyzerDefinition

Analyzer definitions.

AnalyzeAssetMetadata

Metadata for AnalyzeAsset.

Fields
analysis_status[]

AnalysisStatus

The status of analysis on all search capabilities.

start_time

Timestamp

The start time of the operation.

update_time

Timestamp

The update time of the operation.

AnalysisStatus

The status of analysis on each search capability.

Fields
state

State

status_message

string

search_capability

SearchCapability

The search capability requested.

State

The state of the search capability.

Enums
STATE_UNSPECIFIED The default process state should never happen.
IN_PROGRESS The feature is in progress.
SUCCEEDED The process is successfully done.
FAILED The process failed.

AnalyzeAssetRequest

Request message for AnalyzeAsset.

Fields
name

string

Required. The resource name of the asset to analyze. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

AnalyzeAssetResponse

This type has no fields.

Response message for AnalyzeAsset.

AnalyzeCorpusMetadata

The metadata message for AnalyzeCorpus LRO.

Fields
metadata

OperationMetadata

The metadata of the operation.

AnalyzeCorpusRequest

Request message for AnalyzeCorpus.

Fields
name

string

Required. The parent corpus resource where the assets will be analyzed. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

AnalyzeCorpusResponse

This type has no fields.

The response message for AnalyzeCorpus LRO.

AnalyzerDefinition

Defines an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

Fields
analyzer

string

The name of this analyzer.

Tentatively [a-z][a-z0-9]*(_[a-z0-9]+)*.

operator

string

The name of the operator that this analyzer runs.

Must match the name of a supported operator.

inputs[]

StreamInput

Input streams.

attrs

map<string, AttributeValue>

The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

debug_options

DebugOptions

Debug options.

operator_option

OperatorOption

Operator option.

DebugOptions

Options available for debugging purposes only.

Fields
environment_variables

map<string, string>

Environment variables.

OperatorOption

Option related to the operator.

Fields
tag

string

Tag of the operator.

registry

string

Registry of the operator. e.g. public, dev.

StreamInput

The inputs to this analyzer.

We accept input name references of the following form: :

Example:

Suppose you had an operator named "SomeOp" that has 2 output arguments, the first of which is named "foo" and the second of which is named "bar", and an operator named "MyOp" that accepts 2 inputs.

Also suppose that there is an analyzer named "some-analyzer" that is running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".

To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" output as its first input and "some-analyzer"'s "bar" output as its second input, you can set this field to the following: input = ["some-analyzer:foo", "some-analyzer:bar"]

Fields
input

string

The name of the stream input (as discussed above).

Annotation

An annotation is a resource in asset. It represents a key-value mapping of content in asset.

Fields
name

string

Resource name of the annotation. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

user_specified_annotation

UserSpecifiedAnnotation

User provided annotation.

AnnotationCustomizedStruct

Customized struct represnation in annotation.

Fields
elements

map<string, AnnotationValue>

A map from elements' keys to element's annotation value.

AnnotationList

List representation in annotation.

Fields
values[]

AnnotationValue

The values of LIST data type annotation.

AnnotationMatchingResult

Stores the criteria-annotation matching results for each search result item.

Fields
criteria

Criteria

The criteria used for matching. It can be an input search criteria or a criteria converted from a facet selection.

matched_annotations[]

Annotation

Matched annotations for the criteria.

status

Status

Status of the match result. Possible values: FAILED_PRECONDITION - the criteria is not eligible for match. OK - matching is performed.

AnnotationValue

Value of annotation, including all types available in data schema.

Fields

Union field value.

value can be only one of the following:

int_value

int64

Value of int type annotation.

float_value

float

Value of float type annotation.

str_value

string

Value of string type annotation.

datetime_value

string

Value of date time type annotation.

geo_coordinate

GeoCoordinate

Value of geo coordinate type annotation.

proto_any_value

Any

Value of any proto value.

bool_value

bool

Value of boolean type annotation.

list_value

AnnotationList

Value of list type annotation.

customized_struct_value

AnnotationCustomizedStruct

Value of custom struct type annotation.

AppPlatformCloudFunctionRequest

For any cloud function based customer processing logic, customer's cloud function is expected to receive AppPlatformCloudFunctionRequest as request and send back AppPlatformCloudFunctionResponse as response. Message of request from AppPlatform to Cloud Function.

Fields
app_platform_metadata

AppPlatformMetadata

The metadata of the AppPlatform for customer to identify the source of the payload.

annotations[]

StructedInputAnnotation

The actual annotations to be processed by the customized Cloud Function.

StructedInputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

Fields
ingestion_time_micros

int64

The ingestion time of the current annotation.

annotation

Struct

The struct format of the actual annotation.

AppPlatformCloudFunctionResponse

Message of the response from customer's Cloud Function to AppPlatform.

Fields
annotations[]

StructedOutputAnnotation

The modified annotations that is returned back to AppPlatform. If the annotations fields are empty, then those annotations will be dropped by AppPlatform.

annotation_passthrough

bool

If set to true, AppPlatform will use original annotations instead of dropping them, even if it is empty in the annotations filed.

events[]

AppPlatformEventBody

The event notifications that is returned back to AppPlatform. Typically it will then be configured to be consumed/forwared to a operator that handles events, such as Pub/Sub operator.

StructedOutputAnnotation

A general annotation message that uses struct format to represent different concrete annotation protobufs.

Fields
annotation

Struct

The struct format of the actual annotation.

AppPlatformEventBody

Message of content of appPlatform event

Fields
event_message

string

Human readable string of the event like "There are more than 6 people in the scene". or "Shelf is empty!".

payload

Struct

For the case of Pub/Sub, it will be stored in the message attributes. ​​pubsub.proto

event_id

string

User defined Event Id, used to classify event, within a delivery interval, events from the same application instance with the same id will be de-duplicated & only first one will be sent out. Empty event_id will be treated as "".

AppPlatformMetadata

Message of essential metadata of App Platform. This message is usually attached to a certain processor output annotation for customer to identify the source of the data.

Fields
application

string

The application resource name.

instance_id

string

The instance resource id. Instance is the nested resource of application under collection 'instances'.

node

string

The node name of the application graph.

processor

string

The referred processor resource name of the application node.

Application

Message describing Application object

Fields
name

string

name of resource

create_time

Timestamp

Output only. [Output only] Create timestamp

update_time

Timestamp

Output only. [Output only] Update timestamp

labels

map<string, string>

Labels as key value pairs

display_name

string

Required. A user friendly display name for the solution.

description

string

A description for this application.

application_configs

ApplicationConfigs

Application graph configuration.

runtime_info

ApplicationRuntimeInfo

Output only. Application graph runtime info. Only exists when application state equals to DEPLOYED.

state

State

Output only. State of the application.

billing_mode

BillingMode

Billing mode of the application.

ApplicationRuntimeInfo

Message storing the runtime information of the application.

Fields
deploy_time

Timestamp

Timestamp when the engine be deployed

global_output_resources[]

GlobalOutputResource

Globally created resources like warehouse dataschemas.

monitoring_config

MonitoringConfig

Monitoring-related configuration for this application.

GlobalOutputResource

Message about output resources from application.

Fields
output_resource

string

The full resource name of the outputted resources.

producer_node

string

The name of graph node who produces the output resource name. For example: output_resource: /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema producer_node: occupancy-count

key

string

The key of the output resource, it has to be unique within the same producer node. One producer node can output several output resources, the key can be used to match corresponding output resources.

MonitoringConfig

Monitoring-related configuration for an application.

Fields
enabled

bool

Whether this application has monitoring enabled.

BillingMode

Billing mode of the Application

Enums
BILLING_MODE_UNSPECIFIED The default value.
PAYG Pay as you go billing mode.
MONTHLY Monthly billing mode.

State

State of the Application

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
CREATED State CREATED.
DEPLOYING State DEPLOYING.
DEPLOYED State DEPLOYED.
UNDEPLOYING State UNDEPLOYING.
DELETED State DELETED.
ERROR State ERROR.
CREATING State CREATING.
UPDATING State Updating.
DELETING State Deleting.
FIXING State Fixing.

ApplicationConfigs

Message storing the graph of the application.

Fields
nodes[]

Node

A list of nodes in the application graph.

ApplicationInstance

Message for creating a Instance.

Fields
instance_id

string

Required. Id of the requesting object.

instance

Instance

Required. The resource being created.

ApplicationNodeAnnotation

Message describing annotations specific to application node. This message is a duplication of StreamWithAnnotation.NodeAnnotation.

Fields
node

string

The node name of the application graph.

annotations[]

StreamAnnotation

The node specific stream annotations.

ApplicationStreamInput

Message about a single stream input config.

Fields
stream_with_annotation

StreamWithAnnotation

Asset

An asset is a resource in corpus. It represents a media object inside corpus, contains metadata and another resource annotation. Different feature could be applied to the asset to generate annotations. User could specified annotation related to the target asset.

Fields
name

string

Resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ttl

Duration

The duration for which all media assets, associated metadata, and search documents can exist. If not set, then it will using the default ttl in the parent corpus resource.

asset_gcs_source

AssetGcsSource

Output only. The original cloud storage source uri that is associated with this asset.

AssetSource

The source of the asset.

Fields

Union field source_form.

source_form can be only one of the following:

asset_gcs_source

AssetGcsSource

The source of the asset is from Cloud Storage.

asset_content_data

AssetContentData

The source of the asset is from content bytes.

AssetContentData

The content of the asset.

Fields
asset_content_data

bytes

AssetGcsSource

The asset source is from Cloud Storage.

Fields
gcs_uri

string

Cloud storage uri.

AttributeValue

Represents an actual value of an operator attribute.

Fields
Union field value. Attribute value. value can be only one of the following:
i

int64

int.

f

float

float.

b

bool

bool.

s

bytes

string.

AutoscalingMetricSpec

The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.

Fields
metric_name

string

Required. The resource metric name. Supported metrics:

  • For Online Prediction:
  • aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle
  • aiplatform.googleapis.com/prediction/online/cpu/utilization
target

int32

The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.

BatchRunProcessRequest

Request message for running the processes in a batch.

Fields
parent

string

Required. The parent resource shared by all processes being created.

requests[]

CreateProcessRequest

Required. The create process requests.

options

BatchRunProcessOptions

Optional. Options for batch processes.

batch_id

string

Output only. The batch ID.

BatchRunProcessOptions

Options for batch processes.

Fields
retry_count

int32

The retry counts per process. Default: 3.

batch_size

int32

The batch size. Default: 5, maximum: 100.

BatchRunProcessResponse

Response message for running the processes in a batch.

Fields
batch_id

string

The batch ID.

processes[]

Process

Processes created.

BigQueryConfig

Message of configurations for BigQuery processor.

Fields
table

string

BigQuery table resource for Vision AI Platform to ingest annotations to.

cloud_function_mapping

map<string, string>

Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema:

ingestion_time: TIMESTAMP, the ingestion time of the original data.

application: STRING, name of the application which produces the annotation.

instance: STRING, Id of the instance which produces the annotation.

node: STRING, name of the application graph node which produces the annotation.

annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column.

To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery.

If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction. * The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation. * The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field. * To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse.

create_default_table_if_not_exists

bool

If true, App Platform will create the BigQuery DataSet and the BigQuery Table with default schema if the specified table doesn't exist. This doesn't work if any cloud function customized schema is specified since the system doesn't know your desired schema. JSON column will be used in the default table created by App Platform.

BoolValue

Fields
value

bool

Channel

Message describing the Channel object.

Fields
name

string

Name of the resource.

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

labels

map<string, string>

Labels as key value pairs.

annotations

map<string, string>

Annotations to allow clients to store small amounts of arbitrary data.

stream

string

Required. Stream that is associated with this series.

event

string

Required. Event that is associated with this series.

CircleArea

Representation of a circle area.

Fields
latitude

double

Latitude of circle area's center. Degrees [-90 .. 90]

longitude

double

Longitude of circle area's center. Degrees [-180 .. 180]

radius_meter

double

Radius of the circle area in meters.

ClassificationPredictionResult

Prediction output format for Image and Text Classification.

Fields
ids[]

int64

The resource IDs of the AnnotationSpecs that had been identified.

display_names[]

string

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

confidences[]

float

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

ClipAssetRequest

Request message for ClipAsset API.

Fields
name

string

Required. The resource name of the asset to request clips for. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

temporal_partition

TemporalPartition

Required. The time range to request clips for.

ClipAssetResponse

Response message for ClipAsset API.

Fields
time_indexed_uris[]

TimeIndexedUri

A list of signed uris to download the video clips that cover the requested time range ordered by time.

TimeIndexedUri

Signed uri with corresponding time range.

Fields
temporal_partition

TemporalPartition

Time range of the video that the uri is for.

uri

string

Signed uri to download the video clip.

Cluster

Message describing the Cluster object.

Fields
name

string

Output only. Name of the resource.

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

labels

map<string, string>

Labels as key value pairs

annotations

map<string, string>

Annotations to allow clients to store small amounts of arbitrary data.

dataplane_service_endpoint

string

Output only. The DNS name of the data plane service

state

State

Output only. The current state of the cluster.

psc_target

string

Output only. The private service connection service target name.

State

The current state of the cluster.

Enums
STATE_UNSPECIFIED Not set.
PROVISIONING The PROVISIONING state indicates the cluster is being created.
RUNNING The RUNNING state indicates the cluster has been created and is fully usable.
STOPPING The STOPPING state indicates the cluster is being deleted.
ERROR The ERROR state indicates the cluster is unusable. It will be automatically deleted.

ClusterInfo

Fields
streams_count

int32

The number of active streams in the cluster.

processes_count

int32

The number of active processes in the cluster.

Collection

A collection is a resource in a corpus. It serves as a container of references to original resources.

Fields
name

string

Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

display_name

string

Optional. The collection name for displaying. The name can be up to 256 characters long.

description

string

Optional. Description of the collection. Can be up to 25000 characters long.

CollectionItem

A CollectionItem is an item in a collection. Each item is a reference to the original resource in a collection.

Fields
collection

string

Required. The collection name that this item belongs to. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

type

Type

Required. The type of item.

item_resource

string

Required. The name of the CollectionItem. Its format depends on the type above. For ASSET: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

Type

CollectionItem types.

Enums
TYPE_UNSPECIFIED The default type of item should never happen.
ASSET Asset type item.

CommitRequest

The message for explicitly committing the read progress.

This may only be used when ReceivePacketsControlledMode is set in the initial setup request.

Fields
offset

int64

The offset to commit.

ControlledMode

The options for receiver under the controlled mode.

Fields
fallback_starting_offset

string

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

Union field starting_offset. This is the offset from which to start receiveing. starting_offset can be only one of the following:
starting_logical_offset

string

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

Corpus

Corpus is a set of media contents for management. Within a corpus, media shares the same data schema. Search is also restricted within a single corpus.

Fields
name

string

Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

display_name

string

Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

description

string

Optional. Description of the corpus. Can be up to 25000 characters long.

default_ttl

Duration

Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.

type

Type

Optional. Type of the asset inside corpus.

search_capability_setting

SearchCapabilitySetting

Default search capability setting on corpus level.

Type

Type of the asset inside the corpus.

Enums
TYPE_UNSPECIFIED The default type, not supposed to be used. If this default type is used, the corpus will be created as STREAM_VIDEO corpus.
STREAM_VIDEO Asset is a live streaming video asset.
IMAGE Asset is an image.
VIDEO_ON_DEMAND Asset is a video asset.

CreateAnalysisRequest

Message for creating an Analysis.

Fields
parent

string

Required. Value for parent.

analysis_id

string

Required. Id of the requesting object.

analysis

Analysis

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateAnnotationRequest

Request message for CreateAnnotation.

Fields
parent

string

Required. The parent resource where this annotation will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

annotation

Annotation

Required. The annotation to create.

annotation_id

string

Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify. Otherwise, annotation id will be generated by system.

This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

CreateApplicationInstancesRequest

Message for adding stream input to an Application.

Fields
name

string

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

application_instances[]

ApplicationInstance

Required. The resources being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateApplicationInstancesResponse

This type has no fields.

Message for CreateApplicationInstance Response.

CreateApplicationRequest

Message for creating a Application.

Fields
parent

string

Required. Value for parent.

application_id

string

Required. Id of the requesting object.

application

Application

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateAssetRequest

Request message for CreateAssetRequest.

Fields
parent

string

Required. The parent resource where this asset will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

asset

Asset

Required. The asset to create.

asset_id

string

Optional. The ID to use for the asset, which will become the final component of the asset's resource name if user choose to specify. Otherwise, asset id will be generated by system.

This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

CreateClusterRequest

Message for creating a Cluster.

Fields
parent

string

Required. Value for parent.

cluster_id

string

Required. Id of the requesting object.

cluster

Cluster

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateCollectionMetadata

Metadata message for CreateCollectionRequest

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

CreateCollectionRequest

Request message for CreateCollection.

Fields
parent

string

Required. The parent resource where this collection will be created. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

collection

Collection

Required. The collection resource to be created.

collection_id

string

Optional. The ID to use for the collection, which will become the final component of the resource name if user choose to specify. Otherwise, collection id will be generated by system.

This value should be up to 55 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

CreateCorpusMetadata

Metadata for CreateCorpus API.

Fields
create_time

Timestamp

The create time of the create corpus operation.

update_time

Timestamp

The update time of the create corpus operation.

CreateCorpusRequest

Request message of CreateCorpus API.

Fields
parent

string

Required. Form: projects/{project_number}/locations/{location_id}

corpus

Corpus

Required. The corpus to be created.

CreateDataSchemaRequest

Request message for CreateDataSchema.

Fields
parent

string

Required. The parent resource where this data schema will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

data_schema

DataSchema

Required. The data schema to create.

CreateDraftRequest

Message for creating a Draft.

Fields
parent

string

Required. Value for parent.

draft_id

string

Required. Id of the requesting object.

draft

Draft

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateEventRequest

Message for creating a Event.

Fields
parent

string

Required. Value for parent.

event_id

string

Required. Id of the requesting object.

event

Event

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateIndexEndpointMetadata

Metadata message for CreateIndexEndpoint.

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

CreateIndexEndpointRequest

Request message for CreateIndexEndpoint.

Fields
parent

string

Required. Format: projects/{project}/locations/{location}

index_endpoint_id

string

Optional. The ID to use for the IndexEndpoint, which will become the final component of the IndexEndpoint's resource name if the user specifies it. Otherwise, IndexEndpoint id will be autogenerated.

This value should be up to 63 characters, and valid characters are a-z, 0-9 and dash (-). The first character must be a letter, the last must be a letter or a number.

index_endpoint

IndexEndpoint

Required. The resource being created.

CreateIndexMetadata

Metadata message for CreateIndexRequest

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

CreateIndexRequest

Message for creating an Index.

Fields
parent

string

Required. Value for the parent. The resource name of the Corpus under which this index is created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

index_id

string

Optional. The ID for the index. This will become the final resource name for the index. If the user does not specify this value, it will be generated by system.

This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

index

Index

Required. The index being created.

CreateOperatorRequest

Message for creating a Operator.

Fields
parent

string

Required. Value for parent.

operator_id

string

Required. Id of the requesting object.

operator

Operator

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateProcessRequest

Message for creating a Process.

Fields
parent

string

Required. Value for parent.

process_id

string

Required. Id of the requesting object.

process

Process

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateProcessorRequest

Message for creating a Processor.

Fields
parent

string

Required. Value for parent.

processor_id

string

Required. Id of the requesting object.

processor

Processor

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateSearchConfigRequest

Request message for CreateSearchConfig.

Fields
parent

string

Required. The parent resource where this search configuration will be created. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

search_config

SearchConfig

Required. The search config to create.

search_config_id

string

Required. ID to use for the new search config. Will become the final component of the SearchConfig's resource name. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-_/. The first character must be a letter, the last could be a letter or a number.

CreateSearchHypernymRequest

Request message for creating SearchHypernym.

Fields
parent

string

Required. The parent resource where this SearchHypernym will be created. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

search_hypernym

SearchHypernym

Required. The SearchHypernym to create.

search_hypernym_id

string

Optional. The search hypernym id. If omitted, a random UUID will be generated.

CreateSeriesRequest

Message for creating a Series.

Fields
parent

string

Required. Value for parent.

series_id

string

Required. Id of the requesting object.

series

Series

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateStreamRequest

Message for creating a Stream.

Fields
parent

string

Required. Value for parent.

stream_id

string

Required. Id of the requesting object.

stream

Stream

Required. The resource being created.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Criteria

Filter criteria applied to current search results.

Fields
field

string

The UGA field or ML field to apply filtering criteria.

fetch_matched_annotations

bool

If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types: - INTEGER - FLOAT - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) - BOOLEAN

Union field value.

value can be only one of the following:

text_array

StringArray

The text values associated with the field.

int_range_array

IntRangeArray

The integer ranges associated with the field.

float_range_array

FloatRangeArray

The float ranges associated with the field.

date_time_range_array

DateTimeRangeArray

The datetime ranges associated with the field.

geo_location_array

GeoLocationArray

Geo Location array.

bool_value

BoolValue

A Boolean value.

CustomProcessorSourceInfo

Describes the source info for a custom processor.

Fields
source_type

SourceType

The original product which holds the custom processor's functionality.

additional_info

map<string, string>

Output only. Additional info related to the imported custom processor. Data is filled in by app platform during the processor creation.

model_schema

ModelSchema

Model schema files which specifies the signature of the model. For VERTEX_CUSTOM models, instances schema is required. If instances schema is not specified during the processor creation, VisionAI Platform will try to get it from Vertex, if it doesn't exist, the creation will fail.

Union field artifact_path. The path where App Platform loads the artifacts for the custom processor. artifact_path can be only one of the following:
vertex_model

string

The resource name original model hosted in the vertex AI platform.

product_recognizer_artifact

ProductRecognizerArtifact

Artifact for product recognizer.

ModelSchema

The schema is defined as an OpenAPI 3.0.2 Schema Object.

Fields
instances_schema

GcsSource

Cloud Storage location to a YAML file that defines the format of a single instance used in prediction and explanation requests.

parameters_schema

GcsSource

Cloud Storage location to a YAML file that defines the prediction and explanation parameters.

predictions_schema

GcsSource

Cloud Storage location to a YAML file that defines the format of a single prediction or explanation.

ProductRecognizerArtifact

Message describes product recognizer artifact.

Fields
retail_product_recognition_index

string

Required. Resource name of RetailProductRecognitionIndex. Format is 'projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*'

vertex_model

string

Optional. The resource name of embedding model hosted in Vertex AI Platform.

SourceType

Source type of the imported custom processor.

Enums
SOURCE_TYPE_UNSPECIFIED Source type unspecified.
VERTEX_AUTOML Custom processors coming from Vertex AutoML product.
VERTEX_CUSTOM Custom processors coming from general custom models from Vertex.
PRODUCT_RECOGNIZER Source for Product Recognizer.

DataSchema

Data schema indicates how the user specified annotation is interpreted in the system.

Fields
name

string

Resource name of the data schema in the form of: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema} where {data_schema} part should be the same as the key field below.

key

string

Required. The key of this data schema. This key should be matching the key of user specified annotation and unique inside corpus. This value can be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number.

schema_details

DataSchemaDetails

The schema details mapping to the key.

DataSchemaDetails

Data schema details indicates the data type and the data struct corresponding to the key of user specified annotation.

Fields
type

DataType

Type of the annotation.

proto_any_config

ProtoAnyConfig

Config for protobuf any type.

list_config

ListConfig

Config for List data type.

customized_struct_config

CustomizedStructConfig

Config for CustomizedStruct data type.

granularity

Granularity

The granularity associated with this DataSchema.

search_strategy

SearchStrategy

The search strategy to be applied on the key above.

CustomizedStructConfig

The configuration for CUSTOMIZED_STRUCT data type.

Fields
field_schemas

map<string, DataSchemaDetails>

Direct child elements data schemas.

DataType

Data type of the annotation.

Enums
DATA_TYPE_UNSPECIFIED Unspecified type.
INTEGER Integer type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by IntRangeArray.
FLOAT Float type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by FloatRangeArray.
STRING String type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME Supported formats: %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 Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by DateTimeRangeArray.
GEO_COORDINATE Geo coordinate type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by GeoLocationArray.
PROTO_ANY Type to pass any proto as available in annotations.proto. Only use internally. Available proto types and its corresponding search behavior: - ImageObjectDetectionPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH. - ClassificationPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH. - ImageSegmentationPredictionResult, allows NO_SEARCH. - VideoActionRecognitionPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - VideoObjectTrackingPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - VideoClassificationPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - OccupancyCountingPredictionResult, allows EXACT_SEARCH on stats.full_frame_count.count and NO_SEARCH. - ObjectDetectionPredictionResult, allows SMART_SEARCH on identified_boxes.entity.label_string and NO_SEARCH.
BOOLEAN Boolean type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH.
LIST List type. - Each element in the list must be of the exact same data schema; otherwise, they are invalid arguments. - List level cannot set search strategy. Leaf node level can do. - Elements cannot be another list (no list of list). - Elements can be CUSTOMIZED_STRUCT, and max number of layers is 10.
CUSTOMIZED_STRUCT Struct type. - SearchStrategy: * Data Schema that's CUSTOMIZED_STRUCT cannot set search strategy. * Leaf-node elements allow setting search strategy based on element's SearchStrategy restriction. - Nested layer restrictions: * Data Schema that's CUSTOMIZED_STRUCT allows its fields to be of CUSTOMIZED_STRUCT as well, but the overall layers restriction is 10.

Granularity

The granularity of annotations under this DataSchema.

Enums
GRANULARITY_UNSPECIFIED Unspecified granularity.
GRANULARITY_ASSET_LEVEL Asset-level granularity (annotations must not contain partition info).
GRANULARITY_PARTITION_LEVEL Partition-level granularity (annotations must contain partition info).

ListConfig

The configuration for LIST data type.

Fields
value_schema

DataSchemaDetails

The value's data schema in the list.

ProtoAnyConfig

The configuration for PROTO_ANY data type.

Fields
type_uri

string

The type URI of the proto message.

SearchStrategy

The search strategy for annotations value of the key.

Fields
search_strategy_type

SearchStrategyType

The type of search strategy to be applied on the key above. The allowed search_strategy_type is different for different data types, which is documented in the DataSchemaDetails.DataType. Specifying unsupported search_strategy_type for data types will result in INVALID_ARGUMENT error.

SearchStrategyType

The types of search strategies to be applied on the annotation key.

Enums

DataType

All supported data types.

Enums
DATA_TYPE_UNSPECIFIED The default value of DataType.
VIDEO Video data type like H264.
IMAGE Image data type.
PROTO Protobuf data type, usually used for general data blob.
PLACEHOLDER A placeholder data type, applicable for the universal input processor which supports any data type. This will be instantiated and replaced by a concrete underlying DataType during instance deployment.

DateTimeRange

Datetime range type.

Fields
start

DateTime

Start date time.

end

DateTime

End data time.

DateTimeRangeArray

A list of datetime range values.

Fields
date_time_ranges[]

DateTimeRange

Date time ranges.

DedicatedResources

A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.

Fields
machine_spec

MachineSpec

Required. Immutable. The specification of a single machine used by the prediction.

min_replica_count

int32

Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1.

If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.

max_replica_count

int32

Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value.

The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).

autoscaling_metric_specs[]

AutoscalingMetricSpec

Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric.

If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics.

If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set.

For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to aiplatform.googleapis.com/prediction/online/cpu/utilization and autoscaling_metric_specs.target to 80.

DeleteAnalysisRequest

Message for deleting an Analysis.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteAnnotationRequest

Request message for DeleteAnnotation API.

Fields
name

string

Required. The name of the annotation to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

DeleteApplicationInstancesRequest

Message for removing stream input from an Application.

Fields
name

string

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

instance_ids[]

string

Required. Id of the requesting object.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteApplicationInstancesResponse

This type has no fields.

Message for DeleteApplicationInstance Response.

DeleteApplicationRequest

Message for deleting an Application.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

force

bool

Optional. If set to true, any instances and drafts from this application will also be deleted. (Otherwise, the request will only work if the application has no instances and drafts.)

DeleteAssetMetadata

This type has no fields.

The metadata for DeleteAsset API that embeds in metadata field.

DeleteAssetRequest

Request message for DeleteAsset.

Fields
name

string

Required. The name of the asset to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

DeleteClusterRequest

Message for deleting a Cluster.

Fields
name

string

Required. Name of the resource

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

force

bool

Optional. If set to true, all child resources of the cluster will be deleted. (Otherwise, the request will only work if the cluster has no children.)

DeleteCollectionMetadata

Metadata message for DeleteCollectionRequest

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

DeleteCollectionRequest

Request message for DeleteCollectionRequest.

Fields
name

string

Required. The name of the collection to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

DeleteCorpusRequest

Request message for DeleteCorpus.

Fields
name

string

Required. The resource name of the corpus to delete.

DeleteDataSchemaRequest

Request message for DeleteDataSchema.

Fields
name

string

Required. The name of the data schema to delete. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}

DeleteDraftRequest

Message for deleting a Draft.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteEventRequest

Message for deleting a Event.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteIndexEndpointMetadata

Metadata message for DeleteIndexEndpoint.

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

DeleteIndexEndpointRequest

Request message for DeleteIndexEndpoint.

Fields
name

string

Required. Name of the resource.

DeleteIndexMetadata

This type has no fields.

Metadata message for DeleteIndexRequest

DeleteIndexRequest

Request message for DeleteIndex.

Fields
name

string

Required. The name of the index to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

DeleteOperatorRequest

Message for deleting a Operator

Fields
name

string

Required. Name of the resource

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteProcessRequest

Message for deleting a Process.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteProcessorRequest

Message for deleting a Processor.

Fields
name

string

Required. Name of the resource

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteSearchConfigRequest

Request message for DeleteSearchConfig.

Fields
name

string

Required. The name of the search configuration to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

DeleteSearchHypernymRequest

Request message for deleting SearchHypernym.

Fields
name

string

Required. The name of the SearchHypernym to delete. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

DeleteSeriesRequest

Message for deleting a Series.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteStreamRequest

Message for deleting a Stream.

Fields
name

string

Required. Name of the resource.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeployApplicationRequest

Message for deploying an Application.

Fields
name

string

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

validate_only

bool

If set, validate the request and preview the application graph, but do not actually deploy it.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

enable_monitoring

bool

Optional. Whether or not to enable monitoring for the application on deployment.

DeployApplicationResponse

This type has no fields.

RPC Request Messages. Message for DeployApplication Response.

DeployIndexMetadata

Metadata message for DeployIndex.

Fields
operation_metadata

OperationMetadata

Common metadata of the long-running operation.

deployed_index

string

Output only. The index being deployed.

DeployIndexRequest

Request message for DeployIndex.

Fields
index_endpoint

string

Required. IndexEndpoint the index is deployed to. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployed_index

DeployedIndex

Required. Index to deploy.

DeployIndexResponse

This type has no fields.

DeployIndex response once the operation is done.

DeployRetailProductRecognitionIndexResponse

This type has no fields.

Message for DeployRetailProductRecognitionIndex response.

DeployedIndex

A deployment of an Index.

Fields
index

string

Required. Name of the deployed Index. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

DeployedIndexReference

Points to a DeployedIndex.

Fields
index_endpoint

string

Immutable. A resource name of the IndexEndpoint.

Draft

Message describing Draft object

Fields
name

string

name of resource

create_time

Timestamp

Output only. [Output only] Create timestamp

update_time

Timestamp

Output only. [Output only] Create timestamp

labels

map<string, string>

Labels as key value pairs

display_name

string

Required. A user friendly display name for the solution.

description

string

A description for this application.

draft_application_configs

ApplicationConfigs

The draft application configs which haven't been updated to an application.

EagerMode

This type has no fields.

The options for receiver under the eager mode.

Event

Message describing the Event object.

Fields
name

string

Name of the resource.

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

labels

map<string, string>

Labels as key value pairs.

annotations

map<string, string>

Annotations to allow clients to store small amounts of arbitrary data.

alignment_clock

Clock

The clock used for joining streams.

grace_period

Duration

Grace period for cleaning up the event. This is the time the controller waits for before deleting the event. During this period, if there is any active channel on the event. The deletion of the event after grace_period will be ignored.

Clock

Clock that will be used for joining streams.

Enums
CLOCK_UNSPECIFIED Clock is not specified.
CAPTURE Use the timestamp when the data is captured. Clients need to sync the clock.
INGEST Use the timestamp when the data is received.

EventUpdate

The event update message.

Fields
stream

string

The name of the stream that the event is attached to.

event

string

The name of the event.

series

string

The name of the series.

update_time

Timestamp

The timestamp when the Event update happens.

offset

int64

The offset of the message that will be used to acknowledge of the message receiving.

EventUpdateFilter

EventUpdateFilter is the filter that the watchers can speficy on which event updates that they want to receive.

Fields

Union field start_time.

start_time can be only one of the following:

special_mode

SpecialMode

Special modes other than a specific timestamp.

specific_time

Timestamp

Specific timestamp after which the event updates happens.

SpecialMode

Special modes other than a specific timestamp.

Enums
SPECIAL_MODE_UNSPECIFIED Special mode unspecified.
BEGINNING BEGINNING special mode means all currently available events and incoming event updates.
LATEST LATEST special mode means only the latest events and incoming event updates.

EventUpdateType

The type of the event updates. Can be extended in the future for other use cases. e.g. EVENT_DETACHED_FROM_STREAM, and more.

Enums
EVENT_UPDATE_TYPE_UNSPECIFIED Event update type unspecified.
EVENT_AVAILABLE_ON_STREAM Event is available to read from on a stream.
EVENT_HEARTBEAT Heartbeat message that is used to track liveliness of the gRPC connection.

ExportRetailProductRecognitionIndexCoverageResponse

This type has no fields.

Message for response to exporting RetailProductRecognitionIndex coverage file.

FacetBucket

Holds the facet value, selections state, and metadata.

Fields
selected

bool

Whether one facet bucket is selected. This field represents user's facet selection. It is set by frontend in SearchVideosRequest.

Union field bucket_value. Bucket associated with a facet. For example, bucket of facet "team" can be "49ers", "patriots", etc; bucket of facet "player" can be "tom brady", "drew brees", etc. bucket_value can be only one of the following:
value

FacetValue

Singular value.

range

Range

Range value.

Range

The range of values [start, end) for which faceting is applied.

Fields
start

FacetValue

Start of the range. Non-existence indicates some bound (e.g. -inf).

end

FacetValue

End of the range. Non-existence indicates some bound (e.g. inf).

FacetBucketType

Different types for a facet bucket.

Enums
FACET_BUCKET_TYPE_UNSPECIFIED Unspecified type.
FACET_BUCKET_TYPE_VALUE Value type.
FACET_BUCKET_TYPE_DATETIME Datetime type.
FACET_BUCKET_TYPE_FIXED_RANGE Fixed Range type.
FACET_BUCKET_TYPE_CUSTOM_RANGE Custom Range type.

FacetGroup

A group of facet buckets to be passed back and forth between backend & frontend.

Fields
facet_id

string

Unique id of the facet group.

display_name

string

Display name of the facet. To be used by UI for facet rendering.

buckets[]

FacetBucket

Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc.

bucket_type

FacetBucketType

Facet bucket type.

fetch_matched_annotations

bool

If true, return query matched annotations for this facet group's selection. This option is only applicable for facets based on partition level annotations. It supports the following facet values: - INTEGER - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)

FacetProperty

Central configuration for a facet.

Fields
mapped_fields[]

string

Name of the facets, which are the dimensions users want to use to refine search results. mapped_fields will match UserSpecifiedDataSchema keys.

For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].

UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.

display_name

string

Display name of the facet. To be used by UI for facet rendering.

result_size

int64

Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size.

bucket_type

FacetBucketType

Facet bucket type e.g. value, range.

Union field range_facet_config.

range_facet_config can be only one of the following:

fixed_range_bucket_spec

FixedRangeBucketSpec

Fixed range facet bucket config.

custom_range_bucket_spec

CustomRangeBucketSpec

Custom range facet bucket config.

datetime_bucket_spec

DateTimeBucketSpec

Datetime range facet bucket config.

CustomRangeBucketSpec

If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use integer bucket value as an example, when the endpoints are 0, 10, 100, and 1000, we will generate the following facets: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). Notably: - endpoints must be listed in ascending order. Otherwise, the SearchConfig API will reject the facet config. - < 1 endpoints is an invalid spec.

Fields
endpoints[]

FacetValue

Currently, only integer type is supported for this field.

DateTimeBucketSpec

If bucket type is DATE, specify how date values are bucketized.

Fields
granularity

Granularity

Granularity of date type facet.

Granularity

Granularity enum for the datetime bucket.

Enums
GRANULARITY_UNSPECIFIED Unspecified granularity.
YEAR Granularity is year.
MONTH Granularity is month.
DAY Granularity is day.

FixedRangeBucketSpec

If bucket type is FIXED_RANGE, specify how values are bucketized. Use FixedRangeBucketSpec when you want to create multiple buckets with equal granularities. Using integer bucket value as an example, when bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet will be aggregated via the following buckets: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). Notably, bucket_count <= 1 is an invalid spec.

Fields
bucket_start

FacetValue

Lower bound of the bucket. NOTE: Only integer type is currently supported for this field.

bucket_granularity

FacetValue

Bucket granularity. NOTE: Only integer type is currently supported for this field.

bucket_count

int32

Total number of buckets.

FacetValue

Definition of a single value with generic type.

Fields

Union field value.

value can be only one of the following:

string_value

string

String type value.

integer_value

int64

Integer type value.

datetime_value

DateTime

Datetime type value.

FloatRange

Float range type.

Fields
start

float

Start of the float range.

end

float

End of the float range.

FloatRangeArray

A list of float range values.

Fields
float_ranges[]

FloatRange

Float range values.

GcsOutputConfig

Message describing GcsOutputConfig.

Fields
gcs_path

string

The Cloud Storage path for Vision AI Platform to ingest annotations to.

GcsSource

The Google Cloud Storage location for the input content.

Fields
uris[]

string

Required. References to a Google Cloud Storage paths.

GeneralObjectDetectionConfig

This type has no fields.

Message of configurations for General Object Detection processor.

GenerateHlsUriRequest

Request message for GenerateHlsUri API.

Fields
name

string

Required. The resource name of the asset to request clips for. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

temporal_partitions[]

TemporalPartition

The time range to request clips for. Will be ignored if get_live_view is set to True. The total time range requested should be smaller than 24h.

live_view_enabled

bool

Option to exclusively show a livestream of the asset with up to 3 minutes of backlog data.

GenerateHlsUriResponse

Response message for GenerateHlsUri API.

Fields
uri

string

A signed uri to download the HLS manifest corresponding to the requested times.

temporal_partitions[]

TemporalPartition

A list of temporal partitions of the content returned in the order they appear in the stream.

GenerateRetrievalUrlRequest

Request message for GenerateRetrievalUrl API.

Fields
name

string

Required. The resource name of the asset to request signed url for. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

GenerateRetrievalUrlResponse

Response message for GenerateRetrievalUrl API.

Fields
signed_uri

string

A signed url to download the content of the asset.

GenerateStreamHlsTokenRequest

Request message for getting the auth token to access the stream HLS contents.

Fields
stream

string

Required. The name of the stream.

GenerateStreamHlsTokenResponse

Response message for GenerateStreamHlsToken.

Fields
token

string

The generated JWT token.

The caller should insert this token to the authorization header of the HTTP requests to get the HLS playlist manifest and the video chunks. eg: curl -H "Authorization: Bearer $TOKEN" https://domain.com/test-stream.playback/master.m3u8

expiration_time

Timestamp

The expiration time of the token.

GeoCoordinate

Location Coordinate Representation

Fields
latitude

double

Latitude Coordinate. Degrees [-90 .. 90]

longitude

double

Longitude Coordinate. Degrees [-180 .. 180]

GeoLocationArray

A list of locations.

Fields
circle_areas[]

CircleArea

A list of circle areas.

GetAnalysisRequest

Message for getting an Analysis.

Fields
name

string

Required. Name of the resource.

GetAnnotationRequest

Request message for GetAnnotation API.

Fields
name

string

Required. The name of the annotation to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}

GetApplicationRequest

Message for getting a Application.

Fields
name

string

Required. Name of the resource.

GetAssetRequest

Request message for GetAsset.

Fields
name

string

Required. The name of the asset to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

GetClusterRequest

Message for getting a Cluster.

Fields
name

string

Required. Name of the resource.

GetCollectionRequest

Request message for GetCollectionRequest.

Fields
name

string

Required. The name of the collection to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

GetCorpusRequest

Request message for GetCorpus.

Fields
name

string

Required. The resource name of the corpus to retrieve.

GetDataSchemaRequest

Request message for GetDataSchema.

Fields
name

string

Required. The name of the data schema to retrieve. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}

GetDraftRequest

Message for getting a Draft.

Fields
name

string

Required. Name of the resource.

GetEventRequest

Message for getting a Event.

Fields
name

string

Required. Name of the resource.

GetIndexEndpointRequest

Request message for GetIndexEndpoint.

Fields
name

string

Required. Name of the IndexEndpoint resource.

GetIndexRequest

Request message for getting an Index.

Fields
name

string

Required. Name of the Index resource. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

GetInstanceRequest

Message for getting a Instance.

Fields
name

string

Required. Name of the resource.

GetProcessRequest

Message for getting a Process.

Fields
name

string

Required. Name of the resource.

GetProcessorRequest

Message for getting a Processor.

Fields
name

string

Required. Name of the resource.

GetSearchConfigRequest

Request message for GetSearchConfig.

Fields
name

string

Required. The name of the search configuration to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

GetSearchHypernymRequest

Request message for getting SearchHypernym.

Fields
name

string

Required. The name of the SearchHypernym to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}

ImageObjectDetectionPredictionResult

Prediction output format for Image Object Detection.

Fields
ids[]

int64

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly. It is the id segment instead of full resource name.

display_names[]

string

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

confidences[]

float

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

bboxes[]

ListValue

Bounding boxes, i.e. the rectangles over the image, that pinpoint the found AnnotationSpecs. Given in order that matches the IDs. Each bounding box is an array of 4 numbers xMin, xMax, yMin, and yMax, which represent the extremal coordinates of the box. They are relative to the image size, and the point 0,0 is in the top left of the image.

ImageQuery

Image query for search endpoint request.

Fields

Union field image.

image can be only one of the following:

input_image

bytes

Input image in raw bytes.

asset

string

Resource name of the asset. Only supported in IMAGE corpus type. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

ImageSegmentationPredictionResult

Prediction output format for Image Segmentation.

Fields
category_mask

string

A PNG image where each pixel in the mask represents the category in which the pixel in the original image was predicted to belong to. The size of this image will be the same as the original image. The mapping between the AnntoationSpec and the color can be found in model's metadata. The model will choose the most likely category and if none of the categories reach the confidence threshold, the pixel will be marked as background.

confidence_mask

string

A one channel image which is encoded as an 8bit lossless PNG. The size of the image will be the same as the original image. For a specific pixel, darker color means less confidence in correctness of the cateogry in the categoryMask for the corresponding pixel. Black means no confidence and white means complete confidence.

ImportAssetsMetadata

The metadata message for ImportAssets LRO.

Fields
metadata

OperationMetadata

The metadata of the operation.

ImportAssetsRequest

The request message for ImportAssets.

Fields
parent

string

Required. The parent corpus resource where the assets will be imported. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

Union field source. The source. source can be only one of the following:
assets_gcs_uri

string

The file contains all assets information to be imported. * The file is in JSONL format. * Each line corresponding to one asset. * Each line will be converted into InputImageAsset proto.

ImportAssetsResponse

This type has no fields.

The response message for ImportAssets LRO.

ImportRetailProductsResponse

This type has no fields.

ImportProducts response once the operation is done.

Index

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

Fields
name

string

Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

display_name

string

Optional. Optional user-specified display name of the index.

description

string

Optional. Optional description of the index.

state

State

Output only. State of the index.

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

deployed_indexes[]

DeployedIndexReference

Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes.

Union field asset_filter. Specifies how assets are selected for this index. Default to entire_corpus if unspecified. Behavior in UpdateIndex: if update_mask includes one of the asset_filter field paths, the index will be rebuilt with latest assets, including their analyzed data and annotations. asset_filter can be only one of the following:
entire_corpus

bool

Include all assets under the corpus.

State

Enum representing the different states through which an Index might cycle during its lifetime.

Enums
STATE_UNSPECIFIED The default value. Should not be used.
CREATING State CREATING.
CREATED State CREATED.
UPDATING State UPDATING.

IndexAssetMetadata

Metadata for IndexAsset.

Fields
indexing_status
(deprecated)

IndexingStatus

The status of indexing this asset.

status

IndexingStatus

The status of indexing this asset.

start_time

Timestamp

The start time of the operation.

update_time

Timestamp

The update time of the operation.

IndexingStatus

The status of indexing for the asset.

Fields
state

State

State of this asset's indexing.

status_message

string

Detailed message describing the state.

State

State enum for this asset's indexing.

Enums
STATE_UNSPECIFIED The default process state should never happen.
IN_PROGRESS The indexing is in progress.
SUCCEEDED The process is successfully done.
FAILED The process failed.

IndexAssetRequest

Request message for IndexAsset.

Fields
name

string

Required. The resource name of the asset to index. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

index

string

Optional. The name of the index. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

IndexAssetResponse

This type has no fields.

Response message for IndexAsset.

IndexEndpoint

Message representing IndexEndpoint resource. ImageIndexes are deployed into it.

Fields
name

string

Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}

display_name

string

Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.

description

string

Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.

deployed_index

DeployedIndex

Output only. The Index deployed in this IndexEndpoint.

state

State

Output only. IndexEndpoint state.

labels

map<string, string>

Optional. The labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

create_time

Timestamp

Output only. Create timestamp.

update_time

Timestamp

Output only. Update timestamp.

State

IndexEndpoint stage.

Enums
STATE_UNSPECIFIED The default value. Should not be used.
CREATING State CREATING.
CREATED State CREATED.
UPDATING State UPDATING.
FAILED State FAILED.

IndexedAsset

An IndexedAsset is an asset that the index is built upon.

Fields
index

string

Required. The index that this indexed asset belongs to. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

asset

string

Required. The resource name of the asset. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}

create_time

Timestamp

Output only. The create timestamp.

update_time

Timestamp

Output only. The update timestamp.

IndexingStatus

The status of indexing for the asset.

Fields
state

State

Output only. State of this asset's indexing.

status_message

string

Detailed message describing the state.

State

State enum for this asset's indexing.

Enums
STATE_UNSPECIFIED The default process state should never happen.
IN_PROGRESS The indexing is in progress.
SUCCEEDED The process is successfully done.
FAILED The process failed.

IngestAssetRequest

Request message for IngestAsset API.

Fields

Union field streaming_request.

streaming_request can be only one of the following:

config

Config

Provides information for the data and the asset resource name that the data belongs to. The first IngestAssetRequest message must only contain a Config message.

time_indexed_data

TimeIndexedData

Data to be ingested.

Config

Configuration for the data.

Fields
asset

string

Required. The resource name of the asset that the ingested data belongs to.

Union field data_type.

data_type can be only one of the following:

video_type

VideoType

Type information for video data.

VideoType

Type information for video data.

Fields
container_format

ContainerFormat

Container format of the video data.

ContainerFormat

Container format of the video.

Enums
CONTAINER_FORMAT_UNSPECIFIED The default type, not supposed to be used.
CONTAINER_FORMAT_MP4 Mp4 container format.

TimeIndexedData

Contains the data and the corresponding time range this data is for.

Fields
data

bytes

Data to be ingested.

temporal_partition

TemporalPartition

Time range of the data.

IngestAssetResponse

Response message for IngestAsset API.

Fields
successfully_ingested_partition

TemporalPartition

Time range of the data that has been successfully ingested.

Instance

Message describing Instance object

Fields
name

string

Output only. name of resource

create_time

Timestamp

Output only. [Output only] Create timestamp

update_time

Timestamp

Output only. [Output only] Update timestamp

labels

map<string, string>

Labels as key value pairs

display_name

string

Required. A user friendly display name for the solution.

description

string

A description for this instance.

instance_type

InstanceType

The instance type for the current instance.

input_resources[]

InputResource

The input resources for the current application instance. For example: input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a

output_resources[]

OutputResource

All the output resources associated to one application instance.

state

State

State of the instance.

InputResource

Message of input resource used in one application instance.

Fields
consumer_node

string

The name of graph node who receives the input resource. For example: 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

The specific input resource binding which will consume the current Input Resource, can be ignored is there is only 1 input binding.

annotations

ResourceAnnotations

Contains resource annotations.

Union field input_resource_information. Required. Specify the input to the application instance. input_resource_information can be only one of the following:
input_resource

string

The direct input resource name. If the instance type is STREAMING_PREDICTION, the input resource is in format of "projects/123/locations/us-central1/clusters/456/streams/stream-a". If the instance type is BATCH_PREDICTION from Cloud Storage input container, the input resource is in format of "gs://bucket-a".

annotated_stream
(deprecated)

StreamWithAnnotation

If the input resource is VisionAI Stream, the associated annotations can be specified using annotated_stream instead.

OutputResource

Message of output resource used in one application instance.

Fields
output_resource

string

The output resource name for the current application instance.

producer_node

string

The name of graph node who produces the output resource name. For example: 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

The specific output resource binding which produces the current OutputResource.

is_temporary

bool

Output only. Whether the output resource is temporary which means the resource is generated during the deployment of the application. Temporary resource will be deleted during the undeployment of the application.

autogen

bool

Output only. Whether the output resource is created automatically by the Vision AI App Platform.

State

State of the Instance

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
CREATING State CREATING.
CREATED State CREATED.
DEPLOYING State DEPLOYING.
DEPLOYED State DEPLOYED.
UNDEPLOYING State UNDEPLOYING.
DELETED State DELETED.
ERROR State ERROR.
UPDATING State Updating
DELETING State Deleting.
FIXING State Fixing.

IntRange

Integer range type.

Fields
start

int64

Start of the int range.

end

int64

End of the int range.

IntRangeArray

A list of integer range values.

Fields
int_ranges[]

IntRange

Int range values.

ListAnalysesRequest

Message for requesting list of Analyses

Fields
parent

string

Required. Parent value for ListAnalysesRequest

page_size

int32

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

page_token

string

A token identifying a page of results the server should return.

filter

string

Filtering results

order_by

string

Hint for how to order the results

ListAnalysesResponse

Message for response to listing Analyses

Fields
analyses[]

Analysis

The list of Analysis

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListAnnotationsRequest

Request message for GetAnnotation API.

Fields
parent

string

The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

page_size

int32

The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token <