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

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)

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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_test_cases_get	select	projectsId, locationsId, agentsId, testCasesId
projects_locations_agents_test_cases_list	select	projectsId, locationsId, agentsId	pageSize, pageToken, view
projects_locations_agents_test_cases_create	insert	projectsId, locationsId, agentsId
projects_locations_agents_test_cases_patch	update	projectsId, locationsId, agentsId, testCasesId	updateMask
projects_locations_agents_test_cases_batch_delete	delete	projectsId, locationsId, agentsId
projects_locations_agents_test_cases_batch_run	exec	projectsId, locationsId, agentsId
projects_locations_agents_test_cases_calculate_coverage	exec	projectsId, locationsId, agentsId	type
projects_locations_agents_test_cases_export	exec	projectsId, locationsId, agentsId
projects_locations_agents_test_cases_import	exec	projectsId, locationsId, agentsId
projects_locations_agents_test_cases_run	exec	projectsId, locationsId, agentsId, testCasesId

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

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
;

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

INSERT examples

projects_locations_agents_test_cases_create

No description available.

INSERT INTO google.dialogflow.test_cases (
data__displayName,
data__lastTestResult,
data__name,
data__notes,
data__tags,
data__testCaseConversationTurns,
data__testConfig,
projectsId,
locationsId,
agentsId
)
SELECT 
'{{ displayName }}',
'{{ lastTestResult }}',
'{{ name }}',
'{{ notes }}',
'{{ tags }}',
'{{ testCaseConversationTurns }}',
'{{ testConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}'
RETURNING
name,
creationTime,
displayName,
lastTestResult,
notes,
tags,
testCaseConversationTurns,
testConfig
;

Manifest

