Class ExperimentsAsyncClient (1.11.0)

Version 1.11.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

ExperimentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.experiments.transports.base.ExperimentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing Experiments.

Properties

transport

Returns the transport used by the client instance.

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

Methods

ExperimentsAsyncClient

ExperimentsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.experiments.transports.base.ExperimentsTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the experiments 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	Union[str, .ExperimentsTransport] The transport to use. If set to None, a transport is chosen automatically.
client_options	ClientOptions Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Exceptions
Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_experiment

create_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.CreateExperimentRequest, dict]] = None, *, parent: Optional[str] = None, experiment: Optional[google.cloud.dialogflowcx_v3beta1.types.experiment.Experiment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an xref_Experiment in the specified xref_Environment.

from google.cloud import dialogflowcx_v3beta1

async def sample_create_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    experiment = dialogflowcx_v3beta1.Experiment()
    experiment.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.CreateExperimentRequest(
        parent="parent_value",
        experiment=experiment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.CreateExperimentRequest, dict] The request object. The request message for Experiments.CreateExperiment.
parent	str Required. The Agent to create an Environment for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
experiment	Experiment Required. The experiment to create. This corresponds to the experiment 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.types.Experiment	Represents an experiment in an environment.

delete_experiment

delete_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.DeleteExperimentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified xref_Experiment.

from google.cloud import dialogflowcx_v3beta1

async def sample_delete_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeleteExperimentRequest(
        name="name_value",
    )

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

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.DeleteExperimentRequest, dict] The request object. The request message for Experiments.DeleteExperiment.
name	str Required. The name of the Environment to delete. Format: projects/. 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, str]] Strings which should be sent along with the request as metadata.

experiment_path

experiment_path(
    project: str, location: str, agent: str, environment: str, experiment: str
)

Returns a fully-qualified experiment 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
ExperimentsAsyncClient	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
ExperimentsAsyncClient	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
ExperimentsAsyncClient	The constructed client.

get_experiment

get_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.GetExperimentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified xref_Experiment.

from google.cloud import dialogflowcx_v3beta1

async def sample_get_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.GetExperimentRequest, dict] The request object. The request message for Experiments.GetExperiment.
name	str Required. The name of the Environment. Format: projects/. 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.types.Experiment	Represents an experiment in an environment.

get_mtls_endpoint_and_cert_source

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

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.

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_transport_class

get_transport_class()

Returns an appropriate transport class.

list_experiments

list_experiments(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.ListExperimentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all experiments in the specified xref_Environment.

from google.cloud import dialogflowcx_v3beta1

async def sample_list_experiments():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListExperimentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.ListExperimentsRequest, dict] The request object. The request message for Experiments.ListExperiments.
parent	str Required. The Environment to list all environments for. Format: projects/. 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.services.experiments.pagers.ListExperimentsAsyncPager	The response message for Experiments.ListExperiments. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_experiment_path

parse_experiment_path(path: str)

Parses a experiment path into its component segments.

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

start_experiment

start_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.StartExperimentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts the specified xref_Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

from google.cloud import dialogflowcx_v3beta1

async def sample_start_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.StartExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.StartExperimentRequest, dict] The request object. The request message for Experiments.StartExperiment.
name	str Required. Resource name of the experiment to start. Format: projects/. 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.types.Experiment	Represents an experiment in an environment.

stop_experiment

stop_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.StopExperimentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops the specified xref_Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

from google.cloud import dialogflowcx_v3beta1

async def sample_stop_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.StopExperimentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.StopExperimentRequest, dict] The request object. The request message for Experiments.StopExperiment.
name	str Required. Resource name of the experiment to stop. Format: projects/. 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.types.Experiment	Represents an experiment in an environment.

update_experiment

update_experiment(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.experiment.UpdateExperimentRequest, dict]] = None, *, experiment: Optional[google.cloud.dialogflowcx_v3beta1.types.experiment.Experiment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified xref_Experiment.

from google.cloud import dialogflowcx_v3beta1

async def sample_update_experiment():
    # Create a client
    client = dialogflowcx_v3beta1.ExperimentsAsyncClient()

    # Initialize request argument(s)
    experiment = dialogflowcx_v3beta1.Experiment()
    experiment.display_name = "display_name_value"

    request = dialogflowcx_v3beta1.UpdateExperimentRequest(
        experiment=experiment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3beta1.types.UpdateExperimentRequest, dict] The request object. The request message for Experiments.UpdateExperiment.
experiment	Experiment Required. The experiment to update. This corresponds to the experiment field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Required. The mask to control which fields get updated. This corresponds to the update_mask 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, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3beta1.types.Experiment	Represents an experiment in an environment.

version_path

version_path(project: str, location: str, agent: str, flow: str, version: str)

Returns a fully-qualified version string.