test_cases
Creates, updates, deletes, gets or lists a test_cases resource.
Overview
| Name | test_cases |
| Type | Resource |
| Id | google.dialogflow.test_cases |
Fields
The following fields are returned by SELECT queries:
- projects_locations_agents_test_cases_get
- projects_locations_agents_test_cases_list
| Name | Datatype | Description |
|---|---|---|
name | string | |
creationTime | string (google-datetime) | |
displayName | string | |
lastTestResult | object | (id: GoogleCloudDialogflowCxV3TestCaseResult) |
notes | string | |
tags | array | |
testCaseConversationTurns | array | |
testConfig | object | (id: GoogleCloudDialogflowCxV3TestConfig) |
| Name | Datatype | Description |
|---|---|---|
name | string | |
creationTime | string (google-datetime) | |
displayName | string | |
lastTestResult | object | (id: GoogleCloudDialogflowCxV3TestCaseResult) |
notes | string | |
tags | array | |
testCaseConversationTurns | array | |
testConfig | object | (id: GoogleCloudDialogflowCxV3TestConfig) |
Methods
The following methods are available for this resource:
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 | |
locationsId | string | |
projectsId | string | |
testCasesId | string | |
pageSize | integer (int32) | |
pageToken | string | |
type | string | |
updateMask | string (google-fieldmask) | |
view | string |
SELECT examples
- projects_locations_agents_test_cases_get
- projects_locations_agents_test_cases_list
Successful response
SELECT
name,
creationTime,
displayName,
lastTestResult,
notes,
tags,
testCaseConversationTurns,
testConfig
FROM google.dialogflow.test_cases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND testCasesId = '{{ testCasesId }}' -- required
;
Successful response
SELECT
name,
creationTime,
displayName,
lastTestResult,
notes,
tags,
testCaseConversationTurns,
testConfig
FROM google.dialogflow.test_cases
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND view = '{{ view }}'
AND pageToken = '{{ pageToken }}'
;
INSERT examples
- projects_locations_agents_test_cases_create
- Manifest
No description available.
INSERT INTO google.dialogflow.test_cases (
data__tags,
data__notes,
data__name,
data__testCaseConversationTurns,
data__lastTestResult,
data__testConfig,
data__displayName,
projectsId,
locationsId,
agentsId
)
SELECT
'{{ tags }}',
'{{ notes }}',
'{{ name }}',
'{{ testCaseConversationTurns }}',
'{{ lastTestResult }}',
'{{ testConfig }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}'
RETURNING
name,
creationTime,
displayName,
lastTestResult,
notes,
tags,
testCaseConversationTurns,
testConfig
;
# Description fields are for documentation purposes
- name: test_cases
props:
- name: projectsId
value: "{{ projectsId }}"
description: Required parameter for the test_cases resource.
- name: locationsId
value: "{{ locationsId }}"
description: Required parameter for the test_cases resource.
- name: agentsId
value: "{{ agentsId }}"
description: Required parameter for the test_cases resource.
- name: tags
value:
- "{{ tags }}"
- name: notes
value: "{{ notes }}"
- name: name
value: "{{ name }}"
- name: testCaseConversationTurns
value:
- userInput:
isWebhookEnabled: {{ isWebhookEnabled }}
injectedParameters: "{{ injectedParameters }}"
enableSentimentAnalysis: {{ enableSentimentAnalysis }}
input:
text:
text: "{{ text }}"
audio:
config:
sampleRateHertz: {{ sampleRateHertz }}
model: "{{ model }}"
bargeInConfig: "{{ bargeInConfig }}"
audioEncoding: "{{ audioEncoding }}"
enableWordInfo: {{ enableWordInfo }}
singleUtterance: {{ singleUtterance }}
modelVariant: "{{ modelVariant }}"
optOutConformerModelMigration: {{ optOutConformerModelMigration }}
phraseHints: "{{ phraseHints }}"
audio: "{{ audio }}"
dtmf:
finishDigit: "{{ finishDigit }}"
digits: "{{ digits }}"
intent:
intent: "{{ intent }}"
toolCallResult:
tool: "{{ tool }}"
action: "{{ action }}"
error:
message: "{{ message }}"
outputParameters: "{{ outputParameters }}"
languageCode: "{{ languageCode }}"
event:
event: "{{ event }}"
virtualAgentOutput:
differences:
- description: "{{ description }}"
type: "{{ type }}"
triggeredIntent:
trainingPhrases:
- parts: "{{ parts }}"
repeatCount: {{ repeatCount }}
id: "{{ id }}"
priority: {{ priority }}
displayName: "{{ displayName }}"
parameters:
- entityType: "{{ entityType }}"
redact: {{ redact }}
id: "{{ id }}"
isList: {{ isList }}
isFallback: {{ isFallback }}
dtmfPattern: "{{ dtmfPattern }}"
name: "{{ name }}"
labels: "{{ labels }}"
description: "{{ description }}"
sessionParameters: "{{ sessionParameters }}"
currentPage:
eventHandlers:
- name: "{{ name }}"
event: "{{ event }}"
targetPage: "{{ targetPage }}"
triggerFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
targetFlow: "{{ targetFlow }}"
targetPlaybook: "{{ targetPlaybook }}"
form:
parameters:
- required: {{ required }}
isList: {{ isList }}
redact: {{ redact }}
displayName: "{{ displayName }}"
advancedSettings:
loggingSettings: "{{ loggingSettings }}"
audioExportGcsDestination: "{{ audioExportGcsDestination }}"
speechSettings: "{{ speechSettings }}"
dtmfSettings: "{{ dtmfSettings }}"
entityType: "{{ entityType }}"
fillBehavior:
initialPromptFulfillment: "{{ initialPromptFulfillment }}"
repromptEventHandlers: "{{ repromptEventHandlers }}"
defaultValue: "{{ defaultValue }}"
displayName: "{{ displayName }}"
transitionRouteGroups:
- "{{ transitionRouteGroups }}"
knowledgeConnectorSettings:
targetFlow: "{{ targetFlow }}"
dataStoreConnections:
- dataStore: "{{ dataStore }}"
documentProcessingMode: "{{ documentProcessingMode }}"
dataStoreType: "{{ dataStoreType }}"
triggerFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
enabled: {{ enabled }}
targetPage: "{{ targetPage }}"
name: "{{ name }}"
transitionRoutes:
- name: "{{ name }}"
targetPage: "{{ targetPage }}"
condition: "{{ condition }}"
description: "{{ description }}"
targetFlow: "{{ targetFlow }}"
intent: "{{ intent }}"
triggerFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
description: "{{ description }}"
entryFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators:
- inputParameters: "{{ inputParameters }}"
generator: "{{ generator }}"
outputParameter: "{{ outputParameter }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions:
- parameter: "{{ parameter }}"
value: "{{ value }}"
tag: "{{ tag }}"
advancedSettings:
loggingSettings: "{{ loggingSettings }}"
audioExportGcsDestination: "{{ audioExportGcsDestination }}"
speechSettings: "{{ speechSettings }}"
dtmfSettings: "{{ dtmfSettings }}"
messages:
- playAudio:
audioUri: "{{ audioUri }}"
allowPlaybackInterruption: {{ allowPlaybackInterruption }}
toolCall:
tool: "{{ tool }}"
action: "{{ action }}"
inputParameters: "{{ inputParameters }}"
knowledgeInfoCard: "{{ knowledgeInfoCard }}"
endInteraction: "{{ endInteraction }}"
conversationSuccess:
metadata: "{{ metadata }}"
channel: "{{ channel }}"
text:
text: "{{ text }}"
allowPlaybackInterruption: {{ allowPlaybackInterruption }}
telephonyTransferCall:
phoneNumber: "{{ phoneNumber }}"
responseType: "{{ responseType }}"
payload: "{{ payload }}"
outputAudioText:
text: "{{ text }}"
ssml: "{{ ssml }}"
allowPlaybackInterruption: {{ allowPlaybackInterruption }}
mixedAudio:
segments: "{{ segments }}"
liveAgentHandoff:
metadata: "{{ metadata }}"
conditionalCases:
- cases: "{{ cases }}"
advancedSettings:
loggingSettings:
enableInteractionLogging: {{ enableInteractionLogging }}
enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
enableStackdriverLogging: {{ enableStackdriverLogging }}
audioExportGcsDestination:
uri: "{{ uri }}"
speechSettings:
useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
models: "{{ models }}"
endpointerSensitivity: {{ endpointerSensitivity }}
noSpeechTimeout: "{{ noSpeechTimeout }}"
dtmfSettings:
maxDigits: {{ maxDigits }}
finishDigit: "{{ finishDigit }}"
interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
enabled: {{ enabled }}
endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
textResponses:
- text: "{{ text }}"
allowPlaybackInterruption: {{ allowPlaybackInterruption }}
status:
code: {{ code }}
message: "{{ message }}"
details: "{{ details }}"
diagnosticInfo: "{{ diagnosticInfo }}"
- name: lastTestResult
value:
testResult: "{{ testResult }}"
testTime: "{{ testTime }}"
conversationTurns:
- userInput:
isWebhookEnabled: {{ isWebhookEnabled }}
injectedParameters: "{{ injectedParameters }}"
enableSentimentAnalysis: {{ enableSentimentAnalysis }}
input:
text:
text: "{{ text }}"
audio:
config: "{{ config }}"
audio: "{{ audio }}"
dtmf:
finishDigit: "{{ finishDigit }}"
digits: "{{ digits }}"
intent:
intent: "{{ intent }}"
toolCallResult:
tool: "{{ tool }}"
action: "{{ action }}"
error: "{{ error }}"
outputParameters: "{{ outputParameters }}"
languageCode: "{{ languageCode }}"
event:
event: "{{ event }}"
virtualAgentOutput:
differences:
- description: "{{ description }}"
type: "{{ type }}"
triggeredIntent:
trainingPhrases:
- parts: "{{ parts }}"
repeatCount: {{ repeatCount }}
id: "{{ id }}"
priority: {{ priority }}
displayName: "{{ displayName }}"
parameters:
- entityType: "{{ entityType }}"
redact: {{ redact }}
id: "{{ id }}"
isList: {{ isList }}
isFallback: {{ isFallback }}
dtmfPattern: "{{ dtmfPattern }}"
name: "{{ name }}"
labels: "{{ labels }}"
description: "{{ description }}"
sessionParameters: "{{ sessionParameters }}"
currentPage:
eventHandlers:
- name: "{{ name }}"
event: "{{ event }}"
targetPage: "{{ targetPage }}"
triggerFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
targetFlow: "{{ targetFlow }}"
targetPlaybook: "{{ targetPlaybook }}"
form:
parameters: "{{ parameters }}"
displayName: "{{ displayName }}"
transitionRouteGroups:
- "{{ transitionRouteGroups }}"
knowledgeConnectorSettings:
targetFlow: "{{ targetFlow }}"
dataStoreConnections: "{{ dataStoreConnections }}"
triggerFulfillment: "{{ triggerFulfillment }}"
enabled: {{ enabled }}
targetPage: "{{ targetPage }}"
name: "{{ name }}"
transitionRoutes:
- name: "{{ name }}"
targetPage: "{{ targetPage }}"
condition: "{{ condition }}"
description: "{{ description }}"
targetFlow: "{{ targetFlow }}"
intent: "{{ intent }}"
triggerFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
description: "{{ description }}"
entryFulfillment:
returnPartialResponses: {{ returnPartialResponses }}
generators: "{{ generators }}"
webhook: "{{ webhook }}"
enableGenerativeFallback: {{ enableGenerativeFallback }}
setParameterActions: "{{ setParameterActions }}"
tag: "{{ tag }}"
advancedSettings: "{{ advancedSettings }}"
messages: "{{ messages }}"
conditionalCases: "{{ conditionalCases }}"
advancedSettings:
loggingSettings: "{{ loggingSettings }}"
audioExportGcsDestination: "{{ audioExportGcsDestination }}"
speechSettings: "{{ speechSettings }}"
dtmfSettings: "{{ dtmfSettings }}"
textResponses:
- text: "{{ text }}"
allowPlaybackInterruption: {{ allowPlaybackInterruption }}
status:
code: {{ code }}
message: "{{ message }}"
details: "{{ details }}"
diagnosticInfo: "{{ diagnosticInfo }}"
environment: "{{ environment }}"
name: "{{ name }}"
- name: testConfig
value:
page: "{{ page }}"
flow: "{{ flow }}"
trackingParameters:
- "{{ trackingParameters }}"
- name: displayName
value: "{{ displayName }}"
UPDATE examples
- projects_locations_agents_test_cases_patch
No description available.
UPDATE google.dialogflow.test_cases
SET
data__tags = '{{ tags }}',
data__notes = '{{ notes }}',
data__name = '{{ name }}',
data__testCaseConversationTurns = '{{ testCaseConversationTurns }}',
data__lastTestResult = '{{ lastTestResult }}',
data__testConfig = '{{ testConfig }}',
data__displayName = '{{ displayName }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND testCasesId = '{{ testCasesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
creationTime,
displayName,
lastTestResult,
notes,
tags,
testCaseConversationTurns,
testConfig;
DELETE examples
- projects_locations_agents_test_cases_batch_delete
No description available.
DELETE FROM google.dialogflow.test_cases
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
;
Lifecycle Methods
- projects_locations_agents_test_cases_import
- projects_locations_agents_test_cases_export
- projects_locations_agents_test_cases_calculate_coverage
- projects_locations_agents_test_cases_run
- projects_locations_agents_test_cases_batch_run
Successful response
EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_import
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required
@@json=
'{
"gcsUri": "{{ gcsUri }}",
"content": "{{ content }}"
}'
;
Successful response
EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_export
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required
@@json=
'{
"dataFormat": "{{ dataFormat }}",
"filter": "{{ filter }}",
"gcsUri": "{{ gcsUri }}"
}'
;
Successful response
EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_calculate_coverage
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@type='{{ type }}'
;
Successful response
EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_run
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required,
@testCasesId='{{ testCasesId }}' --required
@@json=
'{
"environment": "{{ environment }}"
}'
;
Successful response
EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_batch_run
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@agentsId='{{ agentsId }}' --required
@@json=
'{
"environment": "{{ environment }}",
"testCases": "{{ testCases }}"
}'
;