API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Examples API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Examples API
  version: 1.0.0
extends: openapi/google-dialogflow-examples-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a playbook example
      effect: read
      questions:
      - What conversation does one example in my Dialogflow playbook demonstrate?
      - Can I see the actions and output of a single playbook example?
      instructions:
      - text: Get example {example} of playbook {playbook} on agent {agent} in project {project}, location {location}.
        slots:
          example: path.examplesId
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show playbook example {example} with its actions.
        slots:
          example: path.examplesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playbook example
      effect: destructive
      questions:
      - Can I remove a bad few-shot example from a playbook?
      - Is deleting a playbook example permanent?
      instructions:
      - text: Delete example {example} from playbook {playbook} on agent {agent} in project {project}, location {location}.
        slots:
          example: path.examplesId
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove example {example} from playbook {playbook}.
        slots:
          example: path.examplesId
          playbook: path.playbooksId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples/{examplesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a playbook example
      effect: write
      questions:
      - How do I fix the actions in an existing playbook example?
      - Can I change the expected output of a playbook example?
      instructions:
      - text: Update example {example} of playbook {playbook} on agent {agent} in project {project}, location {location} with actions {actions}.
        slots:
          example: path.examplesId
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          actions: requestBody.actions
      - text: Set the playbook output of example {example} to {output}.
        slots:
          example: path.examplesId
          output: requestBody.playbookOutput
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples'].get
  update:
    x-apievangelist-phrasing:
      intent: List examples of a playbook
      effect: read
      questions:
      - Which examples have I given a playbook to learn from?
      - Can I list a playbook's examples for one language only?
      instructions:
      - text: List examples of playbook {playbook} on agent {agent} in project {project}, location {location}.
        slots:
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show playbook {playbook}'s examples in language {language}.
        slots:
          playbook: path.playbooksId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}/examples'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an example to a playbook
      effect: write
      questions:
      - How do I teach a playbook with a sample conversation?
      - Can a new playbook example include the expected input and output parameters?
      instructions:
      - text: Create example {display_name} on playbook {playbook} of agent {agent} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Add an example to playbook {playbook} with actions {actions} and input {input}.
        slots:
          playbook: path.playbooksId
          actions: requestBody.actions
          input: requestBody.playbookInput
      method: generated
      generated: '2026-10-01'