Algolia · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Advanced Personalization API
13 actions
13 updates
phrasing
extends
openapi/algolia-advanced-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.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/{path}'].get
$.paths['/{path}'].put
$.paths['/{path}'].post
$.paths['/{path}'].delete
$.paths['/2/config'].get
$.paths['/2/config'].put
$.paths['/2/users'].get
$.paths['/2/users/{userID}'].get
$.paths['/2/users/{userID}'].delete
$.paths['/2/realtime/users/{userToken}'].get
$.paths['/2/realtime/users/{userToken}/compute'].post
$.paths['/setClientApiKey'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Advanced Personalization API
version: 1.0.0
extends: openapi/algolia-advanced-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: 12
- target: $.paths['/{path}'].get
update:
x-apievangelist-phrasing:
intent: Send a raw GET request to Advanced Personalization
effect: read
questions:
- Can I read an Advanced Personalization endpoint that the client library doesn't wrap?
- Is there a generic way to GET any Advanced Personalization path with my own query parameters?
instructions:
- text: Send a raw GET request to Advanced Personalization path {path}.
slots:
path: path.path
- text: Fetch Advanced 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 Advanced Personalization
effect: write
questions:
- Can I send a custom PUT to an Advanced Personalization path with no dedicated method?
- Is there a passthrough for replacing a resource on an arbitrary Advanced Personalization endpoint?
instructions:
- text: Send a raw PUT request to Advanced Personalization path {path}.
slots:
path: path.path
- text: PUT to Advanced 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 Advanced Personalization
effect: write
questions:
- Can I POST to an Advanced Personalization endpoint the SDK doesn't expose?
- What's the generic escape hatch for posting to any Advanced Personalization path?
instructions:
- text: Send a raw POST request to Advanced Personalization path {path}.
slots:
path: path.path
- text: POST to Advanced 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 Advanced Personalization
effect: destructive
questions:
- Can I issue a DELETE against an arbitrary Advanced Personalization path?
- Is there a generic delete call for Advanced Personalization endpoints without a dedicated method?
instructions:
- text: Send a raw DELETE request to Advanced Personalization path {path}.
slots:
path: path.path
- text: DELETE Advanced Personalization path {path} with query parameters {parameters}.
slots:
path: path.path
parameters: query.parameters
method: generated
generated: '2026-09-26'
- target: $.paths['/2/config'].get
update:
x-apievangelist-phrasing:
intent: Get the Advanced Personalization configuration
effect: read
questions:
- Which indices have Advanced Personalization configured, and with what settings?
- What does my current per-index Advanced Personalization configuration look like?
instructions:
- text: Show my Advanced Personalization configuration for every index.
- text: List the per-index configuration objects for Advanced Personalization.
method: generated
generated: '2026-09-26'
- target: $.paths['/2/config'].put
update:
x-apievangelist-phrasing:
intent: Update the Advanced Personalization configuration
effect: write
questions:
- How do I turn on Advanced Personalization for a new index?
- Can I change the re-ranking and profile type used by Advanced Personalization?
instructions:
- text: Configure Advanced Personalization for indices {indices} with features {features}, profile type {profileType} and re-ranking {personalizationReRanking}.
slots:
indices: requestBody.indices
features: requestBody.features
profileType: requestBody.profileType
personalizationReRanking: requestBody.personalizationReRanking
- text: Set Advanced Personalization re-ranking to {personalizationReRanking} on indices {indices}, keeping features {features} and profile type {profileType}.
slots:
personalizationReRanking: requestBody.personalizationReRanking
indices: requestBody.indices
features: requestBody.features
profileType: requestBody.profileType
method: generated
generated: '2026-09-26'
- target: $.paths['/2/users'].get
update:
x-apievangelist-phrasing:
intent: List Advanced Personalization user profiles
effect: read
questions:
- How do I page through all the user profiles Advanced Personalization has built?
- Can I find the users who have an affinity for a specific facet value?
- Which user profiles were active in a given date range for certain indices?
instructions:
- text: List Advanced Personalization user profiles between {startDate} and {endDate}.
slots:
startDate: query.startDate
endDate: query.endDate
- text: Find user profiles with affinity {affinity} on indices {indices}, {limit} at a time.
slots:
affinity: query.affinity
indices: query.indices
limit: query.limit
- text: Get the next page of user profiles after token {nextPageToken}.
slots:
nextPageToken: query.nextPageToken
method: generated
generated: '2026-09-26'
- target: $.paths['/2/users/{userID}'].get
update:
x-apievangelist-phrasing:
intent: Get one Advanced Personalization user profile
effect: read
questions:
- What has Advanced Personalization stored about one specific user ID?
- How do I inspect a single user's advanced profile?
instructions:
- text: Show the Advanced Personalization profile for user {userID}.
slots:
userID: path.userID
- text: Retrieve user profile {userID} from Advanced Personalization.
slots:
userID: path.userID
method: generated
generated: '2026-09-26'
- target: $.paths['/2/users/{userID}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an Advanced Personalization user profile
effect: destructive
questions:
- How do I delete one user's Advanced Personalization profile by user ID?
- Can I wipe a single advanced user profile to honor a data removal request?
instructions:
- text: Delete the Advanced Personalization profile for user {userID}.
slots:
userID: path.userID
- text: Remove user {userID} from Advanced Personalization.
slots:
userID: path.userID
method: generated
generated: '2026-09-26'
- target: $.paths['/2/realtime/users/{userToken}'].get
update:
x-apievangelist-phrasing:
intent: Get a user's real-time personalization profile
effect: read
questions:
- What search filters does the real-time profile currently apply for a user token?
- How do I see a shopper's live personalization profile during their session?
instructions:
- text: Show the real-time personalization profile for user token {userToken}.
slots:
userToken: path.userToken
- text: Get the live search filters personalized for {userToken}.
slots:
userToken: path.userToken
method: generated
generated: '2026-09-26'
- target: $.paths['/2/realtime/users/{userToken}/compute'].post
update:
x-apievangelist-phrasing:
intent: Recompute a user's real-time personalization profile
effect: write
questions:
- How do I force a refresh of a user's real-time personalization profile?
- Can I ask Algolia to recompute the live profile for one user token right now?
instructions:
- text: Recompute the real-time personalization profile for user token {userToken}.
slots:
userToken: path.userToken
- text: Trigger a fresh computation of {userToken}'s live personalization profile.
slots:
userToken: path.userToken
method: generated
generated: '2026-09-26'
- target: $.paths['/setClientApiKey'].get
update:
x-apievangelist-phrasing:
intent: Switch the API key the Advanced Personalization client uses
effect: write
questions:
- Can I change which API key my Advanced Personalization client authenticates with?
- How do I rotate the key an existing Advanced Personalization client sends?
instructions:
- text: Switch the Advanced Personalization client to API key {apiKey}.
slots:
apiKey: query.apiKey
- text: Use {apiKey} for all further Advanced Personalization requests.
slots:
apiKey: query.apiKey
method: generated
generated: '2026-09-26'