Vision AI v1 API - Class Warehouse.WarehouseBase (1.0.0-beta01)

[BindServiceMethod(typeof(Warehouse), "BindService")]
public abstract class Warehouse.WarehouseBase

Reference documentation and code samples for the Vision AI v1 API class Warehouse.WarehouseBase.

Base class for server-side implementations of Warehouse

Inheritance

object > Warehouse.WarehouseBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Methods

AddCollectionItem(AddCollectionItemRequest, ServerCallContext)

public virtual Task<AddCollectionItemResponse> AddCollectionItem(AddCollectionItemRequest request, ServerCallContext context)

Adds an item into a Collection.

Parameters
Name	Description
request	AddCollectionItemRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAddCollectionItemResponse	The response to send back to the client (wrapped by a task).

AnalyzeAsset(AnalyzeAssetRequest, ServerCallContext)

public virtual Task<Operation> AnalyzeAsset(AnalyzeAssetRequest request, ServerCallContext context)

Analyze asset to power search capability.

Parameters
Name	Description
request	AnalyzeAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

AnalyzeCorpus(AnalyzeCorpusRequest, ServerCallContext)

public virtual Task<Operation> AnalyzeCorpus(AnalyzeCorpusRequest request, ServerCallContext context)

Analyzes a corpus.

Parameters
Name	Description
request	AnalyzeCorpusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ClipAsset(ClipAssetRequest, ServerCallContext)

public virtual Task<ClipAssetResponse> ClipAsset(ClipAssetRequest request, ServerCallContext context)

Supported by STREAM_VIDEO corpus type. 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.

Parameters
Name	Description
request	ClipAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskClipAssetResponse	The response to send back to the client (wrapped by a task).

CreateAnnotation(CreateAnnotationRequest, ServerCallContext)

public virtual Task<Annotation> CreateAnnotation(CreateAnnotationRequest request, ServerCallContext context)

Creates annotation inside asset.

Parameters
Name	Description
request	CreateAnnotationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotation	The response to send back to the client (wrapped by a task).

CreateAsset(CreateAssetRequest, ServerCallContext)

public virtual Task<Asset> CreateAsset(CreateAssetRequest request, ServerCallContext context)

Creates an asset inside corpus.

Parameters
Name	Description
request	CreateAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAsset	The response to send back to the client (wrapped by a task).

CreateCollection(CreateCollectionRequest, ServerCallContext)

public virtual Task<Operation> CreateCollection(CreateCollectionRequest request, ServerCallContext context)

Creates a collection.

Parameters
Name	Description
request	CreateCollectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateCorpus(CreateCorpusRequest, ServerCallContext)

public virtual Task<Operation> CreateCorpus(CreateCorpusRequest request, ServerCallContext context)

Creates a corpus inside a project.

Parameters
Name	Description
request	CreateCorpusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateDataSchema(CreateDataSchemaRequest, ServerCallContext)

public virtual Task<DataSchema> CreateDataSchema(CreateDataSchemaRequest request, ServerCallContext context)

Creates data schema inside corpus.

Parameters
Name	Description
request	CreateDataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataSchema	The response to send back to the client (wrapped by a task).

CreateIndex(CreateIndexRequest, ServerCallContext)

public virtual Task<Operation> CreateIndex(CreateIndexRequest request, ServerCallContext context)

Creates an Index under the corpus.

Parameters
Name	Description
request	CreateIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateIndexEndpoint(CreateIndexEndpointRequest, ServerCallContext)

public virtual Task<Operation> CreateIndexEndpoint(CreateIndexEndpointRequest request, ServerCallContext context)

Creates an IndexEndpoint.

Parameters
Name	Description
request	CreateIndexEndpointRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateSearchConfig(CreateSearchConfigRequest, ServerCallContext)

