Update (#63)

Co-authored-by: zhe_mstr <[email protected]>

docs/common-workflows/analytics/question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md

@@ -16,7 +16,7 @@ Obtain the authorization token needed to execute the request using [POST /api/au
 
 ## Ask suggested questions with bot routing
 
-Endpoint: [POST /api/question/suggestions](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Question%20Suggestions/createSuggestions_1)
+Endpoint: [POST /api/questions/suggestions](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Question%20Suggestions/createSuggestions_1)
 
 Sample Request Header:
 
@@ -45,7 +45,7 @@ Sample Request Body:
 Sample Curl:
 
 ```bash
-curl 'https://demo.microstrategy.com/MicroStrategyLibrary/api/question/suggestions' \
+curl 'https://demo.microstrategy.com/MicroStrategyLibrary/api/questions/suggestions' \
 -X 'POST' \
 --header 'X-MSTR-AuthToken: t40ltbk411923ipk85r8r0tace' \
 --header 'X-MSTR-ProjectID: FCC1924411EAABC39C6C0080EFA54501' \

docs/common-workflows/analytics/use-bot-api/ask-bot-instance-question.md

@@ -6,6 +6,18 @@ description: This workflow sample demonstrates how to ask the bot instance a que
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Ask Question to Bots in the Application API](../question-with-bot-routing-api/ask-question-to-bots-in-the-application) for bot-related workflows.
+
+Using Ask Question to Bots in the Application API:
+
+- Bot instances are managed automatically, eliminating the need for manual instance management.
+- The API automatically selects the most appropriate bot to answer a question, or you can specify a specific bot by including its ID in the query parameters.
+- It offers ongoing support and updates, ensuring compatibility with new bot-related features.
+
+:::
+
 This workflow sample demonstrates how to ask the bot instance a question.
 
 :::info

docs/common-workflows/analytics/use-bot-api/ask-bot-instance-suggested-question.md

@@ -6,6 +6,18 @@ description: This workflow sample demonstrates how to ask a bot instance for sug
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Ask Suggested Question to Bots in the Application API](../question-with-bot-routing-api/ask-suggested-question-to-bots-in-the-application.md) for retrieving suggested questions from bots.
+
+Using Ask Suggested Question to Bots in the Application API:
+
+- You do not need to manually create or manage bot instances. The API automatically creates and manages bot instances.
+- The API automatically selects the most appropriate bot based on your previous questions to suggest relevant questions.
+- You can use query parameters to specify a bot to receive suggested questions.
+
+:::
+
 This workflow sample demonstrates how to ask a bot instance for suggested questions.
 
 :::info

docs/common-workflows/analytics/use-bot-api/create-a-bot-instance.md

@@ -6,6 +6,18 @@ description: This workflow sample demonstrates how to create a bot instance
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows.
+
+Using the Question with Bot Routing API:
+
+- You do not need to manually create or manage bot instances. The API automatically creates and manages bot instances.
+- It offers ongoing support and updates, ensuring compatibility with new bot-related features.
+- It provides enhanced functionality, such as intelligent bot selection and flexible bot routing.
+
+:::
+
 This workflow sample demonstrates how to create a bot instance.
 
 :::info

docs/common-workflows/analytics/use-bot-api/delete-a-bot-instance.md

@@ -6,6 +6,22 @@ description: This workflow sample demonstrates how to delete a bot instance
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Question with Bot Routing API](../question-with-bot-routing-api/question-api.md) for bot-related workflows.
+
+Using the Question with Bot Routing API:
+
+- You do not need to manually create or manage bot instances. The API automatically creates and manages bot instances.
+- It offers ongoing support and updates, ensuring compatibility with new bot-related features.
+- It provides enhanced functionality, such as intelligent bot selection and flexible bot routing.
+
+:::
+
+This workflow sample demonstrates how to create a bot instance.
+
+:::info
+
 This workflow sample demonstrates how to delete a bot instance.
 
 :::info

docs/common-workflows/analytics/use-bot-api/get-a-bot-question.md

@@ -6,6 +6,14 @@ description: This workflow sample demonstrates how to get a chat bot's question.
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the [Get Question from Bots in the Application API](../question-with-bot-routing-api/get-question-from-bots-in-the-application.md) for retrieving bot responses.
+
+The Get Question from Bots in the Application API can be used in combination with the [Ask Question to Bots in the Application API](../question-with-bot-routing-api/ask-question-to-bots-in-the-application.md) to ask questions and retrieve answers from bots. This streamlined workflow removes manual bot instance management and provides flexible bot routing.
+
+:::
+
 This workflow sample demonstrates how to get a chat bot's question.
 
 :::info

docs/common-workflows/analytics/use-bot-api/use-bot-api.md

@@ -5,6 +5,24 @@ description: This page contains a summary of REST APIs for the "bots" endpoint.
 
 <Available since="MicroStrategy ONE (March 2024)" />
 
+:::caution
+
+The following Bot APIs are planned for future retirement. Therefore, MicroStrategy recommends that you use the [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) instead:
+
+- [Create a bot instance.](./create-a-bot-instance.md)
+- [Ask for suggested questions](./ask-bot-instance-suggested-question.md)
+- [Ask a bot question](./ask-bot-instance-question.md)
+- [Get a bot question](./get-a-bot-question.md)
+- [Delete a bot instance](./delete-a-bot-instance.md)
+
+Reason:
+
+- **Easy to use**: The [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) automatically manage bot instances, eliminating the need for users to manually create and manage bot instances through separate API calls.
+- **More powerful**: The [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) provide intelligent bot routing by automatically selecting the most appropriate bot to handle a question. If you need to ask a specific bot, you can specify the bot ID as a query parameter. For more details, see [Ask a Question to Bots in the Application](../question-with-bot-routing-api/ask-question-to-bots-in-the-application.md).
+- **Ongoing support and updates**: The [Question with Bot Routing APIs](../question-with-bot-routing-api/question-api.md) will continue to receive updates and support for future bot-related features. In contrast, the Bot APIs will not receive updates or new features and may eventually lead to exceptions as maintenance ends.
+
+:::
+
 For users interested in creating a custom chatbot experience utilizing the capabilities of MicroStrategy AI, a suite of bot-related APIs is available. These APIs are designed to facilitate seamless integration of MicroStrategy AI into nearly any application. By leveraging these tools, users can enhance their applications with advanced AI features quickly and efficiently. For further details on how to use these APIs, please refer to the following sections of this manual.
 
 - [Get a bot's configuration](./get-bot-configuration.md)