API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Flows 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 Flows API
  version: 1.0.0
extends: openapi/google-dialogflow-flows-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: 10
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows on a CX agent
      effect: read
      questions:
      - What flows make up my Dialogflow CX agent?
      - Can I list an agent's flows with names in a specific language?
      instructions:
      - text: List the flows on agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show agent {agent}'s flows in language {language_code}.
        slots:
          agent: path.agentsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow on a CX agent
      effect: write
      questions:
      - How do I add a new conversation flow to my CX agent?
      - Can I set a description and NLU settings when creating a flow?
      instructions:
      - text: Create a flow named {display_name} on agent {agent} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Add flow {display_name} to agent {agent} described as {description}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow
      effect: read
      questions:
      - Can I see the transition routes and event handlers of one flow?
      - Where do I fetch a single flow's configuration?
      instructions:
      - text: Get flow {flow} on agent {agent} in project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the routes and handlers of flow {flow} in language {language_code}.
        slots:
          flow: path.flowsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow
      effect: destructive
      questions:
      - Can I delete a flow that other pages still transition to?
      - What does the force option do when removing a flow?
      instructions:
      - text: Delete flow {flow} from agent {agent} in project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Force-delete flow {flow} and clear references to it.
        slots:
          flow: path.flowsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a flow
      effect: write
      questions:
      - How do I rename a flow or change its routes?
      - Is it possible to lock a flow so nobody edits it?
      instructions:
      - text: Rename flow {flow} on agent {agent} (project {project}, location {location}) to {display_name}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      - text: Set the locked flag on flow {flow} to {locked}.
        slots:
          flow: path.flowsId
          locked: requestBody.locked
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a flow into a CX agent
      effect: write
      questions:
      - Can I import a flow from a file in Cloud Storage into my agent?
      - What happens if an imported flow has the same name as an existing one?
      instructions:
      - text: Import a flow from {flow_uri} into agent {agent} in project {project}, location {location}.
        slots:
          flow_uri: requestBody.flowUri
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Import the flow at {flow_uri} into agent {agent} with import option {import_option}.
        slots:
          flow_uri: requestBody.flowUri
          agent: path.agentsId
          import_option: requestBody.importOption
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/validationResult'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow's latest validation result
      effect: read
      questions:
      - Which validation issues were found the last time my flow was validated?
      - Can I read a flow's stored validation result for one language?
      instructions:
      - text: Get the latest validation result for flow {flow} on agent {agent}, project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show stored validation findings of flow {flow} in {language_code}.
        slots:
          flow: path.flowsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a flow
      effect: write
      questions:
      - How do I check a flow for errors before I train or deploy it?
      - Can I run validation on a flow for just one language?
      instructions:
      - text: Validate flow {flow} on agent {agent} in project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Run a fresh validation of flow {flow} for language {language_code}.
        slots:
          flow: path.flowsId
          language_code: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a flow
      effect: write
      questions:
      - Can I export a single flow to a file?
      - Will exporting a flow include the other flows it references?
      instructions:
      - text: Export flow {flow} on agent {agent} in project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: 'Export flow {flow} to {flow_uri}, including referenced flows: {include_refs}.'
        slots:
          flow: path.flowsId
          flow_uri: requestBody.flowUri
          include_refs: requestBody.includeReferencedFlows
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:train'].post
  update:
    x-apievangelist-phrasing:
      intent: Train a flow
      effect: write
      questions:
      - Do I need to retrain a flow after changing its training phrases?
      - Is training one flow a long-running job?
      instructions:
      - text: Train flow {flow} on agent {agent} in project {project}, location {location}.
        slots:
          flow: path.flowsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Retrain the NLU model of flow {flow} now.
        slots:
          flow: path.flowsId
      method: generated
      generated: '2026-10-01'