Skip to content
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

feat(documentation): remove categories from links WDOC-948 #4187

Merged
merged 2 commits into from
Jan 20, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions ai-data/generative-apis/api-cli/understanding-errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ If the response code is not within the 2xx range, the response will contain an e
Below are usual HTTP error codes:

- 400 - **Bad Request**: The format or content of your payload is incorrect. The body may be too large, or fail to parse, or the content-type is mismatched.
- 401 - **Unauthorized**: The `authorization` header is missing. Find required headers in [this page](/ai-data/generative-apis/api-cli/using-generative-apis/)
- 403 - **Forbidden**: Your API key does not exist or does not have the necessary permissions to access the requested resource. Find required permission sets in [this page](/ai-data/generative-apis/api-cli/using-generative-apis/)
- 401 - **Unauthorized**: The `authorization` header is missing. Find required headers in [this page](/generative-apis/api-cli/using-generative-apis/)
- 403 - **Forbidden**: Your API key does not exist or does not have the necessary permissions to access the requested resource. Find required permission sets in [this page](/generative-apis/api-cli/using-generative-apis/)
- 404 - **Route Not Found**: The requested resource could not be found. Check your request is being made to the correct endpoint.
- 422 - **Model Not Found**: The `model` key is present in the request payload, but the corresponding model is not found.
- 422 - **Missing Model**: The `model` key is missing from the request payload.
- 429 - **Too Many Requests**: You are exceeding your current quota for the requested model, calculated in requests per minute. Find rate limits on [this page](/ai-data/generative-apis/reference-content/rate-limits/)
- 429 - **Too Many Tokens**: You are exceeding your current quota for the requested model, calculated in tokens per minute. Find rate limits on [this page](/ai-data/generative-apis/reference-content/rate-limits/)
- 429 - **Too Many Requests**: You are exceeding your current quota for the requested model, calculated in requests per minute. Find rate limits on [this page](/generative-apis/reference-content/rate-limits/)
- 429 - **Too Many Tokens**: You are exceeding your current quota for the requested model, calculated in tokens per minute. Find rate limits on [this page](/generative-apis/reference-content/rate-limits/)
- 500 - **API error**: An unexpected internal error has occurred within Scaleway's systems. If the issue persists, please [open a support ticket](https://console.scaleway.com/support/tickets/create).

For streaming responses via SSE, 5xx errors may occur after a 200 response has been returned.
14 changes: 7 additions & 7 deletions ai-data/generative-apis/api-cli/using-chat-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ curl --request POST \

## Headers

Find required headers in [this page](/ai-data/generative-apis/api-cli/using-generative-apis/).
Find required headers in [this page](/generative-apis/api-cli/using-generative-apis/).

## Body

