# 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 Playbooks API
  version: 1.0.0
extends: openapi/google-dialogflow-playbooks-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: 7
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List playbooks on a CX agent
      effect: read
      questions:
      - Which playbooks does my Dialogflow CX agent have?
      - Can I page through an agent's playbooks?
      instructions:
      - text: List playbooks on CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} playbooks per page for agent {agent}.
        slots:
          page_size: query.pageSize
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a playbook on a CX agent
      effect: write
      questions:
      - How do I create a generative playbook with a goal and step-by-step instructions?
      - Can a new playbook reference tools and other playbooks it is allowed to call?
      instructions:
      - text: Create playbook {display_name} on CX agent {agent} in project {project}, location {location} with goal {goal}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          goal: requestBody.goal
      - text: Add a playbook {display_name} to agent {agent} that can use tools {tools}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          tools: requestBody.referencedTools
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a playbook
      effect: read
      questions:
      - What goal and instructions does one of my agent's playbooks contain?
      - Can I check a playbook's token count and referenced tools?
      instructions:
      - text: Get playbook {playbook} on CX 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 goal and instructions.
        slots:
          playbook: path.playbooksId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playbook
      effect: destructive
      questions:
      - Can I remove a playbook from my CX agent?
      - Is deleting a playbook done by its ID?
      instructions:
      - text: Delete playbook {playbook} from CX agent {agent} in project {project}, location {location}.
        slots:
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the playbook {playbook} from agent {agent}.
        slots:
          playbook: path.playbooksId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a playbook
      effect: write
      questions:
      - How do I rewrite the instructions of an existing playbook?
      - Can I change the LLM model settings used by just one playbook?
      instructions:
      - text: Update the goal of playbook {playbook} on agent {agent} in project {project}, location {location} to {goal}.
        slots:
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          goal: requestBody.goal
      - text: Replace playbook {playbook}'s instruction with {instruction}.
        slots:
          playbook: path.playbooksId
          instruction: requestBody.instruction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a playbook into a CX agent
      effect: write
      questions:
      - Can I import a playbook I exported from another agent?
      - What import strategy options decide how conflicting playbook resources are handled?
      instructions:
      - text: Import a playbook from {playbook_uri} into CX agent {agent} in project {project}, location {location}.
        slots:
          playbook_uri: requestBody.playbookUri
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Load playbook content {content} into agent {agent} with import strategy {strategy}.
        slots:
          content: requestBody.playbookContent
          agent: path.agentsId
          strategy: requestBody.importStrategy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/playbooks/{playbooksId}:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a playbook
      effect: write
      questions:
      - How do I export a single playbook to a file in Cloud Storage?
      - Which data format can a playbook export use?
      instructions:
      - text: Export playbook {playbook} from CX agent {agent} in project {project}, location {location} to {playbook_uri}.
        slots:
          playbook: path.playbooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          playbook_uri: requestBody.playbookUri
      - text: Export playbook {playbook} in {format} format.
        slots:
          playbook: path.playbooksId
          format: requestBody.dataFormat
      method: generated
      generated: '2026-10-01'