librechat-data-provider 0.6.3 → 0.6.5

package/src/schemas.ts

@@ -22,9 +22,19 @@ export enum EModelEndpoint {
   gptPlugins = 'gptPlugins',
   anthropic = 'anthropic',
   assistants = 'assistants',
+  azureAssistants = 'azureAssistants',
   custom = 'custom',
 }
 
+export type AssistantsEndpoint = EModelEndpoint.assistants | EModelEndpoint.azureAssistants;
+
+export const isAssistantsEndpoint = (endpoint?: AssistantsEndpoint | null | string): boolean => {
+  if (!endpoint) {
+    return false;
+  }
+  return endpoint.toLowerCase().endsWith(EModelEndpoint.assistants);
+};
+
 export enum ImageDetail {
   low = 'low',
   auto = 'auto',
@@ -76,7 +86,7 @@ export const isImageVisionTool = (tool: FunctionTool | FunctionToolCall) =>
 
 export const openAISettings = {
   model: {
-    default: 'gpt-3.5-turbo',
+    default: 'gpt-4o',
   },
   temperature: {
     min: 0,
@@ -211,7 +221,7 @@ export enum EAgent {
 
 export const agentOptionSettings = {
   model: {
-    default: 'gpt-4-turbo',
+    default: 'gpt-4o',
   },
   temperature: {
     min: 0,
@@ -381,6 +391,19 @@ export type TConversation = z.infer<typeof tConversationSchema> & {
   presetOverride?: Partial<TPreset>;
 };
 
+export const tSharedLinkSchema = z.object({
+  conversationId: z.string(),
+  shareId: z.string(),
+  messages: z.array(z.string()),
+  isAnonymous: z.boolean(),
+  isPublic: z.boolean(),
+  isVisible: z.boolean(),
+  title: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+export type TSharedLink = z.infer<typeof tSharedLinkSchema>;
+
 export const openAISchema = tConversationSchema
   .pick({
     model: true,
@@ -400,25 +423,33 @@ export const openAISchema = tConversationSchema
     maxContextTokens: true,
     max_tokens: true,
   })
-  .transform((obj) => ({
-    ...obj,
-    model: obj.model ?? openAISettings.model.default,
-    chatGptLabel: obj.modelLabel ?? obj.chatGptLabel ?? null,
-    promptPrefix: obj.promptPrefix ?? null,
-    temperature: obj.temperature ?? openAISettings.temperature.default,
-    top_p: obj.top_p ?? openAISettings.top_p.default,
-    presence_penalty: obj.presence_penalty ?? openAISettings.presence_penalty.default,
-    frequency_penalty: obj.frequency_penalty ?? openAISettings.frequency_penalty.default,
-    resendFiles:
-      typeof obj.resendFiles === 'boolean' ? obj.resendFiles : openAISettings.resendFiles.default,
-    imageDetail: obj.imageDetail ?? openAISettings.imageDetail.default,
-    stop: obj.stop ?? undefined,
-    iconURL: obj.iconURL ?? undefined,
-    greeting: obj.greeting ?? undefined,
-    spec: obj.spec ?? undefined,
-    maxContextTokens: obj.maxContextTokens ?? undefined,
-    max_tokens: obj.max_tokens ?? undefined,
-  }))
+  .transform((obj) => {
+    const result = {
+      ...obj,
+      model: obj.model ?? openAISettings.model.default,
+      chatGptLabel: obj.chatGptLabel ?? obj.modelLabel ?? null,
+      promptPrefix: obj.promptPrefix ?? null,
+      temperature: obj.temperature ?? openAISettings.temperature.default,
+      top_p: obj.top_p ?? openAISettings.top_p.default,
+      presence_penalty: obj.presence_penalty ?? openAISettings.presence_penalty.default,
+      frequency_penalty: obj.frequency_penalty ?? openAISettings.frequency_penalty.default,
+      resendFiles:
+        typeof obj.resendFiles === 'boolean' ? obj.resendFiles : openAISettings.resendFiles.default,
+      imageDetail: obj.imageDetail ?? openAISettings.imageDetail.default,
+      stop: obj.stop ?? undefined,
+      iconURL: obj.iconURL ?? undefined,
+      greeting: obj.greeting ?? undefined,
+      spec: obj.spec ?? undefined,
+      maxContextTokens: obj.maxContextTokens ?? undefined,
+      max_tokens: obj.max_tokens ?? undefined,
+    };
+
+    if (obj.modelLabel) {
+      result.modelLabel = null;
+    }
+
+    return result;
+  })
   .catch(() => ({
     model: openAISettings.model.default,
     chatGptLabel: null,
@@ -605,27 +636,35 @@ export const gptPluginsSchema = tConversationSchema
     spec: true,
     maxContextTokens: true,
   })
-  .transform((obj) => ({
-    ...obj,
-    model: obj.model ?? 'gpt-3.5-turbo',
-    chatGptLabel: obj.modelLabel ?? obj.chatGptLabel ?? null,
-    promptPrefix: obj.promptPrefix ?? null,
-    temperature: obj.temperature ?? 0.8,
-    top_p: obj.top_p ?? 1,
-    presence_penalty: obj.presence_penalty ?? 0,
-    frequency_penalty: obj.frequency_penalty ?? 0,
-    tools: obj.tools ?? [],
-    agentOptions: obj.agentOptions ?? {
-      agent: EAgent.functions,
-      skipCompletion: true,
-      model: 'gpt-3.5-turbo',
-      temperature: 0,
-    },
-    iconURL: obj.iconURL ?? undefined,
-    greeting: obj.greeting ?? undefined,
-    spec: obj.spec ?? undefined,
-    maxContextTokens: obj.maxContextTokens ?? undefined,
-  }))
+  .transform((obj) => {
+    const result = {
+      ...obj,
+      model: obj.model ?? 'gpt-3.5-turbo',
+      chatGptLabel: obj.chatGptLabel ?? obj.modelLabel ?? null,
+      promptPrefix: obj.promptPrefix ?? null,
+      temperature: obj.temperature ?? 0.8,
+      top_p: obj.top_p ?? 1,
+      presence_penalty: obj.presence_penalty ?? 0,
+      frequency_penalty: obj.frequency_penalty ?? 0,
+      tools: obj.tools ?? [],
+      agentOptions: obj.agentOptions ?? {
+        agent: EAgent.functions,
+        skipCompletion: true,
+        model: 'gpt-3.5-turbo',
+        temperature: 0,
+      },
+      iconURL: obj.iconURL ?? undefined,
+      greeting: obj.greeting ?? undefined,
+      spec: obj.spec ?? undefined,
+      maxContextTokens: obj.maxContextTokens ?? undefined,
+    };
+
+    if (obj.modelLabel) {
+      result.modelLabel = null;
+    }
+
+    return result;
+  })
   .catch(() => ({
     model: 'gpt-3.5-turbo',
     chatGptLabel: null,

package/src/types/assistants.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3 } from 'openapi-types';
+import type { AssistantsEndpoint } from 'src/schemas';
 import type { TFile } from './files';
 
 export type Schema = OpenAPIV3.SchemaObject & { description?: string };
@@ -10,10 +11,16 @@ export type Metadata = {
 
 export enum Tools {
   code_interpreter = 'code_interpreter',
+  file_search = 'file_search',
   retrieval = 'retrieval',
   function = 'function',
 }
 
+export enum EToolResources {
+  code_interpreter = 'code_interpreter',
+  file_search = 'file_search',
+}
+
 export type Tool = {
   [type: string]: Tools;
 };
@@ -27,6 +34,35 @@ export type FunctionTool = {
   };
 };
 
+/**
+ * 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;
@@ -38,8 +74,11 @@ export type Assistant = {
   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;
@@ -48,6 +87,8 @@ export type AssistantCreateParams = {
   metadata?: Metadata | null;
   name?: string | null;
   tools?: Array<FunctionTool | string>;
+  endpoint: AssistantsEndpoint;
+  version: number | string;
 };
 
 export type AssistantUpdateParams = {
@@ -58,6 +99,8 @@ export type AssistantUpdateParams = {
   metadata?: Metadata | null;
   name?: string | null;
   tools?: Array<FunctionTool | string>;
+  tool_resources?: ToolResources;
+  endpoint: AssistantsEndpoint;
 };
 
 export type AssistantListParams = {
@@ -65,6 +108,7 @@ export type AssistantListParams = {
   before?: string | null;
   after?: string | null;
   order?: 'asc' | 'desc';
+  endpoint: AssistantsEndpoint;
 };
 
 export type AssistantListResponse = {
@@ -123,12 +167,22 @@ export type RetrievalToolCall = {
   type: 'retrieval'; // The type of tool call, always '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; // The ID of the tool call object.
+  file_search: unknown; // An empty object for now.
+  type: 'file_search'; // The type of tool call, always 'retrieval'.
+};
+
 /**
  * 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 | FunctionToolCall>; // An array of tool calls the run step was involved in.
+  tool_calls: Array<CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall>; // An array of tool calls the run step was involved in.
   type: 'tool_calls'; // Always 'tool_calls'.
 };
 
@@ -203,6 +257,7 @@ export enum StepTypes {
 export enum ToolCallTypes {
   FUNCTION = 'function',
   RETRIEVAL = 'retrieval',
+  FILE_SEARCH = 'file_search',
   CODE_INTERPRETER = 'code_interpreter',
 }
 
@@ -239,7 +294,14 @@ export type PartMetadata = {
   action?: boolean;
 };
 
-export type ContentPart = (CodeToolCall | RetrievalToolCall | FunctionToolCall | ImageFile | Text) &
+export type ContentPart = (
+  | CodeToolCall
+  | RetrievalToolCall
+  | FileSearchToolCall
+  | FunctionToolCall
+  | ImageFile
+  | Text
+) &
   PartMetadata;
 
 export type TMessageContentParts =
@@ -247,7 +309,8 @@ export type TMessageContentParts =
   | { type: ContentTypes.TEXT; text: Text & PartMetadata }
   | {
       type: ContentTypes.TOOL_CALL;
-      tool_call: (CodeToolCall | RetrievalToolCall | FunctionToolCall) & PartMetadata;
+      tool_call: (CodeToolCall | RetrievalToolCall | FileSearchToolCall | FunctionToolCall) &
+        PartMetadata;
     }
   | { type: ContentTypes.IMAGE_FILE; image_file: ImageFile & PartMetadata };
 
@@ -315,6 +378,7 @@ export type Action = {
   type?: string;
   settings?: Record<string, unknown>;
   metadata: ActionMetadata;
+  version: number | string;
 };
 
 export type AssistantAvatar = {
@@ -334,6 +398,7 @@ export type AssistantDocument = {
 };
 
 export enum FilePurpose {
+  Vision = 'vision',
   FineTune = 'fine-tune',
   FineTuneResults = 'fine-tune-results',
   Assistants = 'assistants',

package/src/types/files.ts

@@ -1,11 +1,17 @@
+import { EToolResources } from './assistants';
+
 export enum FileSources {
   local = 'local',
   firebase = 'firebase',
+  azure = 'azure',
   openai = 'openai',
   s3 = 's3',
   vectordb = 'vectordb',
 }
 
+export const checkOpenAIStorage = (source: string) =>
+  source === FileSources.openai || source === FileSources.azure;
+
 export enum FileContext {
   avatar = 'avatar',
   unknown = 'unknown',
@@ -54,6 +60,7 @@ export type TFile = {
   usage: number;
   context?: FileContext;
   source?: FileSources;
+  filterSource?: FileSources;
   width?: number;
   height?: number;
   expiresAt?: string | Date;
@@ -97,6 +104,7 @@ export type BatchFile = {
 export type DeleteFilesBody = {
   files: BatchFile[];
   assistant_id?: string;
+  tool_resource?: EToolResources;
 };
 
 export type DeleteMutationOptions = {

package/src/types/mutations.ts

@@ -45,6 +45,8 @@ export type AssistantAvatarVariables = {
   model: string;
   formData: FormData;
   postCreation?: boolean;
+  endpoint: types.AssistantsEndpoint;
+  version: number | string;
 };
 
 export type UpdateActionVariables = {
@@ -53,6 +55,8 @@ export type UpdateActionVariables = {
   metadata: ActionMetadata;
   action_id?: string;
   model: string;
+  endpoint: types.AssistantsEndpoint;
+  version: number | string;
 };
 
 export type UploadAssistantAvatarOptions = MutationOptions<Assistant, AssistantAvatarVariables>;
@@ -66,7 +70,11 @@ export type UpdateAssistantVariables = {
 
 export type UpdateAssistantMutationOptions = MutationOptions<Assistant, UpdateAssistantVariables>;
 
-export type DeleteAssistantBody = { assistant_id: string; model: string };
+export type DeleteAssistantBody = {
+  assistant_id: string;
+  model: string;
+  endpoint: types.AssistantsEndpoint;
+};
 
 export type DeleteAssistantMutationOptions = MutationOptions<
   void,
@@ -77,6 +85,7 @@ export type UpdateActionResponse = [AssistantDocument, Assistant, Action];
 export type UpdateActionOptions = MutationOptions<UpdateActionResponse, UpdateActionVariables>;
 
 export type DeleteActionVariables = {
+  endpoint: types.AssistantsEndpoint;
   assistant_id: string;
   action_id: string;
   model: string;
@@ -90,3 +99,13 @@ export type DeleteConversationOptions = MutationOptions<
 >;
 
 export type ForkConvoOptions = MutationOptions<types.TForkConvoResponse, types.TForkConvoRequest>;
+
+export type CreateSharedLinkOptions = MutationOptions<
+  types.TSharedLink,
+  Partial<types.TSharedLink>
+>;
+export type UpdateSharedLinkOptions = MutationOptions<
+  types.TSharedLink,
+  Partial<types.TSharedLink>
+>;
+export type DeleteSharedLinkOptions = MutationOptions<types.TSharedLink, { shareId: string }>;

package/src/types/queries.ts

@@ -1,5 +1,5 @@
 import type { InfiniteData } from '@tanstack/react-query';
-import type { TMessage, TConversation } from '../schemas';
+import type { TMessage, TConversation, TSharedLink } from '../schemas';
 export type Conversation = {
   id: string;
   createdAt: number;
@@ -16,7 +16,7 @@ export type ConversationListParams = {
   order?: 'asc' | 'desc';
   pageNumber: string; // Add this line
   conversationId?: string;
-  isArchived: boolean;
+  isArchived?: boolean;
 };
 
 // Type for the response from the conversation list API
@@ -33,3 +33,24 @@ export type ConversationUpdater = (
   data: ConversationData,
   conversation: TConversation,
 ) => ConversationData;
+
+export type SharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
+  messages: TMessage[];
+};
+export type SharedLinkListParams = Omit<ConversationListParams, 'isArchived' | 'conversationId'> & {
+  isPublic?: boolean;
+};
+
+export type SharedLinksResponse = Omit<ConversationListResponse, 'conversations' | 'messages'> & {
+  sharedLinks: TSharedLink[];
+};
+
+// Type for the response from the conversation list API
+export type SharedLinkListResponse = {
+  sharedLinks: TSharedLink[];
+  pageNumber: string;
+  pageSize: string | number;
+  pages: string | number;
+};
+
+export type SharedLinkListData = InfiniteData<SharedLinkListResponse>;

package/src/types.ts

@@ -1,5 +1,12 @@
 import OpenAI from 'openai';
-import type { TResPlugin, TMessage, TConversation, EModelEndpoint, ImageDetail } from './schemas';
+import type {
+  TResPlugin,
+  TMessage,
+  TConversation,
+  EModelEndpoint,
+  ImageDetail,
+  TSharedLink,
+} from './schemas';
 import type { TSpecsConfig } from './models';
 export type TOpenAIMessage = OpenAI.Chat.ChatCompletionMessageParam;
 export type TOpenAIFunction = OpenAI.Chat.ChatCompletionCreateParams.Function;
@@ -133,6 +140,19 @@ export type TArchiveConversationRequest = {
 
 export type TArchiveConversationResponse = TConversation;
 
+export type TSharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
+  messages: TMessage[];
+};
+export type TSharedLinkRequest = Partial<
+  Omit<TSharedLink, 'messages' | 'createdAt' | 'updatedAt'>
+> & {
+  conversationId: string;
+};
+
+export type TSharedLinkResponse = TSharedLink;
+export type TSharedLinksResponse = TSharedLink[];
+export type TDeleteSharedLinkResponse = TSharedLink;
+
 export type TForkConvoRequest = {
   messageId: string;
   conversationId: string;
@@ -163,6 +183,7 @@ export type TConfig = {
   plugins?: Record<string, string>;
   name?: string;
   iconURL?: string;
+  version?: string;
   modelDisplayLabel?: string;
   userProvide?: boolean | null;
   userProvideURL?: boolean | null;