diff --git a/README.md b/README.md index c916e0a5..dccdf5f4 100644 --- a/README.md +++ b/README.md @@ -198,7 +198,7 @@ Avatar URL: 'https://app.box.com/api/avatar/large/77777' # 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 diff --git a/docs/ai.md b/docs/ai.md index 990a3ee2..01c2dc08 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -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) @@ -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 @@ -39,7 +39,7 @@ FLAGS --save-to-file-path= 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?" @@ -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 @@ -79,7 +79,8 @@ FLAGS --save-to-file-path= 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" @@ -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 @@ -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" @@ -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 @@ -165,7 +166,8 @@ FLAGS --save-to-file-path= 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?" diff --git a/package.json b/package.json index 52f2f210..028b5138 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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": [ diff --git a/src/commands/ai/ask.js b/src/commands/ai/ask.js index 5d8ecbe7..abebf8a1 100644 --- a/src/commands/ai/ask.js +++ b/src/commands/ai/ask.js @@ -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?"', ]; diff --git a/src/commands/ai/extract-structured.js b/src/commands/ai/extract-structured.js index bb025a95..c965ec94 100644 --- a/src/commands/ai/extract-structured.js +++ b/src/commands/ai/extract-structured.js @@ -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"}}\'', diff --git a/src/commands/ai/extract.js b/src/commands/ai/extract.js index 9440e916..e85b8446 100644 --- a/src/commands/ai/extract.js +++ b/src/commands/ai/extract.js @@ -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"}}\'', diff --git a/src/commands/ai/text-gen.js b/src/commands/ai/text-gen.js index 4225cb71..c62bf0a4 100644 --- a/src/commands/ai/text-gen.js +++ b/src/commands/ai/text-gen.js @@ -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?"', ];