As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Experiments

class google.cloud.dialogflowcx_v3.services.experiments.ExperimentsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [Experiments][google.cloud.dialogflow.cx.v3.Experiment].

Instantiates the experiments client.

Parameters
  • 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateExperimentRequest) – The request object. The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3.Experiments.CreateExperiment].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • experiment (google.cloud.dialogflowcx_v3.types.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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

async delete_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())None[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteExperimentRequest) – The request object. The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3.Experiments.DeleteExperiment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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.

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

Returns a fully-qualified experiment string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ExperimentsAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

ExperimentsAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ExperimentsAsyncClient

async get_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetExperimentRequest) – The request object. The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3.Experiments.GetExperiment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_experiments(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsAsyncPager[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListExperimentsRequest) – The request object. The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

  • parent (str) –

    Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

    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

The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_experiment_path(path: str)Dict[str, str]

Parses a experiment path into its component segments.

static parse_version_path(path: str)Dict[str, str]

Parses a version path into its component segments.

async start_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.StartExperimentRequest) – The request object. The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3.Experiments.StartExperiment].

  • name (str) –

    Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

async stop_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.StopExperimentRequest) – The request object. The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3.Experiments.StopExperiment].

  • name (str) –

    Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

property transport: google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ExperimentsTransport

async update_experiment(request: Optional[google.cloud.dialogflowcx_v3.types.experiment.UpdateExperimentRequest] = None, *, experiment: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
Returns

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

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

Returns a fully-qualified version string.

class google.cloud.dialogflowcx_v3.services.experiments.ExperimentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.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>)[source]

Service for managing [Experiments][google.cloud.dialogflow.cx.v3.Experiment].

Instantiates the experiments client.

Parameters
  • 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 (google.api_core.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.

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

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateExperimentRequest) – The request object. The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3.Experiments.CreateExperiment].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • experiment (google.cloud.dialogflowcx_v3.types.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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

delete_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())None[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteExperimentRequest) – The request object. The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3.Experiments.DeleteExperiment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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.

static experiment_path(project: str, location: str, agent: str, environment: str, experiment: str)str[source]

Returns a fully-qualified experiment string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ExperimentsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

ExperimentsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

ExperimentsClient

get_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetExperimentRequest) – The request object. The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3.Experiments.GetExperiment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

list_experiments(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsPager[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListExperimentsRequest) – The request object. The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

  • parent (str) –

    Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

    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

The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_experiment_path(path: str)Dict[str, str][source]

Parses a experiment path into its component segments.

static parse_version_path(path: str)Dict[str, str][source]

Parses a version path into its component segments.

start_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.StartExperimentRequest) – The request object. The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3.Experiments.StartExperiment].

  • name (str) –

    Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

stop_experiment(request: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.StopExperimentRequest) – The request object. The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3.Experiments.StopExperiment].

  • name (str) –

    Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

    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

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

property transport: google.cloud.dialogflowcx_v3.services.experiments.transports.base.ExperimentsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ExperimentsTransport

update_experiment(request: Optional[google.cloud.dialogflowcx_v3.types.experiment.UpdateExperimentRequest] = None, *, experiment: Optional[google.cloud.dialogflowcx_v3.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]] = ())google.cloud.dialogflowcx_v3.types.experiment.Experiment[source]

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

Parameters
Returns

Represents an experiment in an environment.

Return type

google.cloud.dialogflowcx_v3.types.Experiment

static version_path(project: str, location: str, agent: str, flow: str, version: str)str[source]

Returns a fully-qualified version string.

class google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsResponse]], request: google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsRequest, response: google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_experiments requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListExperimentsResponse object, and provides an __aiter__ method to iterate through its experiments field.

If there are more pages, the __aiter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.experiments.pagers.ListExperimentsPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsResponse], request: google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsRequest, response: google.cloud.dialogflowcx_v3.types.experiment.ListExperimentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_experiments requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListExperimentsResponse object, and provides an __iter__ method to iterate through its experiments field.

If there are more pages, the __iter__ method will make additional ListExperiments requests and continue to iterate through the experiments field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListExperimentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters