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.

Sign up for GitHub

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

Jump to bottom

Documentation for AI Subscription Portal #8678

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Documentation for AI Subscription Portal #8678

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
280e523
Documentation for AI Subscription Portal
piyumaldk Nov 5, 2024
31fe926
Requested changes
piyumaldk Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added en/docs/assets/img/observe/ai-subscription-portal-2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/docs/assets/img/observe/ai-subscription-portal-3.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/docs/assets/img/observe/ai-subscription-portal.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 31 additions & 17 deletions en/docs/consume/discover-apis/marketplace-assistant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,47 @@ The Marketplace Assistant is a powerful tool provided by API Manager, utilizing
Follow the steps below to get started with the Marketplace Assistant:

!!! tip
If you've previously registered your environment for the [API Chat]({{base_path}}/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat), you can skip Step 1 by utilizing the same credentials for the Marketplace Assistant. Otherwise, complete Step 1 to register your on-premise environment.
If you've previously registered your environment for the [API Chat]({{base_path}}/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat), you can skip Step 1 and 2 by utilizing the same credentials for the Marketplace Assistant. Otherwise, complete Step 1 to register your on-premise environment.

## Step 1 - Sign in to Choreo
## Step 1 - Sign In to AI Subscription Portal
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

1. Navigate to Choreo using the URL: <a href="https://console.choreo.dev">https://console.choreo.dev</a>.
!!! warning
Information in the AI Subscription Portal will be stored in the United States.

2. Sign-in to Choreo.
1. Navigate to the AI Subscription Portal using the following URL: <a href="https://ai-subscriptions.wso2.com">https://ai-subscriptions.wso2.com</a>.

[![Choreo sign-in options]({{base_path}}/assets/img/observe/sign-in-choreo.png)]({{base_path}}/assets/img/observe/sign-in-choreo.png)
2. Register for an Account.

## Step 2 - Register your environment
[![AI Subscription Portal]({{base_path}}/assets/img/observe/ai-subscription-portal.png)]({{base_path}}/assets/img/observe/ai-subscription-portal.png)

Follow the instructions below to register your on-premise environment:
- Click **Register**.
- Enter a valid email address and click **Register**.
- Check your email inbox and click **Complete Account Creation**.
- Provide an organization name (make a note of this, as it will be required for every login) and create a secure password.

1. Click the **Settings** on the bottom left corner.
3. Log In to the AI Subscription Portal.
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

[![Settings Menu]({{base_path}}/assets/img/observe/settings-menu.png)]({{base_path}}/assets/img/observe/settings-menu.png)
- Click **Sign In** and enter your organization name.
- Enter your email address and password.

2. If you are a member of multiple organizations, select the appropriate organization from the top left-hand corner.
## Step 2 - Create a Key by Subscribing
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

3. Select the **On-prem Keys** tab and click **Generate Key**.
1. On the main landing page, click **New Subscription**.

[![On-prem Key]({{base_path}}/assets/img/observe/on-prem-key.png)]({{base_path}}/assets/img/observe/on-prem-key.png)
[![AI Subscription Portal Initial Dashboard]({{base_path}}/assets/img/observe/ai-subscription-portal-2.png)]({{base_path}}/assets/img/observe/ai-subscription-portal-2.png)

4. Enter a suitable name for your environment (e.g., dev).
2. Select **wso2am** as the product, enter an appropriate name, and create the subscription.

5. Click **Generate**.
6. Copy the key that was generated before closing the dialog box.
!!! info
Users can create multiple subscriptions for different on-premises environments and manage them through the portal.

!!! warning
Do not use the same key for different environments or products. Each key is used to differentiate environments when accessing AI services.

[![AI Subscription Portal Dashboard]({{base_path}}/assets/img/observe/ai-subscription-portal-3.png)]({{base_path}}/assets/img/observe/ai-subscription-portal-3.png)

!!! info
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved
Users can revoke and regenerate keys for any subscription, as well as delete subscriptions. Please perform these actions with caution, as they will immediately invalidate any existing keys in use.

## Step 3 - Configure API Manager

Expand All @@ -47,8 +60,9 @@ To enable the Marketplace Assistant and populate the vector database, the API Ma
```toml
[apim.ai]
enable = true
endpoint = "https://dev-tools.wso2.com/apim-ai-service"
token = "<use token that you generated>"
endpoint = "https://dev-tools.wso2.com/apim-ai-service/v2"
key = "<use key that you generated>"
token_endpoint = "https://api.asgardeo.io/t/wso2devtools/oauth2/token"
```

