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

Name	Datatype	Description
name	string
createTime	string (google-datetime)
definition	object	(id: GoogleCloudDialogflowCxV3ExperimentDefinition)
description	string
displayName	string
endTime	string (google-datetime)
experimentLength	string (google-duration)
lastUpdateTime	string (google-datetime)
result	object	(id: GoogleCloudDialogflowCxV3ExperimentResult)
rolloutConfig	object	(id: GoogleCloudDialogflowCxV3RolloutConfig)
rolloutFailureReason	string
rolloutState	object	(id: GoogleCloudDialogflowCxV3RolloutState)
startTime	string (google-datetime)
state	string	(STATE_UNSPECIFIED, DRAFT, RUNNING, DONE, ROLLOUT_FAILED)
variantsHistory	array

projects_locations_agents_environments_experiments_list

Name	Datatype	Description
name	string
createTime	string (google-datetime)
definition	object	(id: GoogleCloudDialogflowCxV3ExperimentDefinition)
description	string
displayName	string
endTime	string (google-datetime)
experimentLength	string (google-duration)
lastUpdateTime	string (google-datetime)
result	object	(id: GoogleCloudDialogflowCxV3ExperimentResult)
rolloutConfig	object	(id: GoogleCloudDialogflowCxV3RolloutConfig)
rolloutFailureReason	string
rolloutState	object	(id: GoogleCloudDialogflowCxV3RolloutState)
startTime	string (google-datetime)
state	string	(STATE_UNSPECIFIED, DRAFT, RUNNING, DONE, ROLLOUT_FAILED)
variantsHistory	array

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
projects_locations_agents_environments_experiments_list	select	projectsId, locationsId, agentsId, environmentsId	pageToken, pageSize
projects_locations_agents_environments_experiments_create	insert	projectsId, locationsId, agentsId, environmentsId
projects_locations_agents_environments_experiments_patch	update	projectsId, locationsId, agentsId, environmentsId, experimentsId	updateMask
projects_locations_agents_environments_experiments_delete	delete	projectsId, locationsId, agentsId, environmentsId, experimentsId
projects_locations_agents_environments_experiments_start	exec	projectsId, locationsId, agentsId, environmentsId, experimentsId
projects_locations_agents_environments_experiments_stop	exec	projectsId, locationsId, agentsId, environmentsId, experimentsId

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

Successful response

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

Successful response

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 pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_agents_environments_experiments_create

No description available.

INSERT INTO google.dialogflow.experiments (
data__result,
data__endTime,
data__experimentLength,
data__rolloutConfig,
data__name,
data__lastUpdateTime,
data__rolloutFailureReason,
data__createTime,
data__state,
data__startTime,
data__displayName,
data__description,
data__rolloutState,
data__definition,
data__variantsHistory,
projectsId,
locationsId,
agentsId,
environmentsId
)
SELECT 
'{{ result }}',
'{{ endTime }}',
'{{ experimentLength }}',
'{{ rolloutConfig }}',
'{{ name }}',
'{{ lastUpdateTime }}',
'{{ rolloutFailureReason }}',
'{{ createTime }}',
'{{ state }}',
'{{ startTime }}',
'{{ displayName }}',
'{{ description }}',
'{{ rolloutState }}',
'{{ definition }}',
'{{ 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: "{{ projectsId }}"
    description: Required parameter for the experiments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the experiments resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the experiments resource.
  - name: environmentsId
    value: "{{ environmentsId }}"
    description: Required parameter for the experiments resource.
  - name: result
    value:
      versionMetrics:
        - version: "{{ version }}"
          sessionCount: {{ sessionCount }}
          metrics: "{{ metrics }}"
      lastUpdateTime: "{{ lastUpdateTime }}"
  - name: endTime
    value: "{{ endTime }}"
  - name: experimentLength
    value: "{{ experimentLength }}"
  - name: rolloutConfig
    value:
      rolloutSteps:
        - trafficPercent: {{ trafficPercent }}
          minDuration: "{{ minDuration }}"
          displayName: "{{ displayName }}"
      rolloutCondition: "{{ rolloutCondition }}"
      failureCondition: "{{ failureCondition }}"
  - name: name
    value: "{{ name }}"
  - name: lastUpdateTime
    value: "{{ lastUpdateTime }}"
  - name: rolloutFailureReason
    value: "{{ rolloutFailureReason }}"
  - name: createTime
    value: "{{ createTime }}"
  - name: state
    value: "{{ state }}"
    valid_values: ['STATE_UNSPECIFIED', 'DRAFT', 'RUNNING', 'DONE', 'ROLLOUT_FAILED']
  - name: startTime
    value: "{{ startTime }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: rolloutState
    value:
      step: "{{ step }}"
      stepIndex: {{ stepIndex }}
      startTime: "{{ startTime }}"
  - name: definition
    value:
      condition: "{{ condition }}"
      versionVariants:
        variants:
          - trafficAllocation: {{ trafficAllocation }}
            version: "{{ version }}"
            isControlGroup: {{ isControlGroup }}
  - name: variantsHistory
    value:
      - updateTime: "{{ updateTime }}"
        versionVariants:
          variants:
            - trafficAllocation: {{ trafficAllocation }}
              version: "{{ version }}"
              isControlGroup: {{ isControlGroup }}

UPDATE examples

projects_locations_agents_environments_experiments_patch

No description available.

UPDATE google.dialogflow.experiments
SET 
data__result = '{{ result }}',
data__endTime = '{{ endTime }}',
data__experimentLength = '{{ experimentLength }}',
data__rolloutConfig = '{{ rolloutConfig }}',
data__name = '{{ name }}',
data__lastUpdateTime = '{{ lastUpdateTime }}',
data__rolloutFailureReason = '{{ rolloutFailureReason }}',
data__createTime = '{{ createTime }}',
data__state = '{{ state }}',
data__startTime = '{{ startTime }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__rolloutState = '{{ rolloutState }}',
data__definition = '{{ definition }}',
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

No description available.

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

Successful response

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

Successful response

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
;