Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Results API

3 actions 3 updates phrasing extends openapi/google-dialogflow-results-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Google Dialogflow's API. It is a proposal applied on top of the contract, not a document Google Dialogflow publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}'].get

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results'].get

OpenAPI Overlay

# 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 Results API
  version: 1.0.0
extends: openapi/google-dialogflow-results-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: 2
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one test case run result
      effect: read
      questions:
      - Did a specific run of my Dialogflow CX test case pass or fail?
      - Can I see the conversation turns recorded in one test case result?
      instructions:
      - text: Get result {result} of test case {test_case} on agent {agent} in project {project}, location {location}.
        slots:
          result: path.resultsId
          test_case: path.testCasesId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the outcome of test case run {result}.
        slots:
          result: path.resultsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List run results of a test case
      effect: read
      questions:
      - What is the pass/fail history of one of my CX agent's test cases?
      - Can I filter test case results, for instance to only recent failures?
      instructions:
      - text: List results of 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 test case {test_case} results matching filter {filter}.
        slots:
          test_case: path.testCasesId
          filter: query.filter
      method: generated
      generated: '2026-10-01'