Expand All @@ -69,12 +69,12 @@ Our chat API is OpenAI compatible. Use OpenAI’s [API reference](https://platfo
- stream
- stream_options
- presence_penalty
- [response_format](/ai-data/generative-apis/how-to/use-structured-outputs)
- [response_format](/generative-apis/how-to/use-structured-outputs)
- logprobs
- stop
- seed
- [tools](/ai-data/generative-apis/how-to/use-function-calling)
- [tool_choice](/ai-data/generative-apis/how-to/use-function-calling)
- [tools](/generative-apis/how-to/use-function-calling)
- [tool_choice](/generative-apis/how-to/use-function-calling)

### Unsupported parameters

Expand All @@ -88,6 +88,6 @@ If you have a use case requiring one of these unsupported parameters, please [co

## Going further

1. [Python code examples](/ai-data/generative-apis/how-to/query-language-models/#querying-language-models-via-api) to query text models using Scaleway's Chat API
2. [How to use structured outputs](/ai-data/generative-apis/how-to/use-structured-outputs) with the `response_format` parameter
3. [How to use function calling](/ai-data/generative-apis/how-to/use-function-calling) with `tools` and `tool_choice`
1. [Python code examples](/generative-apis/how-to/query-language-models/#querying-language-models-via-api) to query text models using Scaleway's Chat API
2. [How to use structured outputs](/generative-apis/how-to/use-structured-outputs) with the `response_format` parameter
3. [How to use function calling](/generative-apis/how-to/use-function-calling) with `tools` and `tool_choice`
4 changes: 2 additions & 2 deletions ai-data/generative-apis/api-cli/using-embeddings-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ curl --request POST \

## Headers

Find required headers in [this page](/ai-data/generative-apis/api-cli/using-generative-apis/).
Find required headers in [this page](/generative-apis/api-cli/using-generative-apis/).

## Body

Expand All @@ -53,5 +53,5 @@ Our embeddings API is OpenAI compatible. Use OpenAI’s [API reference](https://
If you have a use case requiring one of these unsupported parameters, please [contact us via Slack](https://slack.scaleway.com/) on #ai channel.

<Message type="note">
Check our [Python code examples](/ai-data/generative-apis/how-to/query-embedding-models/#querying-embedding-models-via-api) to query embedding models using Scaleway's Embeddings API.
Check our [Python code examples](/generative-apis/how-to/query-embedding-models/#querying-embedding-models-via-api) to query embedding models using Scaleway's Embeddings API.
</Message>
8 changes: 4 additions & 4 deletions ai-data/generative-apis/api-cli/using-generative-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ dates:

## Access

- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) is needed.
- A valid [API key](/iam/how-to/create-api-keys/) is needed.

## Authentication

Expand Down Expand Up @@ -51,11 +51,11 @@ curl --request POST \

## Permissions

Permissions define the actions a user or an application can perform on Scaleway Generative APIs. They are managed using Scaleway’s [Identity and Access Management](/identity-and-access-management/iam/quickstart/) interface.
Permissions define the actions a user or an application can perform on Scaleway Generative APIs. They are managed using Scaleway’s [Identity and Access Management](/iam/quickstart/) interface.

[Owner](/identity-and-access-management/iam/concepts/#owner) status or certain [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allow you to perform actions in the intended Organization.
[Owner](/iam/concepts/#owner) status or certain [IAM permissions](/iam/concepts/#permission) allow you to perform actions in the intended Organization.

Querying AI models hosted by Scaleway Generative APIs will require any of the following [permission sets](/identity-and-access-management/iam/concepts/#permission-set):
Querying AI models hosted by Scaleway Generative APIs will require any of the following [permission sets](/iam/concepts/#permission-set):

- **GenerativeApisModelAccess**
- **GenerativeApisFullAccess**
Expand Down
12 changes: 6 additions & 6 deletions ai-data/generative-apis/how-to/query-code-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ dates:

Scaleway's Generative APIs service allows users to interact with powerful code models hosted on the platform.

Code models are inherently [language models](/ai-data/generative-apis/how-to/query-language-models/) specialized in **understanding code**, **generating code** and **fixing code**.
Code models are inherently [language models](/generative-apis/how-to/query-language-models/) specialized in **understanding code**, **generating code** and **fixing code**.

As such, they will be available through the same interfaces as language models:
- The Scaleway [console](https://console.scaleway.com) provides complete [playground](/ai-data/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/ai-data/generative-apis/how-to/query-language-models/#querying-language-models-via-api)
- The Scaleway [console](https://console.scaleway.com) provides complete [playground](/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/generative-apis/how-to/query-language-models/#querying-language-models-via-api)

For more information on how to query language models, read [our dedicated documentation](/ai-data/generative-apis/how-to/query-language-models/).
For more information on how to query language models, read [our dedicated documentation](/generative-apis/how-to/query-language-models/).

Code models are also ideal AI assistants when **added to IDEs** (integrated development environments).

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) for API authentication
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
- An IDE such as Visual Studio Code or JetBrains

## Install Continue in your IDE
Expand Down
8 changes: 4 additions & 4 deletions ai-data/generative-apis/how-to/query-embedding-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ The embedding service is OpenAI compatible. Refer to OpenAI's [embedding documen
<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) for API authentication
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
- Python 3.7+ installed on your system

## Querying embedding models via API
Expand Down Expand Up @@ -72,8 +72,8 @@ This code sends input text to the `bge-multilingual-gemma2` embedding model and
The following parameters can be adjusted to influence the output of the embedding model:

- **`input`** (string or array of strings): The text or data you want to convert into vectors.
- **`model`** (string): The specific embedding model to use, find all our [supported models](/ai-data/generative-apis/reference-content/supported-models).
- **`model`** (string): The specific embedding model to use, find all our [supported models](/generative-apis/reference-content/supported-models).

<Message type="warning">
If you encounter an error such as "Forbidden 403" refer to the [API documentation](/ai-data/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
If you encounter an error such as "Forbidden 403" refer to the [API documentation](/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
</Message>
12 changes: 6 additions & 6 deletions ai-data/generative-apis/how-to/query-language-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ dates:
Scaleway's Generative APIs service allows users to interact with powerful language models hosted on the platform.

There are several ways to interact with language models:
- The Scaleway [console](https://console.scaleway.com) provides complete [playground](/ai-data/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/ai-data/generative-apis/how-to/query-language-models/#querying-language-models-via-api)
- The Scaleway [console](https://console.scaleway.com) provides complete [playground](/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/generative-apis/how-to/query-language-models/#querying-language-models-via-api)

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) for API authentication
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
- Python 3.7+ installed on your system

## Accessing the Playground
Expand All @@ -41,7 +41,7 @@ The web playground displays.

## Querying language models via API

The [Chat API](/ai-data/generative-apis/api-cli/using-chat-api/) is an OpenAI-compatible REST API for generating and manipulating conversations.
The [Chat API](/generative-apis/api-cli/using-chat-api/) is an OpenAI-compatible REST API for generating and manipulating conversations.

You can query the models programmatically using your favorite tools or languages.
In the following example, we will use the OpenAI Python client.
Expand Down Expand Up @@ -114,7 +114,7 @@ The following parameters will influence the output of the model:
- **`stop`**: A string or list of strings where the model will stop generating further tokens. This is useful for controlling the end of the output.

<Message type="warning">
If you encounter an error such as "Forbidden 403" refer to the [API documentation](/ai-data/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
If you encounter an error such as "Forbidden 403" refer to the [API documentation](/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
</Message>

## Streaming
Expand Down
12 changes: 6 additions & 6 deletions ai-data/generative-apis/how-to/query-vision-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Scaleway's Generative APIs service allows users to interact with powerful vision
</Message>

There are several ways to interact with vision models:
- The Scaleway [console](https://console.scaleway.com) provides a complete [playground](/ai-data/generative-apis/how-to/query-vision-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/ai-data/generative-apis/how-to/query-vision-models/#querying-vision-models-via-the-api)
- The Scaleway [console](https://console.scaleway.com) provides a complete [playground](/generative-apis/how-to/query-vision-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time.
- Via the [Chat API](/generative-apis/how-to/query-vision-models/#querying-vision-models-via-the-api)

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) for API authentication
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
- Python 3.7+ installed on your system

## Accessing the playground
Expand All @@ -45,7 +45,7 @@ The web playground displays.

## Querying vision models via the API

The [Chat API](/ai-data/generative-apis/api-cli/using-chat-api/) is an OpenAI-compatible REST API for generating and manipulating conversations.
The [Chat API](/generative-apis/api-cli/using-chat-api/) is an OpenAI-compatible REST API for generating and manipulating conversations.

You can query the vision models programmatically using your favorite tools or languages.
Vision models take both text and images as inputs.
Expand Down Expand Up @@ -173,7 +173,7 @@ The following parameters will influence the output of the model:
- **`stop`**: A string or list of strings where the model will stop generating further tokens. This is useful for controlling the end of the output.

<Message type="warning">
If you encounter an error such as "Forbidden 403", refer to the [API documentation](/ai-data/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
If you encounter an error such as "Forbidden 403", refer to the [API documentation](/generative-apis/api-cli/understanding-errors) for troubleshooting tips.
</Message>

## Streaming
Expand Down
8 changes: 4 additions & 4 deletions ai-data/generative-apis/how-to/use-function-calling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ Function calling allows a large language model (LLM) to interact with external t

<Macro id="requirements" />

- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) for API authentication
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/) for API authentication
- Python 3.7+ installed on your system

## Supported models

All the [chat models](/ai-data/generative-apis/reference-content/supported-models/#chat-models) hosted by Scaleway support function calling.
All the [chat models](/generative-apis/reference-content/supported-models/#chat-models) hosted by Scaleway support function calling.

## Understanding function calling

Expand Down Expand Up @@ -323,7 +323,7 @@ For more information about function calling and advanced implementations, refer

- [OpenAI Function Calling Guide](https://platform.openai.com/docs/guides/function-calling)
- [JSON Schema Specification](https://json-schema.org/specification)
- [Chat Completions API Reference](/ai-data/generative-apis/api-cli/using-chat-api/)
- [Chat Completions API Reference](/generative-apis/api-cli/using-chat-api/)

Function calling significantly extends the capabilities of language models by allowing them to interact with external tools and APIs.

Expand Down
Loading
Loading