Skip to content

Commit f7b6430

Browse files
SowaProgramujeSowaProgramuje
committed
Merge branch 'main' of github.com:box/developer.box.com
2 parents 635c0f8 + 85f02dc commit f7b6430

22 files changed

Lines changed: 414 additions & 60 deletions

‎content/guides/ai-studio/ai-studio-agents/create-agents.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
rank: 1
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Create agents
13+
14+
<Messsage type='caution'>
15+
16+
Box AI Studio is available only for Enterprise Advanced accounts.
17+
18+
</Message>
19+
20+
The `POST /2.0/ai_agents` endpoint allows you to create a new, custom [AI agent][agents].
21+
22+
## Send a request
23+
24+
To send a request, use the `POST /2.0/ai_agents` endpoint.
25+
26+
Make sure you have generated the developer token
27+
to authorize your app. See [getting started with Box AI][prereq]
28+
for details.
29+
30+
<Samples id='post-ai-agents' />
31+
32+
### Parameters
33+
34+
To make a call, you must pass the following parameters. Mandatory parameters are in **bold**.
35+
36+
<!--alex ignore-->
37+
38+
| Parameter| Description| Example|
39+
|--------|--------|-------|
40+
| **`type`** | The type of agent used to handle queries. | `ai_agent` |
41+
| **`name`** | The name of the AI Agent. | `My AI Agent` |
42+
| **`access_state`** | The state of the AI Agent. Value is one of `enabled` `disabled`. | `enabled` |
43+
| `icon_reference` | The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>` , where the possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`, `logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png` `logo_analytics.png`,`logo_classification.png`. | `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg` |
44+
| `allowed_entities` | List of allowed users or groups. | |
45+
| `ask` | The AI Agent to be used for ask. | `ask` |
46+
| `extract` | The AI Agent to be used for extraction. | |
47+
| `text_gen` | The AI agent used for generating text. | |
48+
49+
<!--alex enable-->
50+
51+
[agents]: g://box-ai/ai-agents/index
52+
[prereq]: g://ai-studio/getting-started-ai-studio

‎content/guides/ai-studio/ai-studio-agents/delete-agents.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
rank: 5
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Delete AI agent
13+
14+
The `DELETE /2.0/ai_agents/{id}` endpoint allows you to delete a custom AI agent based on its ID.
15+
16+
## Send a request
17+
18+
To send a request, use the `DELETE /2.0/ai_agents/{id}` endpoint.
19+
20+
<Samples id='delete-ai-agents-id' />
21+
22+
### Parameters
23+
24+
To make a call, you must pass the following parameters. Mandatory parameters are in **bold**.
25+
26+
| Parameter| Description| Example|
27+
|--------|--------|-------|
28+
| **`agent_id`** | The ID of the agent to delete. | `1234` |

‎content/guides/ai-studio/ai-studio-agents/get-agent-id.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
rank: 3
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Get AI agent by ID
13+
14+
The `GET /2.0/ai_agents/{id}` endpoint allows you to list a specific AI
15+
agent by the `agent_id` parameter.
16+
17+
## Send a request
18+
19+
To send a request, use the `GET /2.0/ai_agents/{id}` endpoint.
20+
21+
<Samples id='get-ai-agents-id' />
22+
23+
### Parameters
24+
25+
To make a call, you must pass the following parameters. Mandatory parameters are in **bold**.
26+
27+
| Parameter| Description| Example|
28+
|--------|--------|-------|
29+
| **`agent_id`** | The agent id to get. | `1234` |
30+
| `fields` | The fields to return in the response. | `ask` |

