Skip to content

AI Studio guides#681

Merged
superojla merged 24 commits intomainfrom
DDOC-1219-ai-studio
Feb 18, 2025
Merged

AI Studio guides#681
superojla merged 24 commits intomainfrom
DDOC-1219-ai-studio

Conversation

@superojla
Copy link
Copy Markdown
Collaborator

Create AI studio developer guides based on AI studio API.

Closes DDOC-1219

| `extract` | The AI Agent to be used for extraction. | |
| **`is_enterprise_default`** | If the agent is default for enterprise. | `false` |
| **`name`** | The name of the AI Agent. | `My AI Agent` |
| `text_gen` | The AI agent used for generating text. | |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we gather ask, extract and text_gen in three consecutive lines?

| **`name`** | The name of the AI Agent. | `My AI Agent` |
| `text_gen` | The AI agent used for generating text. | |

## Update AI agent
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if update and delete should be on separate pages, as the url includes just create-agents scope?

| `extract` | The AI Agent to be used for extraction. | |
| **`is_enterprise_default`** | If the agent is default for enterprise. | `false` |
| **`name`** | The name of the AI Agent. | `My AI Agent` |
| `text_gen` | The AI agent used for generating text. | |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we gather ask, extract and text_gen in three consecutive lines?

Comment thread content/guides/ai-studio/index.md Outdated
# Box AI Studio

<Messsage type='caution'>
Box AI Studio is available only for Enterprise Advance accounts.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enterprise Advanced, missing "d"

- box-ai/ai-tutorials/extract-metadata
---
# Create agents

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add legal info: Box AI Studio is available only for Enterprise Advanced accounts.

---

# Get agents

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add legal info Box AI Studio is available only for Enterprise Advanced accounts.

| `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` |
| `limit` | The maximum number of items to return per page. | `1000` |
| `marker` | Defines the position marker at which to begin returning results. | `JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii` |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have any additional information about those markers? This is not clear to me.

Comment thread content/guides/ai-studio/getting-started-ai-studio.md
or other clients, such as [Postman][postman], to make
calls.

<!-- This doc should include information on how to enable AI studio and what is needed to start working with the API. Similar doc is already created for Box AI:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this comment

[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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add information where those agents are later available for use, as this is not clear.

better results for this language.

</Message>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed in Box AI main guide there is Box AI API in User Activity Report (UAR) section, should we also inlcude it here?

@superojla superojla merged commit 282e483 into main Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants