Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Dialogflow Intents API

24 actions 24 updates phrasing extends openapi/google-dialogflow-intents-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 24 · first 16 shown; the file carries all of them

$.info
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export'].post
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].delete
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].patch
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents'].get
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents'].post
$.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].delete
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].patch
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents:batchUpdate'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents:batchDelete'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/intents'].get

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 Intents API
  version: 1.0.0
extends: openapi/google-dialogflow-intents-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: 23
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export intents from a CX agent
      effect: write
      questions:
      - How can I export all the intents from my Dialogflow CX agent to a file?
      - Can CX intent exports be written straight to a Cloud Storage URI instead of returned inline?
      - Which data formats are available when exporting intents out of a conversational agent?
      instructions:
      - text: Export the intents of CX agent {agent} in project {project}, location {location} to {intents_uri}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          intents_uri: requestBody.intentsUri
      - text: Export only intents {intents} from CX agent {agent} in {format} format.
        slots:
          intents: requestBody.intents
          agent: path.agentsId
          format: requestBody.dataFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one intent from a CX agent
      effect: read
      questions:
      - What training phrases and parameters does a particular CX agent intent have?
      - Can I read a CX intent's details in a specific language?
      instructions:
      - text: Show CX intent {intent} on agent {agent} in project {project}, location {location}.
        slots:
          intent: path.intentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Fetch CX agent {agent}'s intent {intent} with its {language} training phrases.
        slots:
          agent: path.agentsId
          intent: path.intentsId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an intent from a CX agent
      effect: destructive
      questions:
      - Can I delete a single intent from my Dialogflow CX agent by its ID?
      - Is removing an intent I no longer need from a CX agent a one-call operation?
      instructions:
      - text: Delete CX intent {intent} from agent {agent} in project {project}, location {location}.
        slots:
          intent: path.intentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the intent {intent} from my CX agent {agent}.
        slots:
          intent: path.intentsId
          agent: path.agentsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an intent on a CX agent
      effect: write
      questions:
      - How do I add more training phrases to an existing CX intent?
      - Can I change just a CX intent's display name or priority without resending everything?
      - Is there a way to mark an existing CX intent as a fallback intent?
      instructions:
      - text: Rename CX intent {intent} on agent {agent} in project {project}, location {location} to {display_name}.
        slots:
          intent: path.intentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      - text: Set the priority of CX intent {intent} on agent {agent} to {priority}, changing only fields in mask {update_mask}.
        slots:
          intent: path.intentsId
          agent: path.agentsId
          priority: requestBody.priority
          update_mask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the intents of a CX agent
      effect: read
      questions:
      - Which intents does my CX agent currently have?
      - Can I page through a CX agent's intents with their full training phrases included?
      instructions:
      - text: List every intent on CX agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the first {page_size} intents of CX agent {agent} in {language}.
        slots:
          page_size: query.pageSize
          agent: path.agentsId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an intent on a CX agent
      effect: write
      questions:
      - How do I add a brand-new intent with training phrases to a CX agent?
      - Can a newly created CX intent recognize DTMF keypad input?
      instructions:
      - text: Create a CX intent 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 a new intent {display_name} to CX agent {agent} with training phrases {training_phrases}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          training_phrases: requestBody.trainingPhrases
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import intents into a CX agent
      effect: write
      questions:
      - Can I bulk-load intents into a CX agent from a file in Cloud Storage?
      - What merge options exist when imported CX intents clash with ones already on the agent?
      instructions:
      - text: Import intents from {intents_uri} into CX agent {agent} in project {project}, location {location}.
        slots:
          intents_uri: requestBody.intentsUri
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Load intents into CX agent {agent} from {intents_uri} using merge option {merge_option}.
        slots:
          agent: path.agentsId
          intents_uri: requestBody.intentsUri
          merge_option: requestBody.mergeOption
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an intent from a regional ES agent
      effect: read
      questions:
      - How can I look up a single intent on a Dialogflow ES agent hosted in a specific region?
      - Does fetching a regional ES intent return its training phrases, or only the summary view?
      instructions:
      - text: Get ES intent {intent} from the agent of project {project} in region {location}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          location: path.locationsId
      - text: Fetch regional ES intent {intent} in {location} using intent view {view}.
        slots:
          intent: path.intentsId
          location: path.locationsId
          view: query.intentView
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an intent from a regional ES agent
      effect: destructive
      questions:
      - Can I delete one intent from an ES agent that lives in a non-global region?
      - Is it possible to remove a regional ES intent using only its ID?
      instructions:
      - text: Delete ES intent {intent} from project {project}'s agent in region {location}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove intent {intent} from the regional ES agent in {location}.
        slots:
          intent: path.intentsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an intent on a regional ES agent
      effect: write
      questions:
      - Can I change the response messages of an existing intent on my regional ES agent?
      - Will an existing ES intent in a specific location let me switch on webhook fulfillment?
      - Is there a way to make a regional ES intent end the conversation when it matches?
      instructions:
      - text: Update regional ES intent {intent} in project {project}, location {location} to use action {action}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          location: path.locationsId
          action: requestBody.action
      - text: Set webhook state {webhook_state} on ES intent {intent} in region {location}.
        slots:
          webhook_state: requestBody.webhookState
          intent: path.intentsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents:batchUpdate'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update intents on a regional ES agent
      effect: write
      questions:
      - Can I update many ES agent intents at once in a regional project?
      - Will a batch intent update in a specific location accept a Cloud Storage file of intents?
      instructions:
      - text: Batch-update the intents of project {project}'s ES agent in region {location} from {batch_uri}.
        slots:
          project: path.projectsId
          location: path.locationsId
          batch_uri: requestBody.intentBatchUri
      - text: Apply the inline intent batch {intent_batch} to the regional ES agent in {location}.
        slots:
          intent_batch: requestBody.intentBatchInline
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List intents on a regional ES agent
      effect: read
      questions:
      - What intents are defined on my Dialogflow ES agent in a given region?
      - Can I list a regional ES agent's intents in a language other than the default?
      instructions:
      - text: List the intents of project {project}'s ES agent in location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Page through regional ES intents in {location}, {page_size} per page.
        slots:
          location: path.locationsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an intent on a regional ES agent
      effect: write
      questions:
      - How do I add a follow-up intent to an ES agent in a specific region?
      - Can a new regional ES intent be triggered by an event rather than user text?
      instructions:
      - text: Create ES intent {display_name} on project {project}'s agent in region {location}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
      - text: Add a regional ES intent {display_name} in {location} that fires on event {events}.
        slots:
          display_name: requestBody.displayName
          location: path.locationsId
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/intents:batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-delete intents on a regional ES agent
      effect: destructive
      questions:
      - Can I delete several intents in one request from an ES agent in a specific region?
      - Is there a bulk removal call for regional ES intents rather than deleting them one by one?
      instructions:
      - text: Batch-delete intents {intents} from project {project}'s ES agent in region {location}.
        slots:
          intents: requestBody.intents
          project: path.projectsId
          location: path.locationsId
      - text: 'Remove these intents from the regional ES agent in {location} all at once: {intents}.'
        slots:
          location: path.locationsId
          intents: requestBody.intents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List intents in a regional ES environment
      effect: read
      questions:
      - Which intents are live in a particular environment of my regional ES agent?
      - Can I see the intents served by an ES environment such as production in a given location?
      instructions:
      - text: List intents in environment {environment} of project {project}'s ES agent in region {location}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show intents deployed to regional environment {environment} in {location} in {language}.
        slots:
          environment: path.environmentsId
          location: path.locationsId
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List intents in a global ES environment
      effect: read
      questions:
      - What intents does a global ES environment of my project expose?
      - Is there a way to list intents for an ES environment when my agent has no region?
      instructions:
      - text: List intents in global ES environment {environment} of project {project}.
        slots:
          environment: path.environmentsId
          project: path.projectsId
      - text: Show the intents available in environment {environment} of my default-region ES agent, {page_size} at a time.
        slots:
          environment: path.environmentsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents/{intentsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an intent from a global ES agent
      effect: read
      questions:
      - What does a single intent on my global ES agent contain?
      - Can I get a global ES intent with its training phrases included?
      instructions:
      - text: Get intent {intent} from the global ES agent of project {project}.
        slots:
          intent: path.intentsId
          project: path.projectsId
      - text: Fetch ES intent {intent} in project {project} with view {view} and language {language}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          view: query.intentView
          language: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents/{intentsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an intent from a global ES agent
      effect: destructive
      questions:
      - Can I delete an intent from an ES agent that isn't tied to a region?
      - How would I permanently remove one intent from my project's global ES agent?
      instructions:
      - text: Delete intent {intent} from the global ES agent of project {project}.
        slots:
          intent: path.intentsId
          project: path.projectsId
      - text: Remove global ES intent {intent} from project {project}.
        slots:
          intent: path.intentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents/{intentsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an intent on a global ES agent
      effect: write
      questions:
      - Can I edit the training phrases of an intent on my global ES agent?
      - Is it possible to hand a global ES intent's matches off to a live agent?
      instructions:
      - text: Update global ES intent {intent} in project {project} with new training phrases {training_phrases}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          training_phrases: requestBody.trainingPhrases
      - text: Change the display name of intent {intent} on project {project}'s global ES agent to {display_name}.
        slots:
          intent: path.intentsId
          project: path.projectsId
          display_name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents:batchUpdate'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update intents on a global ES agent
      effect: write
      questions:
      - Can I push a whole batch of intent changes to my global ES agent in one call?
      - Does bulk updating global ES intents support an update mask to limit which fields change?
      instructions:
      - text: Batch-update intents on the global ES agent of project {project} from file {batch_uri}.
        slots:
          project: path.projectsId
          batch_uri: requestBody.intentBatchUri
      - text: Apply intent batch {intent_batch} to project {project}'s global ES agent in {language}.
        slots:
          intent_batch: requestBody.intentBatchInline
          project: path.projectsId
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List intents on a global ES agent
      effect: read
      questions:
      - Which intents exist on my project's global ES agent?
      - Can I page through global ES intents with a custom page size?
      instructions:
      - text: List all intents on the global ES agent of project {project}.
        slots:
          project: path.projectsId
      - text: Show {page_size} intents per page from project {project}'s global ES agent.
        slots:
          page_size: query.pageSize
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an intent on a global ES agent
      effect: write
      questions:
      - How do I create a new intent on an ES agent that has no regional location?
      - Can I create a global ES intent that resets contexts when it matches?
      instructions:
      - text: Create intent {display_name} on the global ES agent of project {project}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
      - text: Add a global ES intent {display_name} to project {project} that triggers action {action}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/intents:batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-delete intents on a global ES agent
      effect: destructive
      questions:
      - Can I wipe out a list of intents from my global ES agent in one request?
      - Is there a batch delete for intents on a project-level ES agent?
      instructions:
      - text: Batch-delete intents {intents} from the global ES agent of project {project}.
        slots:
          intents: requestBody.intents
          project: path.projectsId
      - text: 'Delete all of these intents from project {project}''s global ES agent: {intents}.'
        slots:
          project: path.projectsId
          intents: requestBody.intents
      method: generated
      generated: '2026-10-01'