# 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) Evaluations API
  version: 1.0.0
extends: openapi/google-dialogflow-evaluations-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: 9
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluations of a regional conversation model
      effect: read
      questions:
      - What evaluations have been run against my regional Agent Assist conversation model?
      - Can I page through the evaluation history of a conversation model in one location?
      instructions:
      - text: List evaluations of conversation model {model} in project {project}, location {location}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} evaluations per page for the {location} conversation model {model}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
          model: path.conversationModelsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/conversationModels/{conversationModelsId}/evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a regional conversation model
      effect: write
      questions:
      - How do I measure how well my regional smart reply model performs on held-out data?
      - Can I kick off a new evaluation run for a conversation model in a specific location?
      instructions:
      - text: Create an evaluation of conversation model {model} in project {project}, location {location} using config {evaluation}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
          evaluation: requestBody.conversationModelEvaluation
      - text: Start evaluating 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}/evaluations/{evaluationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a regional conversation model evaluation
      effect: read
      questions:
      - What scores did a specific evaluation of my regional conversation model produce?
      - Can I open one conversation model evaluation result in a given location?
      instructions:
      - text: Get evaluation {evaluation} of conversation model {model} in project {project}, location {location}.
        slots:
          evaluation: path.evaluationsId
          model: path.conversationModelsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the metrics of {location} model evaluation {evaluation}.
        slots:
          location: path.locationsId
          evaluation: path.evaluationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a generator evaluation
      effect: read
      questions:
      - What summarization metrics did an evaluation of my generator report?
      - Has a particular generator evaluation finished running?
      instructions:
      - text: Get evaluation {evaluation} of generator {generator} in project {project}, location {location}.
        slots:
          evaluation: path.evaluationsId
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the status and summarization scores of generator evaluation {evaluation}.
        slots:
          evaluation: path.evaluationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a generator evaluation
      effect: destructive
      questions:
      - Can I delete an old evaluation run for one of my generators?
      - Is removing a generator evaluation permanent?
      instructions:
      - text: Delete evaluation {evaluation} of generator {generator} in project {project}, location {location}.
        slots:
          evaluation: path.evaluationsId
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove generator {generator}'s evaluation {evaluation}.
        slots:
          generator: path.generatorsId
          evaluation: path.evaluationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluations of a generator
      effect: read
      questions:
      - Which evaluations have I run on a summarization generator?
      - Can I page through all evaluations for one generator?
      instructions:
      - text: List evaluations of generator {generator} in project {project}, location {location}.
        slots:
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Show generator {generator}'s evaluations {page_size} at a time.
        slots:
          generator: path.generatorsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a generator
      effect: write
      questions:
      - How do I test the quality of a summarization generator before rolling it out?
      - Can I run a generator evaluation with my own evaluation config and display name?
      instructions:
      - text: Create an evaluation named {display_name} for generator {generator} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          generator: path.generatorsId
          project: path.projectsId
          location: path.locationsId
      - text: Evaluate generator {generator} using evaluation config {config}.
        slots:
          generator: path.generatorsId
          config: requestBody.generatorEvaluationConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}/evaluations'].get
  update:
    x-apievangelist-phrasing:
      intent: List evaluations of a global conversation model
      effect: read
      questions:
      - Which evaluations exist for a project-level conversation model?
      - Can I list a global Agent Assist model's evaluations in pages?
      instructions:
      - text: List evaluations of global conversation model {model} in project {project}.
        slots:
          model: path.conversationModelsId
          project: path.projectsId
      - text: Page through project {project}'s model {model} evaluations, {page_size} each.
        slots:
          project: path.projectsId
          model: path.conversationModelsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/conversationModels/{conversationModelsId}/evaluations/{evaluationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a global conversation model evaluation
      effect: read
      questions:
      - How did my project-level conversation model score in a specific evaluation?
      - Can I fetch a global model evaluation by its ID?
      instructions:
      - text: Get evaluation {evaluation} of global conversation model {model} in project {project}.
        slots:
          evaluation: path.evaluationsId
          model: path.conversationModelsId
          project: path.projectsId
      - text: Show results of project {project}'s model evaluation {evaluation}.
        slots:
          project: path.projectsId
          evaluation: path.evaluationsId
      method: generated
      generated: '2026-10-01'