librechat-data-provider 0.8.402 → 0.8.404

package/dist/types/types/assistants.d.ts

@@ -0,0 +1,547 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { AssistantsEndpoint, AgentProvider } from 'src/schemas';
+import type { Agents, GraphEdge } from './agents';
+import type { ContentTypes } from './runs';
+import type { TFile } from './files';
+import { ArtifactModes } from 'src/artifacts';
+export type Schema = OpenAPIV3.SchemaObject & {
+    description?: string;
+};
+export type Reference = OpenAPIV3.ReferenceObject & {
+    description?: string;
+};
+export type Metadata = {
+    avatar?: string;
+    author?: string;
+} & {
+    [key: string]: unknown;
+};
+export declare enum Tools {
+    execute_code = "execute_code",
+    code_interpreter = "code_interpreter",
+    file_search = "file_search",
+    web_search = "web_search",
+    retrieval = "retrieval",
+    function = "function",
+    memory = "memory",
+    ui_resources = "ui_resources"
+}
+export declare enum EToolResources {
+    code_interpreter = "code_interpreter",
+    execute_code = "execute_code",
+    file_search = "file_search",
+    image_edit = "image_edit",
+    context = "context",
+    ocr = "ocr"
+}
+export type Tool = {
+    [type: string]: Tools;
+};
+export type FunctionTool = {
+    type: Tools;
+    function?: {
+        description: string;
+        name: string;
+        parameters: Record<string, unknown>;
+        strict?: boolean;
+        additionalProperties?: boolean;
+    };
+};
+/**
+ * A set of resources that are used by the assistant's tools. The resources are
+ * specific to the type of tool. For example, the `code_interpreter` tool requires
+ * a list of file IDs, while the `file_search` tool requires a list of vector store
+ * IDs.
+ */
+export interface ToolResources {
+    code_interpreter?: CodeInterpreterResource;
+    file_search?: FileSearchResource;
+}
+export interface CodeInterpreterResource {
+    /**
+     * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+     * available to the `code_interpreter`` tool. There can be a maximum of 20 files
+     * associated with the tool.
+     */
+    file_ids?: Array<string>;
+}
+export interface FileSearchResource {
+    /**
+     * The ID of the
+     * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+     * attached to this assistant. There can be a maximum of 1 vector store attached to
+     * the assistant.
+     */
+    vector_store_ids?: Array<string>;
+}
+export type Assistant = {
+    id: string;
+    created_at: number;
+    description: string | null;
+    file_ids?: string[];
+    instructions: string | null;
+    conversation_starters?: string[];
+    metadata: Metadata | null;
+    model: string;
+    name: string | null;
+    object: string;
+    tools?: FunctionTool[];
+    tool_resources?: ToolResources;
+};
+export type TAssistantsMap = Record<AssistantsEndpoint, Record<string, Assistant>>;
+export type AssistantCreateParams = {
+    model: string;
+    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 = {
+    model?: string;
+    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 = {
+    limit?: number;
+    before?: string | null;
+    after?: string | null;
+    order?: 'asc' | 'desc';
+    endpoint: AssistantsEndpoint;
+};
+export type AssistantListResponse = {
+    object: string;
+    data: Assistant[];
+    first_id: string;
+    last_id: string;
+    has_more: boolean;
+};
+export type File = {
+    file_id: string;
+    id?: string;
+    temp_file_id?: string;
+    bytes: number;
+    created_at: number;
+    filename: string;
+    object: string;
+    purpose: 'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output';
+};
+export type AgentParameterValue = number | string | null;
+export type AgentModelParameters = {
+    model?: string;
+    temperature: AgentParameterValue;
+    maxContextTokens: AgentParameterValue;
+    max_context_tokens: AgentParameterValue;
+    max_output_tokens: AgentParameterValue;
+    top_p: AgentParameterValue;
+    frequency_penalty: AgentParameterValue;
+    presence_penalty: AgentParameterValue;
+    useResponsesApi?: boolean;
+};
+export interface AgentBaseResource {
+    /**
+     * A list of file IDs made available to the tool.
+     */
+    file_ids?: Array<string>;
+    /**
+     * A list of files already fetched.
+     */
+    files?: Array<TFile>;
+}
+export interface AgentToolResources {
+    [EToolResources.image_edit]?: AgentBaseResource;
+    [EToolResources.execute_code]?: ExecuteCodeResource;
+    [EToolResources.file_search]?: AgentFileResource;
+    [EToolResources.context]?: AgentBaseResource;
+    /** @deprecated Use context instead */
+    [EToolResources.ocr]?: AgentBaseResource;
+}
+/**
+ * A resource for the execute_code tool.
+ * Contains file IDs made available to the tool (max 20 files) and already fetched files.
+ */
+export type ExecuteCodeResource = AgentBaseResource;
+export interface AgentFileResource extends AgentBaseResource {
+    /**
+     * 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>;
+}
+export type SupportContact = {
+    name?: string;
+    email?: string;
+};
+/**
+ * Specifies who can invoke a tool.
+ * - 'direct': LLM can call directly
+ * - 'code_execution': Only callable via programmatic tool calling (PTC)
+ */
+export type AllowedCaller = 'direct' | 'code_execution';
+/**
+ * Per-tool configuration options stored at the agent level.
+ * Keyed by tool_id (e.g., "search_mcp_github").
+ */
+export type ToolOptions = {
+    /**
+     * If true, the tool uses deferred loading (discoverable via tool search).
+     * @default false
+     */
+    defer_loading?: boolean;
+    /**
+     * Specifies who can invoke this tool.
+     * - 'direct': LLM can call directly (default behavior)
+     * - 'code_execution': Only callable via PTC sandbox
+     * @default ['direct']
+     */
+    allowed_callers?: AllowedCaller[];
+};
+/**
+ * Map of tool_id to its configuration options.
+ * Used to customize tool behavior per agent.
+ */
+export type AgentToolOptions = Record<string, ToolOptions>;
+export type Agent = {
+    _id?: string;
+    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[];
+    tool_kwargs?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    provider: AgentProvider;
+    model: string | null;
+    model_parameters: AgentModelParameters;
+    conversation_starters?: string[];
+    tool_resources?: AgentToolResources;
+    /** @deprecated Use edges instead */
+    agent_ids?: string[];
+    edges?: GraphEdge[];
+    end_after_tools?: boolean;
+    hide_sequential_outputs?: boolean;
+    artifacts?: ArtifactModes;
+    recursion_limit?: number;
+    isPublic?: boolean;
+    version?: number;
+    category?: string;
+    support_contact?: SupportContact;
+    /** Per-tool configuration options (deferred loading, allowed callers, etc.) */
+    tool_options?: AgentToolOptions;
+};
+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' | 'edges' | 'end_after_tools' | 'hide_sequential_outputs' | 'artifacts' | 'recursion_limit' | 'category' | 'support_contact' | 'tool_options'>;
+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;
+} & Pick<Agent, 'agent_ids' | 'edges' | 'end_after_tools' | 'hide_sequential_outputs' | 'artifacts' | 'recursion_limit' | 'category' | 'support_contact' | 'tool_options'>;
+export type AgentListParams = {
+    limit?: number;
+    requiredPermission: number;
+    category?: string;
+    search?: string;
+    cursor?: string;
+    promoted?: 0 | 1;
+};
+export type AgentListResponse = {
+    object: string;
+    data: Agent[];
+    first_id: string;
+    last_id: string;
+    has_more: boolean;
+    after?: string;
+};
+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.
+ */
+export type CodeToolCall = {
+    id: string;
+    code_interpreter: {
+        input: string;
+        outputs: Array<Record<string, unknown>>;
+    };
+    type: 'code_interpreter';
+};
+/**
+ * Details of a Function tool call the run step was involved in.
+ * Includes the tool call ID, the function definition, and the type of tool call.
+ */
+export type FunctionToolCall = {
+    id: string;
+    function: {
+        arguments: string;
+        name: string;
+        output: string | null;
+    };
+    type: 'function';
+};
+/**
+ * Details of a Retrieval tool call the run step was involved in.
+ * Includes the tool call ID and the type of tool call.
+ */
+export type RetrievalToolCall = {
+    id: string;
+    retrieval: unknown;
+    type: 'retrieval';
+};
+/**
+ * Details of a Retrieval tool call the run step was involved in.
+ * Includes the tool call ID and the type of tool call.
+ */
+export type FileSearchToolCall = {
+    id: string;
+    file_search: unknown;
+    type: 'file_search';
+};
+/**
+ * Details of the tool calls involved in a run step.
+ * Can be associated with one of three types of tools: `code_interpreter`, `retrieval`, or `function`.
+ */
+export type ToolCallsStepDetails = {
+    tool_calls: Array<CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall>;
+    type: 'tool_calls';
+};
+export type ImageFile = TFile & {
+    /**
+     * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
+     * in the message content.
+     */
+    file_id: string;
+    filename: string;
+    filepath: string;
+    height: number;
+    width: number;
+    /**
+     * Prompt used to generate the image if applicable.
+     */
+    prompt?: string;
+    /**
+     * Additional metadata used to generate or about the image/tool_call.
+     */
+    metadata?: Record<string, unknown>;
+};
+export type FileCitation = {
+    end_index: number;
+    file_citation: FileCitationDetails;
+    start_index: number;
+    text: string;
+    type: 'file_citation';
+};
+export type FileCitationDetails = {
+    file_id: string;
+    quote: string;
+};
+export type FilePath = {
+    end_index: number;
+    file_path: FilePathDetails;
+    start_index: number;
+    text: string;
+    type: 'file_path';
+};
+export type FilePathDetails = {
+    file_id: string;
+};
+export type Text = {
+    annotations?: Array<FileCitation | FilePath>;
+    value: string;
+};
+export declare enum AnnotationTypes {
+    FILE_CITATION = "file_citation",
+    FILE_PATH = "file_path"
+}
+export declare enum StepStatus {
+    IN_PROGRESS = "in_progress",
+    CANCELLED = "cancelled",
+    FAILED = "failed",
+    COMPLETED = "completed",
+    EXPIRED = "expired"
+}
+export declare enum MessageContentTypes {
+    TEXT = "text",
+    IMAGE_FILE = "image_file"
+}
+export declare enum RunStatus {
+    QUEUED = "queued",
+    IN_PROGRESS = "in_progress",
+    REQUIRES_ACTION = "requires_action",
+    CANCELLING = "cancelling",
+    CANCELLED = "cancelled",
+    FAILED = "failed",
+    COMPLETED = "completed",
+    EXPIRED = "expired"
+}
+export type PartMetadata = {
+    progress?: number;
+    asset_pointer?: string;
+    status?: string;
+    action?: boolean;
+    auth?: string;
+    expires_at?: number;
+    /** Index indicating parallel sibling content (same stepIndex in multi-agent runs) */
+    siblingIndex?: number;
+    /** Agent ID for parallel agent rendering - identifies which agent produced this content */
+    agentId?: string;
+    /** Group ID for parallel content - parts with same groupId are displayed in columns */
+    groupId?: number;
+};
+/** Metadata for parallel content rendering - subset of PartMetadata */
+export type ContentMetadata = Pick<PartMetadata, 'agentId' | 'groupId'>;
+export type ContentPart = (CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall | Agents.AgentToolCall | ImageFile | Text) & PartMetadata;
+export type TextData = (Text & PartMetadata) | undefined;
+export type SummaryContentPart = {
+    type: ContentTypes.SUMMARY;
+    content?: Array<{
+        type: ContentTypes.TEXT;
+        text: string;
+    }>;
+    tokenCount?: number;
+    summarizing?: boolean;
+    summaryVersion?: number;
+    model?: string;
+    provider?: string;
+    createdAt?: string;
+    boundary?: {
+        messageId: string;
+        contentIndex: number;
+    };
+};
+export type TMessageContentParts = ({
+    type: ContentTypes.ERROR;
+    text?: string | TextData;
+    error?: string;
+} & ContentMetadata) | ({
+    type: ContentTypes.THINK;
+    think?: string | TextData;
+} & ContentMetadata) | ({
+    type: ContentTypes.TEXT;
+    text?: string | TextData;
+    tool_call_ids?: string[];
+} & ContentMetadata) | ({
+    type: ContentTypes.TOOL_CALL;
+    tool_call: (CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall | Agents.AgentToolCall) & PartMetadata;
+} & ContentMetadata) | ({
+    type: ContentTypes.IMAGE_FILE;
+    image_file: ImageFile & PartMetadata;
+} & ContentMetadata) | (SummaryContentPart & ContentMetadata) | (Agents.AgentUpdate & ContentMetadata) | (Agents.MessageContentImageUrl & ContentMetadata) | (Agents.MessageContentVideoUrl & ContentMetadata) | (Agents.MessageContentInputAudio & ContentMetadata);
+export type StreamContentData = TMessageContentParts & {
+    /** The index of the current content part */
+    index: number;
+    /** The current text content was already served but edited to replace elements therein */
+    edited?: boolean;
+};
+export type TContentData = StreamContentData & {
+    messageId: string;
+    conversationId: string;
+    userMessageId: string;
+    thread_id: string;
+    stream?: boolean;
+};
+export declare const actionDelimiter = "_action_";
+export declare const actionDomainSeparator = "---";
+export declare const hostImageIdSuffix = "_host_copy";
+export declare const hostImageNamePrefix = "host_copy_";
+export type AssistantAvatar = {
+    filepath: string;
+    source: string;
+};
+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;
+};
+export type AgentAvatar = {
+    filepath: string;
+    source: string;
+};
+export declare enum FilePurpose {
+    Vision = "vision",
+    FineTune = "fine-tune",
+    FineTuneResults = "fine-tune-results",
+    Assistants = "assistants",
+    AssistantsOutput = "assistants_output"
+}
+export declare const defaultOrderQuery: {
+    order: 'desc';
+    limit: 100;
+};
+export declare enum AssistantStreamEvents {
+    ThreadCreated = "thread.created",
+    ThreadRunCreated = "thread.run.created",
+    ThreadRunQueued = "thread.run.queued",
+    ThreadRunInProgress = "thread.run.in_progress",
+    ThreadRunRequiresAction = "thread.run.requires_action",
+    ThreadRunCompleted = "thread.run.completed",
+    ThreadRunFailed = "thread.run.failed",
+    ThreadRunCancelling = "thread.run.cancelling",
+    ThreadRunCancelled = "thread.run.cancelled",
+    ThreadRunExpired = "thread.run.expired",
+    ThreadRunStepCreated = "thread.run.step.created",
+    ThreadRunStepInProgress = "thread.run.step.in_progress",
+    ThreadRunStepCompleted = "thread.run.step.completed",
+    ThreadRunStepFailed = "thread.run.step.failed",
+    ThreadRunStepCancelled = "thread.run.step.cancelled",
+    ThreadRunStepExpired = "thread.run.step.expired",
+    ThreadRunStepDelta = "thread.run.step.delta",
+    ThreadMessageCreated = "thread.message.created",
+    ThreadMessageInProgress = "thread.message.in_progress",
+    ThreadMessageCompleted = "thread.message.completed",
+    ThreadMessageIncomplete = "thread.message.incomplete",
+    ThreadMessageDelta = "thread.message.delta",
+    ErrorEvent = "error"
+}

package/dist/types/types/files.d.ts

@@ -0,0 +1,172 @@
+import { EToolResources } from './assistants';
+export declare enum FileSources {
+    local = "local",
+    firebase = "firebase",
+    azure = "azure",
+    azure_blob = "azure_blob",
+    openai = "openai",
+    s3 = "s3",
+    vectordb = "vectordb",
+    execute_code = "execute_code",
+    mistral_ocr = "mistral_ocr",
+    azure_mistral_ocr = "azure_mistral_ocr",
+    vertexai_mistral_ocr = "vertexai_mistral_ocr",
+    text = "text",
+    document_parser = "document_parser"
+}
+export declare const checkOpenAIStorage: (source: string) => boolean;
+export declare 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"
+}
+export type EndpointFileConfig = {
+    disabled?: boolean;
+    fileLimit?: number;
+    fileSizeLimit?: number;
+    totalSizeLimit?: number;
+    supportedMimeTypes?: RegExp[];
+};
+export type FileConfig = {
+    endpoints: {
+        [key: string]: EndpointFileConfig;
+    };
+    fileTokenLimit?: number;
+    serverFileSizeLimit?: number;
+    avatarSizeLimit?: number;
+    clientImageResize?: {
+        enabled?: boolean;
+        maxWidth?: number;
+        maxHeight?: number;
+        quality?: number;
+    };
+    ocr?: {
+        supportedMimeTypes?: RegExp[];
+    };
+    text?: {
+        supportedMimeTypes?: RegExp[];
+    };
+    stt?: {
+        supportedMimeTypes?: RegExp[];
+    };
+    checkType?: (fileType: string, supportedTypes: RegExp[]) => boolean;
+};
+export type FileConfigInput = {
+    endpoints?: {
+        [key: string]: EndpointFileConfig;
+    };
+    serverFileSizeLimit?: number;
+    avatarSizeLimit?: number;
+    clientImageResize?: {
+        enabled?: boolean;
+        maxWidth?: number;
+        maxHeight?: number;
+        quality?: number;
+    };
+    ocr?: {
+        supportedMimeTypes?: string[];
+    };
+    text?: {
+        supportedMimeTypes?: string[];
+    };
+    stt?: {
+        supportedMimeTypes?: string[];
+    };
+    checkType?: (fileType: string, supportedTypes: RegExp[]) => boolean;
+};
+export type TFile = {
+    _id?: string;
+    __v?: number;
+    user: string;
+    conversationId?: string;
+    message?: string;
+    file_id: string;
+    temp_file_id?: string;
+    bytes: number;
+    embedded: boolean;
+    filename: string;
+    filepath: string;
+    object: 'file';
+    type: string;
+    usage: number;
+    context?: FileContext;
+    source?: FileSources;
+    filterSource?: FileSources;
+    width?: number;
+    height?: number;
+    expiresAt?: string | Date;
+    preview?: string;
+    metadata?: {
+        fileIdentifier?: string;
+    };
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+};
+export type TFileUpload = TFile & {
+    temp_file_id: string;
+};
+export type AvatarUploadResponse = {
+    url: string;
+};
+export type SpeechToTextResponse = {
+    text: string;
+};
+export type VoiceResponse = string[];
+export type UploadMutationOptions = {
+    onSuccess?: (data: TFileUpload, variables: FormData, context?: unknown) => void;
+    onMutate?: (variables: FormData) => void | Promise<unknown>;
+    onError?: (error: unknown, variables: FormData, context?: unknown) => void;
+};
+export type UploadAvatarOptions = {
+    onSuccess?: (data: AvatarUploadResponse, variables: FormData, context?: unknown) => void;
+    onMutate?: (variables: FormData) => void | Promise<unknown>;
+    onError?: (error: unknown, variables: FormData, context?: unknown) => void;
+};
+export type SpeechToTextOptions = {
+    onSuccess?: (data: SpeechToTextResponse, variables: FormData, context?: unknown) => void;
+    onMutate?: (variables: FormData) => void | Promise<unknown>;
+    onError?: (error: unknown, variables: FormData, context?: unknown) => void;
+};
+export type TextToSpeechOptions = {
+    onSuccess?: (data: ArrayBuffer, variables: FormData, context?: unknown) => void;
+    onMutate?: (variables: FormData) => void | Promise<unknown>;
+    onError?: (error: unknown, variables: FormData, context?: unknown) => void;
+};
+export type VoiceOptions = {
+    onSuccess?: (data: VoiceResponse, variables: unknown, context?: unknown) => void;
+    onMutate?: () => void | Promise<unknown>;
+    onError?: (error: unknown, variables: unknown, context?: unknown) => void;
+};
+export type DeleteFilesResponse = {
+    message: string;
+    result: Record<string, unknown>;
+};
+export type BatchFile = {
+    file_id: string;
+    filepath: string;
+    embedded: boolean;
+    source: FileSources;
+    temp_file_id?: string;
+};
+export type DeleteFilesBody = {
+    files: BatchFile[];
+    agent_id?: string;
+    assistant_id?: string;
+    tool_resource?: EToolResources;
+};
+export type DeleteMutationOptions = {
+    onSuccess?: (data: DeleteFilesResponse, variables: DeleteFilesBody, context?: unknown) => void;
+    onMutate?: (variables: DeleteFilesBody) => void | Promise<unknown>;
+    onError?: (error: unknown, variables: DeleteFilesBody, context?: unknown) => void;
+};