# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Google Dialogflow Environments API
  version: 1.0.0
extends: openapi/google-dialogflow-environments-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: 20
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments of a CX agent
      effect: read
      questions:
      - What environments, like staging and production, does my Dialogflow CX agent have?
      - Can I page through a CX agent's environments in smaller batches?
      instructions:
      - text: List the environments of CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} CX environments 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}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment for a CX agent
      effect: write
      questions:
      - How do I set up a new staging environment for my CX agent?
      - Can a new CX environment pin specific flow versions and its own webhook config?
      instructions:
      - text: Create a CX environment 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 CX environment {display_name} to agent {agent} pinned to version configs {version_configs}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          version_configs: requestBody.versionConfigs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:runContinuousTest'].post
  update:
    x-apievangelist-phrasing:
      intent: Run continuous tests on a CX environment
      effect: write
      questions:
      - Can I kick off the continuous test suite against a CX environment on demand?
      - Is there a way to re-run an environment's configured test cases right now?
      instructions:
      - text: Run the continuous test for CX environment {environment} on agent {agent} in project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Start continuous testing now on environment {environment} of CX agent {agent}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:lookupEnvironmentHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up the history of a CX environment
      effect: read
      questions:
      - How has a CX environment changed over time, version by version?
      - Can I audit past configurations of my CX production environment?
      instructions:
      - text: Look up the history of CX environment {environment} on agent {agent} in project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the last {page_size} revisions of CX environment {environment}.
        slots:
          page_size: query.pageSize
          environment: path.environmentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:deployFlow'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a flow version to a CX environment
      effect: write
      questions:
      - How do I promote a specific flow version into my CX production environment?
      - Can I deploy one flow version to an environment without touching the others?
      instructions:
      - text: Deploy flow version {flow_version} to CX environment {environment} on agent {agent} in project {project}, location {location}.
        slots:
          flow_version: requestBody.flowVersion
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Push flow version {flow_version} live in environment {environment}.
        slots:
          flow_version: requestBody.flowVersion
          environment: path.environmentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a CX environment
      effect: read
      questions:
      - Which flow versions and webhook settings is a CX environment currently using?
      - Can I view a single CX environment's configuration by ID?
      instructions:
      - text: Get CX environment {environment} of agent {agent} in project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show me the configuration of environment {environment} on CX agent {agent}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CX environment
      effect: destructive
      questions:
      - Can I tear down a CX environment I no longer deploy to?
      - Is deleting an unused CX environment done by its ID?
      instructions:
      - text: Delete CX environment {environment} from agent {agent} in project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the {environment} environment from CX agent {agent}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CX environment
      effect: write
      questions:
      - Can I change the description or test-case settings of an existing CX environment?
      - How do I point a CX environment at a different webhook configuration?
      instructions:
      - text: Update CX environment {environment} on agent {agent} in project {project}, location {location} with description {description}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          description: requestBody.description
      - text: Set the webhook config of CX environment {environment} to {webhook_config}.
        slots:
          environment: path.environmentsId
          webhook_config: requestBody.webhookConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a regional ES environment
      effect: read
      questions:
      - Which agent version is a Dialogflow ES environment in a specific region running?
      - What state is a regional ES environment in?
      instructions:
      - text: Get ES environment {environment} for project {project} in region {location}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the regional ES environment {environment} in {location}.
        slots:
          environment: path.environmentsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a regional ES environment
      effect: destructive
      questions:
      - Can I delete an ES environment that belongs to a regional agent?
      - Is a regional ES environment removable once I stop using it?
      instructions:
      - text: Delete ES environment {environment} for project {project} in region {location}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove regional environment {environment} from the ES agent in {location}.
        slots:
          environment: path.environmentsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a regional ES environment
      effect: write
      questions:
      - How do I load a different agent version into an ES environment in a given region?
      - Can I change a regional ES environment's text-to-speech or fulfillment settings?
      instructions:
      - text: Point ES environment {environment} for project {project} in region {location} at agent version {agent_version}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
          agent_version: requestBody.agentVersion
      - text: Update regional environment {environment} in {location} with fulfillment {fulfillment}.
        slots:
          environment: path.environmentsId
          location: path.locationsId
          fulfillment: requestBody.fulfillment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments of a regional ES agent
      effect: read
      questions:
      - What environments exist for my ES agent in a particular location?
      - Can I list regional ES environments a page at a time?
      instructions:
      - text: List ES environments for project {project} in region {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show regional ES environments in {location}, {page_size} per page.
        slots:
          location: path.locationsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment for a regional ES agent
      effect: write
      questions:
      - How do I add a production environment to an ES agent hosted in a specific region?
      - Can I choose the ID of a new regional ES environment myself?
      instructions:
      - text: Create ES environment {environment_id} for project {project} in region {location}.
        slots:
          environment_id: query.environmentId
          project: path.projectsId
          location: path.locationsId
      - text: Add a regional ES environment in {location} running agent version {agent_version}.
        slots:
          location: path.locationsId
          agent_version: requestBody.agentVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the history of a regional ES environment
      effect: read
      questions:
      - Can I see which agent versions a regional ES environment has run in the past?
      - Is there a change log for an ES environment in a specific location?
      instructions:
      - text: Get the history of ES environment {environment} for project {project} in region {location}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show past versions loaded into regional environment {environment} in {location}.
        slots:
          environment: path.environmentsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the history of a global ES environment
      effect: read
      questions:
      - What is the version history of an environment on my project's global ES agent?
      - Can I page through past deployments of a non-regional ES environment?
      instructions:
      - text: Get the history of global ES environment {environment} in project {project}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      - text: Show {page_size} history entries for environment {environment} of project {project}'s global agent.
        slots:
          page_size: query.pageSize
          environment: path.environmentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a global ES environment
      effect: read
      questions:
      - Which agent version does an environment on my global ES agent serve?
      - Can I fetch a project-level ES environment by name?
      instructions:
      - text: Get global ES environment {environment} in project {project}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      - text: Show details of environment {environment} on project {project}'s global agent.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a global ES environment
      effect: destructive
      questions:
      - Can I delete an environment from an ES agent with no region?
      - Is removing a project-level ES environment permanent?
      instructions:
      - text: Delete global ES environment {environment} in project {project}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      - text: Remove environment {environment} from project {project}'s global agent.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a global ES environment
      effect: write
      questions:
      - How do I roll a global ES environment forward to a newer agent version?
      - Can updating a project-level ES environment load it into the draft and discard changes?
      instructions:
      - text: Set global ES environment {environment} in project {project} to agent version {agent_version}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          agent_version: requestBody.agentVersion
      - text: Change the description of project {project}'s global environment {environment} to {description}.
        slots:
          project: path.projectsId
          environment: path.environmentsId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments of a global ES agent
      effect: read
      questions:
      - Which environments are set up on my project's global ES agent?
      - Can I list project-level ES environments with paging?
      instructions:
      - text: List environments of the global ES agent in project {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s global ES environments {page_size} at a time.
        slots:
          project: path.projectsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment for a global ES agent
      effect: write
      questions:
      - How do I create a staging environment for an ES agent that has no regional location?
      - Can a new project-level ES environment start on a specific agent version?
      instructions:
      - text: Create global ES environment {environment_id} in project {project}.
        slots:
          environment_id: query.environmentId
          project: path.projectsId
      - text: Add environment {environment_id} to project {project}'s global agent running version {agent_version}.
        slots:
          environment_id: query.environmentId
          project: path.projectsId
          agent_version: requestBody.agentVersion
      method: generated
      generated: '2026-10-01'