-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add AI Studio API (box/box-openapi#510)
- Loading branch information
1 parent
82cfcf0
commit 0da38a1
Showing
38 changed files
with
3,332 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
{ "engineHash": "c1e6fc8", "specHash": "153fd54", "version": "0.5.0" } | ||
{ "engineHash": "c1e6fc8", "specHash": "f20ba3f", "version": "0.5.0" } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
# AiStudioManager | ||
|
||
|
||
- [List AI agents](#list-ai-agents) | ||
- [Create AI agent](#create-ai-agent) | ||
- [Update AI agent](#update-ai-agent) | ||
- [Get AI agent by agent ID](#get-ai-agent-by-agent-id) | ||
- [Delete AI agent](#delete-ai-agent) | ||
|
||
## List AI agents | ||
|
||
Lists AI agents based on the provided parameters. | ||
|
||
This operation is performed by calling function `getAiAgents`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/get-ai-agents/). | ||
|
||
*Currently we don't have an example for calling `getAiAgents` in integration tests* | ||
|
||
### Arguments | ||
|
||
- queryParams `GetAiAgentsQueryParams` | ||
- Query parameters of getAiAgents method | ||
- headers `GetAiAgentsHeaders` | ||
- Headers of getAiAgents method | ||
|
||
|
||
### Returns | ||
|
||
This function returns a value of type `AiMultipleAgentResponse`. | ||
|
||
A successful response including the agents list. | ||
|
||
|
||
## Create AI agent | ||
|
||
Creates an AI agent. At least one of the following capabilities must be provided: `ask`, `text_gen`, `extract`. | ||
|
||
This operation is performed by calling function `createAiAgent`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/post-ai-agents/). | ||
|
||
*Currently we don't have an example for calling `createAiAgent` in integration tests* | ||
|
||
### Arguments | ||
|
||
- requestBody `CreateAiAgent` | ||
- Request body of createAiAgent method | ||
- headers `CreateAiAgentHeaders` | ||
- Headers of createAiAgent method | ||
|
||
|
||
### Returns | ||
|
||
This function returns a value of type `AiSingleAgentResponseFull`. | ||
|
||
Definition of created AI agent. | ||
|
||
|
||
## Update AI agent | ||
|
||
Updates an AI agent. | ||
|
||
This operation is performed by calling function `updateAiAgentById`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/put-ai-agents-id/). | ||
|
||
*Currently we don't have an example for calling `updateAiAgentById` in integration tests* | ||
|
||
### Arguments | ||
|
||
- agentId `String` | ||
- The ID of the agent to update. Example: "1234" | ||
- requestBody `CreateAiAgent` | ||
- Request body of updateAiAgentById method | ||
- headers `UpdateAiAgentByIdHeaders` | ||
- Headers of updateAiAgentById method | ||
|
||
|
||
### Returns | ||
|
||
This function returns a value of type `AiSingleAgentResponseFull`. | ||
|
||
Definition of created AI agent. | ||
|
||
|
||
## Get AI agent by agent ID | ||
|
||
Gets an AI Agent using the `agent_id` parameter. | ||
|
||
This operation is performed by calling function `getAiAgentById`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/get-ai-agents-id/). | ||
|
||
*Currently we don't have an example for calling `getAiAgentById` in integration tests* | ||
|
||
### Arguments | ||
|
||
- agentId `String` | ||
- The agent id to get. Example: "1234" | ||
- queryParams `GetAiAgentByIdQueryParams` | ||
- Query parameters of getAiAgentById method | ||
- headers `GetAiAgentByIdHeaders` | ||
- Headers of getAiAgentById method | ||
|
||
|
||
### Returns | ||
|
||
This function returns a value of type `AiSingleAgentResponseFull`. | ||
|
||
A successful response including the agent. | ||
|
||
|
||
## Delete AI agent | ||
|
||
Deletes an AI agent using the provided parameters. | ||
|
||
This operation is performed by calling function `deleteAiAgentById`. | ||
|
||
See the endpoint docs at | ||
[API Reference](https://developer.box.com/reference/delete-ai-agents-id/). | ||
|
||
*Currently we don't have an example for calling `deleteAiAgentById` in integration tests* | ||
|
||
### Arguments | ||
|
||
- agentId `String` | ||
- The ID of the agent to delete. Example: "1234" | ||
- headers `DeleteAiAgentByIdHeaders` | ||
- Headers of deleteAiAgentById method | ||
|
||
|
||
### Returns | ||
|
||
This function returns a value of type `void`. | ||
|
||
A successful response with no content. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.