2. Restart the API Manager.
Expand Down
48 changes: 31 additions & 17 deletions en/docs/consume/invoke-apis/invoke-apis-using-tools/test-apis-with-apichat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,47 @@ Testing APIs is an essential step in the API development lifecycle. API Manager
Follow the steps below to test your API with API Chat:

!!! tip
If you've previously registered your environment for the [Marketplace Assistant]({{base_path}}/consume/discover-apis/marketplace-assistant), you can skip Step 1 by utilizing the same credentials for the API Chat. Otherwise, complete Step 1 to register your on-premise environment.
If you've previously registered your environment for the [Marketplace Assistant]({{base_path}}/consume/discover-apis/marketplace-assistant), you can skip Step 1 and 2 by utilizing the same credentials for the API Chat. Otherwise, complete Step 1 and 2 to generate the credentials.

## Step 1 - Sign in to Choreo
## Step 1 - Sign In to AI Subscription Portal
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

1. Navigate to Choreo using the URL: <a href="https://console.choreo.dev">https://console.choreo.dev</a>.
!!! warning
Information in the AI Subscription Portal will be stored in the United States.

2. Sign in to Choreo.
1. Navigate to the AI Subscription Portal using the following URL: <a href="https://ai-subscriptions.wso2.com">https://ai-subscriptions.wso2.com</a>.

[![Choreo sign-in options]({{base_path}}/assets/img/observe/sign-in-choreo.png)]({{base_path}}/assets/img/observe/sign-in-choreo.png)
2. Register for an Account.

## Step 2 - Register your environment
[![AI Subscription Portal]({{base_path}}/assets/img/observe/ai-subscription-portal.png)]({{base_path}}/assets/img/observe/ai-subscription-portal.png)

Follow the instructions below to register your on-premise environment:
- Click **Register**.
- Enter a valid email address and click **Register**.
- Check your email inbox and click **Complete Account Creation**.
- Provide an organization name (make a note of this, as it will be required for every login) and create a secure password.

1. Click the **Settings** on the bottom left corner.
3. Log In to the AI Subscription Portal.
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

[![Settings Menu]({{base_path}}/assets/img/observe/settings-menu.png)]({{base_path}}/assets/img/observe/settings-menu.png)
- Click **Sign In** and enter your organization name.
- Enter your email address and password.

2. If you are a member of multiple organizations, select the appropriate organization from the top left-hand corner.
## Step 2 - Create a Key by Subscribing
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved

3. Select the **On-prem Keys** tab and click **Generate Key**.
1. On the main landing page, click **New Subscription**.

[![On-prem Key]({{base_path}}/assets/img/observe/on-prem-key.png)]({{base_path}}/assets/img/observe/on-prem-key.png)
[![AI Subscription Portal Initial Dashboard]({{base_path}}/assets/img/observe/ai-subscription-portal-2.png)]({{base_path}}/assets/img/observe/ai-subscription-portal-2.png)

4. Enter a suitable name for your environment (e.g., dev).
2. Select **wso2am** as the product, enter an appropriate name, and create the subscription.

5. Click **Generate**.
6. Copy the key that was generated before closing the dialog box.
!!! info
Users can create multiple subscriptions for different on-premises environments and manage them through the portal.

!!! warning
Do not use the same key for different environments or products. Each key is used to differentiate environments when accessing AI services.

[![AI Subscription Portal Dashboard]({{base_path}}/assets/img/observe/ai-subscription-portal-3.png)]({{base_path}}/assets/img/observe/ai-subscription-portal-3.png)

!!! info
tharikaGitHub marked this conversation as resolved.
Show resolved Hide resolved
Users can revoke and regenerate keys for any subscription, as well as delete subscriptions. Please perform these actions with caution, as they will immediately invalidate any existing keys in use.

## Step 3 - Configure API Manager

Expand All @@ -44,8 +57,9 @@ Follow the instructions below to register your on-premise environment:
```toml
[apim.ai]
enable = true
endpoint = "https://dev-tools.wso2.com/apim-ai-service"
token = "<use token that you generated>"
endpoint = "https://dev-tools.wso2.com/apim-ai-service/v2"
key = "<use key that you generated>"
token_endpoint = "https://api.asgardeo.io/t/wso2devtools/oauth2/token"
```

2. Restart the API Manager.
Expand Down