Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Dialogflow Operations API

13 actions 13 updates phrasing extends openapi/google-dialogflow-operations-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 13

$.info

$.paths['/v3/projects/{projectsId}/operations/{operationsId}'].get

$.paths['/v3/projects/{projectsId}/operations/{operationsId}:cancel'].post

$.paths['/v3/projects/{projectsId}/operations'].get

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}'].get

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel'].post

$.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations'].get

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel'].post

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}'].get

$.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations'].get

$.paths['/v2/projects/{projectsId}/operations/{operationsId}:cancel'].post

$.paths['/v2/projects/{projectsId}/operations/{operationsId}'].get

$.paths['/v2/projects/{projectsId}/operations'].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 Google Dialogflow Operations API
  version: 1.0.0
extends: openapi/google-dialogflow-operations-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: 12
- target: $.paths['/v3/projects/{projectsId}/operations/{operationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a CX long-running operation
      effect: read
      questions:
      - How do I check whether a Dialogflow CX export or training job has finished?
      - Can I poll the status of a v3 long-running operation at the project level?
      instructions:
      - text: Look up project-wide CX job {operation} in {project} and report its state.
        slots:
          operation: path.operationsId
          project: path.projectsId
      - text: Poll v3 long-running operation {operation} for project {project} until it reports done.
        slots:
          operation: path.operationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/operations/{operationsId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a CX long-running operation
      effect: destructive
      questions:
      - How do I stop a Dialogflow CX import or export that is still running?
      - Can I cancel a v3 project-level operation before it completes?
      instructions:
      - text: Cancel CX operation {operation} in project {project}.
        slots:
          operation: path.operationsId
          project: path.projectsId
      - text: Abort the running v3 job {operation} for project {project}.
        slots:
          operation: path.operationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List CX long-running operations in a project
      effect: read
      questions:
      - Which Dialogflow CX background jobs are running or recently finished in my project?
      - Can I filter the v3 project-level operations list?
      instructions:
      - text: Show every project-wide CX background job for {project}.
        slots:
          project: path.projectsId
      - text: Show v3 operations in project {project} matching filter {filter}.
        slots:
          project: path.projectsId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a regional CX long-running operation
      effect: read
      questions:
      - How do I check progress of a Dialogflow CX operation running in a specific region?
      - Can I tell if a regional v3 agent restore has completed?
      instructions:
      - text: Get the status of CX operation {operation} in project {project}, region {location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      - text: Poll regional v3 job {operation} under {project}/{location} for its result.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a regional CX long-running operation
      effect: destructive
      questions:
      - How do I cancel a Dialogflow CX operation that is running in a particular region?
      - Can I stop a regional v3 export job midway?
      instructions:
      - text: Cancel CX operation {operation} in project {project}, region {location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      - text: Abort regional v3 job {operation} in {project}/{location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List regional CX long-running operations
      effect: read
      questions:
      - What Dialogflow CX operations are in progress in a given region of my project?
      - Can I list regional v3 operations and still get results when some are unreachable?
      instructions:
      - text: List CX long-running operations in project {project}, region {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show regional v3 operations in {project}/{location} filtered by {filter}.
        slots:
          project: path.projectsId
          location: path.locationsId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a regional ES long-running operation
      effect: destructive
      questions:
      - How do I cancel a Dialogflow ES training or import job running in a specific region?
      - Can I stop a regional v2 operation that is taking too long?
      instructions:
      - text: Cancel ES operation {operation} in project {project}, region {location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      - text: Abort the regional v2 job {operation} under {project}/{location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a regional ES long-running operation
      effect: read
      questions:
      - How do I check whether a regional Dialogflow ES agent training job has finished?
      - Can I read the result of a v2 operation in a specific region?
      instructions:
      - text: Get the status of ES operation {operation} in project {project}, region {location}.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      - text: Poll regional v2 job {operation} in {project}/{location} until it completes.
        slots:
          operation: path.operationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List regional ES long-running operations
      effect: read
      questions:
      - Which Dialogflow ES background operations exist in one region of my project?
      - Can I filter regional v2 operations by their state?
      instructions:
      - text: List ES long-running operations in project {project}, region {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show regional v2 operations in {project}/{location} matching {filter}, {page_size} per page.
        slots:
          project: path.projectsId
          location: path.locationsId
          filter: query.filter
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/operations/{operationsId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an ES long-running operation
      effect: destructive
      questions:
      - How do I cancel a Dialogflow ES job running at the project level?
      - Can I stop a v2 agent import before it finishes?
      instructions:
      - text: Cancel ES operation {operation} in project {project}.
        slots:
          operation: path.operationsId
          project: path.projectsId
      - text: Abort project {project}'s v2 job {operation}.
        slots:
          project: path.projectsId
          operation: path.operationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/operations/{operationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an ES long-running operation
      effect: read
      questions:
      - How do I find out if my Dialogflow ES agent training operation is done?
      - Can I read the error from a failed v2 project-level operation?
      instructions:
      - text: Fetch the outcome of project-wide ES job {operation} in {project}.
        slots:
          operation: path.operationsId
          project: path.projectsId
      - text: Check whether project {project}'s v2 job {operation} succeeded.
        slots:
          project: path.projectsId
          operation: path.operationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List ES long-running operations in a project
      effect: read
      questions:
      - What Dialogflow ES long-running jobs have run in my project?
      - Is there a filter for v2 project-level operations?
      instructions:
      - text: Enumerate all project-wide ES background jobs for {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s v2 operations filtered by {filter}.
        slots:
          project: path.projectsId
          filter: query.filter
      method: generated
      generated: '2026-10-01'