Skip to content

Commit 3325935

Browse files
RoRoJgcalmettesjcirinosclwybene2k1
authored
Apply suggestions from code review
Co-authored-by: Guillaume Calmettes <[email protected]> Co-authored-by: Jessica <[email protected]> Co-authored-by: Benedikt Rollik <[email protected]>
1 parent 7bdddeb commit 3325935

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

macros/ai/chat-comp-vs-responses-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ macro: chat-comp-vs-responses-api
44

55
Both the [Chat Completions API](https://www.scaleway.com/en/developers/api/generative-apis/#path-chat-completions-create-a-chat-completion) and the [Responses API](https://www.scaleway.com/en/developers/api/generative-apis/#path-responses-beta-create-a-response) are OpenAI-compatible REST APIs that can be used for generating and manipulating conversations. The Chat Completions API is focused on generating conversational responses, while the Responses API is a more general REST API for chat, structured outputs, tool use, and multimodal inputs.
66

7-
The **Chat Completions** API was released in 2023, and is an industry standard for building AI applications, being specifically designed for handling multi-turn conversations. It is stateless, but allows users to manage conversation history by appending each new message to the ongoing conversation. It supports `function` tool-calling, where the developer defines a set of functions, which the model can decide whether to call when generating a response. If it decides to call one of these functions, it returns the function name and arguments, and the developer's own code must actually execute the function and feed the result back into the conversation for use by the model.
7+
The **Chat Completions** API was released in 2023, and is an industry standard for building AI applications, being specifically designed for handling multi-turn conversations. It is stateless, but allows users to manage conversation history by appending each new message to the ongoing conversation. Messages in the conversation can include text, images and audio extracts. The API also supports `function` tool-calling, where the developer defines a set of functions, which the model can decide whether to call when generating a response. If it decides to call one of these functions, it returns the function name and arguments, and the developer's own code must actually execute the function and feed the result back into the conversation for use by the model.
88

9-
The **Responses** API was released in 2025, and is designed to combine the simplicity of Chat Completions with the ability to do more agentic tasks and reasoning. It supports statefulness, being able to maintain context without needing to resend the entire conversation history. It offers tool-calling by built-in tools (e.g. web or file search) that the model is able to execute itself while generating a response, though currently only `function` tools are supported by Scaleway. Overall, **Scaleway's support for the Responses API is currently at beta stage**. All supported Generative API models can be used with Responses API, and note that for the `gtp-oss-120b` model, only the Responses API will allow you to access all of its features.
9+
The **Responses** API was released in 2025, and is designed to combine the simplicity of Chat Completions with the ability to do more agentic tasks and reasoning. It supports statefulness, being able to maintain context without needing to resend the entire conversation history. It offers tool-calling by built-in tools (e.g. web or file search) that the model is able to execute itself while generating a response, though currently only `function` tools are supported by Scaleway. Overall, **Scaleway's support for the Responses API is currently at beta stage and the support of the full features set will be incremental**. Most of the supported Generative API models can be used with Responses API, and note that for the **`gtp-oss-120b` model, the use of the Responses API is recommended** as it will allow you to access all of its features, especially tools calling.
1010

1111
For full details on the differences between these APIs, see the [official OpenAI documentation](https://platform.openai.com/docs/guides/migrate-to-responses).

pages/generative-apis/how-to/query-language-models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ client = OpenAI(
7070

7171
### Generating a chat completion
7272

73-
You can now create a chat completion using either the Chat Completions or Responses API, as shown in the following examples: ,
73+
You can now create a chat completion using either the Chat Completions or Responses API, as shown in the following examples:
7474

7575
<Tabs id="generating-chat-completion">
7676

pages/generative-apis/how-to/query-vision-models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can query vision models programmatically using your favorite tools or langua
4848

4949
Vision models take both text and images as inputs.
5050

51-
In the example that follows,we will use the OpenAI Python client.
51+
In the example that follows, we will use the OpenAI Python client.
5252

5353
<Message type="tip">
5454
Unlike traditional language models, vision models will take a content array for the user role, structuring text and images as inputs.

pages/generative-apis/how-to/use-structured-outputs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ There are several ways to interact with language models:
4141
- JSON mode is older and has been used by developers since early API implementations, but lacks reliability in response formats.
4242

4343
<Message type="note">
44-
- All LLMs in the Scaleway library support **Structured outputs** and **JSON mode**. However, a schemaless **JSON mode** will produce lower quality results and is not recommended. Note that structured output is more reliably validated and more richly parsed OKwith the Responses API.
44+
- All LLMs in the Scaleway library support **Structured outputs** and **JSON mode**. However, a schemaless **JSON mode** will produce lower quality results and is not recommended. Note that structured output is more reliably validated and more richly parsed with the Responses API.
4545
</Message>
4646

4747
## Code examples

0 commit comments

Comments
 (0)