box-node-sdk/src/schemas/aiAsk.ts

Official SDK for Box Platform APIs

import { serializeAiAgentReference } from './aiAgentReference';
import { deserializeAiAgentReference } from './aiAgentReference';
import { serializeAiAgentAsk } from './aiAgentAsk';
import { deserializeAiAgentAsk } from './aiAgentAsk';
import { serializeAiItemAsk } from './aiItemAsk';
import { deserializeAiItemAsk } from './aiItemAsk';
import { serializeAiDialogueHistory } from './aiDialogueHistory';
import { deserializeAiDialogueHistory } from './aiDialogueHistory';
import { serializeAiAskAgent } from './aiAskAgent';
import { deserializeAiAskAgent } from './aiAskAgent';
import { AiAgentReference } from './aiAgentReference';
import { AiAgentAsk } from './aiAgentAsk';
import { AiItemAsk } from './aiItemAsk';
import { AiDialogueHistory } from './aiDialogueHistory';
import { AiAskAgent } from './aiAskAgent';
import { BoxSdkError } from '../box/errors';
import { SerializedData } from '../serialization/json';
import { sdIsEmpty } from '../serialization/json';
import { sdIsBoolean } from '../serialization/json';
import { sdIsNumber } from '../serialization/json';
import { sdIsString } from '../serialization/json';
import { sdIsList } from '../serialization/json';
import { sdIsMap } from '../serialization/json';
export type AiAskModeField = 'multiple_item_qa' | 'single_item_qa' | string;
export interface AiAsk {
  /**
   * Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files,
   * whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed.
   * Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages
   * for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will
   * be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only.
   * Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only
   * process the text. */
  readonly mode: AiAskModeField;
  /**
   * The prompt provided by the client to be answered by the LLM.
   * The prompt's length is limited to 10000 characters. */
  readonly prompt: string;
  /**
   * The items to be processed by the LLM, often files. */
  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[];
  /**
   * A flag to indicate whether citations should be returned. */
  readonly includeCitations?: boolean;
  readonly aiAgent?: AiAskAgent;
  readonly rawData?: SerializedData;
}
export function serializeAiAskModeField(val: AiAskModeField): SerializedData {
  return val;
}
export function deserializeAiAskModeField(val: SerializedData): AiAskModeField {
  if (val == 'multiple_item_qa') {
    return val;
  }
  if (val == 'single_item_qa') {
    return val;
  }
  if (sdIsString(val)) {
    return val;
  }
  throw new BoxSdkError({ message: "Can't deserialize AiAskModeField" });
}
export function serializeAiAsk(val: AiAsk): SerializedData {
  return {
    ['mode']: serializeAiAskModeField(val.mode),
    ['prompt']: val.prompt,
    ['items']: val.items.map(function (item: AiItemAsk): SerializedData {
      return serializeAiItemAsk(item);
    }) as readonly any[],
    ['dialogue_history']:
      val.dialogueHistory == void 0
        ? val.dialogueHistory
        : (val.dialogueHistory.map(function (
            item: AiDialogueHistory,
          ): SerializedData {
            return serializeAiDialogueHistory(item);
          }) as readonly any[]),
    ['include_citations']: val.includeCitations,
    ['ai_agent']:
      val.aiAgent == void 0 ? val.aiAgent : serializeAiAskAgent(val.aiAgent),
  };
}
export function deserializeAiAsk(val: SerializedData): AiAsk {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({ message: 'Expecting a map for "AiAsk"' });
  }
  if (val.mode == void 0) {
    throw new BoxSdkError({
      message: 'Expecting "mode" of type "AiAsk" to be defined',
    });
  }
  const mode: AiAskModeField = deserializeAiAskModeField(val.mode);
  if (val.prompt == void 0) {
    throw new BoxSdkError({
      message: 'Expecting "prompt" of type "AiAsk" to be defined',
    });
  }
  if (!sdIsString(val.prompt)) {
    throw new BoxSdkError({
      message: 'Expecting string for "prompt" of type "AiAsk"',
    });
  }
  const prompt: string = val.prompt;
  if (val.items == void 0) {
    throw new BoxSdkError({
      message: 'Expecting "items" of type "AiAsk" to be defined',
    });
  }
  if (!sdIsList(val.items)) {
    throw new BoxSdkError({
      message: 'Expecting array for "items" of type "AiAsk"',
    });
  }
  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)) {
    throw new BoxSdkError({
      message: 'Expecting array for "dialogue_history" of type "AiAsk"',
    });
  }
  const dialogueHistory: undefined | readonly AiDialogueHistory[] =
    val.dialogue_history == void 0
      ? void 0
      : sdIsList(val.dialogue_history)
        ? (val.dialogue_history.map(function (
            itm: SerializedData,
          ): AiDialogueHistory {
            return deserializeAiDialogueHistory(itm);
          }) as readonly any[])
        : [];
  if (
    !(val.include_citations == void 0) &&
    !sdIsBoolean(val.include_citations)
  ) {
    throw new BoxSdkError({
      message: 'Expecting boolean for "include_citations" of type "AiAsk"',
    });
  }
  const includeCitations: undefined | boolean =
    val.include_citations == void 0 ? void 0 : val.include_citations;
  const aiAgent: undefined | AiAskAgent =
    val.ai_agent == void 0 ? void 0 : deserializeAiAskAgent(val.ai_agent);
  return {
    mode: mode,
    prompt: prompt,
    items: items,
    dialogueHistory: dialogueHistory,
    includeCitations: includeCitations,
    aiAgent: aiAgent,
  } satisfies AiAsk;
}