# 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 Experiments…
  version: 1.0.0
extends: openapi/google-dialogflow-experiments-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}/environments/{environmentsId}/experiments/{experimentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experiment
      effect: read
      questions:
      - Can I see the results and state of one A/B experiment in an environment?
      - Where do I check how traffic is split in a CX experiment?
      instructions:
      - text: Get experiment {experiment} in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the variants and result of experiment {experiment} in environment {environment}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experiment
      effect: destructive
      questions:
      - Can I delete an experiment I set up in an environment?
      - Is removing a CX experiment permanent?
      instructions:
      - text: Delete experiment {experiment} from environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove experiment {experiment} under environment {environment}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an experiment
      effect: write
      questions:
      - How do I change the variants or rollout config of an existing experiment?
      - Can I edit an experiment's description after it is created?
      instructions:
      - text: Update experiment {experiment} in environment {environment} of agent {agent} (project {project}, location {location}) with description {description}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          description: requestBody.description
      - text: Change the rollout config of experiment {experiment} to {rollout}.
        slots:
          experiment: path.experimentsId
          rollout: requestBody.rolloutConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an experiment
      effect: write
      questions:
      - How do I begin sending traffic to an experiment's variants?
      - Can a draft experiment be moved into the running state?
      instructions:
      - text: Start experiment {experiment} in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Launch experiment {experiment} so it begins running.
        slots:
          experiment: path.experimentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiments in an environment
      effect: read
      questions:
      - Which experiments are set up in one of my agent's environments?
      - Can I page through all A/B tests for an environment?
      instructions:
      - text: List experiments in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} experiments per page for 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}/experiments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an experiment in an environment
      effect: write
      questions:
      - How do I set up an A/B test between flow versions in an environment?
      - Can I define how long a new experiment should run?
      instructions:
      - text: Create experiment {display_name} in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Set up experiment {display_name} in environment {environment} with definition {definition}.
        slots:
          display_name: requestBody.displayName
          environment: path.environmentsId
          definition: requestBody.definition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running experiment
      effect: destructive
      questions:
      - Can I stop an experiment that is currently running?
      - What happens to traffic once a CX experiment is stopped?
      instructions:
      - text: Stop experiment {experiment} in environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          experiment: path.experimentsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Halt the running experiment {experiment} now.
        slots:
          experiment: path.experimentsId
      method: generated
      generated: '2026-10-01'