‎content/guides/ai-studio/ai-studio-agents/get-agents.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
rank: 2
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Get agents
13+
14+
<Messsage type='caution'>
15+
16+
Box AI Studio is available only for Enterprise Advanced accounts.
17+
18+
</Message>
19+
20+
## List all AI agents
21+
22+
The `GET /2.0/ai_agents` endpoint allows you to list all AI agents based on the provided parameters.
23+
24+
### Send a request
25+
26+
To send a request, use the `GET /2.0/ai_agents` endpoint.
27+
28+
Make sure you have generated the developer token
29+
to authorize your app. See [getting started with Box AI Studio][getting-started]
30+
for details.
31+
32+
<Samples id='get-ai-agents' />
33+
34+
#### Parameters
35+
36+
To make a call, you must pass the following parameters. Mandatory parameters are in **bold**.
37+
38+
| Parameter| Description| Example|
39+
|--------|--------|-------|
40+
| `mode` | The mode to filter the agent configuration to return. Possible values are: `ask`, `text_gen`, and `extract`. | `ask` |
41+
| `fields` | The fields to return in the response. | `ask` |
42+
| `agent_state` | The state of the agent to return. Value is one of `enabled`,`disabled`. | `enabled` |
43+
| `fields` | The fields to return in the response. Value is one of `ask`, `text_gen`, `extract`. | `ask` |
44+
| `include_box_default` | Whether to include the Box default agents in the response. | `true` |
45+
| `limit` | The maximum number of items to return per page. | `1000` |
46+
| `marker` | Defines the position marker at which to begin returning results. | `JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii` |
47+
48+
[getting-started]: g://ai-studio/getting-started-ai-studio

‎content/guides/ai-studio/ai-studio-agents/index.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
rank: 0
3+
related_guides:
4+
- ai-studio/ai-studio-agents/create-agents
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/generate-text
7+
---
8+
9+
# AI studio agents
10+
11+
<Messsage type='caution'>
12+
13+
Box AI Studio is available only for Enterprise Advanced accounts.
14+
15+
</Message>
16+
17+
Create, list, update, and delete custom AI agents.

