diff --git a/content/guides/ai-studio/ai-studio-agents/create-agents.md b/content/guides/ai-studio/ai-studio-agents/create-agents.md new file mode 100644 index 000000000..ae2481718 --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/create-agents.md @@ -0,0 +1,52 @@ +--- +rank: 1 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Create agents + + + +Box AI Studio is available only for Enterprise Advanced accounts. + + + +The `POST/2.0/ai_agents` endpoint allows you to create a new, custom [AI agent][agents]. + +## Send a request + +To send a request, use the `POST/2.0/ai_agents` endpoint. + +Make sure you have generated the developer token +to authorize your app. See [getting started with Box AI][prereq] +for details. + + + +### Parameters + +To make a call, you must pass the following parameters. Mandatory parameters are in **bold**. + + + +| Parameter| Description| Example| +|--------|--------|-------| +| **`type`** | The type of agent used to handle queries. | `ai_agent` | +| **`name`** | The name of the AI Agent. | `My AI Agent` | +| **`access_state`** | The state of the AI Agent. Value is one of `enabled` `disabled`. | `enabled` | +| `icon_reference` | The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/` , 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` | +| `allowed_entities` | List of allowed users or groups. | | +| `ask` | The AI Agent to be used for ask. | `ask` | +| `extract` | The AI Agent to be used for extraction. | | +| `text_gen` | The AI agent used for generating text. | | + + + +[agents]: g://box-ai/ai-agents/index +[prereq]: g://ai-studio/getting-started-ai-studio diff --git a/content/guides/ai-studio/ai-studio-agents/delete-agents.md b/content/guides/ai-studio/ai-studio-agents/delete-agents.md new file mode 100644 index 000000000..cef0426a7 --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/delete-agents.md @@ -0,0 +1,28 @@ +--- +rank: 5 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Delete AI agent + +The `DELETE/2.0/ai_agents/{id}` endpoint allows you to delete a custom AI agent based on its ID. + +## Send a request + +To send a request, use the `DELETE/2.0/ai_agents/{id}` endpoint. + + + +### Parameters + +To make a call, you must pass the following parameters. Mandatory parameters are in **bold**. + +| Parameter| Description| Example| +|--------|--------|-------| +| **`agent_id`** | The ID of the agent to delete. | `1234` | diff --git a/content/guides/ai-studio/ai-studio-agents/get-agent-id.md b/content/guides/ai-studio/ai-studio-agents/get-agent-id.md new file mode 100644 index 000000000..b7bc0522c --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/get-agent-id.md @@ -0,0 +1,30 @@ +--- +rank: 3 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Get AI agent by ID + +The `GET/2.0/ai_agents/{id}` endpoint allows you to list a specific AI +agent by the `agent_id` parameter. + +## Send a request + +To send a request, use the `GET/2.0/ai_agents/{id}` endpoint. + + + +### Parameters + +To make a call, you must pass the following parameters. Mandatory parameters are in **bold**. + +| Parameter| Description| Example| +|--------|--------|-------| +| **`agent_id`** | The agent id to get. | `1234` | +| `fields` | The fields to return in the response. | `ask` | diff --git a/content/guides/ai-studio/ai-studio-agents/get-agents.md b/content/guides/ai-studio/ai-studio-agents/get-agents.md new file mode 100644 index 000000000..a13acaf27 --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/get-agents.md @@ -0,0 +1,48 @@ +--- +rank: 2 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Get agents + + + +Box AI Studio is available only for Enterprise Advanced accounts. + + + +## List all AI agents + +The `GET/2.0/ai_agents` endpoint allows you to list all AI agents based on the provided parameters. + +### Send a request + +To send a request, use the `GET/2.0/ai_agents` endpoint. + +Make sure you have generated the developer token +to authorize your app. See [getting started with Box AI Studio][getting-started] +for details. + + + +#### Parameters + +To make a call, you must pass the following parameters. Mandatory parameters are in **bold**. + +| Parameter| Description| Example| +|--------|--------|-------| +| `mode` | The mode to filter the agent configuration to return. Possible values are: `ask`, `text_gen`, and `extract`. | `ask` | +| `fields` | The fields to return in the response. | `ask` | +| `agent_state` | The state of the agent to return. Value is one of `enabled`,`disabled`. | `enabled` | +| `fields` | The fields to return in the response. Value is one of `ask`, `text_gen`, `extract`. | `ask` | +| `include_box_default` | Whether to include the Box default agents in the response. | `true` | +| `limit` | The maximum number of items to return per page. | `1000` | +| `marker` | Defines the position marker at which to begin returning results. | `JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii` | + +[getting-started]: g://ai-studio/getting-started-ai-studio diff --git a/content/guides/ai-studio/ai-studio-agents/index.md b/content/guides/ai-studio/ai-studio-agents/index.md new file mode 100644 index 000000000..90f829665 --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/index.md @@ -0,0 +1,17 @@ +--- +rank: 0 +related_guides: + - ai-studio/ai-studio-agents/create-agents + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/generate-text +--- + +# AI studio agents + + + +Box AI Studio is available only for Enterprise Advanced accounts. + + + +Create, list, update, and delete custom AI agents. diff --git a/content/guides/ai-studio/ai-studio-agents/update-agents.md b/content/guides/ai-studio/ai-studio-agents/update-agents.md new file mode 100644 index 000000000..1aa45c57f --- /dev/null +++ b/content/guides/ai-studio/ai-studio-agents/update-agents.md @@ -0,0 +1,39 @@ +--- +rank: 4 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Update AI agent + +The `PUT/2.0/ai_agents/{id}` endpoint allows you to update a custom AI agent based on its ID. + +## Send a request + +To send a request, use the `PUT/2.0/ai_agents/{id}` endpoint. + + + +### Parameters + +To make a call, you must pass the following parameters. Mandatory parameters are in **bold**. + + + +| Parameter| Description| Example| +|--------|--------|-------| +| **`type`** | The type of agent used to handle queries. | ```` | +| **`name`**| The name of the AI Agent. | My AI Agent | +| **`access_state`** | The state of the AI Agent. Value is one of `enabled` `disabled`. | `enabled` | +| `icon_reference` | The icon reference of the AI Agent. It should have format of the URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`, 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` | +| `allowed_entities` | List of allowed users or groups. | +| `ask` | The AI Agent to be used for ask. | `ask` | +| `extract` | The AI Agent to be used for extraction. | | +| `text_gen` | The AI agent used for generating text. | | + + diff --git a/content/guides/ai-studio/getting-started-ai-studio.md b/content/guides/ai-studio/getting-started-ai-studio.md new file mode 100644 index 000000000..fa0da03e8 --- /dev/null +++ b/content/guides/ai-studio/getting-started-ai-studio.md @@ -0,0 +1,83 @@ +--- +rank: 1 +related_guides: + - authentication/tokens/developer-tokens/ + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/default-agent-overrides + - box-ai/ai-tutorials/generate-text + - box-ai/ai-tutorials/extract-metadata-structured + - box-ai/ai-tutorials/extract-metadata +--- + +# Get started with AI studio + + + +Box AI Studio is available only for Enterprise Advanced accounts. + + + +To start creating custom AI agents with AI studio you need a platform +application with enabled Box AI scope and a developer token to +authenticate your calls. + +## Create a custom application + +First you need to create a platform application you will use to make calls. To +create an application, follow the guide on [creating platform apps][createapps]. + +## Enable Box AI studio + +To use Box AI studio, make sure it is enabled by a Box admin in the Admin +Console. +If you are a Box Admin, you will find the necessary information in +[Enabling Box AI Studio and Managing Agents][enable]. + +To interact with Box AI API, you need the `ai.readwrite` [scope][scope] +added for your application. Before you add the scope, make sure that the Box +Admin has granted you the access to Box AI API. If you can't see the +**Manage AI** option in your app configuration settings, contact your admin. + +To add a scope: + +1. Open your application in Developer Console. +2. Go to **Configuration** > **Required Access Scopes** > **Content Actions** +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. + + ![box ai scopes](./images/box-ai-app-scopes.png) + +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. + +## Generate a developer token + +You need a developer token +to authenticate your app when sending requests. + +To generate a token: + +1. Go to **Developer Console** > **My Platform Apps**. +2. Click the **Options menu** button (…) on the right. +3. Select **Generate Developer Token**. The token will be automatically generated and saved to clipboard. + +![generate token](../images/developer-token.png) + +You can also open your app, go to +**Configuration** > **Developer Token** +and generate the token. + + +A developer token is only valid for one hour. + + +For additional details, see [developer token][token]. +After you generate the token, you can use it in cURL +or other clients, such as [Postman][postman], to make +calls. + +[enable]: https://support.box.com/hc/en-us/articles/37228079461267-Enabling-Box-AI-Studio-and-Managing-Agents/#h_01JH9HAMP43YYN6VWM51QCK413 +[token]: g://authentication/tokens/developer-tokens +[scope]: g://api-calls/permissions-and-errors/scopes +[createapps]: g://applications/app-types/platform-apps +[postman]: g://tooling/postman +[authorization]: g://authorization +[reauthorization]: g://authorization/custom-app-approval#re-authorization-on-changes diff --git a/content/guides/ai-studio/images/ai-agent-capabilities.png b/content/guides/ai-studio/images/ai-agent-capabilities.png new file mode 100644 index 000000000..8422c7f97 Binary files /dev/null and b/content/guides/ai-studio/images/ai-agent-capabilities.png differ diff --git a/content/guides/ai-studio/images/box-ai-app-scopes.png b/content/guides/ai-studio/images/box-ai-app-scopes.png new file mode 100644 index 000000000..1fc423b9a Binary files /dev/null and b/content/guides/ai-studio/images/box-ai-app-scopes.png differ diff --git a/content/guides/ai-studio/index.md b/content/guides/ai-studio/index.md new file mode 100644 index 000000000..515e5eadd --- /dev/null +++ b/content/guides/ai-studio/index.md @@ -0,0 +1,56 @@ +--- +rank: 0 +related_guides: + - ai-studio/ai-studio-agents/create-agents + - box-ai/ai-tutorials/ask-questions + - box-ai/ai-tutorials/generate-text +--- + +# Box AI Studio + + + +Box AI Studio is available only for Enterprise Advanced accounts. + + + +[Box AI Studio][ai-studio] allows you to build and manage custom AI agents to +best suit your business needs. For example, you can create an AI agent +that acts as a compliance consultant, answering questions regarding customer +documentation with the FedRAMP Moderate compliance in mind. + +## Box AI Studio capabilities + +Currently, you can configure Box AI agent to answer user questions or generate +text you can use in your documents. + +![ai agent capabilities](./images/ai-agent-capabilities.png) + +## Supported languages + + + +Box AI studio works in a number of languages including +English, Japanese, French, Spanish, and many more. +However, the underlying models are primarily +trained on English language documents. This means +that prompts in other languages may return answers +of lower quality than in English. Tests have shown +satisfactory results for summarizing, checking grammar +and spelling, and answering questions, but bear in mind +that the results may be different than in English. + + + + + + + +Switch the language to Japanese to get +better results for this language. + + + + + +[ai-studio]: https://support.box.com/hc/en-us/articles/37228079461267-Enabling-Box-AI-Studio-and-Managing-Agents