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.