Merge pull request #8519 from ashera96/master

Add note for AI API endpoint configuring step
wso2 · Oct 28, 2024 · 4cee2e6 · 4cee2e6
2 parents 1e7d027 + 0707e1f
commit 4cee2e6
Showing 1 changed file with 39 additions and 28 deletions.
diff --git a/en/docs/design/create-api/create-ai-api/create-an-ai-api.md b/en/docs/design/create-api/create-ai-api/create-an-ai-api.md
@@ -1,45 +1,46 @@
 # Create an AI API
 
-AI APIs enable seamless integration of artificial intelligence services into applications through the WSO2 API Manager. By using the AI API feature, users can select specific AI vendors that best suit their needs. WSO2 API Manager provides built-in support for leading AI vendors like OpenAI, Mistral, and Azure AI, while also allowing configuration of custom AI vendors to create AI APIs.
+AI APIs enable seamless integration of artificial intelligence services into applications through the WSO2 API Manager. By using the AI API feature, users can select specific AI vendors that best suit their needs. WSO2 API Manager provides built-in support for leading AI vendors like **OpenAI**, **Mistral**, and **Azure AI**, while also allowing configuration of custom AI vendors to create AI APIs.
 
-Follow the instructions below to create a REST API using the basic flow:
+Follow the instructions below to create an AI API using the basic flow:
 
-### 1. Sign in to the WSO2 API Publisher.
+### Step 1: Create an AI API
 
-`https://<hostname>:9443/publisher` 
+1. Sign in to the API Publisher Portal.
 
-Example: `https://localhost:9443/publisher`
+    `https://<hostname>:9443/publisher` 
 
-<html><div class="admonition note">
-    <p class="admonition-title">Note</p>
-    <p>The <b>Create API</b> button will only appear for a user who has the <code>creator</code> role permission.</p>
-    </div>
-</html>
+    Example: `https://localhost:9443/publisher`
 
-### 2. Click **Create API** and then click **AI API**.
+    <html><div class="admonition note">
+        <p class="admonition-title">Note</p>
+        <p>The <b>Create API</b> button will only appear for a user who has the <code>creator</code> role permission.</p>
+        </div>
+    </html>
 
-[![Select AI API]({{base_path}}/assets/img/learn/select-ai-api.png){: style="width:90%"}]({{base_path}}/assets/img/learn/select-ai-api.png)
+2. Click **Create API** and then click **AI API**.
 
-### 3.  Select **AI Provider** and **AI Provider API Version**.
+    [![Select AI API]({{base_path}}/assets/img/learn/select-ai-api.png){: style="width:90%"}]({{base_path}}/assets/img/learn/select-ai-api.png)
 
-[![Select AI Service Provider and Version]({{base_path}}/assets/img/learn/create-ai-api.png){: style="width:90%"}]({{base_path}}/assets/img/learn/create-ai-api.png)
+3. Select the desired **AI Provider** and the relevant **AI Provider API Version** and click Next.
 
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>The available <b>AI service providers and versions</b> will appear on relevant dropdowns. In adition to inbuild AI service vendors, you can also <a href='{{base_path}}/administer/ai-vendors/custom-ai-vendor/'>configure custom AI service vendors</a>.</p>
-</div>
+    [![Select AI Service Provider and Version]({{base_path}}/assets/img/learn/create-ai-api.png){: style="width:90%"}]({{base_path}}/assets/img/learn/create-ai-api.png)
+
+    <div class="admonition note">
+    <p class="admonition-title">Note</p>
+    <p>The available <b>AI service providers and versions</b> will appear on relevant dropdowns. In adition to inbuild AI service vendors, you can also <a href='{{base_path}}/administer/ai-vendors/custom-ai-vendor/'>configure custom AI service vendors</a>.</p>
+    </div>
 
-### 4.  Configure AI API details. 
+4. Configure AI API details. 
 