public virtual Task<SearchConfig> CreateSearchConfig(CreateSearchConfigRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	CreateSearchConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchConfig	The response to send back to the client (wrapped by a task).

CreateSearchHypernym(CreateSearchHypernymRequest, ServerCallContext)

public virtual Task<SearchHypernym> CreateSearchHypernym(CreateSearchHypernymRequest request, ServerCallContext context)

Creates a SearchHypernym inside a corpus.

Parameters
Name	Description
request	CreateSearchHypernymRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchHypernym	The response to send back to the client (wrapped by a task).

DeleteAnnotation(DeleteAnnotationRequest, ServerCallContext)

public virtual Task<Empty> DeleteAnnotation(DeleteAnnotationRequest request, ServerCallContext context)

Deletes annotation inside asset.

Parameters
Name	Description
request	DeleteAnnotationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteAsset(DeleteAssetRequest, ServerCallContext)

public virtual Task<Operation> DeleteAsset(DeleteAssetRequest request, ServerCallContext context)

Deletes asset inside corpus.

Parameters
Name	Description
request	DeleteAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteCollection(DeleteCollectionRequest, ServerCallContext)

public virtual Task<Operation> DeleteCollection(DeleteCollectionRequest request, ServerCallContext context)

Deletes a collection.

Parameters
Name	Description
request	DeleteCollectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteCorpus(DeleteCorpusRequest, ServerCallContext)

public virtual Task<Empty> DeleteCorpus(DeleteCorpusRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteCorpusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteDataSchema(DeleteDataSchemaRequest, ServerCallContext)

public virtual Task<Empty> DeleteDataSchema(DeleteDataSchemaRequest request, ServerCallContext context)

Deletes data schema inside corpus.

Parameters
Name	Description
request	DeleteDataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteIndex(DeleteIndexRequest, ServerCallContext)

public virtual Task<Operation> DeleteIndex(DeleteIndexRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteIndexEndpoint(DeleteIndexEndpointRequest, ServerCallContext)

public virtual Task<Operation> DeleteIndexEndpoint(DeleteIndexEndpointRequest request, ServerCallContext context)

Deletes an IndexEndpoint.

Parameters
Name	Description
request	DeleteIndexEndpointRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteSearchConfig(DeleteSearchConfigRequest, ServerCallContext)

public virtual Task<Empty> DeleteSearchConfig(DeleteSearchConfigRequest request, ServerCallContext context)

Deletes a search configuration inside a corpus.

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

Parameters
Name	Description
request	DeleteSearchConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteSearchHypernym(DeleteSearchHypernymRequest, ServerCallContext)

public virtual Task<Empty> DeleteSearchHypernym(DeleteSearchHypernymRequest request, ServerCallContext context)

Deletes a SearchHypernym inside a corpus.

Parameters
Name	Description
request	DeleteSearchHypernymRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeployIndex(DeployIndexRequest, ServerCallContext)

public virtual Task<Operation> DeployIndex(DeployIndexRequest request, ServerCallContext context)

Deploys an Index to IndexEndpoint.

Parameters
Name	Description
request	DeployIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateHlsUri(GenerateHlsUriRequest, ServerCallContext)

public virtual Task<GenerateHlsUriResponse> GenerateHlsUri(GenerateHlsUriRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	GenerateHlsUriRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateHlsUriResponse	The response to send back to the client (wrapped by a task).

GenerateRetrievalUrl(GenerateRetrievalUrlRequest, ServerCallContext)

public virtual Task<GenerateRetrievalUrlResponse> GenerateRetrievalUrl(GenerateRetrievalUrlRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	GenerateRetrievalUrlRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateRetrievalUrlResponse	The response to send back to the client (wrapped by a task).

GetAnnotation(GetAnnotationRequest, ServerCallContext)

public virtual Task<Annotation> GetAnnotation(GetAnnotationRequest request, ServerCallContext context)

Reads annotation inside asset.

Parameters
Name	Description
request	GetAnnotationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotation	The response to send back to the client (wrapped by a task).

GetAsset(GetAssetRequest, ServerCallContext)

public virtual Task<Asset> GetAsset(GetAssetRequest request, ServerCallContext context)

Reads an asset inside corpus.

Parameters
Name	Description
request	GetAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAsset	The response to send back to the client (wrapped by a task).

GetCollection(GetCollectionRequest, ServerCallContext)

public virtual Task<Collection> GetCollection(GetCollectionRequest request, ServerCallContext context)

Gets a collection.

Parameters
Name	Description
request	GetCollectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCollection	The response to send back to the client (wrapped by a task).

GetCorpus(GetCorpusRequest, ServerCallContext)

public virtual Task<Corpus> GetCorpus(GetCorpusRequest request, ServerCallContext context)

Gets corpus details inside a project.

Parameters
Name	Description
request	GetCorpusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCorpus	The response to send back to the client (wrapped by a task).

GetDataSchema(GetDataSchemaRequest, ServerCallContext)

public virtual Task<DataSchema> GetDataSchema(GetDataSchemaRequest request, ServerCallContext context)

Gets data schema inside corpus.

Parameters
Name	Description
request	GetDataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataSchema	The response to send back to the client (wrapped by a task).

GetIndex(GetIndexRequest, ServerCallContext)

public virtual Task<Index> GetIndex(GetIndexRequest request, ServerCallContext context)

Gets the details of a single Index under a Corpus.

Parameters
Name	Description
request	GetIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIndex	The response to send back to the client (wrapped by a task).

GetIndexEndpoint(GetIndexEndpointRequest, ServerCallContext)

public virtual Task<IndexEndpoint> GetIndexEndpoint(GetIndexEndpointRequest request, ServerCallContext context)

Gets an IndexEndpoint.

Parameters
Name	Description
request	GetIndexEndpointRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIndexEndpoint	The response to send back to the client (wrapped by a task).

GetSearchConfig(GetSearchConfigRequest, ServerCallContext)

public virtual Task<SearchConfig> GetSearchConfig(GetSearchConfigRequest request, ServerCallContext context)

Gets a search configuration inside a corpus.

Parameters
Name	Description
request	GetSearchConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchConfig	The response to send back to the client (wrapped by a task).

GetSearchHypernym(GetSearchHypernymRequest, ServerCallContext)

public virtual Task<SearchHypernym> GetSearchHypernym(GetSearchHypernymRequest request, ServerCallContext context)

Gets a SearchHypernym inside a corpus.

Parameters
Name	Description
request	GetSearchHypernymRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchHypernym	The response to send back to the client (wrapped by a task).

ImportAssets(ImportAssetsRequest, ServerCallContext)

public virtual Task<Operation> ImportAssets(ImportAssetsRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ImportAssetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

IndexAsset(IndexAssetRequest, ServerCallContext)

public virtual Task<Operation> IndexAsset(IndexAssetRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	IndexAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

IngestAsset(IAsyncStreamReader<IngestAssetRequest>, IServerStreamWriter<IngestAssetResponse>, ServerCallContext)

public virtual Task IngestAsset(IAsyncStreamReader<IngestAssetRequest> requestStream, IServerStreamWriter<IngestAssetResponse> responseStream, ServerCallContext context)

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).

Parameters
Name	Description
requestStream	IAsyncStreamReaderIngestAssetRequest Used for reading requests from the client.
responseStream	IServerStreamWriterIngestAssetResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

ListAnnotations(ListAnnotationsRequest, ServerCallContext)

public virtual Task<ListAnnotationsResponse> ListAnnotations(ListAnnotationsRequest request, ServerCallContext context)

Lists a list of annotations inside asset.

Parameters
Name	Description
request	ListAnnotationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAnnotationsResponse	The response to send back to the client (wrapped by a task).

ListAssets(ListAssetsRequest, ServerCallContext)

public virtual Task<ListAssetsResponse> ListAssets(ListAssetsRequest request, ServerCallContext context)

Lists an list of assets inside corpus.

Parameters
Name	Description
request	ListAssetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAssetsResponse	The response to send back to the client (wrapped by a task).

ListCollections(ListCollectionsRequest, ServerCallContext)

public virtual Task<ListCollectionsResponse> ListCollections(ListCollectionsRequest request, ServerCallContext context)

Lists collections inside a corpus.

Parameters
Name	Description
request	ListCollectionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCollectionsResponse	The response to send back to the client (wrapped by a task).

ListCorpora(ListCorporaRequest, ServerCallContext)

public virtual Task<ListCorporaResponse> ListCorpora(ListCorporaRequest request, ServerCallContext context)

Lists all corpora in a project.

Parameters
Name	Description
request	ListCorporaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCorporaResponse	The response to send back to the client (wrapped by a task).

ListDataSchemas(ListDataSchemasRequest, ServerCallContext)

public virtual Task<ListDataSchemasResponse> ListDataSchemas(ListDataSchemasRequest request, ServerCallContext context)

Lists a list of data schemas inside corpus.

Parameters
Name	Description
request	ListDataSchemasRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDataSchemasResponse	The response to send back to the client (wrapped by a task).

ListIndexEndpoints(ListIndexEndpointsRequest, ServerCallContext)

public virtual Task<ListIndexEndpointsResponse> ListIndexEndpoints(ListIndexEndpointsRequest request, ServerCallContext context)

Lists all IndexEndpoints in a project.

Parameters
Name	Description
request	ListIndexEndpointsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListIndexEndpointsResponse	The response to send back to the client (wrapped by a task).

ListIndexes(ListIndexesRequest, ServerCallContext)

public virtual Task<ListIndexesResponse> ListIndexes(ListIndexesRequest request, ServerCallContext context)

List all Indexes in a given Corpus.

Parameters
Name	Description
request	ListIndexesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListIndexesResponse	The response to send back to the client (wrapped by a task).

ListSearchConfigs(ListSearchConfigsRequest, ServerCallContext)

public virtual Task<ListSearchConfigsResponse> ListSearchConfigs(ListSearchConfigsRequest request, ServerCallContext context)

Lists all search configurations inside a corpus.

Parameters
Name	Description
request	ListSearchConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSearchConfigsResponse	The response to send back to the client (wrapped by a task).

ListSearchHypernyms(ListSearchHypernymsRequest, ServerCallContext)

public virtual Task<ListSearchHypernymsResponse> ListSearchHypernyms(ListSearchHypernymsRequest request, ServerCallContext context)

Lists SearchHypernyms inside a corpus.

Parameters
Name	Description
request	ListSearchHypernymsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSearchHypernymsResponse	The response to send back to the client (wrapped by a task).

RemoveCollectionItem(RemoveCollectionItemRequest, ServerCallContext)

public virtual Task<RemoveCollectionItemResponse> RemoveCollectionItem(RemoveCollectionItemRequest request, ServerCallContext context)

Removes an item from a collection.

Parameters
Name	Description
request	RemoveCollectionItemRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRemoveCollectionItemResponse	The response to send back to the client (wrapped by a task).

RemoveIndexAsset(RemoveIndexAssetRequest, ServerCallContext)

public virtual Task<Operation> RemoveIndexAsset(RemoveIndexAssetRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	RemoveIndexAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SearchAssets(SearchAssetsRequest, ServerCallContext)

public virtual Task<SearchAssetsResponse> SearchAssets(SearchAssetsRequest request, ServerCallContext context)

Search media asset.

Parameters
Name	Description
request	SearchAssetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchAssetsResponse	The response to send back to the client (wrapped by a task).

SearchIndexEndpoint(SearchIndexEndpointRequest, ServerCallContext)

public virtual Task<SearchIndexEndpointResponse> SearchIndexEndpoint(SearchIndexEndpointRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SearchIndexEndpointRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchIndexEndpointResponse	The response to send back to the client (wrapped by a task).

UndeployIndex(UndeployIndexRequest, ServerCallContext)

public virtual Task<Operation> UndeployIndex(UndeployIndexRequest request, ServerCallContext context)

Undeploys an Index from IndexEndpoint.

Parameters
Name	Description
request	UndeployIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAnnotation(UpdateAnnotationRequest, ServerCallContext)

public virtual Task<Annotation> UpdateAnnotation(UpdateAnnotationRequest request, ServerCallContext context)

Updates annotation inside asset.

Parameters
Name	Description
request	UpdateAnnotationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAnnotation	The response to send back to the client (wrapped by a task).

UpdateAsset(UpdateAssetRequest, ServerCallContext)

public virtual Task<Asset> UpdateAsset(UpdateAssetRequest request, ServerCallContext context)

Updates an asset inside corpus.

Parameters
Name	Description
request	UpdateAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAsset	The response to send back to the client (wrapped by a task).

UpdateCollection(UpdateCollectionRequest, ServerCallContext)

public virtual Task<Collection> UpdateCollection(UpdateCollectionRequest request, ServerCallContext context)

Updates a collection.

Parameters
Name	Description
request	UpdateCollectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCollection	The response to send back to the client (wrapped by a task).

UpdateCorpus(UpdateCorpusRequest, ServerCallContext)

public virtual Task<Corpus> UpdateCorpus(UpdateCorpusRequest request, ServerCallContext context)

Updates a corpus in a project.

Parameters
Name	Description
request	UpdateCorpusRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCorpus	The response to send back to the client (wrapped by a task).

UpdateDataSchema(UpdateDataSchemaRequest, ServerCallContext)

public virtual Task<DataSchema> UpdateDataSchema(UpdateDataSchemaRequest request, ServerCallContext context)

Updates data schema inside corpus.

Parameters
Name	Description
request	UpdateDataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataSchema	The response to send back to the client (wrapped by a task).

UpdateIndex(UpdateIndexRequest, ServerCallContext)

public virtual Task<Operation> UpdateIndex(UpdateIndexRequest request, ServerCallContext context)

Updates an Index under the corpus. Users can perform a metadata-only update or trigger a full index rebuild with different update_mask values.

Parameters
Name	Description
request	UpdateIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateIndexEndpoint(UpdateIndexEndpointRequest, ServerCallContext)

public virtual Task<Operation> UpdateIndexEndpoint(UpdateIndexEndpointRequest request, ServerCallContext context)

Updates an IndexEndpoint.

Parameters
Name	Description
request	UpdateIndexEndpointRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateSearchConfig(UpdateSearchConfigRequest, ServerCallContext)

public virtual Task<SearchConfig> UpdateSearchConfig(UpdateSearchConfigRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UpdateSearchConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchConfig	The response to send back to the client (wrapped by a task).

UpdateSearchHypernym(UpdateSearchHypernymRequest, ServerCallContext)

public virtual Task<SearchHypernym> UpdateSearchHypernym(UpdateSearchHypernymRequest request, ServerCallContext context)

Updates a SearchHypernym inside a corpus.

Parameters
Name	Description
request	UpdateSearchHypernymRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchHypernym	The response to send back to the client (wrapped by a task).

UploadAsset(UploadAssetRequest, ServerCallContext)

public virtual Task<Operation> UploadAsset(UploadAssetRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UploadAssetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ViewCollectionItems(ViewCollectionItemsRequest, ServerCallContext)

public virtual Task<ViewCollectionItemsResponse> ViewCollectionItems(ViewCollectionItemsRequest request, ServerCallContext context)

View items inside a collection.

Parameters
Name	Description
request	ViewCollectionItemsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskViewCollectionItemsResponse	The response to send back to the client (wrapped by a task).

ViewIndexedAssets(ViewIndexedAssetsRequest, ServerCallContext)

public virtual Task<ViewIndexedAssetsResponse> ViewIndexedAssets(ViewIndexedAssetsRequest request, ServerCallContext context)

Lists assets inside an index.

Parameters
Name	Description
request	ViewIndexedAssetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskViewIndexedAssetsResponse	The response to send back to the client (wrapped by a task).