API Evangelist conversational phrasing for Google Dialogflow Sessions API

# 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 Sessions API
  version: 1.0.0
extends: openapi/google-dialogflow-sessions-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: 17
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to a CX agent session
      effect: write
      questions:
      - How do I send what a user typed to my Dialogflow CX agent and get the bot's reply back?
      - Can a CX detect-intent call also return synthesized audio of the agent's response?
      instructions:
      - text: Send query input {query_input} to CX agent {agent} session {session} in project {project}, location {location} and return the reply.
        slots:
          query_input: requestBody.queryInput
          agent: path.agentsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Detect the intent for {query_input} in CX session {session} of agent {agent} ({project}/{location}) with audio output {audio_config}.
        slots:
          query_input: requestBody.queryInput
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          audio_config: requestBody.outputAudioConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream a CX agent's reply to a user turn
      effect: write
      questions:
      - Can I get a Dialogflow CX agent's response streamed back in pieces instead of one final reply?
      - Is there a server-streaming version of detect intent for CX draft agent sessions?
      instructions:
      - text: Stream the CX agent {agent} response to {query_input} for session {session} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          query_input: requestBody.queryInput
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Run server-streaming detect intent on CX session {session}, agent {agent} ({project}/{location}) with response view {view}.
        slots:
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          view: requestBody.responseView
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview which intent a CX agent would match
      effect: read
      questions:
      - Which intent would my Dialogflow CX agent match for an utterance, without running fulfillment?
      - Can I get candidate intent matches for a CX session before deciding which one to fulfill?
      instructions:
      - text: Match intents for {query_input} in CX session {session} of agent {agent}, project {project}, location {location}.
        slots:
          query_input: requestBody.queryInput
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the candidate intent matches CX agent {agent} finds for {query_input} in session {session} ({project}/{location}).
        slots:
          agent: path.agentsId
          query_input: requestBody.queryInput
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill a chosen intent match in a CX session
      effect: write
      questions:
      - After matching intents in a CX session, how do I run fulfillment for the match I picked?
      - Can I fulfill a previously matched CX intent and get audio of the response?
      instructions:
      - text: Fulfill match {match} in CX session {session} of agent {agent}, project {project}, location {location}.
        slots:
          match: requestBody.match
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Execute fulfillment for the selected match {match} from request {match_request} on CX agent {agent} session {session} ({project}/{location}).
        slots:
          match: requestBody.match
          match_request: requestBody.matchIntentRequest
          agent: path.agentsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate an answer a CX agent gave
      effect: write
      questions:
      - Can I record whether a user found a Dialogflow CX agent's answer helpful?
      - Can I attach thumbs-up or thumbs-down feedback to a specific CX response ID?
      instructions:
      - text: Submit answer feedback {feedback} for response {response_id} in CX session {session}, agent {agent}, project {project}, location {location}.
        slots:
          feedback: requestBody.answerFeedback
          response_id: requestBody.responseId
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Mark CX agent {agent}'s answer {response_id} in session {session} ({project}/{location}) with feedback {feedback}.
        slots:
          agent: path.agentsId
          response_id: requestBody.responseId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
          feedback: requestBody.answerFeedback
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:serverStreamingDetectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream a reply from a CX environment session
      effect: write
      questions:
      - Can I stream partial responses from a CX agent deployed to my production environment?
      - Is server-streaming detect intent available against a specific Dialogflow CX environment?
      instructions:
      - text: Stream CX environment {environment}'s response to {query_input} for session {session}, agent {agent}, project {project}, location {location}.
        slots:
          environment: path.environmentsId
          query_input: requestBody.queryInput
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Run streaming detect intent in environment {environment} session {session} of CX agent {agent} ({project}/{location}) with query params {params}.
        slots:
          environment: path.environmentsId
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          params: requestBody.queryParams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to a CX environment session
      effect: write
      questions:
      - How do I talk to the version of my CX agent deployed in a specific environment like production?
      - Can I send a user utterance to a CX environment and get back the agent's full reply?
      instructions:
      - text: Send {query_input} to session {session} in CX environment {environment} of agent {agent}, project {project}, location {location}.
        slots:
          query_input: requestBody.queryInput
          session: path.sessionsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Detect intent in environment {environment} for session {session}, CX agent {agent} ({project}/{location}), returning audio as {audio_config}.
        slots:
          environment: path.environmentsId
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          audio_config: requestBody.outputAudioConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:fulfillIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill an intent match in a CX environment session
      effect: write
      questions:
      - Can I run fulfillment for a matched intent in a session on a deployed CX environment?
      - Can I complete a two-step match-then-fulfill flow against my CX staging environment?
      instructions:
      - text: Fulfill match {match} for session {session} in CX environment {environment}, agent {agent}, project {project}, location {location}.
        slots:
          match: requestBody.match
          session: path.sessionsId
          environment: path.environmentsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: In environment {environment}, execute the selected match {match} on CX agent {agent} session {session} ({project}/{location}).
        slots:
          environment: path.environmentsId
          match: requestBody.match
          agent: path.agentsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:matchIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview intent matches in a CX environment session
      effect: read
      questions:
      - Which intent would my deployed CX environment match for a phrase, without fulfilling it?
      - Can I test intent matching against a specific Dialogflow CX environment rather than the draft?
      instructions:
      - text: Match intents for {query_input} in CX environment {environment} session {session}, agent {agent}, project {project}, location {location}.
        slots:
          query_input: requestBody.queryInput
          environment: path.environmentsId
          session: path.sessionsId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: List the intent candidates environment {environment} of CX agent {agent} returns for {query_input} in session {session} ({project}/{location}).
        slots:
          environment: path.environmentsId
          agent: path.agentsId
          query_input: requestBody.queryInput
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all contexts in a regional ES session
      effect: destructive
      questions:
      - Is there a way to reset every active context in a Dialogflow ES conversation hosted in a specific region?
      - Can I wipe the context state of one regional ES session in a single call?
      instructions:
      - text: Delete all contexts in ES session {session} for project {project}, region {location}.
        slots:
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Reset the conversation state of regional ES session {session} under {project}/{location}.
        slots:
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to a regional ES agent
      effect: write
      questions:
      - How do I send text or audio to a Dialogflow ES agent hosted in a specific region and get the matched intent?
      - Can a regional ES detect-intent call take raw input audio?
      instructions:
      - text: Detect intent for {query_input} in ES session {session}, project {project}, region {location}.
        slots:
          query_input: requestBody.queryInput
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      - text: Send audio {audio} to regional ES session {session} in {project}/{location} and return the response.
        slots:
          audio: requestBody.inputAudio
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to a regional ES environment
      effect: write
      questions:
      - How do I query a published Dialogflow ES environment in a specific region for one end user?
      - Can I send audio for a user's session to a regional ES environment and get spoken output back?
      instructions:
      - text: Detect intent for {query_input} for user {user} session {session} in ES environment {environment}, project {project}, region {location}.
        slots:
          query_input: requestBody.queryInput
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Send audio {audio} from user {user} to regional environment {environment} session {session} ({project}/{location}).
        slots:
          audio: requestBody.inputAudio
          user: path.usersId
          environment: path.environmentsId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear contexts for a regional ES user session
      effect: destructive
      questions:
      - How do I reset all contexts for one user's session in a regional Dialogflow ES environment?
      - Can I clear the conversation state of an end user in a published regional ES environment?
      instructions:
      - text: Delete all contexts for user {user} session {session} in ES environment {environment}, project {project}, region {location}.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
          location: path.locationsId
      - text: Reset regional environment {environment} state for user {user}'s session {session} in {project}/{location}.
        slots:
          environment: path.environmentsId
          user: path.usersId
          session: path.sessionsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear contexts for a global ES user session
      effect: destructive
      questions:
      - Can I wipe all active contexts for one user in a published Dialogflow ES environment?
      - Can I reset a user's session state in my global ES production environment?
      instructions:
      - text: Delete all contexts for user {user} session {session} in ES environment {environment} of project {project}.
        slots:
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Reset environment {environment} state for user {user}'s session {session} in project {project}, no region.
        slots:
          environment: path.environmentsId
          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}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to a global ES environment
      effect: write
      questions:
      - How do I send a user's message to a published Dialogflow ES environment without picking a region?
      - Can I get the matched intent and audio reply for one end user's session in my ES production environment?
      instructions:
      - text: Detect intent for {query_input} for user {user} session {session} in ES environment {environment} of project {project}.
        slots:
          query_input: requestBody.queryInput
          user: path.usersId
          session: path.sessionsId
          environment: path.environmentsId
          project: path.projectsId
      - text: Send audio {audio} from user {user} to environment {environment} session {session} in project {project} at the global location.
        slots:
          audio: requestBody.inputAudio
          user: path.usersId
          environment: path.environmentsId
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a user turn to the global ES agent
      effect: write
      questions:
      - How do I send a message to my project's Dialogflow ES agent and get the matched intent and reply?
      - What does the basic ES detect intent call return when I send text to the default agent?
      instructions:
      - text: Detect intent for {query_input} in ES session {session} of project {project}.
        slots:
          query_input: requestBody.queryInput
          session: path.sessionsId
          project: path.projectsId
      - text: Send audio {audio} to the default ES agent session {session} in project {project} and return the fulfillment text.
        slots:
          audio: requestBody.inputAudio
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/sessions/{sessionsId}/contexts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all contexts in a global ES session
      effect: destructive
      questions:
      - Is it possible to clear every active context in a conversation with my project's default ES agent?
      - Can I start a global Dialogflow ES session over by dropping its contexts?
      instructions:
      - text: Delete all contexts in ES session {session} of project {project}.
        slots:
          session: path.sessionsId
          project: path.projectsId
      - text: Wipe the default agent's context state for session {session} in project {project}.
        slots:
          session: path.sessionsId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'