You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started/guide.en-gb.md
+36-49Lines changed: 36 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,73 +21,60 @@ With no extensive AI expertise required, AI Endpoints is an ideal choice for dev
21
21
22
22
The objective of this guide is to help developers interested in AI quickly and easily get started with [AI Endpoints](https://endpoints.ai.cloud.ovh.net/).
23
23
24
-
It explains how to obtain an access token, access AI models, and interact with AI APIs on the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) platform. By following this guide, you will learn how to integrate AI capabilities into your applications with ease.
24
+
It explains how to obtain an access key, access AI models, and interact with AI APIs on the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) platform. By following this guide, you will learn how to integrate AI capabilities into your applications with ease.
25
25
26
26
## Requirements
27
27
28
28
- A [Public Cloud project](/links/public-cloud/public-cloud) in your OVHcloud account
29
29
30
30
## Instructions
31
31
32
-
### Getting an access token
32
+
### Generating your first API access key
33
33
34
-
Getting a token enables you to use the models available in our [catalog](https://endpoints.ai.cloud.ovh.net/catalog) and test their integration into your solutions. To obtain an access token, please follow the steps below:
34
+
Getting an API key enables you to use the models available in our [catalog](https://endpoints.ai.cloud.ovh.net/catalog) and test their integration into your solutions. To obtain an API access key, please follow the steps below:
35
35
36
-
**1\.Visit the AI Endpoints access token page**
36
+
**1\.Access the AI Endpoints section**
37
37
38
-
Click [here](https://endpoints.ai.cloud.ovh.net/)to access AI Endpoints. You can also find the product from the [OVHcloud Control Panel](/links/manager), in the `AI & Machine Learning` category, from the left-hand vertical menu.
38
+
Log in to the [OVHcloud Control Panel](/links/manager), navigate to the `Public Cloud`{.action} section at the top, select your desired Public Cloud project, then go to the `AI & Machine Learning`{.action} category in the leftmenu and choose `AI Endpoints`{.action}.
Once on the site page, click the `Get it`{.action} button. You will be asked to confirm that you accept the [terms of service](https://storage.gra.cloud.ovh.net/v1/AUTH_325716a587c64897acbef9a4a4726e38/contracts/48743bf-AI_Endpoints-ALL-1.1.pdf) of the product.
From there, click the `Generate my first access Key`{.action} blue button to create your API access key. Next, click the `+ Create a new API key`{.action} button. You will be asked to provide a **name** for the key and an optional **description**. You can also set an **expiration date** for the key if desired.
45
45
46
-
**3\. Scope created token to one of your Public Cloud Projects**
46
+
Once you have filled in the required information, click the `Create`{.action} button to confirm the creation of your API key.
47
47
48
-
This will redirect you to the **Public Cloud**. If you haven't already done so, log in to your account, and confirm the following AI OVH OAUTH authorization:
*Note that this access key can be [revoked](#revoke-your-api-access-key) at any time.*
51
51
52
-
You will then need to choose the lifetime of your token, and also select one of the Public Cloud projects of your account to which you want to attach the token.
52
+
**3\. Store created API access key**
53
53
54
-
> [!warning]
55
-
>
56
-
> If you don't have any projects created in your Public Cloud account, you will receive an error message telling you to create one, with a link to follow.
57
-
>
58
-
59
-
Once the authorization process is completed, confirm the token creation by clicking the `Generate token`{.action} button.
60
-
61
-
*Note that this token can be [revoked](#revoke-your-token) at any time.*
This will redirect you to the AI Endpoints site, where you will find your new token in the token field. You will be reminded of the expiry date of your token, and you will be able to copy it.
54
+
Once created, the key will be displayed in the API keys table. You will see your new access key in this table, with its information (name, description, expiry date).
68
55
69
-
{.thumbnail}
56
+
Your key value will be displayed and you can copy it by clicking on the copy icon.
70
57
71
58
> [!primary]
72
59
>
73
-
> It is essential that you **keep your API token private and confidential**.
60
+
> It is essential that you **keep your API key private and confidential**.
74
61
>
75
-
> Moreover, the token displayed will not be stored in the website's memory, so please **make sure to save it securely on your side** for future usage.
62
+
> Moreover, the API key displayed will not be stored in the website's memory, so please **make sure to store it securely on your side** for future usage.
76
63
>
77
64
78
-
With your access token in hand, you are now ready to access the AI models and their easy-to-use APIs.
65
+
With your access API key in hand, you are now ready to access the AI models and their easy-to-use APIs.
79
66
80
67
### Accessing AI models
81
68
82
-
Once your token has been generated, you can navigate to the [Catalog page](https://endpoints.ai.cloud.ovh.net/catalog) to choose the AI model you want to interact with.
69
+
Once your API key has been generated, you can navigate to the [Catalog page](https://endpoints.ai.cloud.ovh.net/catalog) to choose the AI model you want to interact with.
83
70
84
71
AI Endpoints offers a variety of world-renowned AI models to choose from, including:
85
72
86
73
-**Large Language Models (LLM)**: Use models like LLaMa 3, Mistral and more, for conversations and RAG use cases.
87
74
-**Reasoning LLM**: Use reasoning models like DeepSeek-R1 distillations for maths, coding or complex tasks.
88
-
-**Code LLM**: Code generation and code completion from an IDE with models like Codestral or CodeLLaMa.
75
+
-**Code LLM**: Code generation and code completion from an IDE with models like Qwen Coder or Codestral.
89
76
-**Visual LLM**: Multimodal models such as LLaVa-Next, that are able to process images and text inputs, for image understanding or OCR use cases.
90
-
-**Embeddings**: Generate embeddings for use in machine learning applications (BGE base, Multilingual E5).
77
+
-**Embeddings**: Generate embeddings for use in machine learning applications (BGE Base, BGE Multilingual Gemma2, ...).
91
78
-**Natural Language Processing**: Use models like RoBERTa, Bert, and T5 for NLP tasks like sentiment analysis, entity recognition, and text summarization.
92
79
-**Image Generation**: Generate images using Stable Diffusion XL.
93
80
-**Audio Analysis**: Automatic Speech Recognition and Text to Speech using NVIDIA models.
@@ -107,27 +94,27 @@ This will take you to a dedicated page with several options for interacting with
107
94
>>
108
95
>> This option allows you to quickly try out the model by playing with it to see if it meets your needs. This is a great way to get a feel for the model without having to code.
>> The section provides detailed documentation for the model, including example Python code that demonstrates how to interact with the model using its API. The documentation also includes the OpenAI specification codes, as our **LLM APIs are compatible with the OpenAI specifications**.
115
102
>>
116
-
>> To ensure that these code examples work as intended, you should replace the placeholder value `(os.getenv('OVH_AI_ENDPOINTS_ACCESS_TOKEN'))` with your own API token and set it as an environment variable.
103
+
>> To ensure that these code examples work as intended, you should replace the placeholder value `(os.getenv('OVH_AI_ENDPOINTS_ACCESS_TOKEN'))` with your own API key and set it as an environment variable.
>> There, you will find blog articles related to AI Endpoints that you may find helpful in learning how to use the model more effectively. Whether you're building a chatbot with Langchain and JavaScript or creating a video translator app, we provide step-by-step guidance to support your AI projects.
Alternatively, you can also revoke your API token using the `Revoke API token`{.action} button from the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) website. However, please note that this button will only allow you to revoke the most recently created token.
147
+
Alternatively, you can also revoke your API key using the `Revoke API key`{.action} button from the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) website. However, please note that this button will only allow you to revoke the most recently created API key.
161
148
162
-
Once done, you can confirm its deletion by trying to send a request using your revoked token.
149
+
Once done, you can confirm its deletion by trying to send a request using your revoked API key.
163
150
164
151
### Billing and usage
165
152
166
-
AI Endpoints remains **free** during its beta phase.
153
+
For information on pricing and the models lifecycle of the platform, please refer to the [AI Endpoints - Billing and lifecycle](/pages/public_cloud/ai_machine_learning/endpoints_guide_04_billing_concept) documentation.
167
154
168
-
In the interest of transparency towards our customers, you will soon be able to monitor your estimated consumption and resource usage via the [OVHcloud Control Panel](/links/manager), in the `AI Endpoints`{.action} section of the `AI & Machine Learning` category, in the left-hand vertical menu.
155
+
For your convenience, you can monitor your estimated consumption and resource usage through the [OVHcloud Control Panel](/links/manager). To do so, navigate to the `AI Endpoints`{.action} section of the `AI & Machine Learning` category, in the left-hand vertical menu.
0 commit comments