experiments

Creates, updates, deletes, gets or lists an experiments resource.

Overview

Name	experiments
Type	Resource
Id	google.dialogflow.experiments

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_environments_experiments_get

Successful response

Name	Datatype	Description
name	string	The name of the experiment. Format: projects//locations//agents//environments//experiments/.
createTime	string (google-datetime)	Creation time of this experiment.
definition	object	The definition of the experiment. (id: GoogleCloudDialogflowCxV3ExperimentDefinition)
description	string	The human-readable description of the experiment.
displayName	string	Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
endTime	string (google-datetime)	End time of this experiment.
experimentLength	string (google-duration)	Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
lastUpdateTime	string (google-datetime)	Last update time of this experiment.
result	object	Inference result of the experiment. (id: GoogleCloudDialogflowCxV3ExperimentResult)
rolloutConfig	object	The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow. (id: GoogleCloudDialogflowCxV3RolloutConfig)
rolloutFailureReason	string	The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
rolloutState	object	State of the auto rollout process. (id: GoogleCloudDialogflowCxV3RolloutState)
startTime	string (google-datetime)	Start time of this experiment.
state	string	The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
variantsHistory	array	The history of updates to the experiment variants.

projects_locations_agents_environments_experiments_list

Successful response

Name	Datatype	Description
name	string	The name of the experiment. Format: projects//locations//agents//environments//experiments/.
createTime	string (google-datetime)	Creation time of this experiment.
definition	object	The definition of the experiment. (id: GoogleCloudDialogflowCxV3ExperimentDefinition)
description	string	The human-readable description of the experiment.
displayName	string	Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
endTime	string (google-datetime)	End time of this experiment.
experimentLength	string (google-duration)	Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
lastUpdateTime	string (google-datetime)	Last update time of this experiment.
result	object	Inference result of the experiment. (id: GoogleCloudDialogflowCxV3ExperimentResult)
rolloutConfig	object	The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow. (id: GoogleCloudDialogflowCxV3RolloutConfig)
rolloutFailureReason	string	The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
rolloutState	object	State of the auto rollout process. (id: GoogleCloudDialogflowCxV3RolloutState)
startTime	string (google-datetime)	Start time of this experiment.
state	string	The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
variantsHistory	array	The history of updates to the experiment variants.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_environments_experiments_get	select	projectsId, locationsId, agentsId, environmentsId, experimentsId		Retrieves the specified Experiment.
projects_locations_agents_environments_experiments_list	select	projectsId, locationsId, agentsId, environmentsId	pageSize, pageToken	Returns the list of all experiments in the specified Environment.
projects_locations_agents_environments_experiments_create	insert	projectsId, locationsId, agentsId, environmentsId		Creates an Experiment in the specified Environment.
projects_locations_agents_environments_experiments_patch	update	projectsId, locationsId, agentsId, environmentsId, experimentsId	updateMask	Updates the specified Experiment.
projects_locations_agents_environments_experiments_delete	delete	projectsId, locationsId, agentsId, environmentsId, experimentsId		Deletes the specified Experiment.
projects_locations_agents_environments_experiments_start	exec	projectsId, locationsId, agentsId, environmentsId, experimentsId		Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
projects_locations_agents_environments_experiments_stop	exec	projectsId, locationsId, agentsId, environmentsId, experimentsId		Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
environmentsId	string
experimentsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_environments_experiments_get

Retrieves the specified Experiment.

SELECT
name,
createTime,
definition,
description,
displayName,
endTime,
experimentLength,
lastUpdateTime,
result,
rolloutConfig,
rolloutFailureReason,
rolloutState,
startTime,
state,
variantsHistory
FROM google.dialogflow.experiments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND experimentsId = '{{ experimentsId }}' -- required;

projects_locations_agents_environments_experiments_list

Returns the list of all experiments in the specified Environment.

SELECT
name,
createTime,
definition,
description,
displayName,
endTime,
experimentLength,
lastUpdateTime,
result,
rolloutConfig,
rolloutFailureReason,
rolloutState,
startTime,
state,
variantsHistory
FROM google.dialogflow.experiments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_agents_environments_experiments_create

