Google Dialogflow · OpenAPI Overlay 1.0.0

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

11 actions 11 updates phrasing extends openapi/google-dialogflow-participants-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 11

$.info
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}'].patch
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent'].post
$.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants'].get
$.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants'].post
$.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}'].get
$.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}'].patch
$.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent'].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 Dialogflow ES API (v2) Participants API
  version: 1.0.0
extends: openapi/google-dialogflow-participants-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: 10
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants'].get
  update:
    x-apievangelist-phrasing:
      intent: List participants in a regional conversation
      effect: read
      questions:
      - Who are the participants, like end user and human agent, in a conversation hosted in a specific region?
      - Can I page through the participants of a regional Dialogflow conversation?
      instructions:
      - text: List participants in conversation {conversation}, project {project}, region {location}.
        slots:
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} participants at a time for regional conversation {conversation} in {project}/{location}.
        slots:
          page_size: query.pageSize
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a participant to a regional conversation
      effect: write
      questions:
      - How do I add a human agent or end user to a conversation in a specific region?
      - Can I attach an obfuscated external user ID when adding someone to a regional conversation?
      instructions:
      - text: Add a participant with role {role} to conversation {conversation}, project {project}, region {location}.
        slots:
          role: requestBody.role
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      - text: Create a {role} participant for external user {external_id} in regional conversation {conversation} ({project}/{location}).
        slots:
          role: requestBody.role
          external_id: requestBody.obfuscatedExternalUserId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a participant in a regional conversation
      effect: read
      questions:
      - What role and details does one participant have in a regional conversation?
      - Can I fetch a specific participant by ID from a conversation in a non-global location?
      instructions:
      - text: Get participant {participant} in conversation {conversation}, project {project}, region {location}.
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the details of regional participant {participant} from conversation {conversation} ({project}/{location}).
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a participant in a regional conversation
      effect: write
      questions:
      - Can I change a participant's settings in a conversation hosted in a specific region?
      - Can I set the document metadata filters used for a regional participant's knowledge suggestions?
      instructions:
      - text: Update participant {participant} in conversation {conversation}, project {project}, region {location} with metadata filters {filters}.
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
          filters: requestBody.documentsMetadataFilters
      - text: Change the external user ID of regional participant {participant} in {conversation} ({project}/{location}) to {external_id}.
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
          external_id: requestBody.obfuscatedExternalUserId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze a participant message in a regional conversation
      effect: write
      questions:
      - How do I send what a participant said in a regional conversation to get virtual agent replies and suggestions?
      - Can I analyze a participant's audio input in a conversation hosted in a specific region?
      instructions:
      - text: Analyze text {text_input} from participant {participant} in conversation {conversation}, project {project}, region {location}.
        slots:
          text_input: requestBody.textInput
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      - text: Run analyze content on audio {audio_input} from regional participant {participant} in {conversation} ({project}/{location}).
        slots:
          audio_input: requestBody.audioInput
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants'].get
  update:
    x-apievangelist-phrasing:
      intent: List participants in a conversation
      effect: read
      questions:
      - Who is taking part in a Dialogflow conversation at the global location?
      - Can I list every participant of a project-level conversation?
      instructions:
      - text: List participants in conversation {conversation} of project {project}.
        slots:
          conversation: path.conversationsId
          project: path.projectsId
      - text: Show project {project} conversation {conversation}'s participants, {page_size} per page.
        slots:
          project: path.projectsId
          conversation: path.conversationsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a participant to a conversation
      effect: write
      questions:
      - How do I add an end user or human agent to a global Dialogflow conversation?
      - Can I label a new participant's SIP recording media when joining a project-level conversation?
      instructions:
      - text: Add a {role} participant to conversation {conversation} in project {project}.
        slots:
          role: requestBody.role
          conversation: path.conversationsId
          project: path.projectsId
      - text: Join external user {external_id} as {role} to project {project}'s conversation {conversation}.
        slots:
          external_id: requestBody.obfuscatedExternalUserId
          role: requestBody.role
          project: path.projectsId
          conversation: path.conversationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a participant in a conversation
      effect: read
      questions:
      - Which call fetches one participant from a global Dialogflow conversation?
      - Can I see what role a project-level conversation participant has?
      instructions:
      - text: Get participant {participant} in conversation {conversation} of project {project}.
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
      - text: Show project {project} participant {participant} from conversation {conversation}.
        slots:
          project: path.projectsId
          participant: path.participantsId
          conversation: path.conversationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a participant in a conversation
      effect: write
      questions:
      - Can I update a participant's details in a global Dialogflow conversation?
      - Can I change the agent desktop source of a project-level participant?
      instructions:
      - text: Update participant {participant} in conversation {conversation} of project {project} with desktop source {source}.
        slots:
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
          source: requestBody.agentDesktopSource
      - text: Patch {update_mask} on project {project} conversation {conversation} participant {participant}.
        slots:
          update_mask: query.updateMask
          project: path.projectsId
          conversation: path.conversationsId
          participant: path.participantsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze a participant message in a conversation
      effect: write
      questions:
      - How do I send a participant's message in a global conversation and get Agent Assist suggestions back?
      - Can I trigger an event instead of text when analyzing content for a project-level participant?
      instructions:
      - text: Analyze text {text_input} from participant {participant} in conversation {conversation} of project {project}.
        slots:
          text_input: requestBody.textInput
          participant: path.participantsId
          conversation: path.conversationsId
          project: path.projectsId
      - text: Send event {event} for project {project} participant {participant} in conversation {conversation} and return suggestions.
        slots:
          event: requestBody.eventInput
          project: path.projectsId
          participant: path.participantsId
          conversation: path.conversationsId
      method: generated
      generated: '2026-10-01'