‎content/guides/ai-studio/ai-studio-agents/update-agents.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
rank: 4
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Update AI agent
13+
14+
The `PUT /2.0/ai_agents/{id}` endpoint allows you to update a custom AI agent based on its ID.
15+
16+
## Send a request
17+
18+
To send a request, use the `PUT /2.0/ai_agents/{id}` endpoint.
19+
20+
<Samples id='put-ai-agents_id' />
21+
22+
### Parameters
23+
24+
To make a call, you must pass the following parameters. Mandatory parameters are in **bold**.
25+
26+
<!--alex ignore-->
27+
28+
| Parameter| Description| Example|
29+
|--------|--------|-------|
30+
| **`type`** | The type of agent used to handle queries. | ```` |
31+
| **`name`**| The name of the AI Agent. | My AI Agent |
32+
| **`access_state`** | The state of the AI Agent. Value is one of `enabled` `disabled`. | `enabled` |
33+
| `icon_reference` | The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>`, where possible values of `file_name` are: `logo_boxAi.png`,`logo_stamp.png`,`logo_legal.png`,`logo_finance.png`,`logo_config.png`,`logo_handshake.png`,`logo_analytics.png`,`logo_classification.png` | `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg` |
34+
| `allowed_entities` | List of allowed users or groups. |
35+
| `ask` | The AI Agent to be used for ask. | `ask` |
36+
| `extract` | The AI Agent to be used for extraction. | |
37+
| `text_gen` | The AI agent used for generating text. | |
38+
39+
<!--alex ignore-->

‎content/guides/ai-studio/getting-started-ai-studio.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
rank: 1
3+
related_guides:
4+
- authentication/tokens/developer-tokens/
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/default-agent-overrides
7+
- box-ai/ai-tutorials/generate-text
8+
- box-ai/ai-tutorials/extract-metadata-structured
9+
- box-ai/ai-tutorials/extract-metadata
10+
---
11+
12+
# Get started with AI studio
13+
14+
<Messsage type='caution'>
15+
16+
Box AI Studio is available only for Enterprise Advanced accounts.
17+
18+
</Message>
19+
20+
To start creating custom AI agents with AI studio you need a platform
21+
application with enabled Box AI scope and a developer token to
22+
authenticate your calls.
23+
24+
## Create a custom application
25+
26+
First you need to create a platform application you will use to make calls. To
27+
create an application, follow the guide on [creating platform apps][createapps].
28+
29+
## Enable Box AI studio
30+
31+
To use Box AI studio, make sure it is enabled by a Box admin in the Admin
32+
Console.
33+
If you are a Box Admin, you will find the necessary information in
34+
[Enabling Box AI Studio and Managing Agents][enable].
35+
36+
To interact with Box AI API, you need the `ai.readwrite` [scope][scope]
37+
added for your application. Before you add the scope, make sure that the Box
38+
Admin has granted you the access to Box AI API. If you can't see the
39+
**Manage AI** option in your app configuration settings, contact your admin.
40+
41+
To add a scope:
42+
43+
1. Open your application in Developer Console.
44+
2. Go to **Configuration** > **Required Access Scopes** > **Content Actions**
45+
3. Select the **Manage AI** scope. Box Platform will automatically include the scope when making the call. If you are added as an collaborator for a given app, but do not have Box AI API access, you will see the **Manage AI** scope checked and grayed out. This means the app owner has the AI scope enabled but you cannot change this setting.
46+
47+
![box ai scopes](./images/box-ai-app-scopes.png)
48+
49+
4. Submit your app for [authorization or enablement][authorization]. If you want to enable Box AI API for an existing application, you must [re-authorize][reauthorization] it.
50+
51+
## Generate a developer token
52+
53+
You need a developer token
54+
to authenticate your app when sending requests.
55+
56+
To generate a token:
57+
58+
1. Go to **Developer Console** > **My Platform Apps**.
59+
2. Click the **Options menu** button (…) on the right.
60+
3. Select **Generate Developer Token**. The token will be automatically generated and saved to clipboard.
61+
62+
![generate token](../images/developer-token.png)
63+
64+
You can also open your app, go to
65+
**Configuration** > **Developer Token**
66+
and generate the token.
67+
68+
<Message type="notice">
69+
A developer token is only valid for one hour.
70+
</Message>
71+
72+
For additional details, see [developer token][token].
73+
After you generate the token, you can use it in cURL
74+
or other clients, such as [Postman][postman], to make
75+
calls.
76+
77+
[enable]: https://support.box.com/hc/en-us/articles/37228079461267-Enabling-Box-AI-Studio-and-Managing-Agents/#h_01JH9HAMP43YYN6VWM51QCK413
78+
[token]: g://authentication/tokens/developer-tokens
79+
[scope]: g://api-calls/permissions-and-errors/scopes
80+
[createapps]: g://applications/app-types/platform-apps
81+
[postman]: g://tooling/postman
82+
[authorization]: g://authorization
83+
[reauthorization]: g://authorization/custom-app-approval#re-authorization-on-changes

‎content/guides/ai-studio/images/ai-agent-capabilities.png‎

26.4 KB
Loading

‎content/guides/ai-studio/images/box-ai-app-scopes.png‎

197 KB
Loading

‎content/guides/ai-studio/index.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
rank: 0
3+
related_guides:
4+
- ai-studio/ai-studio-agents/create-agents
5+
- box-ai/ai-tutorials/ask-questions
6+
- box-ai/ai-tutorials/generate-text
7+
---
8+
9+
# Box AI Studio
10+
11+
<Messsage type='caution'>
12+
13+
Box AI Studio is available only for Enterprise Advanced accounts.
14+
15+
</Message>
16+
17+
[Box AI Studio][ai-studio] allows you to build and manage custom AI agents to
18+
best suit your business needs. For example, you can create an AI agent
19+
that acts as a compliance consultant, answering questions regarding customer
20+
documentation with the FedRAMP Moderate compliance in mind.
21+
22+
## Box AI Studio capabilities
23+
24+
Currently, you can configure Box AI agent to answer user questions or generate
25+
text you can use in your documents.
26+
27+
![ai agent capabilities](./images/ai-agent-capabilities.png)
28+
29+
## Supported languages
30+
31+
<!--alex ignore-->
32+
33+
Box AI studio works in a number of languages including
34+
English, Japanese, French, Spanish, and many more.
35+
However, the underlying models are primarily
36+
trained on English language documents. This means
37+
that prompts in other languages may return answers
38+
of lower quality than in English. Tests have shown
39+
satisfactory results for summarizing, checking grammar
40+
and spelling, and answering questions, but bear in mind
41+
that the results may be different than in English.
42+
43+
<!--alex enable-->
44+
45+
<Message type="tip">
46+
47+
<!--alex ignore-->
48+
49+
Switch the language to Japanese to get
50+
better results for this language.
51+
52+
</Message>
53+
54+
<!--alex enable-->
55+
56+
[ai-studio]: https://support.box.com/hc/en-us/articles/37228079461267-Enabling-Box-AI-Studio-and-Managing-Agents

0 commit comments

Comments
 (0)