API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents 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 API
  version: 1.0.0
extends: openapi/google-dialogflow-agents-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: 11
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a CX agent
      effect: read
      questions:
      - What are the default language, time zone and start flow of my Dialogflow CX agent?
      - Can I look up a single conversational agent's settings by its ID?
      instructions:
      - text: Get CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the settings of conversational agent {agent}.
        slots:
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CX agent
      effect: destructive
      questions:
      - Can I permanently delete a conversational agent I no longer use?
      - Is deleting a whole CX agent something I can do by its ID?
      instructions:
      - text: Delete CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the entire conversational agent {agent}.
        slots:
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CX agent's settings
      effect: write
      questions:
      - How do I change my CX agent's time zone or supported languages?
      - Can I lock a conversational agent to prevent further edits?
      - Is spell correction something I can switch on for an existing agent?
      instructions:
      - text: Set the time zone of CX agent {agent} in project {project}, location {location} to {time_zone}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          time_zone: requestBody.timeZone
      - text: Lock conversational agent {agent} by setting locked to {locked}.
        slots:
          agent: path.agentsId
          locked: requestBody.locked
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generativeSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CX agent's generative AI settings
      effect: read
      questions:
      - Which LLM model and safety settings is my conversational agent using for generative features?
      - Can I see an agent's generative fallback settings for a given language?
      instructions:
      - text: Get the generative settings of CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show agent {agent}'s generative AI settings for language {language}.
        slots:
          agent: path.agentsId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generativeSettings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CX agent's generative AI settings
      effect: write
      questions:
      - How do I change the LLM model my conversational agent uses?
      - Can I adjust generative safety or knowledge connector settings on an agent?
      instructions:
      - text: Update the generative settings of CX agent {agent} in project {project}, location {location} with LLM settings {llm_settings}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          llm_settings: requestBody.llmModelSettings
      - text: Set generative safety settings {safety_settings} on agent {agent}.
        slots:
          safety_settings: requestBody.generativeSafetySettings
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a CX agent
      effect: write
      questions:
      - How can I back up a whole conversational agent to Cloud Storage?
      - Can an agent export be pushed to a git branch instead of a file?
      - Is it possible to export the agent as it is deployed in a specific environment?
      instructions:
      - text: Export CX agent {agent} in project {project}, location {location} to {agent_uri}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          agent_uri: requestBody.agentUri
      - text: Export agent {agent} from environment {environment} in {format} format.
        slots:
          agent: path.agentsId
          environment: requestBody.environment
          format: requestBody.dataFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a CX agent
      effect: write
      questions:
      - Can I check my conversational agent for configuration problems before deploying?
      - Does agent validation run per language?
      instructions:
      - text: Validate CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Run validation on agent {agent} for language {language}.
        slots:
          agent: path.agentsId
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/validationResult'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest validation result of a CX agent
      effect: read
      questions:
      - What issues did the last validation of my conversational agent find?
      - Can I read an agent's stored validation report for one language?
      instructions:
      - text: Get the validation result of CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the latest validation findings for agent {agent} in {language}.
        slots:
          agent: path.agentsId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List CX agents in a location
      effect: read
      questions:
      - Which conversational agents exist in my project and region?
      - Can I page through all my CX agents in a location?
      instructions:
      - text: List CX agents in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} agents per page in location {location}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CX agent
      effect: write
      questions:
      - How do I create a new Dialogflow CX agent?
      - Can a new conversational agent start with a playbook instead of a flow?
      instructions:
      - text: Create a CX agent named {display_name} in project {project}, location {location} with default language {language} and time zone {time_zone}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
          language: requestBody.defaultLanguageCode
          time_zone: requestBody.timeZone
      - text: Make a new agent {display_name} that starts with playbook {start_playbook}.
        slots:
          display_name: requestBody.displayName
          start_playbook: requestBody.startPlaybook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a CX agent from a backup
      effect: destructive
      questions:
      - Can I overwrite my conversational agent with a previously exported backup?
      - Is restoring an agent from a git source supported?
      instructions:
      - text: Restore CX agent {agent} in project {project}, location {location} from {agent_uri}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          agent_uri: requestBody.agentUri
      - text: Replace agent {agent} with the backup from git source {git_source} using restore option {restore_option}.
        slots:
          agent: path.agentsId
          git_source: requestBody.gitSource
          restore_option: requestBody.restoreOption
      method: generated
      generated: '2026-10-01'