librechat-data-provider 0.7.4 → 0.7.7

package/src/types/agents.ts

@@ -0,0 +1,276 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import { StepTypes, ContentTypes, ToolCallTypes } from './runs';
+import type { FunctionToolCall } from './assistants';
+import type { TAttachment } from 'src/schemas';
+
+export namespace Agents {
+  export type MessageType = 'human' | 'ai' | 'generic' | 'system' | 'function' | 'tool' | 'remove';
+
+  export type ImageDetail = 'auto' | 'low' | 'high';
+
+  export type ReasoningContentText = {
+    type: ContentTypes.THINK;
+    think: string;
+  };
+
+  export type MessageContentText = {
+    type: ContentTypes.TEXT;
+    text: string;
+    tool_call_ids?: string[];
+  };
+
+  export type MessageContentImageUrl = {
+    type: ContentTypes.IMAGE_URL;
+    image_url: string | { url: string; detail?: ImageDetail };
+  };
+
+  export type MessageContentComplex =
+    | ReasoningContentText
+    | MessageContentText
+    | MessageContentImageUrl
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | (Record<string, any> & { type?: ContentTypes | string })
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    | (Record<string, any> & { type?: never });
+
+  export type MessageContent = string | MessageContentComplex[];
+
+  /**
+   * A call to a tool.
+   */
+  export type ToolCall = {
+    /** Type ("tool_call") according to Assistants Tool Call Structure */
+    type: ToolCallTypes.TOOL_CALL;
+    /** The name of the tool to be called */
+    name: string;
+
+    /** The arguments to the tool call */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    args?: string | Record<string, any>;
+
+    /** If provided, an identifier associated with the tool call */
+    id?: string;
+    /** If provided, the output of the tool call */
+    output?: string;
+    /** Auth URL */
+    auth?: string;
+    /** Expiration time */
+    expires_at?: number;
+  };
+
+  export type ToolEndEvent = {
+    /** The Step Id of the Tool Call */
+    id: string;
+    /** The Completed Tool Call */
+    tool_call?: ToolCall;
+    /** The content index of the tool call */
+    index: number;
+  };
+
+  export type ToolCallContent = {
+    type: ContentTypes.TOOL_CALL;
+    tool_call?: ToolCall;
+  };
+
+  /**
+   * A chunk of a tool call (e.g., as part of a stream).
+   * When merging ToolCallChunks (e.g., via AIMessageChunk.__add__),
+   * all string attributes are concatenated. Chunks are only merged if their
+   * values of `index` are equal and not None.
+   *
+   * @example
+   * ```ts
+   * const leftChunks = [
+   *   {
+   *     name: "foo",
+   *     args: '{"a":',
+   *     index: 0
+   *   }
+   * ];
+   *
+   * const leftAIMessageChunk = new AIMessageChunk({
+   *   content: "",
+   *   tool_call_chunks: leftChunks
+   * });
+   *
+   * const rightChunks = [
+   *   {
+   *     name: undefined,
+   *     args: '1}',
+   *     index: 0
+   *   }
+   * ];
+   *
+   * const rightAIMessageChunk = new AIMessageChunk({
+   *   content: "",
+   *   tool_call_chunks: rightChunks
+   * });
+   *
+   * const result = leftAIMessageChunk.concat(rightAIMessageChunk);
+   * // result.tool_call_chunks is equal to:
+   * // [
+   * //   {
+   * //     name: "foo",
+   * //     args: '{"a":1}'
+   * //     index: 0
+   * //   }
+   * // ]
+   * ```
+   *
+   * @property {string} [name] - If provided, a substring of the name of the tool to be called
+   * @property {string} [args] - If provided, a JSON substring of the arguments to the tool call
+   * @property {string} [id] - If provided, a substring of an identifier for the tool call
+   * @property {number} [index] - If provided, the index of the tool call in a sequence
+   */
+  export type ToolCallChunk = {
+    name?: string;
+
+    args?: string;
+
+    id?: string;
+
+    index?: number;
+
+    type?: 'tool_call_chunk';
+  };
+
+  /** Event names are of the format: on_[runnable_type]_(start|stream|end).
+
+  Runnable types are one of:
+
+  llm - used by non chat models
+  chat_model - used by chat models
+  prompt -- e.g., ChatPromptTemplate
+  tool -- LangChain tools
+  chain - most Runnables are of this type
+  Further, the events are categorized as one of:
+
+  start - when the runnable starts
+  stream - when the runnable is streaming
+  end - when the runnable ends
+  start, stream and end are associated with slightly different data payload.
+
+  Please see the documentation for EventData for more details. */
+  export type EventName = string;
+  export type RunStep = {
+    type: StepTypes;
+    id: string; // #new
+    runId?: string; // #new
+    index: number; // #new
+    stepIndex?: number; // #new
+    stepDetails: StepDetails;
+    usage: null | {
+      // Define usage structure if it's ever non-null
+      // prompt_tokens: number; // #new
+      // completion_tokens: number; // #new
+      // total_tokens: number; // #new
+    };
+  };
+  /**
+   * Represents a run step delta i.e. any changed fields on a run step during
+   * streaming.
+   */
+  export interface RunStepDeltaEvent {
+    /**
+     * The identifier of the run step, which can be referenced in API endpoints.
+     */
+    id: string;
+    /**
+     * The delta containing the fields that have changed on the run step.
+     */
+    delta: ToolCallDelta;
+  }
+  export type StepDetails = MessageCreationDetails | ToolCallsDetails;
+  export type MessageCreationDetails = {
+    type: StepTypes.MESSAGE_CREATION;
+    message_creation: {
+      message_id: string;
+    };
+  };
+  export type ToolCallsDetails = {
+    type: StepTypes.TOOL_CALLS;
+    tool_calls: AgentToolCall[];
+  };
+  export type ToolCallDelta = {
+    type: StepTypes.TOOL_CALLS | string;
+    tool_calls?: ToolCallChunk[];
+    auth?: string;
+    expires_at?: number;
+  };
+  export type AgentToolCall = FunctionToolCall | ToolCall;
+  export interface ExtendedMessageContent {
+    type?: string;
+    text?: string;
+    input?: string;
+    index?: number;
+    id?: string;
+    name?: string;
+  }
+  /**
+   * Represents a message delta i.e. any changed fields on a message during
+   * streaming.
+   */
+  export interface MessageDeltaEvent {
+    /**
+     * The identifier of the message, which can be referenced in API endpoints.
+     */
+    id: string;
+    /**
+     * The delta containing the fields that have changed on the Message.
+     */
+    delta: MessageDelta;
+  }
+  /**
+   * The delta containing the fields that have changed on the Message.
+   */
+  export interface MessageDelta {
+    /**
+     * The content of the message in array of text and/or images.
+     */
+    content?: Agents.MessageContentComplex[];
+  }
+
+  /**
+   * Represents a reasoning delta i.e. any changed fields on a message during
+   * streaming.
+   */
+  export interface ReasoningDeltaEvent {
+    /**
+     * The identifier of the message, which can be referenced in API endpoints.
+     */
+    id: string;
+
+    /**
+     * The delta containing the fields that have changed.
+     */
+    delta: ReasoningDelta;
+  }
+
+  /**
+   * The reasoning delta containing the fields that have changed on the Message.
+   */
+  export interface ReasoningDelta {
+    /**
+     * The content of the message in array of text and/or images.
+     */
+    content?: MessageContentComplex[];
+  }
+
+  export type ReasoningDeltaUpdate = { type: ContentTypes.THINK; think: string };
+  export type ContentType =
+    | ContentTypes.THINK
+    | ContentTypes.TEXT
+    | ContentTypes.IMAGE_URL
+    | string;
+}
+
+export type ToolCallResult = {
+  user: string;
+  toolId: string;
+  result?: unknown;
+  messageId: string;
+  partIndex?: number;
+  blockIndex?: number;
+  conversationId: string;
+  attachments?: TAttachment[];
+};

