# 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) Knowledge Bases API
  version: 1.0.0
extends: openapi/google-dialogflow-knowledge-bases-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: 15
- target: $.paths['/v2/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a project-level knowledge base
      effect: read
      questions:
      - What language and display name does one of my Dialogflow knowledge bases have?
      - Can I fetch a project-level knowledge base by its ID?
      instructions:
      - text: Get knowledge base {knowledge_base} in project {project}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
      - text: Show the details of project-level knowledge base {knowledge_base}.
        slots:
          knowledge_base: path.knowledgeBasesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project-level knowledge base
      effect: destructive
      questions:
      - Can I delete a knowledge base that still has documents in it?
      - Is a forced delete needed to remove a non-empty project-level knowledge base?
      instructions:
      - text: Delete knowledge base {knowledge_base} in project {project}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
      - text: Force-delete project-level knowledge base {knowledge_base} along with its documents, force={force}.
        slots:
          knowledge_base: path.knowledgeBasesId
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a project-level knowledge base
      effect: write
      questions:
      - How do I rename a knowledge base in my project?
      - Can I change the language code of an existing project-level knowledge base?
      instructions:
      - text: Rename knowledge base {knowledge_base} in project {project} to {display_name}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
          display_name: requestBody.displayName
      - text: Set the language of project-level knowledge base {knowledge_base} to {language}.
        slots:
          knowledge_base: path.knowledgeBasesId
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/knowledgeBases'].get
  update:
    x-apievangelist-phrasing:
      intent: List project-level knowledge bases
      effect: read
      questions:
      - Which knowledge bases exist in my Google Cloud project?
      - Can I filter my knowledge bases, for instance by display name or language?
      instructions:
      - text: List the knowledge bases in project {project}.
        slots:
          project: path.projectsId
      - text: Show project {project}'s knowledge bases that match filter {filter}.
        slots:
          project: path.projectsId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/knowledgeBases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project-level knowledge base
      effect: write
      questions:
      - How do I create a new knowledge base to hold FAQ documents?
      - Can I set the language when creating a project-level knowledge base?
      instructions:
      - text: Create a knowledge base named {display_name} in project {project}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
      - text: Make a new project-level knowledge base {display_name} in language {language}.
        slots:
          display_name: requestBody.displayName
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a regional knowledge base
      effect: read
      questions:
      - Can I look up a knowledge base that is stored in a specific region?
      - What settings does a regional knowledge base have?
      instructions:
      - text: Get regional knowledge base {knowledge_base} in project {project}, location {location}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
          location: path.locationsId
      - text: Show the {location} knowledge base {knowledge_base}.
        slots:
          location: path.locationsId
          knowledge_base: path.knowledgeBasesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a regional knowledge base
      effect: destructive
      questions:
      - Can I delete a knowledge base hosted in a particular location?
      - Does removing a regional knowledge base with documents require the force flag?
      instructions:
      - text: Delete regional knowledge base {knowledge_base} in project {project}, location {location}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the {location} knowledge base {knowledge_base} even if it has documents, force={force}.
        slots:
          location: path.locationsId
          knowledge_base: path.knowledgeBasesId
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a regional knowledge base
      effect: write
      questions:
      - How can I rename a knowledge base that lives in a specific region?
      - Can I update only selected fields of a regional knowledge base?
      instructions:
      - text: Rename regional knowledge base {knowledge_base} in project {project}, location {location} to {display_name}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
          location: path.locationsId
          display_name: requestBody.displayName
      - text: Update fields {update_mask} on the {location} knowledge base {knowledge_base}.
        slots:
          update_mask: query.updateMask
          location: path.locationsId
          knowledge_base: path.knowledgeBasesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge bases in a region
      effect: read
      questions:
      - Which knowledge bases do I have in a given location?
      - Can regional knowledge bases be listed with a filter and page size?
      instructions:
      - text: List knowledge bases in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} knowledge bases at a time from region {location}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/knowledgeBases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge base in a region
      effect: write
      questions:
      - How do I create a knowledge base that keeps its data in a specific region?
      - Can a regional knowledge base be created for a non-English language?
      instructions:
      - text: Create a regional knowledge base {display_name} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
      - text: Make a {location} knowledge base named {display_name} for language {language}.
        slots:
          location: path.locationsId
          display_name: requestBody.displayName
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a knowledge base attached to an agent
      effect: read
      questions:
      - What knowledge base is my ES agent using, and what are its settings?
      - Can I read an agent knowledge base by ID?
      instructions:
      - text: Get my agent's knowledge base {knowledge_base} in project {project}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
      - text: Display agent knowledge base {knowledge_base}.
        slots:
          knowledge_base: path.knowledgeBasesId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base attached to an agent
      effect: destructive
      questions:
      - Can I detach and delete a knowledge base from my ES agent?
      - Will deleting an agent knowledge base fail if documents remain unless forced?
      instructions:
      - text: Delete my agent's knowledge base {knowledge_base} in project {project}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
      - text: Drop agent knowledge base {knowledge_base} with force set to {force}.
        slots:
          knowledge_base: path.knowledgeBasesId
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a knowledge base attached to an agent
      effect: write
      questions:
      - Can I rename the knowledge base my ES agent answers from?
      - Is the language of an agent knowledge base editable?
      instructions:
      - text: Rename my agent's knowledge base {knowledge_base} in project {project} to {display_name}.
        slots:
          knowledge_base: path.knowledgeBasesId
          project: path.projectsId
          display_name: requestBody.displayName
      - text: Change agent knowledge base {knowledge_base} to language {language}.
        slots:
          knowledge_base: path.knowledgeBasesId
          language: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/knowledgeBases'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge bases attached to an agent
      effect: read
      questions:
      - Which knowledge bases are connected to my project's ES agent?
      - Can I filter the list of agent knowledge bases?
      instructions:
      - text: List my agent's knowledge bases in project {project}.
        slots:
          project: path.projectsId
      - text: Show agent knowledge bases in project {project} matching {filter}.
        slots:
          project: path.projectsId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/knowledgeBases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a knowledge base for an agent
      effect: write
      questions:
      - How do I give my ES agent its own knowledge base?
      - Can I pick a language for a knowledge base created under my agent?
      instructions:
      - text: Create a knowledge base {display_name} for my agent in project {project}.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
      - text: Add agent knowledge base {display_name} in language {language} to project {project}.
        slots:
          display_name: requestBody.displayName
          language: requestBody.languageCode
          project: path.projectsId
      method: generated
      generated: '2026-10-01'