Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Dialogflow Generators API

13 actions 13 updates phrasing extends openapi/google-dialogflow-generators-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}/locations/{locationsId}/agents/{agentsId}/generators'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators'].post
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].delete
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].patch
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].delete
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].patch
$.paths['/v2/projects/{projectsId}/generators'].get
$.paths['/v2/projects/{projectsId}/generators'].post

OpenAPI Overlay

Raw ↑
# 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 Generators API
  version: 1.0.0
extends: openapi/google-dialogflow-generators-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}/locations/{locationsId}/agents/{agentsId}/generators'].get
  update:
    x-apievangelist-phrasing:
      intent: List generators on a CX agent
      effect: read
      questions:
      - Which LLM generators are defined on my Dialogflow CX agent?
      - Can I list a CX agent's generators in a particular language?
      instructions:
      - text: List the generators on CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show CX agent {agent} generators for language {language_code}.
        slots:
          agent: path.agentsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a generator on a CX agent
      effect: write
      questions:
      - How do I add an LLM prompt generator to a CX agent?
      - Can I set the prompt text and model settings when creating a CX generator?
      instructions:
      - text: Create a generator named {display_name} on CX agent {agent} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Add a CX generator to agent {agent} with prompt {prompt_text}.
        slots:
          agent: path.agentsId
          prompt_text: requestBody.promptText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CX agent generator
      effect: read
      questions:
      - Where can I read the prompt behind one of my CX agent's generators?
      - Can I fetch a CX generator's settings for a specific language?
      instructions:
      - text: Get generator {generator} on CX agent {agent} in project {project}, location {location}.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the prompt and model settings of CX generator {generator} on agent {agent}.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CX agent generator
      effect: destructive
      questions:
      - Can I delete a CX generator that pages still reference?
      - Is there a force flag for removing a generator from a CX agent?
      instructions:
      - text: Delete generator {generator} from CX agent {agent} in project {project}, location {location}.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Force-delete CX generator {generator} on agent {agent}, removing its references.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CX agent generator
      effect: write
      questions:
      - How do I change the prompt text of an existing CX generator?
      - Can I update only a CX generator's model parameters?
      instructions:
      - text: Update the prompt of generator {generator} on CX agent {agent} (project {project}, location {location}) to {prompt_text}.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          prompt_text: requestBody.promptText
      - text: Rename CX generator {generator} on agent {agent} to {display_name}.
        slots:
          generator: path.generatorsId
          agent: path.agentsId
          display_name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent-assist generators in a region
      effect: read
      questions:
      - Which Agent Assist generators exist in a given region of my project?
      - Can I page through regional generators used for summaries and coaching?
      instructions:
      - text: List Agent Assist generators for project {project} in location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} regional generators in {location} for project {project}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent-assist generator in a region
      effect: write
      questions:
      - How do I create a summarization generator for Agent Assist in a specific location?
      - Can I choose my own ID when creating a regional generator?
      instructions:
      - text: Create an Agent Assist generator in project {project}, location {location}, described as {description}.
        slots:
          project: path.projectsId
          location: path.locationsId
          description: requestBody.description
      - text: Create regional generator {generator_id} in {location} for project {project}.
        slots:
          generator_id: query.generatorId
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent-assist generator in a region
      effect: read
      questions:
      - Can I view how a regional Agent Assist generator is configured?
      - What trigger event does one of my location-scoped generators use?
      instructions:
      - text: Get Agent Assist generator {generator} in project {project}, location {location}.
        slots:
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the trigger event and context of regional generator {generator} in {location}, project {project}.
        slots:
          generator: path.generatorsId
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent-assist generator in a region
      effect: destructive
      questions:
      - Can I remove a regional Agent Assist generator I no longer use?
      - Is deleting a location-scoped generator permanent?
      instructions:
      - text: Delete Agent Assist generator {generator} in project {project}, location {location}.
        slots:
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove regional generator {generator} from {location} in project {project}.
        slots:
          generator: path.generatorsId
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an agent-assist generator in a region
      effect: write
      questions:
      - How do I change the trigger event on a regional Agent Assist generator?
      - Can I edit a location-scoped generator's description only?
      instructions:
      - text: Update Agent Assist generator {generator} in project {project}, location {location}, to trigger on {trigger_event}.
        slots:
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
          trigger_event: requestBody.triggerEvent
      - text: Change the description of regional generator {generator} in {location}, project {project}, to {description}.
        slots:
          generator: path.generatorsId
          location: path.locationsId
          project: path.projectsId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/generators'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent-assist generators in a project
      effect: read
      questions:
      - What Agent Assist generators does my project have at the global location?
      - Is there a paged list of default-location generators?
      instructions:
      - text: List the global Agent Assist generators in project {project}.
        slots:
          project: path.projectsId
      - text: Show the next page of default-location generators for project {project} from {page_token}.
        slots:
          project: path.projectsId
          page_token: query.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/generators'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent-assist generator in a project
      effect: write
      questions:
      - How do I set up a new Agent Assist generator on the global endpoint?
      - Can I give a default-location generator a custom ID and description?
      instructions:
      - text: Create a global Agent Assist generator in project {project} with ID {generator_id}.
        slots:
          project: path.projectsId
          generator_id: query.generatorId
      - text: Add a default-location generator to project {project} that fires on {trigger_event}.
        slots:
          project: path.projectsId
          trigger_event: requestBody.triggerEvent
      method: generated
      generated: '2026-10-01'