Google Dialogflow · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].delete
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].patch
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].delete
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].patch
$.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].get
$.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].post
$.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].get
$.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].delete
$.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].patch

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 Dialogflow ES API (v2) Contexts API
  version: 1.0.0
extends: openapi/google-dialogflow-contexts-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: 20
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List active contexts in a regional session
      effect: read
      questions:
      - Which contexts are currently active in a session on my regional ES agent?
      - Can I page through the contexts of a draft-agent session in one location?
      instructions:
      - text: List the active contexts in session {session} for project {project} in location {location}.
        slots:
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Show regional session {session} contexts in {location}, {page_size} at a time, for project {project}.
        slots:
          session: path.sessionsId
          location: path.locationsId
          page_size: query.pageSize
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a context to a regional session
      effect: write
      questions:
      - How do I set a context on a live session of my regional agent?
      - Can I control how many turns a context stays active when I add it to a regional session?
      instructions:
      - text: Create context {name} in session {session} for project {project} in location {location}.
        slots:
          name: requestBody.name
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Add context {name} to regional session {session} in {location} for project {project}, active for {lifespan} turns.
        slots:
          name: requestBody.name
          session: path.sessionsId
          location: path.locationsId
          project: path.projectsId
          lifespan: requestBody.lifespanCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a context from a regional session
      effect: read
      questions:
      - What parameters does a specific context hold in my regional session?
      - Can I check the remaining lifespan of one context in a location-scoped session?
      instructions:
      - text: Get context {context} from session {session} for project {project} in location {location}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the parameters stored in regional context {context} of session {session} in {location}, project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a context from a regional session
      effect: destructive
      questions:
      - Can I clear a single context from a session on my regional agent?
      - Does deleting one context end the rest of a location-scoped session?
      instructions:
      - text: Delete context {context} from session {session} for project {project} in location {location}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Drop regional context {context} out of session {session} in {location} for project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          location: path.locationsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a context in a regional session
      effect: write
      questions:
      - Can I change the lifespan of a context that is already active in a regional session?
      - How would I overwrite the parameters on an existing location-scoped context?
      instructions:
      - text: Update context {context} in session {session} for project {project}, location {location}, to last {lifespan} turns.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
          lifespan: requestBody.lifespanCount
      - text: Patch regional context {context} of session {session} in {location}, project {project}, using mask {update_mask}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          location: path.locationsId
          project: path.projectsId
          update_mask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contexts in a regional environment session
      effect: read
      questions:
      - Which contexts are active for one user's session in a regional environment?
      - Can I list contexts per end user in a deployed environment in one location?
      instructions:
      - text: List contexts for user {user} in session {session} of environment {environment}, project {project}, location {location}.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Page through contexts of user {user}'s session {session} in regional environment {environment} with token {page_token}.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          page_token: query.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a context to a regional environment session
      effect: write
      questions:
      - How do I inject a context into an end user's session in a regional deployed environment?
      - Can I create a context for a specific user in a location-scoped environment?
      instructions:
      - text: Create context {name} for user {user} in session {session} of environment {environment}, project {project}, location {location}.
        slots:
          name: requestBody.name
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Give user {user}'s session {session} in regional environment {environment} the context {name} for {lifespan} turns.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          name: requestBody.name
          lifespan: requestBody.lifespanCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a context in a regional environment session
      effect: read
      questions:
      - What does a particular context look like in a user's regional environment session?
      - Can I read one context back from a deployed environment's session in a given location?
      instructions:
      - text: Get context {context} for user {user}, session {session}, environment {environment}, project {project}, location {location}.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Read regional environment {environment} context {context} from user {user}'s session {session}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a context in a regional environment session
      effect: destructive
      questions:
      - Can I delete one context from an end user's session in a regional environment?
      - Is clearing a context in a deployed location-scoped environment immediate?
      instructions:
      - text: Delete context {context} for user {user} in session {session} of environment {environment}, project {project}, location {location}.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Clear regional environment {environment} context {context} from user {user}'s session {session}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a context in a regional environment session
      effect: write
      questions:
      - Can I extend a context's lifespan for one user in a regional deployed environment?
      - How do I change the parameters of a context in a location-scoped environment session?
      instructions:
      - text: Update context {context} for user {user}, session {session}, environment {environment}, project {project}, location {location}, to {lifespan} turns.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
          lifespan: requestBody.lifespanCount
      - text: Patch regional environment {environment} context {context} of user {user}'s session {session} with mask {update_mask}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          update_mask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contexts in an environment user session
      effect: read
      questions:
      - Which contexts are active for a user's session in an environment of my global ES agent?
      - Can I list a default-location environment's session contexts per user?
      instructions:
      - text: List contexts for user {user} in session {session} of global environment {environment}, project {project}.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Show {page_size} contexts per page from user {user}'s session {session} in default environment {environment}, project {project}.
        slots:
          page_size: query.pageSize
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a context to an environment user session
      effect: write
      questions:
      - How do I set a context for one user's session in a global agent environment?
      - Can I add a context with a lifespan to a default-location environment session?
      instructions:
      - text: Create context {name} for user {user} in session {session} of global environment {environment}, project {project}.
        slots:
          name: requestBody.name
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Attach context {name} lasting {lifespan} turns to user {user}'s session {session} in default environment {environment}, project {project}.
        slots:
          name: requestBody.name
          lifespan: requestBody.lifespanCount
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a context in an environment user session
      effect: read
      questions:
      - What's stored in one context of a user's session in my global agent's environment?
      - Can I fetch a single context from a default-location environment session?
      instructions:
      - text: Get context {context} for user {user}, session {session}, global environment {environment}, project {project}.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Fetch default environment {environment} context {context} from user {user}'s session {session} in project {project}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a context in an environment user session
      effect: destructive
      questions:
      - Can I delete a context from a user's session in a global agent environment?
      - Is a deleted context in a default-location environment session gone for good?
      instructions:
      - text: Delete context {context} for user {user} in session {session} of global environment {environment}, project {project}.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Remove default environment {environment} context {context} from user {user}'s session {session} in project {project}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a context in an environment user session
      effect: write
      questions:
      - Can I modify a context's parameters for one user in a global agent environment?
      - How do I reset the lifespan of a context in a default-location environment session?
      instructions:
      - text: Update context {context} for user {user}, session {session}, global environment {environment}, project {project}, to {lifespan} turns.
        slots:
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          lifespan: requestBody.lifespanCount
      - text: Patch default environment {environment} context {context} in user {user}'s session {session}, project {project}, with mask {update_mask}.
        slots:
          environment: path.environmentsId
          context: path.contextsId
          user: path.usersId
          session: path.sessionsId
          project: path.projectsId
          update_mask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List active contexts in a session
      effect: read
      questions:
      - Which contexts are active right now in a session of my global ES agent?
      - How do I see all contexts for a draft-agent session in my default project location?
      instructions:
      - text: List the contexts in session {session} of the global agent in project {project}.
        slots:
          session: path.sessionsId
          project: path.projectsId
      - text: Show default-location session {session} contexts for project {project} after token {page_token}.
        slots:
          session: path.sessionsId
          project: path.projectsId
          page_token: query.pageToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a context to a session
      effect: write
      questions:
      - Can I push a context into a session of my global ES agent from my backend?
      - What lifespan can I give a context I create on a default-location session?
      instructions:
      - text: Create context {name} in session {session} of the global agent in project {project}.
        slots:
          name: requestBody.name
          session: path.sessionsId
          project: path.projectsId
      - text: Set context {name} for {lifespan} turns on default-location session {session}, project {project}.
        slots:
          name: requestBody.name
          lifespan: requestBody.lifespanCount
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a context from a session
      effect: read
      questions:
      - How can I read one context back from a global agent session?
      - Can I see the parameters a single context carries in a default-location session?
      instructions:
      - text: Get context {context} from session {session} of the global agent in project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
      - text: Show default-location context {context} parameters for session {session}, project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a context from a session
      effect: destructive
      questions:
      - Can I delete a single context from a global agent session?
      - Will removing one context from a default-location session affect other contexts?
      instructions:
      - text: Delete context {context} from session {session} of the global agent in project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
      - text: Drop default-location context {context} from session {session} in project {project}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a context in a session
      effect: write
      questions:
      - Can I update the lifespan of a context in my global agent session?
      - How do I change a default-location context's parameters mid-conversation?
      instructions:
      - text: Update context {context} in session {session} of the global agent, project {project}, to last {lifespan} turns.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
          lifespan: requestBody.lifespanCount
      - text: Patch default-location context {context} in session {session}, project {project}, with mask {update_mask}.
        slots:
          context: path.contextsId
          session: path.sessionsId
          project: path.projectsId
          update_mask: query.updateMask
      method: generated
      generated: '2026-10-01'