# 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 Models API
  version: 1.0.0
extends: openapi/google-dialogflow-conversationmodels-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: 12
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}:deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a regional conversation model
      effect: write
      questions:
      - How do I put a trained Agent Assist conversation model in a specific region into service?
      - Can a regional smart reply model be deployed so it starts serving suggestions?
      instructions:
      - text: Deploy conversation model {model} in project {project}, location {location}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Start serving the {location} conversation model {model}.
        slots:
          location: path.locationsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversation models in a region
      effect: read
      questions:
      - Which conversation models have I trained in a particular location?
      - Can I page through regional Agent Assist models?
      instructions:
      - text: List conversation models in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} regional conversation models per page from {location}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels'].post
  update:
    x-apievangelist-phrasing:
      intent: Train a conversation model in a region
      effect: write
      questions:
      - How do I train a smart reply or article suggestion model on my conversation datasets in a given region?
      - Can I pick which datasets a new regional conversation model learns from?
      instructions:
      - text: Create conversation model {display_name} in project {project}, location {location} from datasets {datasets}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
          datasets: requestBody.datasets
      - text: Train a {location} article suggestion model {display_name} with metadata {article_metadata}.
        slots:
          location: path.locationsId
          display_name: requestBody.displayName
          article_metadata: requestBody.articleSuggestionModelMetadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a regional conversation model
      effect: read
      questions:
      - Is my regional conversation model still training or already deployed?
      - What datasets and language does a conversation model in a specific location use?
      instructions:
      - text: Get conversation model {model} in project {project}, location {location}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Check the state of the {location} conversation model {model}.
        slots:
          location: path.locationsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a regional conversation model
      effect: destructive
      questions:
      - Can I delete an Agent Assist model I trained in a specific region?
      - Is removing a regional conversation model permanent?
      instructions:
      - text: Delete conversation model {model} in project {project}, location {location}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the {location} conversation model {model} for good.
        slots:
          location: path.locationsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}:undeploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Undeploy a regional conversation model
      effect: write
      questions:
      - How do I take a regional conversation model out of service without deleting it?
      - Can I stop a deployed smart reply model in one location from serving?
      instructions:
      - text: Undeploy conversation model {model} in project {project}, location {location}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Stop serving the {location} conversation model {model} but keep it.
        slots:
          location: path.locationsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}:undeploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Undeploy a global conversation model
      effect: write
      questions:
      - Can I pause a project-level conversation model that is currently deployed?
      - Will undeploying a global Agent Assist model keep it available to redeploy later?
      instructions:
      - text: Undeploy global conversation model {model} in project {project}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
      - text: Take project {project}'s conversation model {model} offline without deleting it.
        slots:
          project: path.projectsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a global conversation model
      effect: read
      questions:
      - What state is my project-level conversation model in?
      - Can I see the smart reply metadata of a global conversation model?
      instructions:
      - text: Get global conversation model {model} in project {project}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
      - text: Show details of project {project}'s conversation model {model}.
        slots:
          project: path.projectsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a global conversation model
      effect: destructive
      questions:
      - Can I delete a conversation model that isn't tied to a region?
      - Is a project-level Agent Assist model removable once I'm done with it?
      instructions:
      - text: Delete global conversation model {model} in project {project}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
      - text: Permanently remove project {project}'s conversation model {model}.
        slots:
          project: path.projectsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels'].get
  update:
    x-apievangelist-phrasing:
      intent: List global conversation models
      effect: read
      questions:
      - Which conversation models exist at the project level?
      - Can I list my project's Agent Assist models in pages?
      instructions:
      - text: List global conversation models in project {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s conversation models {page_size} at a time.
        slots:
          project: path.projectsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels'].post
  update:
    x-apievangelist-phrasing:
      intent: Train a global conversation model
      effect: write
      questions:
      - How do I train a project-level smart reply model from my conversation datasets?
      - Can I set the language for a new global conversation model?
      instructions:
      - text: Create global conversation model {display_name} in project {project} trained on {datasets}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          datasets: requestBody.datasets
      - text: Train a smart reply model {display_name} for project {project} with metadata {smart_reply_metadata}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          smart_reply_metadata: requestBody.smartReplyModelMetadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}:deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a global conversation model
      effect: write
      questions:
      - Can I deploy a project-level conversation model so agents start getting suggestions?
      - How would I bring a global Agent Assist model I undeployed back online?
      instructions:
      - text: Deploy global conversation model {model} in project {project}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
      - text: Put project {project}'s conversation model {model} back into service.
        slots:
          project: path.projectsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'