Google Dialogflow · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate'].post
$.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate'].post
$.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete'].post
$.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate'].post
$.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate'].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) Entities API
  version: 1.0.0
extends: openapi/google-dialogflow-entities-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: 6
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete entity values in a regional entity type
      effect: destructive
      questions:
      - Can I remove several values from an entity type on my regional ES agent at once?
      - Do I need a language code when bulk-deleting entities in a specific location?
      instructions:
      - text: Delete entity values {values} from entity type {entity_type} in project {project}, location {location}.
        slots:
          values: requestBody.entityValues
          entity_type: path.entityTypesId
          project: path.projectsId
          location: path.locationsId
      - text: Bulk-remove {values} from regional entity type {entity_type} for language {language_code}.
        slots:
          values: requestBody.entityValues
          entity_type: path.entityTypesId
          language_code: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate'].post
  update:
    x-apievangelist-phrasing:
      intent: Update entities in a regional entity type
      effect: write
      questions:
      - How do I update synonyms on many entities of a regional entity type in one call?
      - Can I restrict a regional bulk entity update to certain fields?
      instructions:
      - text: Update entities {entities} in entity type {entity_type}, project {project}, location {location}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          project: path.projectsId
          location: path.locationsId
      - text: Batch-update regional entity type {entity_type} entities using mask {update_mask}.
        slots:
          entity_type: path.entityTypesId
          update_mask: requestBody.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entities to a regional entity type
      effect: write
      questions:
      - Can I add a batch of new values to an entity type on my regional agent?
      - Which language do bulk-created entities in a specific location get?
      instructions:
      - text: Create entities {entities} in entity type {entity_type}, project {project}, location {location}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          project: path.projectsId
          location: path.locationsId
      - text: Add new regional entity values {entities} to {entity_type} in language {language_code}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          language_code: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete entity values in an entity type
      effect: destructive
      questions:
      - Can I delete many values from an entity type on my global ES agent?
      - Is a bulk delete of default-location entity values reversible?
      instructions:
      - text: Delete entity values {values} from global entity type {entity_type} in project {project}.
        slots:
          values: requestBody.entityValues
          entity_type: path.entityTypesId
          project: path.projectsId
      - text: Remove {values} from default-location entity type {entity_type}, project {project}.
        slots:
          values: requestBody.entityValues
          entity_type: path.entityTypesId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate'].post
  update:
    x-apievangelist-phrasing:
      intent: Update entities in an entity type
      effect: write
      questions:
      - How do I bulk-edit entities on an entity type of my global ES agent?
      - Can I change only synonyms when batch-updating default-location entities?
      instructions:
      - text: Update entities {entities} in global entity type {entity_type}, project {project}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          project: path.projectsId
      - text: Batch-update default-location entity type {entity_type} in project {project} for language {language_code}.
        slots:
          entity_type: path.entityTypesId
          project: path.projectsId
          language_code: requestBody.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entities to an entity type
      effect: write
      questions:
      - Can I add many new values to an entity type on my global ES agent in one call?
      - What language are default-location entities created in if I don't specify one?
      instructions:
      - text: Create entities {entities} in global entity type {entity_type}, project {project}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          project: path.projectsId
      - text: Add default-location entity values {entities} to {entity_type} for project {project}.
        slots:
          entities: requestBody.entities
          entity_type: path.entityTypesId
          project: path.projectsId
      method: generated
      generated: '2026-10-01'