Skip to content

feat(specs): rename ai perso to advanced perso #4320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions scripts/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ export const GENERATORS = Object.entries(clientsConfig).reduce(

export const LANGUAGES = [...new Set(Object.values(GENERATORS).map((gen) => gen.language))];

// `crawler` and `ai-personalization` are manually added so we can still bundled and validate the specs
// `crawler` and `advanced-personalization` are manually added so we can still bundled and validate the specs
// the entry can be removed once at least one client is generated
export const CLIENTS = [
...new Set(Object.values(GENERATORS).map((gen) => gen.client)),
'crawler',
'ai-personalization',
'advanced-personalization',
];

export async function run(command: string, { errorMessage, cwd, language }: RunOptions = {}): Promise<string> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ put:
description: |
Updates the configuration.

The configuration is a list of configuration objects for each index. To configure AI Personalization for an index, create a new configuration object for the index.
The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index, create a new configuration object for the index.
requestBody:
required: true
content:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
openapi: 3.1.0
info:
title: AI Personalization API
title: Advanced Personalization API
description: |
The AI Personalization API lets you access user profiles built based on the behavior of your users on your website or app.
The Advanced Personalization API lets you access user profiles built based on the behavior of your users on your website or app.

## Client libraries

Expand All @@ -13,7 +13,7 @@ info:

## Base URLs

The AI Personalization API can be reached from multiple domains, each specific to a region.
The Advanced Personalization API can be reached from multiple domains, each specific to a region.

- `https://ai-personalization.eu.algolia.com`
- `https://ai-personalization.us.algolia.com`
Expand All @@ -37,15 +37,15 @@ info:

## Response status and errors

The AI Personalization API returns JSON responses.
The Advanced Personalization API returns JSON responses.
Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.

Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
Error responses have a `message` property with more information.

## Rate limiting

When making requests to the AI Personalization API, you are limited to 500 API calls per minute per application.
When making requests to the Advanced Personalization API, you are limited to 500 API calls per minute per application.

The following headers provide information about your current limit:

Expand All @@ -55,7 +55,7 @@ info:

## Version

The current version of the AI Personalization API is version 2, as indicated by the `/2/` in each endpoint's URL.
The current version of the Advanced Personalization API is version 2, as indicated by the `/2/` in each endpoint's URL.
version: 2.0.0
components:
securitySchemes:
Expand All @@ -80,22 +80,22 @@ tags:
- name: config
x-displayName: Configuration
description: |
Manage your AI Personalization configuration.
Manage your Advanced Personalization configuration.

The configuration defines the indices, facet attributes and events that describe your user's
behaviour on your website or app. It helps AI Personalization determine how personalization should affect the search results.
behaviour on your website or app. It helps Advanced Personalization determine how personalization should affect the search results.
- name: users
x-displayName: Users
description: |
Manage user profiles generated by AI Personalization.
Manage user profiles generated by Advanced Personalization.

User profiles contain the affinities each user has for the different facets in your index.
externalDocs:
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/
description: |
Related guide: User Profiles.
x-tagGroups:
- name: AI Personalization
- name: Advanced Personalization
tags:
- config
- users
Expand Down