Google Dialogflow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dialogflow ES API (v2) Conversation Profiles API

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

$.info
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].delete
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].patch
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles'].get
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig'].post
$.paths['/v2/projects/{projectsId}/conversationProfiles'].get
$.paths['/v2/projects/{projectsId}/conversationProfiles'].post
$.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig'].post
$.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].get
$.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].delete
$.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].patch
$.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig'].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) Conversation Profiles API
  version: 1.0.0
extends: openapi/google-dialogflow-conversationprofiles-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: 14
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a regional conversation profile
      effect: read
      questions:
      - What settings does one regional Agent Assist conversation profile have?
      - Can I check which virtual agent and language a regional conversation profile uses?
      instructions:
      - text: Get conversation profile {profile} in project {project}, region {location}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      - text: Show the regional profile {profile} configuration under {project}/{location}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a regional conversation profile
      effect: destructive
      questions:
      - Is there a way to delete a regional conversation profile I no longer use?
      - Can I remove a regional Agent Assist profile permanently?
      instructions:
      - text: Delete conversation profile {profile} in project {project}, region {location}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the regional profile {profile} from {project}/{location}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a regional conversation profile
      effect: write
      questions:
      - Can I change the language or time zone of an existing regional conversation profile?
      - Can I update the human agent handoff settings on a profile in a specific region?
      instructions:
      - text: Rename regional conversation profile {profile} in {project}/{location} to {display_name}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      - text: Set language {language} and time zone {time_zone} on profile {profile}, project {project}, region {location}.
        slots:
          language: requestBody.languageCode
          time_zone: requestBody.timeZone
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation profiles in a region
      effect: read
      questions:
      - Which conversation profiles have I set up in a particular region?
      - Can I page through all regional Agent Assist profiles in a project?
      instructions:
      - text: List conversation profiles in project {project}, region {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} regional conversation profiles at a time for {project}/{location}.
        slots:
          page_size: query.pageSize
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversation profile in a region
      effect: write
      questions:
      - How do I create a conversation profile that ties a virtual agent and Agent Assist together in a specific region?
      - Can a new regional conversation profile set speech-to-text and text-to-speech settings?
      instructions:
      - text: Create conversation profile {display_name} in project {project}, region {location}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
      - text: Set up a regional profile {display_name} in {project}/{location} with automated agent config {agent_config} and language {language}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
          agent_config: requestBody.automatedAgentConfig
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on a suggestion feature for a regional profile
      effect: write
      questions:
      - Which call turns on an Agent Assist suggestion feature like smart reply for a regional conversation profile?
      - Can I configure suggestions for just the human agent role on a profile in a specific region?
      instructions:
      - text: Set suggestion feature config {feature_config} for role {role} on profile {profile}, project {project}, region {location}.
        slots:
          feature_config: requestBody.suggestionFeatureConfig
          role: requestBody.participantRole
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      - text: Enable suggestions {feature_config} on regional conversation profile {profile} in {project}/{location}.
        slots:
          feature_config: requestBody.suggestionFeatureConfig
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off a suggestion feature on a regional profile
      effect: write
      questions:
      - Is it possible to switch off one Agent Assist suggestion type on a regional conversation profile?
      - Can I clear the suggestion settings for a single participant role on a profile in a specific region?
      instructions:
      - text: Clear suggestion feature {feature_type} for role {role} on profile {profile}, project {project}, region {location}.
        slots:
          feature_type: requestBody.suggestionFeatureType
          role: requestBody.participantRole
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      - text: Disable {feature_type} suggestions on regional conversation profile {profile} in {project}/{location}.
        slots:
          feature_type: requestBody.suggestionFeatureType
          profile: path.conversationProfilesId
          project: path.projectsId
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation profiles in a project
      effect: read
      questions:
      - What conversation profiles exist in my Dialogflow project at the global location?
      - Can I list a project's Agent Assist profiles without naming a region?
      instructions:
      - text: List the global conversation profiles in project {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s conversation profiles, {page_size} per page.
        slots:
          project: path.projectsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversation profile in a project
      effect: write
      questions:
      - How do I create a global conversation profile for Agent Assist in my project?
      - Can a project-level conversation profile hand off to a human agent?
      instructions:
      - text: Create a global conversation profile {display_name} in project {project}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
      - text: Set up profile {display_name} in project {project} with handoff config {handoff_config}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          handoff_config: requestBody.humanAgentHandoffConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on a suggestion feature for a project profile
      effect: write
      questions:
      - How do I enable an Agent Assist suggestion feature on a global conversation profile?
      - Can I set article or FAQ suggestions for the end-user role on a project-level profile?
      instructions:
      - text: Set suggestion feature config {feature_config} for role {role} on global profile {profile} in project {project}.
        slots:
          feature_config: requestBody.suggestionFeatureConfig
          role: requestBody.participantRole
          profile: path.conversationProfilesId
          project: path.projectsId
      - text: Enable suggestions {feature_config} on project {project}'s conversation profile {profile}.
        slots:
          feature_config: requestBody.suggestionFeatureConfig
          project: path.projectsId
          profile: path.conversationProfilesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project conversation profile
      effect: read
      questions:
      - What does the full configuration of a global conversation profile look like?
      - Can I check the logging and notification settings on a project-level profile?
      instructions:
      - text: Get global conversation profile {profile} in project {project}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
      - text: Show project {project}'s profile {profile} settings.
        slots:
          project: path.projectsId
          profile: path.conversationProfilesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project conversation profile
      effect: destructive
      questions:
      - Can I delete a global conversation profile from my project?
      - Is deleting a project-level Agent Assist profile reversible?
      instructions:
      - text: Delete global conversation profile {profile} in project {project}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
      - text: Remove project {project}'s profile {profile}.
        slots:
          project: path.projectsId
          profile: path.conversationProfilesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a project conversation profile
      effect: write
      questions:
      - How do I change the speech settings on an existing global conversation profile?
      - Can I update only selected fields of a project-level profile with an update mask?
      instructions:
      - text: Rename global conversation profile {profile} in project {project} to {display_name}.
        slots:
          profile: path.conversationProfilesId
          project: path.projectsId
          display_name: requestBody.displayName
      - text: Update {update_mask} on project {project}'s profile {profile} using speech config {stt_config}.
        slots:
          update_mask: query.updateMask
          project: path.projectsId
          profile: path.conversationProfilesId
          stt_config: requestBody.sttConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off a suggestion feature on a project profile
      effect: write
      questions:
      - Is there a way to disable one suggestion feature on a global conversation profile?
      - Can I remove the suggestion config for the human agent role on a project-level profile?
      instructions:
      - text: Clear suggestion feature {feature_type} for role {role} on global profile {profile} in project {project}.
        slots:
          feature_type: requestBody.suggestionFeatureType
          role: requestBody.participantRole
          profile: path.conversationProfilesId
          project: path.projectsId
      - text: Disable {feature_type} suggestions on project {project}'s profile {profile}.
        slots:
          feature_type: requestBody.suggestionFeatureType
          project: path.projectsId
          profile: path.conversationProfilesId
      method: generated
      generated: '2026-10-01'