Made changes

Author: Hawra

src/commands/ai/extract-structured.js

@@ -38,11 +38,11 @@ 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.';
+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.';
 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" --fields "key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name" --fields "key=lastName,type=string,description=Person last name,prompt=What is the last name?,displayName=Last name"',
-		'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","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"},"longText":{"embeddings":{ "model": "azure__openai__text_embedding_ada_002","strategy":{"id": "basic","numTokensPerChunk": 64}},"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model":"azure__openai__gpt_4o_mini","numTokensForCompletion":8400,"promptTemplate":"It is , consider these travel options and answer the.","systemMessage":"You are a helpful travel assistant specialized in budget travel"}}\'',
+	'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","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"}}}\'',
 ];
 AiExtractStructuredCommand._endpoint = 'post_ai_extract_structured';
 
@@ -76,7 +76,8 @@ AiExtractStructuredCommand.flags = {
 		},
 	}),
 	'metadata-template': Flags.string({
-		description: 'The metadata template containing the fields to extract. Example: {"type": "metadata_template", "scope": "enterprise", "template_key": "test"}',
+		description:
+			'The metadata template containing the fields to extract. Example: {"type": "metadata_template", "scope": "enterprise", "template_key": "test"}',
 		parse(input) {
 			const metadataTemplate = {
 				type: 'metadata_template',
@@ -106,14 +107,7 @@ AiExtractStructuredCommand.flags = {
 		multiple: true,
 		description: 'The fields to be extracted from the provided items.',
 		parse(input) {
-			const fields = {
-				key: '',
-				type: '',
-				description: '',
-				prompt: '',
-				displayName: '',
-				options: [],
-			};
+			const fields = {};
 
 			const obj = utils.parseStringToObject(input, [
 				'key',
@@ -163,7 +157,7 @@ AiExtractStructuredCommand.flags = {
 			try {
 				return JSON.parse(input);
 			} catch (error) {
-				throw ('Error parsing ai agent ', error);
+				throw ('Error parsing AI agent ', error);
 			}
 		},
 	}),

src/commands/ai/extract.js

@@ -1,12 +1,12 @@
 'use strict';
 
 const BoxCommand = require('../../box-command');
-const {Flags} = require('@oclif/core');
+const { Flags } = require('@oclif/core');
 const utils = require('../../util');
 
 class AiExtractCommand extends BoxCommand {
 	async run() {
-		const {flags} = await this.parse(AiExtractCommand);
+		const { flags } = await this.parse(AiExtractCommand);
 		let options = {};
 
 		if (flags.prompt) {
@@ -30,7 +30,7 @@ AiExtractCommand.description =
 	'Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs';
 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","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"},"longText":{"embeddings":{ "model": "azure__openai__text_embedding_ada_002","strategy":{"id": "basic","numTokensPerChunk": 64}},"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model":"azure__openai__gpt_4o_mini","numTokensForCompletion":8400,"promptTemplate":"It is , consider these travel options and answer the.","systemMessage":"You are a helpful travel assistant specialized in budget travel"}}\'',
+	'box ai:extract --prompt "firstName, lastName, location, yearOfBirth, company" --items "id=12345,type=file" --ai-agent \'{"type":"ai_agent_extract","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"}}}\'',
 ];
 AiExtractCommand._endpoint = 'post_ai_extract';
 
@@ -39,7 +39,8 @@ AiExtractCommand.flags = {
 	...BoxCommand.flags,
 	prompt: Flags.string({
 		required: true,
-		description: 'The prompt provided to a Large Language Model (LLM) in the request.',
+		description:
+			'The prompt provided to a Large Language Model (LLM) in the request.',
 	}),
 	items: Flags.string({
 		required: true,
@@ -68,9 +69,14 @@ AiExtractCommand.flags = {
 	}),
 	'ai-agent': Flags.string({
 		required: false,
-		description: 'The AI agent to be used for the extraction.',
+		description:
+			'The AI agent to be used for the extraction, provided as a JSON string. Example: {"type": "ai_agent_extract", "basic_text": {"model": "azure__openai__gpt_4o_mini", "prompt_template": "Answer the question based on {content}"}}',
 		parse(input) {
-			return JSON.parse(input);
+			try {
+				return JSON.parse(input);
+			} catch (error) {
+				throw ('Error parsing AI agent ', error);
+			}
 		},
 	}),
 };

test/commands/ai.test.js

@@ -230,7 +230,7 @@ describe('AI', () => {
 					description: 'Person first name',
 					prompt: 'What is the first name?',
 					displayName: 'First name',
-					options: [],
+					options: [{key:'First Name'}],
 				},
 			],
 		};
@@ -267,7 +267,7 @@ describe('AI', () => {
 			.command([
 				'ai:extract-structured',
 				'--items=content=one,two,three,id=12345,type=file',
-				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name',
+				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name,options=First Name',
 				'--json',
 				'--token=test',
 			])
@@ -289,7 +289,7 @@ describe('AI', () => {
 			.command([
 				'ai:extract-structured',
 				'--items=content=one,two,three,id=12345,type=file',
-				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name',
+				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name,options=First Name',
 				'--token=test',
 			])
 
@@ -317,7 +317,7 @@ describe('AI', () => {
 					description: 'Person first name',
 					prompt: 'What is the first name?',
 					displayName: 'First name',
-					options: [],
+					options: [{key:'First Name'}],
 				},
 			],
 			ai_agent: {
@@ -396,7 +396,7 @@ describe('AI', () => {
 			.command([
 				'ai:extract-structured',
 				'--items=content=one,two,three,id=12345,type=file',
-				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name',
+				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name,options=First Name',
 				'--ai-agent',
 				'{"type":"ai_agent_extract_structured","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"},"longText":{"embeddings":{ "model": "azure__openai__text_embedding_ada_002","strategy":{"id": "basic","numTokensPerChunk": 64}},"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model":"azure__openai__gpt_4o_mini","numTokensForCompletion":8400,"promptTemplate":"It is , consider these travel options and answer the.","systemMessage":"You are a helpful travel assistant specialized in budget travel"}}',
 				'--json',
@@ -420,7 +420,7 @@ describe('AI', () => {
 			.command([
 				'ai:extract-structured',
 				'--items=content=one,two,three,id=12345,type=file',
-				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name',
+				'--fields=key=firstName,type=string,description=Person first name,prompt=What is the first name?,displayName=First name,options=First Name',
 				'--ai-agent',
 				'{"type":"ai_agent_extract_structured","basicText":{"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model": "azure__openai__gpt_4o_mini","numTokensForCompletion": 8400,"promptTemplate": "It is, consider these travel options and answer the.","systemMessage": "You are a helpful travel assistant specialized in budget travel"},"longText":{"embeddings":{ "model": "azure__openai__text_embedding_ada_002","strategy":{"id": "basic","numTokensPerChunk": 64}},"llmEndpointParams":{"type":"openai_params","frequencyPenalty": 1.5,"presencePenalty": 1.5,"stop": "<|im_end|>","temperature": 0,"topP": 1},"model":"azure__openai__gpt_4o_mini","numTokensForCompletion":8400,"promptTemplate":"It is , consider these travel options and answer the.","systemMessage":"You are a helpful travel assistant specialized in budget travel"}}',
 				'--token=test',