Class WarehouseAsyncClient (0.1.0)

Service that manages media content + metadata for streaming.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the warehouse async client.

Adds an item into a Collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_add_collection_item():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    item = visionai_v1.CollectionItem()
    item.collection = "collection_value"
    item.type_ = "ASSET"
    item.item_resource = "item_resource_value"

    request = visionai_v1.AddCollectionItemRequest(
        item=item,
    )

    # Make the request
    response = await client.add_collection_item(request=request)

    # Handle the response
    print(response)

Analyze asset to power search capability.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_analyze_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.AnalyzeAssetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.analyze_asset(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Analyzes a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_analyze_corpus():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.AnalyzeCorpusRequest(
        name="name_value",
    )

    # Make the request
    operation = client.analyze_corpus(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Returns a fully-qualified annotation string.

Returns a fully-qualified asset string.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_clip_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ClipAssetRequest(
        name="name_value",
    )

    # Make the request
    response = await client.clip_asset(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified collection string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Returns a fully-qualified corpus string.

Creates annotation inside asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_annotation():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateAnnotationRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_annotation(request=request)

    # Handle the response
    print(response)

Creates an asset inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateAssetRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_asset(request=request)

    # Handle the response
    print(response)

Creates a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_collection():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateCollectionRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_collection(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Creates a corpus inside a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_corpus():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    corpus = visionai_v1.Corpus()
    corpus.display_name = "display_name_value"

    request = visionai_v1.CreateCorpusRequest(
        parent="parent_value",
        corpus=corpus,
    )

    # Make the request
    operation = client.create_corpus(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Creates data schema inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_data_schema():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    data_schema = visionai_v1.DataSchema()
    data_schema.key = "key_value"

    request = visionai_v1.CreateDataSchemaRequest(
        parent="parent_value",
        data_schema=data_schema,
    )

    # Make the request
    response = await client.create_data_schema(request=request)

    # Handle the response
    print(response)

Creates an Index under the corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    index = visionai_v1.Index()
    index.entire_corpus = True

    request = visionai_v1.CreateIndexRequest(
        parent="parent_value",
        index=index,
    )

    # Make the request
    operation = client.create_index(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Creates an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_index_endpoint():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateIndexEndpointRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_index_endpoint(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_search_config():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateSearchConfigRequest(
        parent="parent_value",
        search_config_id="search_config_id_value",
    )

    # Make the request
    response = await client.create_search_config(request=request)

    # Handle the response
    print(response)

Creates a SearchHypernym inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_create_search_hypernym():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.CreateSearchHypernymRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_search_hypernym(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified data_schema string.

Deletes annotation inside asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_annotation():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteAnnotationRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_annotation(request=request)

Deletes asset inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteAssetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_asset(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Deletes a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_collection():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteCollectionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_collection(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_corpus():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteCorpusRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_corpus(request=request)

Deletes data schema inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_data_schema():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteDataSchemaRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_data_schema(request=request)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteIndexRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_index(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Deletes an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_index_endpoint():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteIndexEndpointRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_index_endpoint(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Deletes a search configuration inside a corpus.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_search_config():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteSearchConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_search_config(request=request)

Deletes a SearchHypernym inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_delete_search_hypernym():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.DeleteSearchHypernymRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_search_hypernym(request=request)

Deploys an Index to IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_deploy_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    deployed_index = visionai_v1.DeployedIndex()
    deployed_index.index = "index_value"

    request = visionai_v1.DeployIndexRequest(
        index_endpoint="index_endpoint_value",
        deployed_index=deployed_index,
    )

    # Make the request
    operation = client.deploy_index(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_generate_hls_uri():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GenerateHlsUriRequest(
        name="name_value",
    )

    # Make the request
    response = await client.generate_hls_uri(request=request)

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_generate_retrieval_url():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GenerateRetrievalUrlRequest(
        name="name_value",
    )

    # Make the request
    response = await client.generate_retrieval_url(request=request)

    # Handle the response
    print(response)

Reads annotation inside asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_annotation():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetAnnotationRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_annotation(request=request)

    # Handle the response
    print(response)

Reads an asset inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetAssetRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_asset(request=request)

    # Handle the response
    print(response)

Gets a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_collection():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetCollectionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_collection(request=request)

    # Handle the response
    print(response)

Gets corpus details inside a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_corpus():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetCorpusRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_corpus(request=request)

    # Handle the response
    print(response)

Gets data schema inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_data_schema():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetDataSchemaRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_data_schema(request=request)

    # Handle the response
    print(response)

Gets the details of a single Index under a Corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetIndexRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_index(request=request)

    # Handle the response
    print(response)

Gets an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_index_endpoint():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetIndexEndpointRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_index_endpoint(request=request)

    # Handle the response
    print(response)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets the latest state of a long-running operation.

Gets a search configuration inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_search_config():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetSearchConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_search_config(request=request)

    # Handle the response
    print(response)

Gets a SearchHypernym inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_get_search_hypernym():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.GetSearchHypernymRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_search_hypernym(request=request)

    # Handle the response
    print(response)

Returns an appropriate transport class.

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_import_assets():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ImportAssetsRequest(
        assets_gcs_uri="assets_gcs_uri_value",
        parent="parent_value",
    )

    # Make the request
    operation = client.import_assets(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_index_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.IndexAssetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.index_asset(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Returns a fully-qualified index_endpoint string.

Returns a fully-qualified index string.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_ingest_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    config = visionai_v1.Config()
    config.asset = "asset_value"

    request = visionai_v1.IngestAssetRequest(
        config=config,
    )

    # This method expects an iterator which contains
    # 'visionai_v1.IngestAssetRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = await client.ingest_asset(requests=request_generator())

    # Handle the response
    async for response in stream:
        print(response)

Lists a list of annotations inside asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_annotations():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListAnnotationsRequest(
    )

    # Make the request
    page_result = client.list_annotations(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists an list of assets inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_assets():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListAssetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists collections inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_collections():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListCollectionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_collections(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists all corpora in a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_corpora():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListCorporaRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_corpora(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists a list of data schemas inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_data_schemas():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListDataSchemasRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_data_schemas(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists all IndexEndpoints in a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_index_endpoints():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListIndexEndpointsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_index_endpoints(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

List all Indexes in a given Corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_indexes():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListIndexesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_indexes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists operations that match the specified filter in the request.

Lists all search configurations inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_search_configs():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListSearchConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_search_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists SearchHypernyms inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_list_search_hypernyms():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ListSearchHypernymsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_search_hypernyms(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parses a annotation path into its component segments.

Parses a asset path into its component segments.

Parses a collection path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a corpus path into its component segments.

Parses a data_schema path into its component segments.

Parses a index_endpoint path into its component segments.

Parses a index path into its component segments.

Parses a search_config path into its component segments.

Parses a search_hypernym path into its component segments.

Removes an item from a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_remove_collection_item():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    item = visionai_v1.CollectionItem()
    item.collection = "collection_value"
    item.type_ = "ASSET"
    item.item_resource = "item_resource_value"

    request = visionai_v1.RemoveCollectionItemRequest(
        item=item,
    )

    # Make the request
    response = await client.remove_collection_item(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_remove_index_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.RemoveIndexAssetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.remove_index_asset(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Search media asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_search_assets():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.SearchAssetsRequest(
        corpus="corpus_value",
    )

    # Make the request
    page_result = client.search_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Returns a fully-qualified search_config string.

Returns a fully-qualified search_hypernym string.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_search_index_endpoint():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    image_query = visionai_v1.ImageQuery()
    image_query.input_image = b'input_image_blob'

    request = visionai_v1.SearchIndexEndpointRequest(
        image_query=image_query,
        index_endpoint="index_endpoint_value",
    )

    # Make the request
    page_result = client.search_index_endpoint(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Undeploys an Index from IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_undeploy_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UndeployIndexRequest(
        index_endpoint="index_endpoint_value",
    )

    # Make the request
    operation = client.undeploy_index(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Updates annotation inside asset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_annotation():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateAnnotationRequest(
    )

    # Make the request
    response = await client.update_annotation(request=request)

    # Handle the response
    print(response)

Updates an asset inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateAssetRequest(
    )

    # Make the request
    response = await client.update_asset(request=request)

    # Handle the response
    print(response)

Updates a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_collection():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateCollectionRequest(
    )

    # Make the request
    response = await client.update_collection(request=request)

    # Handle the response
    print(response)

Updates a corpus in a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_corpus():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    corpus = visionai_v1.Corpus()
    corpus.display_name = "display_name_value"

    request = visionai_v1.UpdateCorpusRequest(
        corpus=corpus,
    )

    # Make the request
    response = await client.update_corpus(request=request)

    # Handle the response
    print(response)

Updates data schema inside corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_data_schema():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    data_schema = visionai_v1.DataSchema()
    data_schema.key = "key_value"

    request = visionai_v1.UpdateDataSchemaRequest(
        data_schema=data_schema,
    )

    # Make the request
    response = await client.update_data_schema(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_index():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    index = visionai_v1.Index()
    index.entire_corpus = True

    request = visionai_v1.UpdateIndexRequest(
        index=index,
    )

    # Make the request
    operation = client.update_index(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Updates an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_index_endpoint():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateIndexEndpointRequest(
    )

    # Make the request
    operation = client.update_index_endpoint(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_search_config():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateSearchConfigRequest(
    )

    # Make the request
    response = await client.update_search_config(request=request)

    # Handle the response
    print(response)

Updates a SearchHypernym inside a corpus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_update_search_hypernym():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UpdateSearchHypernymRequest(
    )

    # Make the request
    response = await client.update_search_hypernym(request=request)

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_upload_asset():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.UploadAssetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.upload_asset(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

View items inside a collection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_view_collection_items():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ViewCollectionItemsRequest(
        collection="collection_value",
    )

    # Make the request
    page_result = client.view_collection_items(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Lists assets inside an index.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import visionai_v1

async def sample_view_indexed_assets():
    # Create a client
    client = visionai_v1.WarehouseAsyncClient()

    # Initialize request argument(s)
    request = visionai_v1.ViewIndexedAssetsRequest(
        index="index_value",
    )

    # Make the request
    page_result = client.view_indexed_assets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)