Algolia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Personalization API

10 actions 10 updates phrasing extends openapi/algolia-personalization-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Algolia's API. It is a proposal applied on top of the contract, not a document Algolia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/{path}'].get
$.paths['/{path}'].put
$.paths['/{path}'].post
$.paths['/{path}'].delete
$.paths['/1/profiles/personalization/{userToken}'].get
$.paths['/1/profiles/{userToken}'].delete
$.paths['/1/strategies/personalization'].get
$.paths['/1/strategies/personalization'].post
$.paths['/setClientApiKey'].get

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 Personalization API
  version: 1.0.0
extends: openapi/algolia-personalization-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a raw GET request to the Personalization API
      effect: read
      questions:
      - Can I read a Personalization endpoint that the client library doesn't wrap?
      - Is there a generic way to GET any Personalization API path with custom query parameters?
      instructions:
      - text: Send a raw GET request to Personalization API path {path}.
        slots:
          path: path.path
      - text: Fetch Personalization path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a raw PUT request to the Personalization API
      effect: write
      questions:
      - Can I send a custom PUT to a Personalization path that has no dedicated method?
      - Is there a passthrough for replacing a resource on an arbitrary Personalization endpoint?
      instructions:
      - text: Send a raw PUT request to Personalization API path {path}.
        slots:
          path: path.path
      - text: PUT to Personalization path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a raw POST request to the Personalization API
      effect: write
      questions:
      - Can I POST to a Personalization endpoint the SDK doesn't expose as a method?
      - What's the generic escape hatch for posting to any Personalization API path?
      instructions:
      - text: Send a raw POST request to Personalization API path {path}.
        slots:
          path: path.path
      - text: POST to Personalization path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a raw DELETE request to the Personalization API
      effect: destructive
      questions:
      - Can I issue a DELETE against an arbitrary Personalization API path?
      - Is there a generic delete call for Personalization endpoints without a dedicated method?
      instructions:
      - text: Send a raw DELETE request to Personalization API path {path}.
        slots:
          path: path.path
      - text: DELETE Personalization path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/profiles/personalization/{userToken}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's personalization profile and affinities
      effect: read
      questions:
      - Which facet values does a particular shopper have the strongest affinity for?
      - How do I look up what Algolia Personalization has learned about one user token?
      instructions:
      - text: Show the personalization profile and facet affinities for user token {userToken}.
        slots:
          userToken: path.userToken
      - text: Get the facet affinities recorded for user {userToken}.
        slots:
          userToken: path.userToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/profiles/{userToken}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's personalization profile
      effect: destructive
      questions:
      - How do I erase a user's personalization profile, for example after a privacy request?
      - When can I consider a deleted personalization profile actually gone?
      instructions:
      - text: Delete the personalization profile for user token {userToken}.
        slots:
          userToken: path.userToken
      - text: Erase everything Personalization stored about user {userToken} and tell me when deletion is final.
        slots:
          userToken: path.userToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/strategies/personalization'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current personalization strategy
      effect: read
      questions:
      - What events and facets is my personalization strategy currently scoring?
      - How strong is the personalization impact set on my application right now?
      instructions:
      - text: Show my current personalization strategy.
      - text: Tell me the event scores, facet scores and impact in the active personalization strategy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/strategies/personalization'].post
  update:
    x-apievangelist-phrasing:
      intent: Define the personalization strategy
      effect: write
      questions:
      - How do I tell Personalization which events and facets should drive ranking?
      - Can I dial down how much personalization affects search results?
      instructions:
      - text: Set the personalization strategy with event scoring {eventsScoring}, facet scoring {facetsScoring} and impact {personalizationImpact}.
        slots:
          eventsScoring: requestBody.eventsScoring
          facetsScoring: requestBody.facetsScoring
          personalizationImpact: requestBody.personalizationImpact
      - text: Change the personalization impact to {personalizationImpact} while keeping events {eventsScoring} and facets {facetsScoring}.
        slots:
          personalizationImpact: requestBody.personalizationImpact
          eventsScoring: requestBody.eventsScoring
          facetsScoring: requestBody.facetsScoring
      method: generated
      generated: '2026-09-26'
- target: $.paths['/setClientApiKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Switch the API key the Personalization client uses
      effect: write
      questions:
      - Can I change which API key my Personalization client authenticates with?
      - How do I rotate the key an existing Personalization client sends?
      instructions:
      - text: Switch the Personalization client to authenticate with API key {apiKey}.
        slots:
          apiKey: query.apiKey
      - text: Use {apiKey} for all further Personalization API requests.
        slots:
          apiKey: query.apiKey
      method: generated
      generated: '2026-09-26'