Class ExperimentsClient (0.8.0)

Version 0.8.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

ExperimentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.services.experiments.transports.base.ExperimentsTransport]] = None, 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][google.cloud.dialogflow.cx.v3beta1.Experiment].

Inheritance

builtins.object > ExperimentsClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
ExperimentsTransport	The transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

create_experiment

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

Creates an [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment] in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.CreateExperimentRequest The request object. The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.CreateExperiment].

Returns

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

delete_experiment

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

Deletes the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.DeleteExperimentRequest The request object. The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.DeleteExperiment].

experiment_path

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

Returns a fully-qualified experiment string.

Parameters

Name	Description
project
location
agent
environment
experiment

from_service_account_file

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

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

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
ExperimentsClient	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.

Parameters

Name	Description
info	dict The service account private key info.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
ExperimentsClient	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.

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
ExperimentsClient	The constructed client.

get_experiment

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

Retrieves the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.GetExperimentRequest The request object. The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.GetExperiment].

Returns

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

list_experiments

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

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3beta1.Environment].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.ListExperimentsRequest The request object. The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3beta1.Experiments.ListExperiments].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.services.experiments.pagers.ListExperimentsPager	The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3beta1.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.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_experiment_path

parse_experiment_path(path: str)

Parses a experiment path into its component segments.

Parameter

Name	Description
path

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

Parameter

Name	Description
path

start_experiment

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

Starts the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment]. This rpc only changes the state of experiment from PENDING to RUNNING.

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.StartExperimentRequest The request object. The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.StartExperiment].

Returns

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

stop_experiment

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

Stops the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment]. This rpc only changes the state of experiment from RUNNING to DONE.

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.StopExperimentRequest The request object. The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.StopExperiment].

Returns

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

update_experiment

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

Updates the specified [Experiment][google.cloud.dialogflow.cx.v3beta1.Experiment].

Parameter

Name	Description
request	google.cloud.dialogflowcx_v3beta1.types.UpdateExperimentRequest The request object. The request message for [Experiments.UpdateExperiment][google.cloud.dialogflow.cx.v3beta1.Experiments.UpdateExperiment].

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.

Parameters

Name	Description
project
location
agent
flow
version