package/src/types/assistants.ts

@@ -1,6 +1,9 @@
 import type { OpenAPIV3 } from 'openapi-types';
-import type { AssistantsEndpoint } from 'src/schemas';
+import type { AssistantsEndpoint, AgentProvider } from 'src/schemas';
+import type { ContentTypes } from './runs';
+import type { Agents } from './agents';
 import type { TFile } from './files';
+import { ArtifactModes } from 'src/artifacts';
 
 export type Schema = OpenAPIV3.SchemaObject & { description?: string };
 export type Reference = OpenAPIV3.ReferenceObject & { description?: string };
@@ -13,6 +16,7 @@ export type Metadata = {
 };
 
 export enum Tools {
+  execute_code = 'execute_code',
   code_interpreter = 'code_interpreter',
   file_search = 'file_search',
   retrieval = 'retrieval',
@@ -21,6 +25,7 @@ export enum Tools {
 
 export enum EToolResources {
   code_interpreter = 'code_interpreter',
+  execute_code = 'execute_code',
   file_search = 'file_search',
 }
 
@@ -34,6 +39,8 @@ export type FunctionTool = {
     description: string;
     name: string;
     parameters: Record<string, unknown>;
+    strict?: boolean;
+    additionalProperties?: boolean; // must be false if strict is true https://platform.openai.com/docs/guides/structured-outputs/some-type-specific-keywords-are-not-yet-supported
   };
 };
 
@@ -66,17 +73,20 @@ export interface FileSearchResource {
   vector_store_ids?: Array<string>;
 }
 
+/* Assistant types */
+
 export type Assistant = {
   id: string;
   created_at: number;
   description: string | null;
-  file_ids: string[];
+  file_ids?: string[];
   instructions: string | null;
+  conversation_starters?: string[];
   metadata: Metadata | null;
   model: string;
   name: string | null;
   object: string;
-  tools: FunctionTool[];
+  tools?: FunctionTool[];
   tool_resources?: ToolResources;
 };
 
@@ -87,11 +97,13 @@ export type AssistantCreateParams = {
   description?: string | null;
   file_ids?: string[];
   instructions?: string | null;
+  conversation_starters?: string[];
   metadata?: Metadata | null;
   name?: string | null;
   tools?: Array<FunctionTool | string>;
   endpoint: AssistantsEndpoint;
   version: number | string;
+  append_current_datetime?: boolean;
 };
 
 export type AssistantUpdateParams = {
@@ -99,11 +111,13 @@ export type AssistantUpdateParams = {
   description?: string | null;
   file_ids?: string[];
   instructions?: string | null;
+  conversation_starters?: string[] | null;
   metadata?: Metadata | null;
   name?: string | null;
   tools?: Array<FunctionTool | string>;
   tool_resources?: ToolResources;
   endpoint: AssistantsEndpoint;
+  append_current_datetime?: boolean;
 };
 
 export type AssistantListParams = {
@@ -133,6 +147,138 @@ export type File = {
   purpose: 'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output';
 };
 
+/* Agent types */
+
+export type AgentParameterValue = number | null;
+
+export type AgentModelParameters = {
+  model?: string;
+  temperature: AgentParameterValue;
+  max_context_tokens: AgentParameterValue;
+  max_output_tokens: AgentParameterValue;
+  top_p: AgentParameterValue;
+  frequency_penalty: AgentParameterValue;
+  presence_penalty: AgentParameterValue;
+};
+
+export interface AgentToolResources {
+  execute_code?: ExecuteCodeResource;
+  file_search?: AgentFileSearchResource;
+}
+export interface ExecuteCodeResource {
+  /**
+   * A list of file IDs made available to the `execute_code` tool.
+   * There can be a maximum of 20 files associated with the tool.
+   */
+  file_ids?: Array<string>;
+  /**
+   * A list of files already fetched.
+   */
+  files?: Array<TFile>;
+}
+
+export interface AgentFileSearchResource {
+  /**
+   * The ID of the vector store attached to this agent. There
+   * can be a maximum of 1 vector store attached to the agent.
+   */
+  vector_store_ids?: Array<string>;
+  /**
+   * A list of file IDs made available to the `file_search` tool.
+   * To be used before vector stores are implemented.
+   */
+  file_ids?: Array<string>;
+  /**
+   * A list of files already fetched.
+   */
+  files?: Array<TFile>;
+}
+
+export type Agent = {
+  id: string;
+  name: string | null;
+  author?: string | null;
+  /** The original custom endpoint name, lowercased */
+  endpoint?: string | null;
+  authorName?: string | null;
+  description: string | null;
+  created_at: number;
+  avatar: AgentAvatar | null;
+  instructions: string | null;
+  additional_instructions?: string | null;
+  tools?: string[];
+  projectIds?: string[];
+  tool_kwargs?: Record<string, unknown>;
+  metadata?: Record<string, unknown>;
+  provider: AgentProvider;
+  model: string | null;
+  model_parameters: AgentModelParameters;
+  conversation_starters?: string[];
+  isCollaborative?: boolean;
+  tool_resources?: AgentToolResources;
+  agent_ids?: string[];
+  end_after_tools?: boolean;
+  hide_sequential_outputs?: boolean;
+  artifacts?: ArtifactModes;
+};
+
+export type TAgentsMap = Record<string, Agent | undefined>;
+
+export type AgentCreateParams = {
+  name?: string | null;
+  description?: string | null;
+  avatar?: AgentAvatar | null;
+  file_ids?: string[];
+  instructions?: string | null;
+  tools?: Array<FunctionTool | string>;
+  provider: AgentProvider;
+  model: string | null;
+  model_parameters: AgentModelParameters;
+} & Pick<Agent, 'agent_ids' | 'end_after_tools' | 'hide_sequential_outputs' | 'artifacts'>;
+
+export type AgentUpdateParams = {
+  name?: string | null;
+  description?: string | null;
+  avatar?: AgentAvatar | null;
+  file_ids?: string[];
+  instructions?: string | null;
+  tools?: Array<FunctionTool | string>;
+  tool_resources?: ToolResources;
+  provider?: AgentProvider;
+  model?: string | null;
+  model_parameters?: AgentModelParameters;
+  projectIds?: string[];
+  removeProjectIds?: string[];
+  isCollaborative?: boolean;
+} & Pick<Agent, 'agent_ids' | 'end_after_tools' | 'hide_sequential_outputs' | 'artifacts'>;
+
+export type AgentListParams = {
+  limit?: number;
+  before?: string | null;
+  after?: string | null;
+  order?: 'asc' | 'desc';
+  provider?: AgentProvider;
+};
+
+export type AgentListResponse = {
+  object: string;
+  data: Agent[];
+  first_id: string;
+  last_id: string;
+  has_more: boolean;
+};
+
+export type AgentFile = {
+  file_id: string;
+  id?: string;
+  temp_file_id?: string;
+  bytes: number;
+  created_at: number;
+  filename: string;
+  object: string;
+  purpose: 'fine-tune' | 'fine-tune-results' | 'agents' | 'agents_output';
+};
+
 /**
  * Details of the Code Interpreter tool call the run step was involved in.
  * Includes the tool call ID, the code interpreter definition, and the type of tool call.
@@ -245,25 +391,6 @@ export enum AnnotationTypes {
   FILE_PATH = 'file_path',
 }
 
-export enum ContentTypes {
-  TEXT = 'text',
-  TOOL_CALL = 'tool_call',
-  IMAGE_FILE = 'image_file',
-  ERROR = 'error',
-}
-
-export enum StepTypes {
-  TOOL_CALLS = 'tool_calls',
-  MESSAGE_CREATION = 'message_creation',
-}
-
-export enum ToolCallTypes {
-  FUNCTION = 'function',
-  RETRIEVAL = 'retrieval',
-  FILE_SEARCH = 'file_search',
-  CODE_INTERPRETER = 'code_interpreter',
-}
-
 export enum StepStatus {
   IN_PROGRESS = 'in_progress',
   CANCELLED = 'cancelled',
@@ -295,6 +422,8 @@ export type PartMetadata = {
   asset_pointer?: string;
   status?: string;
   action?: boolean;
+  auth?: string;
+  expires_at?: number;
 };
 
 export type ContentPart = (
@@ -302,6 +431,7 @@ export type ContentPart = (
   | RetrievalToolCall
   | FileSearchToolCall
   | FunctionToolCall
+  | Agents.AgentToolCall
   | ImageFile
   | Text
 ) &
@@ -309,13 +439,21 @@ export type ContentPart = (
 
 export type TMessageContentParts =
   | { type: ContentTypes.ERROR; text: Text & PartMetadata }
-  | { type: ContentTypes.TEXT; text: Text & PartMetadata }
+  | { type: ContentTypes.THINK; think: string | (Text & PartMetadata) }
+  | { type: ContentTypes.TEXT; text: string | (Text & PartMetadata); tool_call_ids?: string[] }
   | {
       type: ContentTypes.TOOL_CALL;
-      tool_call: (CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall) &
+      tool_call: (
+        | CodeToolCall
+        | RetrievalToolCall
+        | FileSearchToolCall
+        | FunctionToolCall
+        | Agents.AgentToolCall
+      ) &
         PartMetadata;
     }
-  | { type: ContentTypes.IMAGE_FILE; image_file: ImageFile & PartMetadata };
+  | { type: ContentTypes.IMAGE_FILE; image_file: ImageFile & PartMetadata }
+  | Agents.MessageContentImageUrl;
 
 export type StreamContentData = TMessageContentParts & {
   /** The index of the current content part */
@@ -375,14 +513,21 @@ export type ActionMetadata = {
   oauth_client_secret?: string;
 };
 
+export type ActionMetadataRuntime = ActionMetadata & {
+  oauth_access_token?: string;
+  oauth_refresh_token?: string;
+  oauth_token_expires_at?: Date;
+};
+
+/* Assistant types */
+
 export type Action = {
   action_id: string;
-  assistant_id: string;
   type?: string;
   settings?: Record<string, unknown>;
   metadata: ActionMetadata;
   version: number | string;
-};
+} & ({ assistant_id: string; agent_id?: never } | { assistant_id?: never; agent_id: string });
 
 export type AssistantAvatar = {
   filepath: string;
@@ -392,12 +537,21 @@ export type AssistantAvatar = {
 export type AssistantDocument = {
   user: string;
   assistant_id: string;
+  conversation_starters?: string[];
   avatar?: AssistantAvatar;
   access_level?: number;
   file_ids?: string[];
   actions?: string[];
   createdAt?: Date;
   updatedAt?: Date;
+  append_current_datetime?: boolean;
+};
+
+/* Agent types */
+
+export type AgentAvatar = {
+  filepath: string;
+  source: string;
 };
 
 export enum FilePurpose {

package/src/types/files.ts

@@ -7,6 +7,7 @@ export enum FileSources {
   openai = 'openai',
   s3 = 's3',
   vectordb = 'vectordb',
+  execute_code = 'execute_code',
 }
 
 export const checkOpenAIStorage = (source: string) =>
@@ -15,13 +16,16 @@ export const checkOpenAIStorage = (source: string) =>
 export enum FileContext {
   avatar = 'avatar',
   unknown = 'unknown',
+  agents = 'agents',
   assistants = 'assistants',
+  execute_code = 'execute_code',
   image_generation = 'image_generation',
   assistants_output = 'assistants_output',
   message_attachment = 'message_attachment',
   filename = 'filename',
   updatedAt = 'updatedAt',
   source = 'source',
+  filterSource = 'filterSource',
   context = 'context',
   bytes = 'bytes',
 }
@@ -65,6 +69,7 @@ export type TFile = {
   height?: number;
   expiresAt?: string | Date;
   preview?: string;
+  metadata?: { fileIdentifier?: string };
   createdAt?: string | Date;
   updatedAt?: string | Date;
 };
@@ -127,6 +132,7 @@ export type BatchFile = {
 
 export type DeleteFilesBody = {
   files: BatchFile[];
+  agent_id?: string;
   assistant_id?: string;
   tool_resource?: EToolResources;
 };