Skip to content

Commit 8ca3c91

Browse files
RoRoJjcirinosclwynerda-codes
authored
fix(review): review docs (#5435)
* fix(review): review docs * Apply suggestions from code review Co-authored-by: Jessica <[email protected]> Co-authored-by: Néda <[email protected]> --------- Co-authored-by: Jessica <[email protected]> Co-authored-by: Néda <[email protected]>
1 parent 694728a commit 8ca3c91

File tree

6 files changed

+107
-91
lines changed

6 files changed

+107
-91
lines changed

pages/generative-apis/faq.mdx

Lines changed: 56 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,52 @@
22
title: Generative APIs FAQ
33
description: Get answers to the most frequently asked questions about Scaleway Generative APIs.
44
dates:
5-
validation: 2025-02-12
5+
validation: 2025-08-20
66
productIcon: GenerativeApiProductIcon
77
---
88

9-
## What are Scaleway Generative APIs?
9+
## General
10+
11+
### What are Scaleway Generative APIs?
1012
Scaleway's Generative APIs provide access to pre-configured, serverless endpoints of leading AI models, hosted in European data centers. This allows you to integrate advanced AI capabilities into your applications without managing underlying infrastructure.
1113

12-
## Which models are supported by Generative APIs?
14+
### How do I get started with Generative APIs?
15+
To get started, explore the [Generative APIs Playground](/generative-apis/quickstart/#start-with-the-generative-apis-playground) in the Scaleway console. For application integration, refer to our [Quickstart guide](/generative-apis/quickstart/), which provides step-by-step instructions on accessing, configuring, and using a Generative APIs endpoint.
16+
17+
### Where are the inference servers located?
18+
All models are currently hosted in a secure data center located in Paris, France, operated by [OPCORE](https://www.opcore.com/). This ensures low latency for European users and compliance with European data privacy regulations.
19+
20+
### What is the difference between Generative APIs and Managed Inference?
21+
- **Generative APIs**: A serverless service providing access to pre-configured AI models via API, billed per token usage.
22+
- **Managed Inference**: Allows deployment of curated or custom models with chosen quantization and Instances, offering predictable throughput and enhanced security features like private network isolation and access control. Managed Inference is billed by hourly usage, whether provisioned capacity is receiving traffic or not.
23+
24+
## Models and libraries
25+
26+
### Which models are supported by Generative APIs?
1327
Our Generative APIs support a range of popular models, including:
1428
- Chat / Text Generation models: Refer to our dedicated [documentation](/generative-apis/reference-content/supported-models/#chat-models) for a list of supported chat models.
1529
- Vision models: Refer to our dedicated [documentation](/generative-apis/reference-content/supported-models/#vision-models) for a list of supported vision models.
1630
- Embedding models: Refer to our dedicated [documentation](/generative-apis/reference-content/supported-models/#embedding-models) for a list of supported embedding models.
1731

18-
## How does the free tier work?
32+
### What is the model lifecycle for Generative APIs?
33+
Scaleway is dedicated to updating and offering the latest versions of generative AI models, while ensuring older models remain accessible for a significant time, and also ensuring the reliability of your production applications. Learn more in our [model lifecycle policy](/generative-apis/reference-content/model-lifecycle/).
34+
35+
### Do model licenses apply when using Generative APIs?
36+
Yes, you need to comply with model licenses when using Generative APIs. Applicable licenses are available for [each model in our documentation](/generative-apis/reference-content/supported-models/#vision-models) and in the console Playground.
37+
38+
### Can I increase maximum output (completion) tokens for a model?
39+
No, you cannot increase maximum output tokens above [limits for each models](/generative-apis/reference-content/supported-models/) in Generative APIs.
40+
These limits are in place to protect you against:
41+
- Long generation which may be ended by an HTTP timeout. Limits are designed to ensure a model will send its HTTP response in less than 5 minutes.
42+
- Uncontrolled billing, as several models are known to be able to enter infinite generation loops (specific prompts can make the model generate the same sentence over and over, without stopping at all).
43+
If you require higher maximum output tokens, you can use [Managed Inference](https://console.scaleway.com/inference/deployments) where these limts do not apply (as your bill will be limited by the size of your deployment).
44+
45+
### Can I use OpenAI libraries and APIs with Scaleway's Generative APIs?
46+
Yes, Scaleway's Generative APIs are designed to be compatible with OpenAI libraries and SDKs, including the OpenAI Python client library and LangChain SDKs. This allows for seamless integration with existing workflows.
47+
48+
## Billing and monitoring
49+
50+
### How does the free tier work?
1951
The free tier allows you to process up to 1,000,000 tokens without incurring any costs. After reaching this limit, you will be charged per million tokens processed. Free tier usage is calculated by adding all input and output tokens consumed from all models used.
2052
For more information, refer to our [pricing page](https://www.scaleway.com/en/pricing/model-as-a-service/#generative-apis) or access your bills by token types and models in [billing section from Scaleway Console](https://console.scaleway.com/billing/payment) (past and provisional bills for the current month).
2153

@@ -46,22 +78,28 @@ Total tokens consumed: `900k`
4678
Total billed consumption: `6 million tokens`
4779
Total bill: `3.20€`
4880

49-
Note that in this example, the first line where the free tier applies will not display in your current Scaleway bills by model but will instead be listed under `Generative APIs Free Tier - First 1M tokens for free`.
81+
Note that in this example, the first line where the free tier applies will not display in your current Scaleway bills by model, but will instead be listed under `Generative APIs Free Tier - First 1M tokens for free`.
5082

51-
## What is a token and how are they counted?
83+
### What are tokens and how are they counted?
5284
A token is the minimum unit of content that is seen and processed by a model. Hence, token definitions depend on input types:
5385
- For text, on average, `1` token corresponds to `~4` characters, and thus `0.75` words (as words are on average five characters long)
5486
- For images, `1` token corresponds to a square of pixels. For example, `mistral-small-3.1-24b-instruct-2503` model image tokens of `28x28` pixels (28-pixels height, and 28-pixels width, hence `784` pixels in total).
5587

5688
The exact token count and definition depend on [tokenizers](https://huggingface.co/learn/llm-course/en/chapter2/4) used by each model. When this difference is significant (such as for image processing), you can find detailed information in each model's documentation (for instance in [`mistral-small-3.1-24b-instruct-2503` size limit documentation](/managed-inference/reference-content/model-catalog/#mistral-small-31-24b-instruct-2503)). When the model is open, you can also find this information in the model files on platforms such as Hugging Face, usually in the `tokenizer_config.json` file.
5789

58-
## How can I monitor my token consumption?
90+
### How can I monitor my token consumption?
5991
You can see your token consumption in [Scaleway Cockpit](/cockpit/). You can access it from the Scaleway console under the [Metrics tab](https://console.scaleway.com/generative-api/metrics).
6092
Note that:
61-
- Cockpits are isolated by Projects, hence you first need to select the right project in the Scaleway console before accessing Cockpit to see your token consumption for this Project (you can see the `project_id` in the Cockpit URL: `https://{project_id}.dashboard.obs.fr-par.scw.cloud/`.
62-
- Cockpit graphs can take up to 1 hour to update token consumption, see [Troubleshooting](https://www.scaleway.com/en/docs/generative-apis/troubleshooting/fixing-common-issues/#tokens-consumption-is-not-displayed-in-cockpit-metrics) for further details.
93+
- Cockpits are isolated by Project, hence you first need to select the right Project in the Scaleway console before accessing Cockpit to see your token consumption for this Project (you can see the `project_id` in the Cockpit URL: `https://{project_id}.dashboard.obs.fr-par.scw.cloud/`.
94+
- Cockpit graphs can take up to 1 hour to update token consumption, see [Troubleshooting](/generative-apis/troubleshooting/fixing-common-issues/#tokens-consumption-is-not-displayed-in-cockpit-metrics) for further details.
95+
96+
### Can I configure a maximum billing threshold?
97+
Currently, you cannot configure a specific threshold after which your usage will be blocked. However:
98+
- You can [configure billing alerts](/billing/how-to/use-billing-alerts/) to ensure you are warned when you hit specific budget thresholds.
99+
- Your total billing remains limited by the amount of tokens you can consume within [rate limits](/generative-apis/reference-content/rate-limits/).
100+
- If you want to ensure fixed billing, you can use [Managed Inference](https://www.scaleway.com/en/inference/), which provides the same set of OpenAI-compatible APIs and a wider range of models.
63101

64-
## How can I give access to token consumption to my users outside of Scaleway?
102+
### How can I give access to token consumption to my users outside of Scaleway?
65103
If your users do not have a Scaleway account, you can still give them access to their Generative API usage consumption by either:
66104
- Providing them an access to Grafana inside [Cockpit](https://console.scaleway.com/cockpit/overview). You can create dedicated [Grafana users](https://console.scaleway.com/cockpit/users) with read-only access (**Viewer** Role). Note that these users will still have access to all other Cockpit dashboards for this project.
67105
- Collecting consumption data from the [Billing API](https://www.scaleway.com/en/developers/api/billing/#path-consumption-get-monthly-consumption) and exposing it to your users. Consumption can be detailed by Projects.
@@ -84,53 +122,26 @@ Note that:
84122
- Cockpits are isolated by Projects. You first need to select the right Project in the Scaleway console before accessing Cockpit to see your token consumption for the desired Project (you can see the `project_id` in the Cockpit URL: `https://{project_id}.dashboard.obs.fr-par.scw.cloud/`.
85123
- Cockpit graphs can take up to 1 hour to update token consumption, see [Troubleshooting](/generative-apis/troubleshooting/fixing-common-issues/#tokens-consumption-is-not-displayed-in-cockpit-metrics) for further details.
86124

87-
## Can I configure a maximum billing threshold?
88-
Currently, you cannot configure a specific threshold after which your usage will blocked. However:
89-
- You can [configure billing alerts](/billing/how-to/use-billing-alerts/) to ensure you are warned when you hit specific budget thresholds.
90-
- Your total billing remains limited by the amount of tokens you can consume within [rate limits](/generative-apis/reference-content/rate-limits/).
91-
- If you want to ensure fixed billing, you can use [Managed Inference](https://www.scaleway.com/en/inference/), which provides the same set of OpenAI-compatible APIs and a wider range of models.
92-
93-
## How can I access and use the Generative APIs?
94-
Access is open to all Scaleway customers. You can start by using the Generative APIs Playground in the Scaleway console to experiment with different models. For integration into applications, you can use the OpenAI-compatible APIs provided by Scaleway. Detailed instructions are available in our [Quickstart guide](/generative-apis/quickstart/).
125+
## Privacy, performance and rate limiting
95126

96-
## Where are the inference servers located?
97-
All models are currently hosted in a secure data center located in Paris, France, operated by [OPCORE](https://www.opcore.com/). This ensures low latency for European users and compliance with European data privacy regulations.
98-
99-
## Where can I find the privacy policy regarding Generative APIs?
127+
### Where can I find the privacy policy regarding Generative APIs?
100128
You can find the privacy policy applicable to all use of Generative APIs [here](/generative-apis/reference-content/data-privacy/).
101129

102-
## Can I use OpenAI libraries and APIs with Scaleway's Generative APIs?
103-
Yes, Scaleway's Generative APIs are designed to be compatible with OpenAI libraries and SDKs, including the OpenAI Python client library and LangChain SDKs. This allows for seamless integration with existing workflows.
104-
105-
## What is the difference between Generative APIs and Managed Inference?
106-
- **Generative APIs**: A serverless service providing access to pre-configured AI models via API, billed per token usage.
107-
- **Managed Inference**: Allows deployment of curated or custom models with chosen quantization and instances, offering predictable throughput and enhanced security features like private network isolation and access control. Managed Inference is billed by hourly usage, whether provisioned capacity is receiving traffic or not.
130+
### What are the SLAs applicable to Generative APIs?
131+
We are currently working on defining our SLAs for Generative APIs. We will provide more information on this topic soon.
108132

109-
## How do I get started with Generative APIs?
110-
To get started, explore the [Generative APIs Playground](/generative-apis/quickstart/#start-with-the-generative-apis-playground) in the Scaleway console. For application integration, refer to our [Quickstart guide](/generative-apis/quickstart/), which provides step-by-step instructions on accessing, configuring, and using a Generative APIs endpoint.
133+
### What are the performance guarantees (vs Managed Inference)?
134+
We are currently working on defining our performance guarantees for Generative APIs. We will provide more information on this topic soon.
111135

112-
## Are there any rate limits for API usage?
136+
### Are there any rate limits for API usage?
113137
Yes, API rate limits define the maximum number of requests a user can make within a specific time frame to ensure fair access and resource allocation between users. If you require increased rate limits we recommend either:
114138
- Using [Managed Inference](https://console.scaleway.com/inference/deployments), which provides dedicated capacity and doesn't enforce rate limits (you remain limited by the total provisioned capacity)
115139
- Contacting your existing Scaleway account manager or our Sales team to discuss volume commitment for specific models that will allow us to increase your quota proportionally.
116140

117141
Refer to our dedicated [documentation](/generative-apis/reference-content/rate-limits/) for more information on rate limits.
118142

119-
## Can I increase maximum output (completion) tokens for a model?
120-
No, you cannot increase maximum output tokens above [limits for each models](https://www.scaleway.com/en/docs/generative-apis/reference-content/supported-models/) in Generative APIs.
121-
These limits are in place to protect you against:
122-
- Long generation which may be ended by an HTTP timeout. Limits are designed to ensure a model will send its HTTP response in less than 5 minutes.
123-
- Uncontrolled billing, as several models are known to be able to enter infinite generation loops (specific prompts can make the model generate the same sentence over and over, without stopping at all).
124-
If you require higher maximum output tokens, you can use [Managed Inference](https://console.scaleway.com/inference/deployments) where these limts do not apply (as your bill will be limited by the size of your deployment).
125143

126-
## What is the model lifecycle for Generative APIs?
127-
Scaleway is dedicated to updating and offering the latest versions of generative AI models, while ensuring older models remain accessible for a significant time, and also ensuring the reliability of your production applications. Learn more in our [model lifecycle policy](/generative-apis/reference-content/model-lifecycle/).
128144

129-
## What are the SLAs applicable to Generative APIs?
130-
We are currently working on defining our SLAs for Generative APIs. We will provide more information on this topic soon.
131145

132-
## What are the performance guarantees (vs Managed Inference)?
133-
We are currently working on defining our performance guarantees for Generative APIs. We will provide more information on this topic soon.
134146

135-
## Do model licenses apply when using Generative APIs?
136-
Yes, you need to comply with model licenses when using Generative APIs. Applicable licenses are available for [each model in our documentation](/generative-apis/reference-content/supported-models/#vision-models) and in Console Playground.
147+

pages/generative-apis/reference-content/adding-ai-to-intellij-using-continue.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Adding AI to IntelliJ IDEA using Continue and Generative APIs
33
description: Learn how to integrate AI-powered code models into IntelliJ IDEA with Continue and Scaleway's Generative APIs.
44
tags: generative-apis ai machine-learning language-models code-assistance intellij-idea continue
55
dates:
6-
validation: 2025-02-14
6+
validation: 2025-08-20
77
posted: 2025-02-14
88
---
99
import Requirements from '@macros/iam/requirements.mdx'
@@ -20,8 +20,6 @@ This guide will help you integrate AI-powered code models into JetBrain's Intell
2020
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
2121
- Installed [IntelliJ IDEA](https://www.jetbrains.com/idea/) on your local machine.
2222

23-
24-
2523
You can install Continue from the [JetBrains marketplace](https://plugins.jetbrains.com/plugin/22707-continue):
2624

2725
1. Open IntelliJ IDEA and go to **Preferences/Settings** (`Ctrl+Alt+S` on Windows/Linux, `Cmd+,` on macOS).
@@ -149,7 +147,6 @@ Alternatively, a `config.json` file can be used with the following format. Note
149147
}
150148
```
151149

152-
153150
<Message type="tip">
154151
For more details on configuring `config.yaml`, refer to the [official Continue documentation](https://docs.continue.dev/reference).
155152
If you want to limit access to a specific Scaleway Project, you should add the field `"apiBase": "https://api.scaleway.ai/###PROJECT_ID###/v1/"` for each model (ie. `models`, `embeddingsProvider` and `tabAutocompleteModel`) since the default URL `https://api.scaleway.ai/v1/` can only be used with the `default` project.

pages/generative-apis/reference-content/adding-ai-to-vscode-using-continue.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Adding AI to VS Code using Continue and Generative APIs
33
description: Learn how to integrate AI-powered code models into VS Code with Continue and Scaleway's Generative APIs.
44
tags: generative-apis ai machine-learning language-models code-assistance vs-code continue
55
dates:
6-
validation: 2025-02-14
6+
validation: 2025-08-20
77
posted: 2025-02-14
88
---
99
import Requirements from '@macros/iam/requirements.mdx'

pages/generative-apis/reference-content/supported-models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Supported models
33
description: This page lists which open-source chat or embedding models Scaleway is currently hosting
44
tags: generative-apis ai-data supported-models
55
dates:
6-
validation: 2025-02-14
6+
validation: 2025-08-20
77
posted: 2024-09-02
88
---
99

pages/load-balancer/how-to/create-manage-acls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to create and manage ACLs
33
description: Discover how to create and manage ACLs for Scaleway Load Balancers. Improve security, manage traffic efficiently, and optimize your network setup easily.
44
tags: acl load-balancer acls access-control-list access control HTTP-header filter allow reject redirect HTTPSacl load-balancer access-control access-control-list
55
dates:
6-
validation: 2025-02-13
6+
validation: 2025-08-20
77
posted: 2022-02-04
88
---
99
import Requirements from '@macros/iam/requirements.mdx'

0 commit comments

Comments
 (0)