-<table><colgroup> <col/> <col/> <col/> </colgroup><tbody><tr><th colspan="2" >Field</th><th >Sample value</th></tr><tr><td colspan="2" class="confluenceTd">Name</td><td class="confluenceTd">MistralAIAPI</td></tr><tr><td colspan="2" class="confluenceTd">Version</td><td colspan="1" class="confluenceTd">0.0.2</td></tr><tr><td colspan="2" class="confluenceTd">Context</td><td class="confluenceTd"><div class="content-wrapper"><p><code>mistralaiapi</code></p><div><div class="confluence-information-macro-body"><p>The API context is used by the Gateway to identify the API. Therefore, the API context must be unique. This context is the API's root context when invoking the API through the Gateway.</p></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can define the API's version as a parameter of its context by adding the <code>{version}</code> into the context. For example, <code>{version}/mistralaiapi</code>. The API Manager assigns the actual version of the API to the <code>{version}</code> parameter internally. For example, <code>https://localhost:8243/0.0.2/mistralaiapi</code>. Note that the version appears before the context, allowing you to group your APIs based on the versions.</p></div></div></div></div></td></tr><tr><td colspan="2" class="confluenceTd">Endpoint</td><td colspan="1" class="confluenceTd"><p><a class="external-link" href="https://api.mistral.ai" rel="nofollow">https://api.mistral.ai</a></p><p>The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints.</p></td></tr></tbody></table>
+    <table><colgroup> <col/> <col/> <col/> </colgroup><tbody><tr><th colspan="2" >Field</th><th >Sample value</th></tr><tr><td colspan="2" class="confluenceTd">Name</td><td class="confluenceTd">MistralAIAPI</td></tr><tr><td colspan="2" class="confluenceTd">Version</td><td colspan="1" class="confluenceTd">0.0.2</td></tr><tr><td colspan="2" class="confluenceTd">Context</td><td class="confluenceTd"><div class="content-wrapper"><p><code>mistralaiapi</code></p><div><div class="confluence-information-macro-body"><p>The API context is used by the Gateway to identify the API. Therefore, the API context must be unique. This context is the API's root context when invoking the API through the Gateway.</p></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can define the API's version as a parameter of its context by adding the <code>{version}</code> into the context. For example, <code>{version}/mistralaiapi</code>. The API Manager assigns the actual version of the API to the <code>{version}</code> parameter internally. For example, <code>https://localhost:8243/0.0.2/mistralaiapi</code>. Note that the version appears before the context, allowing you to group your APIs based on the versions.</p></div></div></div></div></td></tr><tr><td colspan="2" class="confluenceTd">Endpoint</td><td colspan="1" class="confluenceTd"><p><a class="external-link" href="https://api.mistral.ai" rel="nofollow">https://api.mistral.ai</a></p><p>The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints.</p></td></tr></tbody></table>
 
-### 5.  Click **Create** to create the API.
+5. Click **Create** to create the API.
 
 The overview page of the newly created API appears. 
 
-### 6. Go to **API Configurations**, and click **Endpoints**.
+### Step 2: Obtain API Key from AI Service Vendor
 
-#### a. Get an API Key from the AI Service Vendor.
 
 <html><div class="admonition example">
 <p class="admonition-title">Example: Mistral AI</p>
@@ -50,13 +51,23 @@ The overview page of the newly created API appears.
 </div>
 </html>
 
-#### b. Fill **API Key** for Production and Sandbox Endpoints.
+### Step 3: Configure Sandbox and Production Endpoint
+
+1. Go to **API Configurations**, and click **Endpoints**.
+
+2. Fill **API Key** for Production and Sandbox Endpoints using the key which was obtained from Step 2.
+
+    !!! Note
+            APIM supports three AI/LLM vendors by default. The supported authorization approach for each is mentioned below: 
+        - **MistralAI**: `Authorization` header
+        - **AzureOpenAI**: `api-key` header
+        - **OpenAI**: `Authorization` header
 
-**API Key format:** `Bearer <API-Key>` 
+        Note that we prepend "Bearer " to the header value that you provide when it comes to MistralAI and OpenAI since they are expecting an Authorization header.
 
-[![API Key Configurations]({{base_path}}/assets/img/learn/ai-api-auth.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-api-auth.png)
+    [![API Key Configurations]({{base_path}}/assets/img/learn/ai-api-auth.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-api-auth.png)
 
-#### c. Click **Save**.
+3. Click **Save**.
 
 Now, you have successfully created an AI API. Next, [deploy the API]({{base_path}}/deploy-and-publish/deploy-on-gateway/deploy-api/deploy-an-api/), [test the API]({{base_path}}/design/create-api/create-rest-api/test-a-rest-api/), and finally [publish the API]({{base_path}}/deploy-and-publish/publish-on-dev-portal/publish-an-api).
 
@@ -66,7 +77,7 @@ Learn more on the concepts that you need to know when creating a REST API:
 
 <!-- -   [Endpoints]({{base_path}}/design/endpoints/endpoint-types/) -->
 -   [API Security]({{base_path}}/design/api-security/api-authentication/secure-apis-using-oauth2-tokens/)
--   [Rate Limiting]({{base_path}}/design/rate-limiting/introducing-throttling-use-cases/)
+-   [Rate Limiting for AI APIs]({{base_path}}/design/rate-limiting/rate-limiting-for-ai-apis/)
 -   [Life Cycle Management]({{base_path}}/design/lifecycle-management/api-lifecycle/)
 <!-- -   [API Monetization]({{base_path}}/design/api-monetization/monetizing-an-api/) -->
 -   [API Visibility]({{base_path}}/design/advanced-topics/control-api-visibility-and-subscription-availability-in-developer-portal/)