Creates an Experiment in the specified Environment.

INSERT INTO google.dialogflow.experiments (
data__name,
data__displayName,
data__description,
data__state,
data__definition,
data__rolloutConfig,
data__rolloutState,
data__rolloutFailureReason,
data__result,
data__createTime,
data__startTime,
data__endTime,
data__lastUpdateTime,
data__experimentLength,
data__variantsHistory,
projectsId,
locationsId,
agentsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ state }}',
'{{ definition }}',
'{{ rolloutConfig }}',
'{{ rolloutState }}',
'{{ rolloutFailureReason }}',
'{{ result }}',
'{{ createTime }}',
'{{ startTime }}',
'{{ endTime }}',
'{{ lastUpdateTime }}',
'{{ experimentLength }}',
'{{ variantsHistory }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ environmentsId }}'
RETURNING
name,
createTime,
definition,
description,
displayName,
endTime,
experimentLength,
lastUpdateTime,
result,
rolloutConfig,
rolloutFailureReason,
rolloutState,
startTime,
state,
variantsHistory
;

Manifest

# Description fields are for documentation purposes
- name: experiments
  props:
    - name: projectsId
      value: string
      description: Required parameter for the experiments resource.
    - name: locationsId
      value: string
      description: Required parameter for the experiments resource.
    - name: agentsId
      value: string
      description: Required parameter for the experiments resource.
    - name: environmentsId
      value: string
      description: Required parameter for the experiments resource.
    - name: name
      value: string
      description: >
        The name of the experiment. Format: projects//locations//agents//environments//experiments/.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
        
    - name: description
      value: string
      description: >
        The human-readable description of the experiment.
        
    - name: state
      value: string
      description: >
        The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.
        
      valid_values: ['STATE_UNSPECIFIED', 'DRAFT', 'RUNNING', 'DONE', 'ROLLOUT_FAILED']
    - name: definition
      value: object
      description: >
        The definition of the experiment.
        
    - name: rolloutConfig
      value: object
      description: >
        The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.
        
    - name: rolloutState
      value: object
      description: >
        State of the auto rollout process.
        
    - name: rolloutFailureReason
      value: string
      description: >
        The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
        
    - name: result
      value: object
      description: >
        Inference result of the experiment.
        
    - name: createTime
      value: string
      description: >
        Creation time of this experiment.
        
    - name: startTime
      value: string
      description: >
        Start time of this experiment.
        
    - name: endTime
      value: string
      description: >
        End time of this experiment.
        
    - name: lastUpdateTime
      value: string
      description: >
        Last update time of this experiment.
        
    - name: experimentLength
      value: string
      description: >
        Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
        
    - name: variantsHistory
      value: array
      description: >
        The history of updates to the experiment variants.
        

UPDATE examples

projects_locations_agents_environments_experiments_patch

Updates the specified Experiment.

UPDATE google.dialogflow.experiments
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__state = '{{ state }}',
data__definition = '{{ definition }}',
data__rolloutConfig = '{{ rolloutConfig }}',
data__rolloutState = '{{ rolloutState }}',
data__rolloutFailureReason = '{{ rolloutFailureReason }}',
data__result = '{{ result }}',
data__createTime = '{{ createTime }}',
data__startTime = '{{ startTime }}',
data__endTime = '{{ endTime }}',
data__lastUpdateTime = '{{ lastUpdateTime }}',
data__experimentLength = '{{ experimentLength }}',
data__variantsHistory = '{{ variantsHistory }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
definition,
description,
displayName,
endTime,
experimentLength,
lastUpdateTime,
result,
rolloutConfig,
rolloutFailureReason,
rolloutState,
startTime,
state,
variantsHistory;

DELETE examples

projects_locations_agents_environments_experiments_delete

Deletes the specified Experiment.

DELETE FROM google.dialogflow.experiments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required;

Lifecycle Methods

projects_locations_agents_environments_experiments_start

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

EXEC google.dialogflow.experiments.projects_locations_agents_environments_experiments_start 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required;

projects_locations_agents_environments_experiments_stop

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

EXEC google.dialogflow.experiments.projects_locations_agents_environments_experiments_stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required;