Skip to content

Commit

Permalink
Merge pull request #8955 from ashera96/marketplace-assistant-master
Browse files Browse the repository at this point in the history
Minor fixes for Marketplace Assistant related docs
  • Loading branch information
PasanT9 authored Dec 6, 2024
2 parents d586e46 + 683c247 commit 6e8a8c0
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 30 deletions.
46 changes: 21 additions & 25 deletions en/docs/consume/discover-apis/marketplace-assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ Follow the steps below to get started with the Marketplace Assistant:

## Step 3 - Configure API Manager

To enable the Marketplace Assistant and populate the vector database, the API Manager requires configuration. Follow these steps:

### Configure the deployment.toml

1. The following configuration change must be done in the `<API-M_HOME>/repository/conf/deployment.toml` file. Update the `[apim.ai]` config by providing the on-premise token obtained from Step 2. Also, be sure to update the endpoint field as below.

```toml
Expand All @@ -67,11 +63,11 @@ To enable the Marketplace Assistant and populate the vector database, the API Ma

2. Restart the API Manager.

## Step 4 (optional) - Sync vector database with your current APIs and API Products
## Step 4 (optional) - Sync vector database with current APIs and API Products

To ensure that the Marketplace Assistant is aware of all published APIs and to update the vector database with the current APIs, you have to upload all APIs and API Products.

For more information, see [AI Related Operations with apictl]({{base_path}}/install-and-setup/setup/api-controller/ai-related-operations-with-apictl/)
For more information, see [AI related operations with apictl]({{base_path}}/install-and-setup/setup/api-controller/ai-related-operations-with-apictl/)

## Step 5 - Engage with the Marketplace Assistant

Expand All @@ -83,59 +79,59 @@ Explore the features and functionalities of the Marketplace Assistant to streaml

## FAQ

### Why is this an experimental feature?
**1. Why is this an experimental feature?**

The Marketplace Assistant is labeled as an experimental feature because it represents innovative technology that is still under development. AI technology is rapidly evolving with significant enhancements in large language models and the introduction of increasingly efficient chips, and we are integrating the latest advancements to enhance our capabilities. Rolling out new features as experimental underscores our commitment to innovation, and as we continue to refine them, we are focused on enhancing their performance and reliability based on user input and ongoing development efforts.

### What are the usage limits?
**2. What are the usage limits?**

During the trial period, users are subject to the following usage limits:

- Access to up to 1000 APIs to the vectorDB.
- Limited chat functionality based on the number of tokens used by the language model.

### Why did I lose my chat history after I logged out?
**3. Why did I lose my chat history after I logged out?**

Your chat history will be lost after logging out or after a period of inactivity of 1 hour, as per the design of the application. For security and privacy reasons ensure that your conversations are not accessible to other users. Additionally, you have the option to reset your chat history to address any potential privacy concerns.

### Why does the chat not have the context of the initial interactions?
**4. Why does the chat not have the context of the initial interactions?**

The language model operates by considering only the last 5 interactions to respond. Therefore, if your conversation extends beyond 5 interactions, the model may not retain the earlier parts of the chat

### Why can't I list a large number of APIs as recommendations?
**5. Why can't I list a large number of APIs as recommendations?**

This is because the assistant is designed to identify the most suitable APIs rather than listing a large number of options. To enhance the recommendation process, we limit the number of APIs provided to the language model as context. This ensures that the assistant suggests more relevant APIs instead of overwhelming the user with every possible option.

### I'm receiving the message "I am not aware of such API" despite the API being listed on the developer portal.
**6. I'm receiving the message "I am not aware of such API" despite the API being listed on the developer portal.**

There are a few potential reasons for this

#### Assistant uses only public APIs to provide answers.
1. Assistant uses only public APIs to provide answers.

- The marketplace assistant is only using public APIs to answer questions. If there is an API, not a public API, the assistant wouldn't be aware of it.
The marketplace assistant is only using public APIs to answer questions. If there is an API, not a public API, the assistant wouldn't be aware of it.

#### You may have configured the marketplace assistant after publishing those APIs.
2. You may have configured the marketplace assistant after publishing those APIs.

- APIs are only published to the vector database if the Al features are enabled and the token is configured. If you published the API before configuring the assistant, it might not be in the database, and the assistant wouldn't be aware of it. Re-publishing the API and trying again could resolve this. If you have numerous APIs, there's an option to upload them using the WSO2 API Controller
APIs are only published to the vector database if the AI features are enabled and the token is configured. If you published the API before configuring the assistant, it might not be in the database, and the assistant wouldn't be aware of it. Re-publishing the API and trying again could resolve this. If you have numerous APIs, there's an option to upload them using the WSO2 API Controller

#### If you've published the API and are still receiving the above response, there could be two reasons:
3. If you've published the API and are still receiving the above response, there could be two reasons:

- The API details may have failed to upload to the vector database due to reasons like network issues.
- The language model may not be responding correctly. Even if the APL is in the database, there's a chance the language model can't understand and answer properly. Trying different prompts may help clarify the issue.
- The API details may have failed to upload to the vector database due to reasons like network issues.
- The language model may not be responding correctly. Even if the APL is in the database, there's a chance the language model can't understand and answer properly. Trying different prompts may help clarify the issue.

### I am getting this error response: `Apologies for the inconvenience. It appears that the token limit has been exceeded`
**7. I am getting this error response: `Apologies for the inconvenience. It appears that the token limit has been exceeded`**

This message indicates that the request you made has exceeded the allowed token limit usage. During the trial period, token usage is limited, You have the option to upgrade your subscription plan to access Marketplace Assistant without interruption.

### I am getting this error response: Apologies for the inconvenience. `It appears that your token is invalid or expired. Please provide a valid token or upgrade your subscription plan `
**8. I am getting this error response: Apologies for the inconvenience. `It appears that your token is invalid or expired. Please provide a valid token or upgrade your subscription plan `**

This message suggests that your on-prem key is not valid or it is expired. You can request an extended trial period or you can upgrade your subscription plan so that you can seamlessly use Marketplace Assistant

### I am getting this error response: Apologies for the inconvenience. `It seems that something went wrong with the Marketplace Assistant. Please try again later `
**9. I am getting this error response: Apologies for the inconvenience. `It seems that something went wrong with the Marketplace Assistant. Please try again later `**

This message signifies that an unexpected error has occurred. It could be due to various reasons such as server issues, network problems, etc. Kindly reach out to the administrator for assistance in resolving the problem,

### What type of questions I can ask from Marketplace Assistant:
**10. What type of questions I can ask from Marketplace Assistant:**

You can ask the Marketplace Assistant various questions related to APIs and their functionalities. Some examples include:

Expand All @@ -148,12 +144,12 @@ For instance, you can ask questions like:

- I am trying to develop an application where `<Use case description>`. What are APIs you can recommend for me to use?
- What are the APIs you know about `<Topic>`?
- What are the differences between `<APII>` and `<API2>`.
- What are the differences between `<API1>` and `<API2>`.

Feel free to ask any questions related to APIs or the functionality of APIs, and the assistant will do its best to provide helpful responses,
if you encounter any issues or have further questions, go to the Issues tab of this GitHub repo [API Manager](https://github.com/wso2/api-manager/issues) and click the New issue button to file a bug report or ask questions.

### This error message is prompted in the terminal when I use the apictl to upload my APIs: `context deadline exceeded (Client.Timeout exceeded while awaiting headers)`.
**11. This error message is prompted in the terminal when I use the apictl to upload my APIs: `context deadline exceeded (Client.Timeout exceeded while awaiting headers)`.**

The dafault HTTP request timeout for apictl is 10s. Due to network connnectivity or some other issues, the uploading might exceed this limit. If you encounter this issue you can simply set the timeout to a higher value.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AI Related operations with apictl
# AI related operations with apictl

To ensure that the Marketplace Assistant is fully informed about all published APIs and API Products, it is essential to update the vector database with the current APIs.
**WSO2 API Controller (apictl)** allows you to update the vector Database with the current APIs.
To ensure that the Marketplace Assistant is fully informed about all published APIs and API Products, it is essential to update the vector database.
You can use the **WSO2 API Controller (apictl)** to keep the vector database upto date.

First you have to download and intialize the apictl.
First you have to download and initialize the apictl.

1. Make sure that the WSO2 API-M is started and that the corresponding version of apictl is set up.
For more information, see [Download and Initialize the apictl]({{base_path}}/install-and-setup/setup/api-controller/getting-started-with-wso2-api-controller/#download-and-initialize-the-apictl).
Expand All @@ -12,7 +12,7 @@ For more information, see [Download and Initialize the apictl]({{base_path}}/ins

### Set token as a config variable

Set the Token (Which is generated for AI features) as a config.
Using the token which was generated for Marketplace Assistant set the ai-token as shown below.

- **Command**

Expand Down

0 comments on commit 6e8a8c0

Please sign in to comment.