# 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 Test Cases…
  version: 1.0.0
extends: openapi/google-dialogflow-test-cases-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}/testCases:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import test cases into a CX agent
      effect: write
      questions:
      - Can I load conversation test cases from a file into my CX agent?
      - Does importing test cases from Cloud Storage overwrite existing ones?
      instructions:
      - text: Import test cases from {gcs_uri} into agent {agent} in project {project}, location {location}.
        slots:
          gcs_uri: requestBody.gcsUri
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Bulk-load agent {agent}'s test cases from the file at {gcs_uri}.
        slots:
          agent: path.agentsId
          gcs_uri: requestBody.gcsUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test case
      effect: read
      questions:
      - Where can I see the turns and last result of one test case?
      - Can I look up a single CX test case by its ID?
      instructions:
      - text: Get test case {test_case} on agent {agent} in project {project}, location {location}.
        slots:
          test_case: path.testCasesId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the conversation turns of test case {test_case}.
        slots:
          test_case: path.testCasesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a test case
      effect: write
      questions:
      - How do I edit the expected turns of an existing test case?
      - Can I add tags or notes to a test case after creating it?
      instructions:
      - text: Update test case {test_case} on agent {agent} (project {project}, location {location}) with notes {notes}.
        slots:
          test_case: path.testCasesId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          notes: requestBody.notes
      - text: Set the tags of test case {test_case} to {tags}.
        slots:
          test_case: path.testCasesId
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a single test case
      effect: write
      questions:
      - Can I run one test case against a particular environment?
      - What happens when I execute a test case without naming an environment?
      instructions:
      - text: Run test case {test_case} on agent {agent} in project {project}, location {location}.
        slots:
          test_case: path.testCasesId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Execute test case {test_case} against environment {environment}.
        slots:
          test_case: path.testCasesId
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases'].get
  update:
    x-apievangelist-phrasing:
      intent: List test cases on a CX agent
      effect: read
      questions:
      - Which test cases are defined for my CX agent?
      - Can I list test cases with only basic fields instead of full turns?
      instructions:
      - text: List the test cases on agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show agent {agent}'s test cases using view {view}.
        slots:
          agent: path.agentsId
          view: query.view
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test case
      effect: write
      questions:
      - How do I write a new conversation test case for my agent?
      - Can I tag a new test case when I create it?
      instructions:
      - text: Create a test case 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 test case {display_name} to agent {agent} with tags {tags}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Calculate test coverage for a CX agent
      effect: read
      questions:
      - How much of my agent's intents or transitions do my test cases cover?
      - Can I measure test coverage for route groups instead of intents?
      instructions:
      - text: Calculate test coverage for agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Compute agent {agent}'s test coverage of type {type}.
        slots:
          agent: path.agentsId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun'].post
  update:
    x-apievangelist-phrasing:
      intent: Run several test cases at once
      effect: write
      questions:
      - Can I run a batch of test cases in a single request?
      - Which environment do batch test runs use?
      instructions:
      - text: Batch-run test cases {test_cases} on agent {agent} in project {project}, location {location}.
        slots:
          test_cases: requestBody.testCases
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Run tests {test_cases} of agent {agent} together in environment {environment}.
        slots:
          test_cases: requestBody.testCases
          agent: path.agentsId
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several test cases at once
      effect: destructive
      questions:
      - Can I delete many test cases in one call?
      - Is a bulk delete of test cases reversible?
      instructions:
      - text: Delete test cases {names} from agent {agent} in project {project}, location {location}.
        slots:
          names: requestBody.names
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Bulk-remove the test cases {names} on agent {agent}.
        slots:
          names: requestBody.names
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export test cases from a CX agent
      effect: write
      questions:
      - Can I export my agent's test cases to Cloud Storage?
      - Is it possible to export only test cases that match a filter?
      instructions:
      - text: Export the test cases of agent {agent} in project {project}, location {location} to {gcs_uri}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          gcs_uri: requestBody.gcsUri
      - text: Export agent {agent} test cases matching {filter} in format {data_format}.
        slots:
          agent: path.agentsId
          filter: requestBody.filter
          data_format: requestBody.dataFormat
      method: generated
      generated: '2026-10-01'