examples

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

Overview

Name	examples
Type	Resource
Id	google.dialogflow.examples

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_playbooks_examples_get

Name	Datatype	Description
name	string
actions	array
conversationState	string	(OUTPUT_STATE_UNSPECIFIED, OUTPUT_STATE_OK, OUTPUT_STATE_CANCELLED, OUTPUT_STATE_FAILED, OUTPUT_STATE_ESCALATED, OUTPUT_STATE_PENDING)
createTime	string (google-datetime)
description	string
displayName	string
languageCode	string
playbookInput	object	(id: GoogleCloudDialogflowCxV3PlaybookInput)
playbookOutput	object	(id: GoogleCloudDialogflowCxV3PlaybookOutput)
tokenCount	string (int64)
updateTime	string (google-datetime)

projects_locations_agents_playbooks_examples_list

Name	Datatype	Description
name	string
actions	array
conversationState	string	(OUTPUT_STATE_UNSPECIFIED, OUTPUT_STATE_OK, OUTPUT_STATE_CANCELLED, OUTPUT_STATE_FAILED, OUTPUT_STATE_ESCALATED, OUTPUT_STATE_PENDING)
createTime	string (google-datetime)
description	string
displayName	string
languageCode	string
playbookInput	object	(id: GoogleCloudDialogflowCxV3PlaybookInput)
playbookOutput	object	(id: GoogleCloudDialogflowCxV3PlaybookOutput)
tokenCount	string (int64)
updateTime	string (google-datetime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_playbooks_examples_get	select	projectsId, locationsId, agentsId, playbooksId, examplesId
projects_locations_agents_playbooks_examples_list	select	projectsId, locationsId, agentsId, playbooksId	languageCode, pageSize, pageToken
projects_locations_agents_playbooks_examples_create	insert	projectsId, locationsId, agentsId, playbooksId
projects_locations_agents_playbooks_examples_patch	update	projectsId, locationsId, agentsId, playbooksId, examplesId	updateMask
projects_locations_agents_playbooks_examples_delete	delete	projectsId, locationsId, agentsId, playbooksId, examplesId

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
examplesId	string
locationsId	string
playbooksId	string
projectsId	string
languageCode	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_playbooks_examples_get

Successful response

SELECT
name,
actions,
conversationState,
createTime,
description,
displayName,
languageCode,
playbookInput,
playbookOutput,
tokenCount,
updateTime
FROM google.dialogflow.examples
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND examplesId = '{{ examplesId }}' -- required
;

projects_locations_agents_playbooks_examples_list

Successful response

SELECT
name,
actions,
conversationState,
createTime,
description,
displayName,
languageCode,
playbookInput,
playbookOutput,
tokenCount,
updateTime
FROM google.dialogflow.examples
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND languageCode = '{{ languageCode }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_playbooks_examples_create

No description available.

INSERT INTO google.dialogflow.examples (
data__playbookOutput,
data__displayName,
data__conversationState,
data__name,
data__languageCode,
data__playbookInput,
data__description,
data__actions,
projectsId,
locationsId,
agentsId,
playbooksId
)
SELECT 
'{{ playbookOutput }}',
'{{ displayName }}',
'{{ conversationState }}',
'{{ name }}',
'{{ languageCode }}',
'{{ playbookInput }}',
'{{ description }}',
'{{ actions }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ playbooksId }}'
RETURNING
name,
actions,
conversationState,
createTime,
description,
displayName,
languageCode,
playbookInput,
playbookOutput,
tokenCount,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: examples
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the examples resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the examples resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the examples resource.
  - name: playbooksId
    value: "{{ playbooksId }}"
    description: Required parameter for the examples resource.
  - name: playbookOutput
    value:
      executionSummary: "{{ executionSummary }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: conversationState
    value: "{{ conversationState }}"
    valid_values: ['OUTPUT_STATE_UNSPECIFIED', 'OUTPUT_STATE_OK', 'OUTPUT_STATE_CANCELLED', 'OUTPUT_STATE_FAILED', 'OUTPUT_STATE_ESCALATED', 'OUTPUT_STATE_PENDING']
  - name: name
    value: "{{ name }}"
  - name: languageCode
    value: "{{ languageCode }}"
  - name: playbookInput
    value:
      precedingConversationSummary: "{{ precedingConversationSummary }}"
  - name: description
    value: "{{ description }}"
  - name: actions
    value:
      - userUtterance:
          text: "{{ text }}"
        playbookInvocation:
          displayName: "{{ displayName }}"
          playbookOutput:
            executionSummary: "{{ executionSummary }}"
          playbook: "{{ playbook }}"
          playbookState: "{{ playbookState }}"
          playbookInput:
            precedingConversationSummary: "{{ precedingConversationSummary }}"
        playbookTransition:
          playbook: "{{ playbook }}"
          displayName: "{{ displayName }}"
        agentUtterance:
          text: "{{ text }}"
        flowInvocation:
          displayName: "{{ displayName }}"
          flow: "{{ flow }}"
          flowState: "{{ flowState }}"
        flowTransition:
          displayName: "{{ displayName }}"
          flow: "{{ flow }}"
        toolUse:
          tool: "{{ tool }}"
          displayName: "{{ displayName }}"
          inputActionParameters: "{{ inputActionParameters }}"
          action: "{{ action }}"
          outputActionParameters: "{{ outputActionParameters }}"

UPDATE examples

projects_locations_agents_playbooks_examples_patch

No description available.

UPDATE google.dialogflow.examples
SET 
data__playbookOutput = '{{ playbookOutput }}',
data__displayName = '{{ displayName }}',
data__conversationState = '{{ conversationState }}',
data__name = '{{ name }}',
data__languageCode = '{{ languageCode }}',
data__playbookInput = '{{ playbookInput }}',
data__description = '{{ description }}',
data__actions = '{{ actions }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND playbooksId = '{{ playbooksId }}' --required
AND examplesId = '{{ examplesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
actions,
conversationState,
createTime,
description,
displayName,
languageCode,
playbookInput,
playbookOutput,
tokenCount,
updateTime;

DELETE examples

projects_locations_agents_playbooks_examples_delete

No description available.

DELETE FROM google.dialogflow.examples
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND playbooksId = '{{ playbooksId }}' --required
AND examplesId = '{{ examplesId }}' --required
;