feat: Add hubs support to /ai/ask (box/box-codegen#656) (#507)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "7874ac3", "specHash": "1fdcbef", "version": "1.11.0" }
+{ "engineHash": "a88aabb", "specHash": "59747aa", "version": "1.11.0" }

docs/ai.md

@@ -22,16 +22,16 @@ await client.ai.createAiAsk({
   mode: 'multiple_item_qa' as AiAskModeField,
   prompt: 'Which direction sun rises?',
   items: [
-    new AiItemBase({
+    {
       id: fileToAsk1.id,
-      type: 'file' as AiItemBaseTypeField,
+      type: 'file' as AiItemAskTypeField,
       content: 'Earth goes around the sun',
-    }),
-    new AiItemBase({
+    } satisfies AiItemAsk,
+    {
       id: fileToAsk2.id,
-      type: 'file' as AiItemBaseTypeField,
+      type: 'file' as AiItemAskTypeField,
       content: 'Sun rises in the East in the morning',
-    }),
+    } satisfies AiItemAsk,
   ],
 } satisfies AiAsk);
 ```
@@ -45,9 +45,9 @@ await client.ai.createAiAsk({
 
 ### Returns
 
-This function returns a value of type `AiResponseFull`.
+This function returns a value of type `undefined | AiResponseFull`.
 
-A successful response including the answer from the LLM.
+A successful response including the answer from the LLM.No content is available to answer the question. This is returned when the request item is a hub, but content in the hubs is not indexed. To ensure content in the hub is indexed, make sure Box AI for Hubs in the Admin Console was enabled before hub creation.
 
 ## Generate text
 

package-lock.json

@@ -317,12 +317,12 @@ export class AiManager {
    * Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
    * @param {AiAsk} requestBody Request body of createAiAsk method
    * @param {CreateAiAskOptionalsInput} optionalsInput
-   * @returns {Promise<AiResponseFull>}
+   * @returns {Promise<undefined | AiResponseFull>}
    */
   async createAiAsk(
     requestBody: AiAsk,
     optionalsInput: CreateAiAskOptionalsInput = {},
-  ): Promise<AiResponseFull> {
+  ): Promise<undefined | AiResponseFull> {
     const optionals: CreateAiAskOptionals = new CreateAiAskOptionals({
       headers: optionalsInput.headers,
       cancellationToken: optionalsInput.cancellationToken,
@@ -349,6 +349,9 @@ export class AiManager {
           cancellationToken: cancellationToken,
         }),
       );
+    if ((toString(response.status) as string) == '204') {
+      return void 0;
+    }
     return {
       ...deserializeAiResponseFull(response.data!),
       rawData: response.data!,

src/managers/ai.generated.ts

@@ -1,10 +1,10 @@
-import { serializeAiItemBase } from './aiItemBase.generated.js';
-import { deserializeAiItemBase } from './aiItemBase.generated.js';
+import { serializeAiItemAsk } from './aiItemAsk.generated.js';
+import { deserializeAiItemAsk } from './aiItemAsk.generated.js';
 import { serializeAiDialogueHistory } from './aiDialogueHistory.generated.js';
 import { deserializeAiDialogueHistory } from './aiDialogueHistory.generated.js';
 import { serializeAiAgentAsk } from './aiAgentAsk.generated.js';
 import { deserializeAiAgentAsk } from './aiAgentAsk.generated.js';
-import { AiItemBase } from './aiItemBase.generated.js';
+import { AiItemAsk } from './aiItemAsk.generated.js';
 import { AiDialogueHistory } from './aiDialogueHistory.generated.js';
 import { AiAgentAsk } from './aiAgentAsk.generated.js';
 import { BoxSdkError } from '../box/errors.js';
@@ -29,7 +29,7 @@ export interface AiAsk {
    * **Note**: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.
    * If the file size exceeds 1MB, the first 1MB of text representation will be processed.
    * If you set `mode` parameter to `single_item_qa`, the `items` array can have one element only.  */
-  readonly items: readonly AiItemBase[];
+  readonly items: readonly AiItemAsk[];
   /**
    * The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response. */
   readonly dialogueHistory?: readonly AiDialogueHistory[];
@@ -58,8 +58,8 @@ export function serializeAiAsk(val: AiAsk): SerializedData {
   return {
     ['mode']: serializeAiAskModeField(val.mode),
     ['prompt']: val.prompt,
-    ['items']: val.items.map(function (item: AiItemBase): SerializedData {
-      return serializeAiItemBase(item);
+    ['items']: val.items.map(function (item: AiItemAsk): SerializedData {
+      return serializeAiItemAsk(item);
     }) as readonly any[],
     ['dialogue_history']:
       val.dialogueHistory == void 0
@@ -105,9 +105,9 @@ export function deserializeAiAsk(val: SerializedData): AiAsk {
       message: 'Expecting array for "items" of type "AiAsk"',
     });
   }
-  const items: readonly AiItemBase[] = sdIsList(val.items)
-    ? (val.items.map(function (itm: SerializedData): AiItemBase {
-        return deserializeAiItemBase(itm);
+  const items: readonly AiItemAsk[] = sdIsList(val.items)
+    ? (val.items.map(function (itm: SerializedData): AiItemAsk {
+        return deserializeAiItemAsk(itm);
       }) as readonly any[])
     : [];
   if (!(val.dialogue_history == void 0) && !sdIsList(val.dialogue_history)) {

src/schemas/aiAsk.generated.ts

@@ -0,0 +1,74 @@
+import { BoxSdkError } from '../box/errors.js';
+import { SerializedData } from '../serialization/json.js';
+import { sdIsEmpty } from '../serialization/json.js';
+import { sdIsBoolean } from '../serialization/json.js';
+import { sdIsNumber } from '../serialization/json.js';
+import { sdIsString } from '../serialization/json.js';
+import { sdIsList } from '../serialization/json.js';
+import { sdIsMap } from '../serialization/json.js';
+export type AiItemAskTypeField = 'file' | 'hubs';
+export interface AiItemAsk {
+  /**
+   * The ID of the file. */
+  readonly id: string;
+  /**
+   * The type of the item. A `hubs` item must be used as a single item. */
+  readonly type: AiItemAskTypeField;
+  /**
+   * The content of the item, often the text representation. */
+  readonly content?: string;
+  readonly rawData?: SerializedData;
+}
+export function serializeAiItemAskTypeField(
+  val: AiItemAskTypeField,
+): SerializedData {
+  return val;
+}
+export function deserializeAiItemAskTypeField(
+  val: SerializedData,
+): AiItemAskTypeField {
+  if (val == 'file') {
+    return val;
+  }
+  if (val == 'hubs') {
+    return val;
+  }
+  throw new BoxSdkError({ message: "Can't deserialize AiItemAskTypeField" });
+}
+export function serializeAiItemAsk(val: AiItemAsk): SerializedData {
+  return {
+    ['id']: val.id,
+    ['type']: serializeAiItemAskTypeField(val.type),
+    ['content']: val.content,
+  };
+}
+export function deserializeAiItemAsk(val: SerializedData): AiItemAsk {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({ message: 'Expecting a map for "AiItemAsk"' });
+  }
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message: 'Expecting "id" of type "AiItemAsk" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "id" of type "AiItemAsk"',
+    });
+  }
+  const id: string = val.id;
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message: 'Expecting "type" of type "AiItemAsk" to be defined',
+    });
+  }
+  const type: AiItemAskTypeField = deserializeAiItemAskTypeField(val.type);
+  if (!(val.content == void 0) && !sdIsString(val.content)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "content" of type "AiItemAsk"',
+    });
+  }
+  const content: undefined | string =
+    val.content == void 0 ? void 0 : val.content;
+  return { id: id, type: type, content: content } satisfies AiItemAsk;
+}

src/schemas/aiItemAsk.generated.ts

@@ -6,10 +6,10 @@ import { serializeAiAsk } from '../schemas/aiAsk.generated.js';
 import { deserializeAiAsk } from '../schemas/aiAsk.generated.js';
 import { serializeAiAskModeField } from '../schemas/aiAsk.generated.js';
 import { deserializeAiAskModeField } from '../schemas/aiAsk.generated.js';
-import { serializeAiItemBase } from '../schemas/aiItemBase.generated.js';
-import { deserializeAiItemBase } from '../schemas/aiItemBase.generated.js';
-import { serializeAiItemBaseTypeField } from '../schemas/aiItemBase.generated.js';
-import { deserializeAiItemBaseTypeField } from '../schemas/aiItemBase.generated.js';
+import { serializeAiItemAsk } from '../schemas/aiItemAsk.generated.js';
+import { deserializeAiItemAsk } from '../schemas/aiItemAsk.generated.js';
+import { serializeAiItemAskTypeField } from '../schemas/aiItemAsk.generated.js';
+import { deserializeAiItemAskTypeField } from '../schemas/aiItemAsk.generated.js';
 import { serializeAiResponse } from '../schemas/aiResponse.generated.js';
 import { deserializeAiResponse } from '../schemas/aiResponse.generated.js';
 import { serializeAiTextGen } from '../schemas/aiTextGen.generated.js';
@@ -32,6 +32,8 @@ import { serializeUploadFileRequestBodyAttributesParentField } from '../managers
 import { deserializeUploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js';
 import { serializeAiExtract } from '../schemas/aiExtract.generated.js';
 import { deserializeAiExtract } from '../schemas/aiExtract.generated.js';
+import { serializeAiItemBase } from '../schemas/aiItemBase.generated.js';
+import { deserializeAiItemBase } from '../schemas/aiItemBase.generated.js';
 import { serializeAiExtractStructuredResponse } from '../schemas/aiExtractStructuredResponse.generated.js';
 import { deserializeAiExtractStructuredResponse } from '../schemas/aiExtractStructuredResponse.generated.js';
 import { serializeAiExtractStructured } from '../schemas/aiExtractStructured.generated.js';
@@ -67,8 +69,8 @@ import { FileFull } from '../schemas/fileFull.generated.js';
 import { AiResponseFull } from '../schemas/aiResponseFull.generated.js';
 import { AiAsk } from '../schemas/aiAsk.generated.js';
 import { AiAskModeField } from '../schemas/aiAsk.generated.js';
-import { AiItemBase } from '../schemas/aiItemBase.generated.js';
-import { AiItemBaseTypeField } from '../schemas/aiItemBase.generated.js';
+import { AiItemAsk } from '../schemas/aiItemAsk.generated.js';
+import { AiItemAskTypeField } from '../schemas/aiItemAsk.generated.js';
 import { AiResponse } from '../schemas/aiResponse.generated.js';
 import { AiTextGen } from '../schemas/aiTextGen.generated.js';
 import { AiTextGenItemsField } from '../schemas/aiTextGen.generated.js';
@@ -82,6 +84,7 @@ import { UploadFileRequestBody } from '../managers/uploads.generated.js';
 import { UploadFileRequestBodyAttributesField } from '../managers/uploads.generated.js';
 import { UploadFileRequestBodyAttributesParentField } from '../managers/uploads.generated.js';
 import { AiExtract } from '../schemas/aiExtract.generated.js';
+import { AiItemBase } from '../schemas/aiItemBase.generated.js';
 import { AiExtractStructuredResponse } from '../schemas/aiExtractStructuredResponse.generated.js';
 import { AiExtractStructured } from '../schemas/aiExtractStructured.generated.js';
 import { AiExtractStructuredFieldsField } from '../schemas/aiExtractStructured.generated.js';
@@ -118,48 +121,48 @@ import { sdIsMap } from '../serialization/json.js';
 export const client: BoxClient = getDefaultClient();
 test('testAskAISingleItem', async function testAskAISingleItem(): Promise<any> {
   const fileToAsk: FileFull = await uploadNewFile();
-  const response: AiResponseFull = await client.ai.createAiAsk({
+  const response: undefined | AiResponseFull = await client.ai.createAiAsk({
     mode: 'single_item_qa' as AiAskModeField,
     prompt: 'which direction sun rises',
     items: [
-      new AiItemBase({
+      {
         id: fileToAsk.id,
-        type: 'file' as AiItemBaseTypeField,
+        type: 'file' as AiItemAskTypeField,
         content: 'Sun rises in the East',
-      }),
+      } satisfies AiItemAsk,
     ],
   } satisfies AiAsk);
-  if (!(response.answer.includes('East') as boolean)) {
+  if (!(response!.answer.includes('East') as boolean)) {
     throw new Error('Assertion failed');
   }
-  if (!(response.completionReason == 'done')) {
+  if (!(response!.completionReason == 'done')) {
     throw new Error('Assertion failed');
   }
   await client.files.deleteFileById(fileToAsk.id);
 });
 test('testAskAIMultipleItems', async function testAskAIMultipleItems(): Promise<any> {
   const fileToAsk1: FileFull = await uploadNewFile();
   const fileToAsk2: FileFull = await uploadNewFile();
-  const response: AiResponseFull = await client.ai.createAiAsk({
+  const response: undefined | AiResponseFull = await client.ai.createAiAsk({
     mode: 'multiple_item_qa' as AiAskModeField,
     prompt: 'Which direction sun rises?',
     items: [
-      new AiItemBase({
+      {
         id: fileToAsk1.id,
-        type: 'file' as AiItemBaseTypeField,
+        type: 'file' as AiItemAskTypeField,
         content: 'Earth goes around the sun',
-      }),
-      new AiItemBase({
+      } satisfies AiItemAsk,
+      {
         id: fileToAsk2.id,
-        type: 'file' as AiItemBaseTypeField,
+        type: 'file' as AiItemAskTypeField,
         content: 'Sun rises in the East in the morning',
-      }),
+      } satisfies AiItemAsk,
     ],
   } satisfies AiAsk);
-  if (!(response.answer.includes('East') as boolean)) {
+  if (!(response!.answer.includes('East') as boolean)) {
     throw new Error('Assertion failed');
   }
-  if (!(response.completionReason == 'done')) {
+  if (!(response!.completionReason == 'done')) {
     throw new Error('Assertion failed');
   }
   await client.files.deleteFileById(fileToAsk1.id);