librechat-data-provider 0.5.0 → 0.5.2

package/src/config.ts

@@ -18,6 +18,11 @@ export const defaultRetrievalModels = [
   'gpt-4-1106',
 ];
 
+export enum SettingsViews {
+  default = 'default',
+  advanced = 'advanced',
+}
+
 export const fileSourceSchema = z.nativeEnum(FileSources);
 
 export const modelConfigSchema = z
@@ -55,8 +60,8 @@ export const azureGroupSchema = z
   .and(azureBaseSchema);
 
 export const azureGroupConfigsSchema = z.array(azureGroupSchema).min(1);
+export type TAzureGroup = z.infer<typeof azureGroupSchema>;
 export type TAzureGroups = z.infer<typeof azureGroupConfigsSchema>;
-
 export type TAzureModelMapSchema = {
   // deploymentName?: string;
   // version?: string;
@@ -77,6 +82,7 @@ export type TValidatedAzureConfig = {
 
 export enum Capabilities {
   code_interpreter = 'code_interpreter',
+  image_vision = 'image_vision',
   retrieval = 'retrieval',
   actions = 'actions',
   tools = 'tools',
@@ -95,6 +101,7 @@ export const assistantEndpointSchema = z.object({
     .optional()
     .default([
       Capabilities.code_interpreter,
+      Capabilities.image_vision,
       Capabilities.retrieval,
       Capabilities.actions,
       Capabilities.tools,
@@ -143,6 +150,8 @@ export const endpointSchema = z.object({
   customOrder: z.number().optional(),
 });
 
+export type TEndpoint = z.infer<typeof endpointSchema>;
+
 export const azureEndpointSchema = z
   .object({
     groups: azureGroupConfigsSchema,
@@ -178,7 +187,7 @@ export const rateLimitSchema = z.object({
 
 export const configSchema = z.object({
   version: z.string(),
-  cache: z.boolean(),
+  cache: z.boolean().optional().default(true),
   interface: z
     .object({
       privacyPolicy: z
@@ -229,6 +238,7 @@ export enum KnownEndpoints {
   ollama = 'ollama',
   perplexity = 'perplexity',
   'together.ai' = 'together.ai',
+  cohere = 'cohere',
 }
 
 export enum FetchTokenConfig {
@@ -292,6 +302,7 @@ export const defaultModels = {
   [EModelEndpoint.anthropic]: [
     'claude-3-opus-20240229',
     'claude-3-sonnet-20240229',
+    'claude-3-haiku-20240307',
     'claude-2.1',
     'claude-2',
     'claude-1.2',
@@ -511,7 +522,7 @@ export enum Constants {
   /**
    * Key for the app's version.
    */
-  VERSION = 'v0.6.10',
+  VERSION = 'v0.7.0',
   /**
    * Key for the Custom Config's version (librechat.yaml).
    */
@@ -522,8 +533,62 @@ export enum Constants {
   NO_PARENT = '00000000-0000-0000-0000-000000000000',
 }
 
+/**
+ * Enum for Cohere related constants
+ */
+export enum CohereConstants {
+  /**
+   * Cohere API Endpoint, for special handling
+   */
+  API_URL = 'https://api.cohere.ai/v1',
+  /**
+   * Role for "USER" messages
+   */
+  ROLE_USER = 'USER',
+  /**
+   * Role for "SYSTEM" messages
+   */
+  ROLE_SYSTEM = 'SYSTEM',
+  /**
+   * Role for "CHATBOT" messages
+   */
+  ROLE_CHATBOT = 'CHATBOT',
+  /**
+   * Title message as required by Cohere
+   */
+  TITLE_MESSAGE = 'TITLE:',
+}
+
 export const defaultOrderQuery: {
-  order: 'asc';
+  order: 'desc';
+  limit: 100;
 } = {
-  order: 'asc',
+  order: 'desc',
+  limit: 100,
 };
+
+export 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/src/data-service.ts

@@ -6,10 +6,7 @@ import * as t from './types';
 import * as s from './schemas';
 import request from './request';
 import * as endpoints from './api-endpoints';
-
-export function getConversations(pageNumber: string): Promise<t.TGetConversationsResponse> {
-  return request.get(endpoints.conversations(pageNumber));
-}
+import type { AxiosResponse } from 'axios';
 
 export function abortRequestWithMessage(
   endpoint: string,
@@ -19,15 +16,6 @@ export function abortRequestWithMessage(
   return request.post(endpoints.abortRequest(endpoint), { arg: { abortKey, message } });
 }
 
-export function deleteConversation(payload: t.TDeleteConversationRequest) {
-  //todo: this should be a DELETE request
-  return request.post(endpoints.deleteConversation(), { arg: payload });
-}
-
-export function clearAllConversations(): Promise<unknown> {
-  return request.post(endpoints.deleteConversation(), { arg: {} });
-}
-
 export function revokeUserKey(name: string): Promise<unknown> {
   return request.delete(endpoints.revokeUserKey(name));
 }
@@ -43,20 +31,6 @@ export function getMessagesByConvoId(conversationId: string): Promise<s.TMessage
   return request.get(endpoints.messages(conversationId));
 }
 
-export function getConversationById(id: string): Promise<s.TConversation> {
-  return request.get(endpoints.conversationById(id));
-}
-
-export function updateConversation(
-  payload: t.TUpdateConversationRequest,
-): Promise<t.TUpdateConversationResponse> {
-  return request.post(endpoints.updateConversation(), { arg: payload });
-}
-
-export function genTitle(payload: m.TGenTitleRequest): Promise<m.TGenTitleResponse> {
-  return request.post(endpoints.genTitle(), payload);
-}
-
 export function updateMessage(payload: t.TUpdateMessageRequest): Promise<unknown> {
   const { conversationId, messageId, text } = payload;
   if (!conversationId) {
@@ -103,13 +77,6 @@ export function getUserBalance(): Promise<string> {
   return request.get(endpoints.balance());
 }
 
-export const searchConversations = async (
-  q: string,
-  pageNumber: string,
-): Promise<t.TSearchResults> => {
-  return request.get(endpoints.search(q, pageNumber));
-};
-
 export const updateTokenCount = (text: string) => {
   return request.post(endpoints.tokenizer(), { arg: text });
 };
@@ -196,6 +163,10 @@ export const listAssistants = (
   return request.get(endpoints.assistants(), { params });
 };
 
+export function getAssistantDocs(): Promise<a.AssistantDocument[]> {
+  return request.get(endpoints.assistants('documents'));
+}
+
 /* Tools */
 
 export const getAvailableTools = (): Promise<s.TPlugin[]> => {
@@ -231,19 +202,13 @@ export const uploadAssistantAvatar = (data: m.AssistantAvatarVariables): Promise
   );
 };
 
-export const updateAction = (data: m.UpdateActionVariables): Promise<m.UpdateActionResponse> => {
-  const { assistant_id, ...body } = data;
-  return request.post(endpoints.assistants(`actions/${assistant_id}`), body);
+export const getFileDownload = async (userId: string, filepath: string): Promise<AxiosResponse> => {
+  const encodedFilePath = encodeURIComponent(filepath);
+  return request.getResponse(`${endpoints.files()}/download/${userId}/${encodedFilePath}`, {
+    responseType: 'blob',
+  });
 };
 
-export function getActions(): Promise<a.Action[]> {
-  return request.get(endpoints.assistants('actions'));
-}
-
-export function getAssistantDocs(): Promise<a.AssistantDocument[]> {
-  return request.get(endpoints.assistants('documents'));
-}
-
 export const deleteFiles = async (
   files: f.BatchFile[],
   assistant_id?: string,
@@ -252,8 +217,35 @@ export const deleteFiles = async (
     data: { files, assistant_id },
   });
 
+/* actions */
+
+export const updateAction = (data: m.UpdateActionVariables): Promise<m.UpdateActionResponse> => {
+  const { assistant_id, ...body } = data;
+  return request.post(endpoints.assistants(`actions/${assistant_id}`), body);
+};
+
+export function getActions(): Promise<a.Action[]> {
+  return request.get(endpoints.assistants('actions'));
+}
+
+export const deleteAction = async (
+  assistant_id: string,
+  action_id: string,
+  model: string,
+): Promise<void> =>
+  request.delete(endpoints.assistants(`actions/${assistant_id}/${action_id}/${model}`));
+
 /* conversations */
 
+export function deleteConversation(payload: t.TDeleteConversationRequest) {
+  //todo: this should be a DELETE request
+  return request.post(endpoints.deleteConversation(), { arg: payload });
+}
+
+export function clearAllConversations(): Promise<unknown> {
+  return request.post(endpoints.deleteConversation(), { arg: {} });
+}
+
 export const listConversations = (
   params?: q.ConversationListParams,
 ): Promise<q.ConversationListResponse> => {
@@ -275,5 +267,27 @@ export const listConversationsByQuery = (
   }
 };
 
-export const deleteAction = async (assistant_id: string, action_id: string): Promise<void> =>
-  request.delete(endpoints.assistants(`actions/${assistant_id}/${action_id}`));
+export const searchConversations = async (
+  q: string,
+  pageNumber: string,
+): Promise<t.TSearchResults> => {
+  return request.get(endpoints.search(q, pageNumber));
+};
+
+export function getConversations(pageNumber: string): Promise<t.TGetConversationsResponse> {
+  return request.get(endpoints.conversations(pageNumber));
+}
+
+export function getConversationById(id: string): Promise<s.TConversation> {
+  return request.get(endpoints.conversationById(id));
+}
+
+export function updateConversation(
+  payload: t.TUpdateConversationRequest,
+): Promise<t.TUpdateConversationResponse> {
+  return request.post(endpoints.updateConversation(), { arg: payload });
+}
+
+export function genTitle(payload: m.TGenTitleRequest): Promise<m.TGenTitleResponse> {
+  return request.post(endpoints.genTitle(), payload);
+}

package/src/keys.ts

@@ -22,6 +22,7 @@ export enum QueryKeys {
   tools = 'tools',
   actions = 'actions',
   assistantDocs = 'assistantDocs',
+  fileDownload = 'fileDownload',
 }
 
 export enum MutationKeys {

package/src/request.ts

@@ -8,6 +8,10 @@ async function _get<T>(url: string, options?: AxiosRequestConfig): Promise<T> {
   return response.data;
 }
 
+async function _getResponse<T>(url: string, options?: AxiosRequestConfig): Promise<T> {
+  return await axios.get(url, { ...options });
+}
+
 async function _post(url: string, data?: any) {
   const response = await axios.post(url, JSON.stringify(data), {
     headers: { 'Content-Type': 'application/json' },
@@ -114,6 +118,7 @@ axios.interceptors.response.use(
 
 export default {
   get: _get,
+  getResponse: _getResponse,
   post: _post,
   postMultiPart: _postMultiPart,
   put: _put,

package/src/schemas.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
-import type { TMessageContentParts } from './types/assistants';
+import { Tools } from './types/assistants';
+import type { TMessageContentParts, FunctionTool, FunctionToolCall } from './types/assistants';
 import type { TFile } from './types/files';
 
 export const isUUID = z.string().uuid();
@@ -25,9 +26,26 @@ export const defaultAssistantFormValues = {
   model: '',
   functions: [],
   code_interpreter: false,
+  image_vision: false,
   retrieval: false,
 };
 
+export const ImageVisionTool: FunctionTool = {
+  type: Tools.function,
+  [Tools.function]: {
+    name: 'image_vision',
+    description: 'Get detailed text descriptions for all current image attachments.',
+    parameters: {
+      type: 'object',
+      properties: {},
+      required: [],
+    },
+  },
+};
+
+export const isImageVisionTool = (tool: FunctionTool | FunctionToolCall) =>
+  tool.type === 'function' && tool.function?.name === ImageVisionTool?.function?.name;
+
 export const endpointSettings = {
   [EModelEndpoint.google]: {
     model: {

package/src/types/assistants.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3 } from 'openapi-types';
+import type { TFile } from './files';
 
 export type Schema = OpenAPIV3.SchemaObject & { description?: string };
 export type Reference = OpenAPIV3.ReferenceObject & { description?: string };
@@ -131,7 +132,7 @@ export type ToolCallsStepDetails = {
   type: 'tool_calls'; // Always 'tool_calls'.
 };
 
-export type ImageFile = {
+export type ImageFile = TFile & {
   /**
    * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
    * in the message content.
@@ -182,10 +183,16 @@ export type Text = {
   value: string;
 };
 
+export enum AnnotationTypes {
+  FILE_CITATION = 'file_citation',
+  FILE_PATH = 'file_path',
+}
+
 export enum ContentTypes {
   TEXT = 'text',
   TOOL_CALL = 'tool_call',
   IMAGE_FILE = 'image_file',
+  ERROR = 'error',
 }
 
 export enum StepTypes {
@@ -236,6 +243,7 @@ export type ContentPart = (CodeToolCall | RetrievalToolCall | FunctionToolCall |
   PartMetadata;
 
 export type TMessageContentParts =
+  | { type: ContentTypes.ERROR; text: Text & PartMetadata }
   | { type: ContentTypes.TEXT; text: Text & PartMetadata }
   | {
       type: ContentTypes.TOOL_CALL;
@@ -243,16 +251,25 @@ export type TMessageContentParts =
     }
   | { type: ContentTypes.IMAGE_FILE; image_file: ImageFile & PartMetadata };
 
-export type TContentData = TMessageContentParts & {
+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;
-  index: number;
   stream?: boolean;
 };
 
 export const actionDelimiter = '_action_';
+export const actionDomainSeparator = '---';
+export const hostImageIdSuffix = '_host_copy';
+export const hostImageNamePrefix = 'host_copy_';
 
 export enum AuthTypeEnum {
   ServiceHttp = 'service_http',

package/src/types/files.ts

@@ -3,6 +3,7 @@ export enum FileSources {
   firebase = 'firebase',
   openai = 'openai',
   s3 = 's3',
+  vectordb = 'vectordb',
 }
 
 export enum FileContext {

package/src/types/mutations.ts

@@ -56,6 +56,7 @@ export type UpdateActionVariables = {
   functions: FunctionTool[];
   metadata: ActionMetadata;
   action_id?: string;
+  model: string;
 };
 
 export type UploadAssistantAvatarOptions = {
@@ -109,6 +110,7 @@ export type UpdateActionOptions = {
 export type DeleteActionVariables = {
   assistant_id: string;
   action_id: string;
+  model: string;
 };
 
 export type DeleteActionOptions = {

package/tsconfig.json

@@ -8,7 +8,7 @@
     "target": "es5",
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
-    "lib": ["es2017", "dom"],
+    "lib": ["es2017", "dom", "ES2021.String"],
     "allowJs": true,
     "skipLibCheck": true,
     "esModuleInterop": true,