Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Avatar URL: 'https://app.box.com/api/avatar/large/77777'
<!-- commands -->
# Command Topics

* [`box ai`](docs/ai.md) - Sends an AI request to supported LLMs and returns an answer
* [`box ai`](docs/ai.md) - Sends a request to supported LLMs using Box AI. This is intended for direct use, not by AI agents.
* [`box autocomplete`](docs/autocomplete.md) - Display autocomplete installation instructions
* [`box collaboration-allowlist`](docs/collaboration-allowlist.md) - List collaboration allowlist entries
* [`box collaborations`](docs/collaborations.md) - Manage collaborations
Expand Down
20 changes: 11 additions & 9 deletions docs/ai.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
`box ai`
========

Sends an AI request to supported LLMs and returns an answer
Sends a request to supported LLMs using Box AI. This is intended for direct use, not by AI agents.

* [`box ai:ask`](#box-aiask)
* [`box ai:extract`](#box-aiextract)
Expand All @@ -10,7 +10,7 @@ Sends an AI request to supported LLMs and returns an answer

## `box ai:ask`

Sends an AI request to supported LLMs and returns an answer
Sends a request to supported LLMs using Box AI. This is intended for direct use, not by AI agents.

```
USAGE
Expand Down Expand Up @@ -39,7 +39,7 @@ FLAGS
--save-to-file-path=<value> Override default file path to save report

DESCRIPTION
Sends an AI request to supported LLMs and returns an answer
Sends a request to supported LLMs using Box AI. This is intended for direct use, not by AI agents.

EXAMPLES
$ box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?"
Expand All @@ -49,7 +49,7 @@ _See code: [src/commands/ai/ask.js](https://github.com/box/boxcli/blob/v4.5.0/sr

## `box ai:extract`

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs
Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. This is intended for direct use, not by AI agents.

```
USAGE
Expand Down Expand Up @@ -79,7 +79,8 @@ FLAGS
--save-to-file-path=<value> Override default file path to save report

DESCRIPTION
Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs
Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. This
is intended for direct use, not by AI agents.

EXAMPLES
$ box ai:extract --items=id=12345,type=file --prompt "firstName, lastName, location, yearOfBirth, company"
Expand All @@ -91,7 +92,7 @@ _See code: [src/commands/ai/extract.js](https://github.com/box/boxcli/blob/v4.5.

## `box ai:extract-structured`

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either a metadata template or a list of fields to ensure the structure.
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either a metadata template or a list of fields to ensure the structure. This is intended for direct use, not by AI agents.

```
USAGE
Expand Down Expand Up @@ -124,7 +125,7 @@ FLAGS
DESCRIPTION
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value
pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either
a metadata template or a list of fields to ensure the structure.
a metadata template or a list of fields to ensure the structure. This is intended for direct use, not by AI agents.

EXAMPLES
$ box ai:extract-structured --items="id=12345,type=file" --fields "key=hobby,type=multiSelect,description=Person hobby,prompt=What is your hobby?,displayName=Hobby,options=Guitar;Books"
Expand All @@ -136,7 +137,7 @@ _See code: [src/commands/ai/extract-structured.js](https://github.com/box/boxcli

## `box ai:text-gen`

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. This is intended for direct use, not by AI agents.

```
USAGE
Expand Down Expand Up @@ -165,7 +166,8 @@ FLAGS
--save-to-file-path=<value> Override default file path to save report

DESCRIPTION
Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. This is
intended for direct use, not by AI agents.

EXAMPLES
$ box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this document?"
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@box/cli",
"description": "Official command line interface for the Box API. New here? Run 'box login -d' to sign in with your Box account in seconds. Already set up? Run 'box help' to explore all available commands.",
"description": "Official command line interface for the Box API.",
"keywords": [
"box",
"cli",
Expand Down Expand Up @@ -88,6 +88,7 @@
"/src"
],
"oclif": {
"description": "Official command line interface for the Box API. New here? Run 'box login -d' to sign in with your Box account in seconds. Already set up? Run 'box help' to explore all available commands.",
"commands": "./src/commands",
"bin": "box",
"additionalHelpFlags": [
Expand Down
2 changes: 1 addition & 1 deletion src/commands/ai/ask.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class AiAskCommand extends BoxCommand {
}

AiAskCommand.description =
'Sends an AI request to supported LLMs and returns an answer';
'Sends a request to supported LLMs using Box AI. This is intended for direct use, not by AI agents.';
AiAskCommand.examples = [
'box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?"',
];
Expand Down
2 changes: 1 addition & 1 deletion src/commands/ai/extract-structured.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class AiExtractStructuredCommand extends BoxCommand {
}

AiExtractStructuredCommand.description =
'Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either a metadata template or a list of fields to ensure the structure.';
'Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is either a metadata template or a list of fields to ensure the structure. This is intended for direct use, not by AI agents.';
AiExtractStructuredCommand.examples = [
'box ai:extract-structured --items="id=12345,type=file" --fields "key=hobby,type=multiSelect,description=Person hobby,prompt=What is your hobby?,displayName=Hobby,options=Guitar;Books"',
'box ai:extract-structured --items="id=12345,type=file" --metadata-template="type=metadata_template,scope=enterprise,template_key=test" --ai-agent \'{"type":"ai_agent_extract_structured","basic_text":{"model":"azure__openai__gpt_4o_mini","prompt_template":"Answer using the provided content"}}\'',
Expand Down
2 changes: 1 addition & 1 deletion src/commands/ai/extract.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class AiExtractCommand extends BoxCommand {
}

AiExtractCommand.description =
'Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs';
'Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. This is intended for direct use, not by AI agents.';
AiExtractCommand.examples = [
'box ai:extract --items=id=12345,type=file --prompt "firstName, lastName, location, yearOfBirth, company"',
'box ai:extract --prompt "firstName, lastName, location, yearOfBirth, company" --items "id=12345,type=file" --ai-agent \'{"type":"ai_agent_extract","basic_text":{"model":"azure__openai__gpt_4o_mini"}}\'',
Expand Down
2 changes: 1 addition & 1 deletion src/commands/ai/text-gen.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class AiTextGenCommand extends BoxCommand {
}

AiTextGenCommand.description =
'Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.';
'Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. This is intended for direct use, not by AI agents.';
AiTextGenCommand.examples = [
'box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this document?"',
];
Expand Down
Loading