Class EvaluationServiceClient (0.13.5) 

EvaluationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing Evaluations,

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
EvaluationServiceTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

EvaluationServiceClient

EvaluationServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1alpha.services.evaluation_service.transports.base.EvaluationServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the evaluation service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,EvaluationServiceTransport,Callable[..., EvaluationServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the EvaluationServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

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.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_evaluation

create_evaluation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1alpha.types.evaluation_service.CreateEvaluationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    evaluation: typing.Optional[
        google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a xref_Evaluation.

Upon creation, the evaluation will be automatically triggered and begin execution.

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

def sample_create_evaluation():
    # Create a client
    client = discoveryengine_v1alpha.EvaluationServiceClient()

    # Initialize request argument(s)
    evaluation = discoveryengine_v1alpha.Evaluation()
    evaluation.evaluation_spec.search_request.serving_config = "serving_config_value"
    evaluation.evaluation_spec.query_set_spec.sample_query_set = "sample_query_set_value"

    request = discoveryengine_v1alpha.CreateEvaluationRequest(
        parent="parent_value",
        evaluation=evaluation,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1alpha.types.CreateEvaluationRequest, dict]

The request object. Request message for EvaluationService.CreateEvaluation method.
parent str

Required. The parent resource name, such as projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
evaluation google.cloud.discoveryengine_v1alpha.types.Evaluation

Required. The Evaluation to create. This corresponds to the evaluation field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Evaluation An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

evaluation_path

evaluation_path(project: str, location: str, evaluation: str) -> str

Returns a fully-qualified evaluation string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
EvaluationServiceClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
EvaluationServiceClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
EvaluationServiceClient The constructed client.

get_evaluation

get_evaluation(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1alpha.types.evaluation_service.GetEvaluationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.discoveryengine_v1alpha.types.evaluation.Evaluation

Gets a xref_Evaluation.

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

def sample_get_evaluation():
    # Create a client
    client = discoveryengine_v1alpha.EvaluationServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.GetEvaluationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1alpha.types.GetEvaluationRequest, dict]

The request object. Request message for EvaluationService.GetEvaluation method.
name str

Required. Full resource name of Evaluation, such as projects/{project}/locations/{location}/evaluations/{evaluation}. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.discoveryengine_v1alpha.types.Evaluation An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

list_evaluation_results

list_evaluation_results(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationResultsRequest,
            dict,
        ]
    ] = None,
    *,
    evaluation: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager
)

Gets a list of results for a given a xref_Evaluation.

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

def sample_list_evaluation_results():
    # Create a client
    client = discoveryengine_v1alpha.EvaluationServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ListEvaluationResultsRequest(
        evaluation="evaluation_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationResultsRequest, dict]

The request object. Request message for EvaluationService.ListEvaluationResults method.
evaluation str

Required. The evaluation resource name, such as projects/{project}/locations/{location}/evaluations/{evaluation}. If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a PERMISSION_DENIED error is returned. This corresponds to the evaluation field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationResultsPager Response message for EvaluationService.ListEvaluationResults method. Iterating over this object will yield results and resolve additional pages automatically.

list_evaluations

list_evaluations(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1alpha.types.evaluation_service.ListEvaluationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager
)

Gets a list of xref_Evaluations.

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

def sample_list_evaluations():
    # Create a client
    client = discoveryengine_v1alpha.EvaluationServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ListEvaluationsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1alpha.types.ListEvaluationsRequest, dict]

The request object. Request message for EvaluationService.ListEvaluations method.
parent str

Required. The parent location resource name, such as projects/{project}/locations/{location}. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.discoveryengine_v1alpha.services.evaluation_service.pagers.ListEvaluationsPager Response message for EvaluationService.ListEvaluations method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

location_path

location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

parse_evaluation_path

parse_evaluation_path(path: str) -> typing.Dict[str, str]

Parses a evaluation path into its component segments.

parse_location_path

parse_location_path(path: str) -> typing.Dict[str, str]

Parses a location path into its component segments.

parse_sample_query_path

parse_sample_query_path(path: str) -> typing.Dict[str, str]

Parses a sample_query path into its component segments.

parse_sample_query_set_path

parse_sample_query_set_path(path: str) -> typing.Dict[str, str]

Parses a sample_query_set path into its component segments.

parse_serving_config_path

parse_serving_config_path(path: str) -> typing.Dict[str, str]

Parses a serving_config path into its component segments.

parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

sample_query_path

sample_query_path(
    project: str, location: str, sample_query_set: str, sample_query: str
) -> str

Returns a fully-qualified sample_query string.

sample_query_set_path

sample_query_set_path(project: str, location: str, sample_query_set: str) -> str

Returns a fully-qualified sample_query_set string.

serving_config_path

serving_config_path(
    project: str, location: str, data_store: str, serving_config: str
) -> str

Returns a fully-qualified serving_config string.

session_path

session_path(project: str, location: str, data_store: str, session: str) -> str

Returns a fully-qualified session string.