# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for cdp-api Realtime Personalization API
  version: 1.0.0
extends: openapi/treasure-data-realtime-personalization-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['/audiences/{audienceId}/realtime_personalization_services'].get
  update:
    x-apievangelist-phrasing:
      intent: List realtime personalization services
      effect: read
      questions:
      - Which realtime personalization services are set up for an audience?
      - Can I filter personalization services by name or page through them?
      instructions:
      - text: List the realtime personalization services for audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Find personalization services in audience {audienceId} whose name includes {name_include}.
        slots:
          audienceId: path.audienceId
          name_include: query.name_include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a realtime personalization service
      effect: write
      questions:
      - How do I stand up a realtime personalization service for an audience?
      - Can a new personalization service be made public when I create it?
      instructions:
      - text: Create a personalization service named {name} for audience {audienceId}.
        slots:
          name: requestBody.name
          audienceId: path.audienceId
      - text: Create personalization service {name} in audience {audienceId} described as {description}, with public set to {public}.
        slots:
          name: requestBody.name
          audienceId: path.audienceId
          description: requestBody.description
          public: requestBody.public
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realtime personalization service
      effect: read
      questions:
      - What is configured on one personalization service?
      - Can I look up a single personalization service in an audience?
      instructions:
      - text: Show personalization service {realtimePersonalizationServiceId} in audience {audienceId}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      - text: Fetch the details of personalization service {realtimePersonalizationServiceId} for audience {audienceId}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a realtime personalization service
      effect: destructive
      questions:
      - How do I shut down and remove a personalization service?
      - Is deleting a whole personalization service permanent?
      instructions:
      - text: Delete personalization service {realtimePersonalizationServiceId} from audience {audienceId}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      - text: Remove the unused personalization service {realtimePersonalizationServiceId} in audience {audienceId}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a realtime personalization service
      effect: write
      questions:
      - Can I rename a personalization service or change its description?
      - What can be edited on an existing personalization service?
      instructions:
      - text: Rename personalization service {realtimePersonalizationServiceId} in audience {audienceId} to {name}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
          name: requestBody.name
      - text: Set the name of service {realtimePersonalizationServiceId} in audience {audienceId} to {name} and its description to {description}.
        slots:
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a personalization token
      effect: write
      questions:
      - How do I issue an access token for a personalization service?
      - Can I restrict a personalization token to certain IP addresses?
      instructions:
      - text: Create a token named {name} for personalization service {realtimePersonalizationServiceId} in audience {audienceId}.
        slots:
          name: requestBody.name
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      - text: Issue personalization token {name} on service {realtimePersonalizationServiceId} in audience {audienceId}, allowed only from {allowedIps}.
        slots:
          name: requestBody.name
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
          allowedIps: requestBody.allowedIps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}/tokens/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a personalization token
      effect: destructive
      questions:
      - How do I revoke a personalization token that leaked?
      - Does deleting a token stop clients that use it from calling the service?
      instructions:
      - text: Delete token {tokenId} from personalization service {realtimePersonalizationServiceId} in audience {audienceId}.
        slots:
          tokenId: path.tokenId
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      - text: Revoke personalization token {tokenId} on service {realtimePersonalizationServiceId}, audience {audienceId}.
        slots:
          tokenId: path.tokenId
          realtimePersonalizationServiceId: path.realtimePersonalizationServiceId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_personalizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a realtime personalization
      effect: write
      questions:
      - Can I define a new realtime personalization that returns profile data in real time?
      - What attributes are required to create a realtime personalization entity?
      instructions:
      - text: Create a realtime personalization with attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Create a realtime personalization with {attributes} linked to {relationships}.
        slots:
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_personalizations/{realtimePersonalizationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realtime personalization
      effect: read
      questions:
      - What is configured on a particular realtime personalization?
      - Can I fetch a single realtime personalization entity by ID?
      instructions:
      - text: Show realtime personalization {realtimePersonalizationId}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
      - text: Fetch the settings of realtime personalization {realtimePersonalizationId}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_personalizations/{realtimePersonalizationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a realtime personalization
      effect: destructive
      questions:
      - How do I remove a realtime personalization entity?
      - Is deleting a realtime personalization permanent?
      instructions:
      - text: Delete realtime personalization {realtimePersonalizationId}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
      - text: Remove the obsolete realtime personalization {realtimePersonalizationId}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_personalizations/{realtimePersonalizationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a realtime personalization
      effect: write
      questions:
      - Can I change the attributes of an existing realtime personalization?
      - What happens when I edit a realtime personalization entity?
      instructions:
      - text: Update realtime personalization {realtimePersonalizationId} with attributes {attributes}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
          attributes: requestBody.attributes
      - text: Change the attributes of existing realtime personalization {realtimePersonalizationId} to {attributes}.
        slots:
          realtimePersonalizationId: path.realtimePersonalizationId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/realtime_personalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List realtime personalizations in a parent segment
      effect: read
      questions:
      - Which realtime personalizations exist under a parent segment?
      - Can I list only the realtime personalizations I have edit permission on?
      instructions:
      - text: List realtime personalizations under parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: List realtime personalizations in parent segment {parentSegmentId} where I have {permissions} permission.
        slots:
          parentSegmentId: path.parentSegmentId
          permissions: query.permissions
      method: generated
      generated: '2026-10-01'