Class CompletionServiceClient (1.9.0)

Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Returns the transport used by the client instance.

Instantiates the completion service client.

Releases underlying transport's resources.

Returns a fully-qualified catalog 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.

Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2alpha

def sample_complete_query():
    # Create a client
    client = retail_v2alpha.CompletionServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.CompleteQueryRequest(
        catalog="catalog_value",
        query="query_value",
    )

    # Make the request
    response = client.complete_query(request=request)

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

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

Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

from google.cloud import retail_v2alpha

def sample_import_completion_data():
    # Create a client
    client = retail_v2alpha.CompletionServiceClient()

    # Initialize request argument(s)
    input_config = retail_v2alpha.CompletionDataInputConfig()
    input_config.big_query_source.dataset_id = "dataset_id_value"
    input_config.big_query_source.table_id = "table_id_value"

    request = retail_v2alpha.ImportCompletionDataRequest(
        parent="parent_value",
        input_config=input_config,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parses a catalog 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.