# 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: displayName
    value: "{{ displayName }}"
  - name: lastTestResult
    value:
      conversationTurns:
        - userInput:
            enableSentimentAnalysis: {{ enableSentimentAnalysis }}
            injectedParameters: "{{ injectedParameters }}"
            input:
              audio:
                audio: "{{ audio }}"
                config: "{{ config }}"
              dtmf:
                digits: "{{ digits }}"
                finishDigit: "{{ finishDigit }}"
              event:
                event: "{{ event }}"
              intent:
                intent: "{{ intent }}"
              languageCode: "{{ languageCode }}"
              text:
                text: "{{ text }}"
              toolCallResult:
                action: "{{ action }}"
                error: "{{ error }}"
                outputParameters: "{{ outputParameters }}"
                tool: "{{ tool }}"
            isWebhookEnabled: {{ isWebhookEnabled }}
          virtualAgentOutput:
            currentPage:
              advancedSettings:
                audioExportGcsDestination: "{{ audioExportGcsDestination }}"
                dtmfSettings: "{{ dtmfSettings }}"
                loggingSettings: "{{ loggingSettings }}"
                speechSettings: "{{ speechSettings }}"
              description: "{{ description }}"
              displayName: "{{ displayName }}"
              entryFulfillment:
                advancedSettings: "{{ advancedSettings }}"
                codeBlockFunction: "{{ codeBlockFunction }}"
                conditionalCases: "{{ conditionalCases }}"
                enableGenerativeFallback: {{ enableGenerativeFallback }}
                generators: "{{ generators }}"
                messages: "{{ messages }}"
                returnPartialResponses: {{ returnPartialResponses }}
                setParameterActions: "{{ setParameterActions }}"
                tag: "{{ tag }}"
                webhook: "{{ webhook }}"
              eventHandlers:
                - event: "{{ event }}"
                  name: "{{ name }}"
                  targetFlow: "{{ targetFlow }}"
                  targetPage: "{{ targetPage }}"
                  targetPlaybook: "{{ targetPlaybook }}"
                  triggerFulfillment:
                    advancedSettings: "{{ advancedSettings }}"
                    codeBlockFunction: "{{ codeBlockFunction }}"
                    conditionalCases: "{{ conditionalCases }}"
                    enableGenerativeFallback: {{ enableGenerativeFallback }}
                    generators: "{{ generators }}"
                    messages: "{{ messages }}"
                    returnPartialResponses: {{ returnPartialResponses }}
                    setParameterActions: "{{ setParameterActions }}"
                    tag: "{{ tag }}"
                    webhook: "{{ webhook }}"
              form:
                parameters: "{{ parameters }}"
              knowledgeConnectorSettings:
                dataStoreConnections: "{{ dataStoreConnections }}"
                enabled: {{ enabled }}
                targetFlow: "{{ targetFlow }}"
                targetPage: "{{ targetPage }}"
                triggerFulfillment: "{{ triggerFulfillment }}"
              name: "{{ name }}"
              transitionRouteGroups:
                - "{{ transitionRouteGroups }}"
              transitionRoutes:
                - condition: "{{ condition }}"
                  description: "{{ description }}"
                  intent: "{{ intent }}"
                  name: "{{ name }}"
                  targetFlow: "{{ targetFlow }}"
                  targetPage: "{{ targetPage }}"
                  triggerFulfillment:
                    advancedSettings: "{{ advancedSettings }}"
                    codeBlockFunction: "{{ codeBlockFunction }}"
                    conditionalCases: "{{ conditionalCases }}"
                    enableGenerativeFallback: {{ enableGenerativeFallback }}
                    generators: "{{ generators }}"
                    messages: "{{ messages }}"
                    returnPartialResponses: {{ returnPartialResponses }}
                    setParameterActions: "{{ setParameterActions }}"
                    tag: "{{ tag }}"
                    webhook: "{{ webhook }}"
            diagnosticInfo: "{{ diagnosticInfo }}"
            differences:
              - description: "{{ description }}"
                type: "{{ type }}"
            sessionParameters: "{{ sessionParameters }}"
            status:
              code: {{ code }}
              details: "{{ details }}"
              message: "{{ message }}"
            textResponses:
              - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                text: "{{ text }}"
            triggeredIntent:
              description: "{{ description }}"
              displayName: "{{ displayName }}"
              dtmfPattern: "{{ dtmfPattern }}"
              isFallback: {{ isFallback }}
              labels: "{{ labels }}"
              name: "{{ name }}"
              parameters:
                - entityType: "{{ entityType }}"
                  id: "{{ id }}"
                  isList: {{ isList }}
                  redact: {{ redact }}
              priority: {{ priority }}
              trainingPhrases:
                - id: "{{ id }}"
                  parts: "{{ parts }}"
                  repeatCount: {{ repeatCount }}
      environment: "{{ environment }}"
      name: "{{ name }}"
      testResult: "{{ testResult }}"
      testTime: "{{ testTime }}"
  - name: name
    value: "{{ name }}"
  - name: notes
    value: "{{ notes }}"
  - name: tags
    value:
      - "{{ tags }}"
  - name: testCaseConversationTurns
    value:
      - userInput:
          enableSentimentAnalysis: {{ enableSentimentAnalysis }}
          injectedParameters: "{{ injectedParameters }}"
          input:
            audio:
              audio: "{{ audio }}"
              config:
                audioEncoding: "{{ audioEncoding }}"
                bargeInConfig: "{{ bargeInConfig }}"
                enableWordInfo: {{ enableWordInfo }}
                model: "{{ model }}"
                modelVariant: "{{ modelVariant }}"
                optOutConformerModelMigration: {{ optOutConformerModelMigration }}
                phraseHints: "{{ phraseHints }}"
                sampleRateHertz: {{ sampleRateHertz }}
                singleUtterance: {{ singleUtterance }}
            dtmf:
              digits: "{{ digits }}"
              finishDigit: "{{ finishDigit }}"
            event:
              event: "{{ event }}"
            intent:
              intent: "{{ intent }}"
            languageCode: "{{ languageCode }}"
            text:
              text: "{{ text }}"
            toolCallResult:
              action: "{{ action }}"
              error:
                message: "{{ message }}"
              outputParameters: "{{ outputParameters }}"
              tool: "{{ tool }}"
          isWebhookEnabled: {{ isWebhookEnabled }}
        virtualAgentOutput:
          currentPage:
            advancedSettings:
              audioExportGcsDestination:
                uri: "{{ uri }}"
              dtmfSettings:
                enabled: {{ enabled }}
                endpointingTimeoutDuration: "{{ endpointingTimeoutDuration }}"
                finishDigit: "{{ finishDigit }}"
                interdigitTimeoutDuration: "{{ interdigitTimeoutDuration }}"
                maxDigits: {{ maxDigits }}
              loggingSettings:
                enableConsentBasedRedaction: {{ enableConsentBasedRedaction }}
                enableInteractionLogging: {{ enableInteractionLogging }}
                enableStackdriverLogging: {{ enableStackdriverLogging }}
              speechSettings:
                endpointerSensitivity: {{ endpointerSensitivity }}
                models: "{{ models }}"
                noSpeechTimeout: "{{ noSpeechTimeout }}"
                useTimeoutBasedEndpointing: {{ useTimeoutBasedEndpointing }}
            description: "{{ description }}"
            displayName: "{{ displayName }}"
            entryFulfillment:
              advancedSettings:
                audioExportGcsDestination: "{{ audioExportGcsDestination }}"
                dtmfSettings: "{{ dtmfSettings }}"
                loggingSettings: "{{ loggingSettings }}"
                speechSettings: "{{ speechSettings }}"
              codeBlockFunction: "{{ codeBlockFunction }}"
              conditionalCases:
                - cases: "{{ cases }}"
              enableGenerativeFallback: {{ enableGenerativeFallback }}
              generators:
                - generator: "{{ generator }}"
                  inputParameters: "{{ inputParameters }}"
                  outputParameter: "{{ outputParameter }}"
              messages:
                - channel: "{{ channel }}"
                  conversationSuccess:
                    metadata: "{{ metadata }}"
                  endInteraction: "{{ endInteraction }}"
                  knowledgeInfoCard: "{{ knowledgeInfoCard }}"
                  liveAgentHandoff:
                    metadata: "{{ metadata }}"
                  mixedAudio:
                    segments: "{{ segments }}"
                  outputAudioText:
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    ssml: "{{ ssml }}"
                    text: "{{ text }}"
                  payload: "{{ payload }}"
                  playAudio:
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    audioUri: "{{ audioUri }}"
                  responseType: "{{ responseType }}"
                  telephonyTransferCall:
                    phoneNumber: "{{ phoneNumber }}"
                  text:
                    allowPlaybackInterruption: {{ allowPlaybackInterruption }}
                    text: "{{ text }}"
                  toolCall:
                    action: "{{ action }}"
                    inputParameters: "{{ inputParameters }}"
                    tool: "{{ tool }}"
              returnPartialResponses: {{ returnPartialResponses }}
              setParameterActions:
                - parameter: "{{ parameter }}"
                  value: "{{ value }}"
              tag: "{{ tag }}"
              webhook: "{{ webhook }}"
            eventHandlers:
              - event: "{{ event }}"
                name: "{{ name }}"
                targetFlow: "{{ targetFlow }}"
                targetPage: "{{ targetPage }}"
                targetPlaybook: "{{ targetPlaybook }}"
                triggerFulfillment:
                  advancedSettings: "{{ advancedSettings }}"
                  codeBlockFunction: "{{ codeBlockFunction }}"
                  conditionalCases: "{{ conditionalCases }}"
                  enableGenerativeFallback: {{ enableGenerativeFallback }}
                  generators: "{{ generators }}"
                  messages: "{{ messages }}"
                  returnPartialResponses: {{ returnPartialResponses }}
                  setParameterActions: "{{ setParameterActions }}"
                  tag: "{{ tag }}"
                  webhook: "{{ webhook }}"
            form:
              parameters:
                - advancedSettings:
                    audioExportGcsDestination: "{{ audioExportGcsDestination }}"
                    dtmfSettings: "{{ dtmfSettings }}"
                    loggingSettings: "{{ loggingSettings }}"
                    speechSettings: "{{ speechSettings }}"
                  defaultValue: "{{ defaultValue }}"
                  displayName: "{{ displayName }}"
                  entityType: "{{ entityType }}"
                  fillBehavior:
                    initialPromptFulfillment: "{{ initialPromptFulfillment }}"
                    repromptEventHandlers: "{{ repromptEventHandlers }}"
                  isList: {{ isList }}
                  redact: {{ redact }}
                  required: {{ required }}
            knowledgeConnectorSettings:
              dataStoreConnections:
                - dataStore: "{{ dataStore }}"
                  dataStoreType: "{{ dataStoreType }}"
                  documentProcessingMode: "{{ documentProcessingMode }}"
              enabled: {{ enabled }}
              targetFlow: "{{ targetFlow }}"
              targetPage: "{{ targetPage }}"
              triggerFulfillment:
                advancedSettings: "{{ advancedSettings }}"
                codeBlockFunction: "{{ codeBlockFunction }}"
                conditionalCases: "{{ conditionalCases }}"
                enableGenerativeFallback: {{ enableGenerativeFallback }}
                generators: "{{ generators }}"
                messages: "{{ messages }}"
                returnPartialResponses: {{ returnPartialResponses }}
                setParameterActions: "{{ setParameterActions }}"
                tag: "{{ tag }}"
                webhook: "{{ webhook }}"
            name: "{{ name }}"
            transitionRouteGroups:
              - "{{ transitionRouteGroups }}"
            transitionRoutes:
              - condition: "{{ condition }}"
                description: "{{ description }}"
                intent: "{{ intent }}"
                name: "{{ name }}"
                targetFlow: "{{ targetFlow }}"
                targetPage: "{{ targetPage }}"
                triggerFulfillment:
                  advancedSettings: "{{ advancedSettings }}"
                  codeBlockFunction: "{{ codeBlockFunction }}"
                  conditionalCases: "{{ conditionalCases }}"
                  enableGenerativeFallback: {{ enableGenerativeFallback }}
                  generators: "{{ generators }}"
                  messages: "{{ messages }}"
                  returnPartialResponses: {{ returnPartialResponses }}
                  setParameterActions: "{{ setParameterActions }}"
                  tag: "{{ tag }}"
                  webhook: "{{ webhook }}"
          diagnosticInfo: "{{ diagnosticInfo }}"
          differences:
            - description: "{{ description }}"
              type: "{{ type }}"
          sessionParameters: "{{ sessionParameters }}"
          status:
            code: {{ code }}
            details: "{{ details }}"
            message: "{{ message }}"
          textResponses:
            - allowPlaybackInterruption: {{ allowPlaybackInterruption }}
              text: "{{ text }}"
          triggeredIntent:
            description: "{{ description }}"
            displayName: "{{ displayName }}"
            dtmfPattern: "{{ dtmfPattern }}"
            isFallback: {{ isFallback }}
            labels: "{{ labels }}"
            name: "{{ name }}"
            parameters:
              - entityType: "{{ entityType }}"
                id: "{{ id }}"
                isList: {{ isList }}
                redact: {{ redact }}
            priority: {{ priority }}
            trainingPhrases:
              - id: "{{ id }}"
                parts: "{{ parts }}"
                repeatCount: {{ repeatCount }}
  - name: testConfig
    value:
      flow: "{{ flow }}"
      page: "{{ page }}"
      trackingParameters:
        - "{{ trackingParameters }}"

UPDATE examples

projects_locations_agents_test_cases_patch

No description available.

UPDATE google.dialogflow.test_cases
SET 
data__displayName = '{{ displayName }}',
data__lastTestResult = '{{ lastTestResult }}',
data__name = '{{ name }}',
data__notes = '{{ notes }}',
data__tags = '{{ tags }}',
data__testCaseConversationTurns = '{{ testCaseConversationTurns }}',
data__testConfig = '{{ testConfig }}'
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_batch_run

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 }}"
}'
;

projects_locations_agents_test_cases_calculate_coverage

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 }}'
;

projects_locations_agents_test_cases_export

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 }}"
}'
;

projects_locations_agents_test_cases_import

Successful response

EXEC google.dialogflow.test_cases.projects_locations_agents_test_cases_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required 
@@json=
'{
"content": "{{ content }}", 
"gcsUri": "{{ gcsUri }}"
}'
;

projects_locations_agents_test_cases_run

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 }}"
}'
;