API Evangelist conversational phrasing for Dialogflow ES API (v2) Agent API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dialogflow ES API (v2) Agent API
  version: 1.0.0
extends: openapi/google-dialogflow-agent-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: 16
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent:restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a regional ES agent from a ZIP
      effect: destructive
      questions:
      - Can I replace my regional ES agent entirely with one from a ZIP backup?
      - Does restoring an agent in a specific location wipe its current intents and entities?
      instructions:
      - text: Restore the ES agent in project {project}, location {location}, from the ZIP at {agent_uri}.
        slots:
          project: path.projectsId
          location: path.locationsId
          agent_uri: requestBody.agentUri
      - text: Overwrite the regional agent in {location} for project {project} with the backup at {agent_uri}.
        slots:
          location: path.locationsId
          project: path.projectsId
          agent_uri: requestBody.agentUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/fulfillment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a regional agent's fulfillment
      effect: read
      questions:
      - Which webhook fulfillment is configured for my ES agent in a particular region?
      - Can I check whether fulfillment is enabled on a location-scoped agent?
      instructions:
      - text: Get the fulfillment settings of the ES agent in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show the regional webhook fulfillment for {location} in project {project}.
        slots:
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/fulfillment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a regional agent's fulfillment
      effect: write
      questions:
      - How do I point my regional ES agent's fulfillment at a new webhook service?
      - Can I disable fulfillment for an agent in one location without deleting it?
      instructions:
      - text: Update the fulfillment of the ES agent in project {project}, location {location}, to use web service {service}.
        slots:
          project: path.projectsId
          location: path.locationsId
          service: requestBody.genericWebService
      - text: Set regional fulfillment enabled to {enabled} for {location} in project {project}.
        slots:
          enabled: requestBody.enabled
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/validationResult'].get
  update:
    x-apievangelist-phrasing:
      intent: Get validation errors for a regional agent
      effect: read
      questions:
      - Are there validation errors in my regional ES agent after training?
      - Can I see agent validation results for one language in a specific location?
      instructions:
      - text: Get the validation result for the ES agent in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show regional agent validation issues in {location} for project {project} in language {language_code}.
        slots:
          location: path.locationsId
          project: path.projectsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent:search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ES agents in a regional location
      effect: read
      questions:
      - Which ES agents can I access across sub-projects in one location?
      - Is there a regional search that returns agents for all sub-projects of a project?
      instructions:
      - text: Search ES agents under project {project} in location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: List regional agents in {location} under project {project}, {page_size} per page.
        slots:
          location: path.locationsId
          project: path.projectsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a regional ES agent to a ZIP
      effect: write
      questions:
      - How do I back up my regional ES agent as a ZIP file?
      - Can I export an agent in a given location straight to Cloud Storage?
      instructions:
      - text: Export the ES agent in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Export the regional agent in {location} for project {project} to {agent_uri}.
        slots:
          location: path.locationsId
          project: path.projectsId
          agent_uri: requestBody.agentUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent:train'].post
  update:
    x-apievangelist-phrasing:
      intent: Train a regional ES agent
      effect: write
      questions:
      - How do I retrain my regional ES agent after changing intents?
      - Is training an agent in a specific location a long-running operation?
      instructions:
      - text: Train the ES agent in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Kick off regional agent training in {location} for project {project}.
        slots:
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import into a regional ES agent from a ZIP
      effect: write
      questions:
      - Can I merge intents and entities from a ZIP into my regional ES agent?
      - What happens to existing intents when I import a ZIP into an agent in one location?
      instructions:
      - text: Import the agent ZIP at {agent_uri} into project {project}, location {location}.
        slots:
          agent_uri: requestBody.agentUri
          project: path.projectsId
          location: path.locationsId
      - text: Merge the regional agent in {location} for project {project} with the content of {agent_uri}.
        slots:
          location: path.locationsId
          project: path.projectsId
          agent_uri: requestBody.agentUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent:restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore the default ES agent from a ZIP
      effect: destructive
      questions:
      - Can I fully replace my global ES agent with a ZIP backup?
      - Will restoring the default-location agent remove intents that aren't in the ZIP?
      instructions:
      - text: Restore the global ES agent in project {project} from {agent_uri}.
        slots:
          project: path.projectsId
          agent_uri: requestBody.agentUri
      - text: Replace the default-location agent of project {project} with backup {agent_uri}.
        slots:
          project: path.projectsId
          agent_uri: requestBody.agentUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent:search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search ES agents across sub-projects
      effect: read
      questions:
      - Which ES agents can I see across sub-projects using the global endpoint?
      - Can I page through agent search results in the default location?
      instructions:
      - text: Search ES agents under project {project} at the global location.
        slots:
          project: path.projectsId
      - text: Continue the default-location agent search for project {project} from token {page_token}.
        slots:
          project: path.projectsId
          page_token: query.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/validationResult'].get
  update:
    x-apievangelist-phrasing:
      intent: Get validation errors for the default agent
      effect: read
      questions:
      - Does my global ES agent have validation warnings I should fix?
      - Can I see the default-location agent's validation result for one language?
      instructions:
      - text: Get the validation result for the global ES agent in project {project}.
        slots:
          project: path.projectsId
      - text: Show default-location agent validation errors for project {project} in {language_code}.
        slots:
          project: path.projectsId
          language_code: query.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent:export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export the default ES agent to a ZIP
      effect: write
      questions:
      - How can I download my global ES agent as a ZIP?
      - Can I write the default-location agent export to a Cloud Storage URI?
      instructions:
      - text: Export the global ES agent in project {project}.
        slots:
          project: path.projectsId
      - text: Export project {project}'s default-location agent to {agent_uri}.
        slots:
          project: path.projectsId
          agent_uri: requestBody.agentUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/fulfillment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default agent's fulfillment
      effect: read
      questions:
      - What fulfillment webhook does my global ES agent call?
      - Is fulfillment turned on for the default-location agent?
      instructions:
      - text: Get the fulfillment of the global ES agent in project {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s default-location webhook fulfillment config.
        slots:
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/fulfillment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the default agent's fulfillment
      effect: write
      questions:
      - Can I change the webhook URL used by my global ES agent's fulfillment?
      - How would I switch off fulfillment for the default-location agent?
      instructions:
      - text: Update the global ES agent fulfillment in project {project} to web service {service}.
        slots:
          project: path.projectsId
          service: requestBody.genericWebService
      - text: Set default-location fulfillment enabled to {enabled} for project {project}.
        slots:
          enabled: requestBody.enabled
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent:import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import into the default ES agent from a ZIP
      effect: write
      questions:
      - Can I add intents and entities from a ZIP to my global ES agent without a full restore?
      - What does importing into the default-location agent do with conflicting intents?
      instructions:
      - text: Import the agent ZIP at {agent_uri} into the global agent of project {project}.
        slots:
          agent_uri: requestBody.agentUri
          project: path.projectsId
      - text: Merge {agent_uri} into project {project}'s default-location agent.
        slots:
          agent_uri: requestBody.agentUri
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent:train'].post
  update:
    x-apievangelist-phrasing:
      intent: Train the default ES agent
      effect: write
      questions:
      - How do I start training my global ES agent?
      - Does the default-location agent need retraining after I edit entities?
      instructions:
      - text: Train the global ES agent in project {project}.
        slots:
          project: path.projectsId
      - text: Retrain project {project}'s default-location agent now.
        slots:
          project: path.projectsId
      method: generated
      generated: '2026-10-01'