feat: wip

Author: amirai21

examples/studio/conversational-rag/rag-engine.ts

@@ -5,18 +5,21 @@ function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
-async function uploadGetUpdateDelete(fileInput, label) {
+async function uploadGetUpdateDelete(fileInput, path) {
   const client = new AI21({ apiKey: process.env.AI21_API_KEY });
   try {
-    const uploadFileResponse: UploadFileResponse = await client.ragEngine.create(fileInput, {
-      path: label,
-    });
+    const uploadFileResponse: UploadFileResponse = await client.ragEngine.create(
+      {
+        file: fileInput,
+        path: path,
+      });
     console.log(uploadFileResponse);
     let file: FileResponse = await client.ragEngine.get(uploadFileResponse.fileId);
     console.log(file);
     await sleep(1000); // Give it a sec to start process before updating
     console.log('Now updating the file labels and publicUrl...');
-    await client.ragEngine.update(uploadFileResponse.fileId, {
+    await client.ragEngine.update({
+      fileId: uploadFileResponse.fileId,
       labels: ['test99'],
       publicUrl: 'https://www.miri.com',
     });

src/APIClient.ts

@@ -26,18 +26,16 @@ const validatePositiveInteger = (name: string, n: unknown): number => {
   return n;
 };
 
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const appendBodyToFormData = (formData: UnifiedFormData, body: Record<string, any>): void => {
-    for (const [key, value] of Object.entries(body)) {
-      if (Array.isArray(value)) {
-        value.forEach((item) => formData.append(key, item));
-      } else {
-        formData.append(key, value);
-      }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const appendBodyToFormData = (formData: UnifiedFormData, body: Record<string, any>): void => {
+  for (const [key, value] of Object.entries(body)) {
+    if (Array.isArray(value)) {
+      value.forEach((item) => formData.append(key, item));
+    } else {
+      formData.append(key, value);
     }
-  };
-
+  }
+};
 
 export abstract class APIClient {
   protected baseURL: string;
@@ -136,7 +134,11 @@ export abstract class APIClient {
     return url;
   }
 
-  private prepareAndExecuteRequest<Req, Rsp>(method: HTTPMethod, path: string, opts?: RequestOptions<Req>): Promise<Rsp> {
+  private prepareAndExecuteRequest<Req, Rsp>(
+    method: HTTPMethod,
+    path: string,
+    opts?: RequestOptions<Req>,
+  ): Promise<Rsp> {
     const options = {
       method,
       path,
@@ -148,9 +150,7 @@ export abstract class APIClient {
       options.headers = { ...options.headers, 'Content-Type': 'application/json' };
     }
 
-    return this.performRequest(options).then(
-      (response) => this.fetch.handleResponse<Rsp>(response) as Rsp,
-    );
+    return this.performRequest(options).then((response) => this.fetch.handleResponse<Rsp>(response) as Rsp);
   }
 
   private async performRequest(options: FinalRequestOptions): Promise<APIResponseProps> {

src/resources/rag/ragEngine.ts

@@ -5,32 +5,20 @@ import {
   UploadFileRequest,
   ListFilesFilters,
   UpdateFileRequest,
-  FilePathOrFileObject,
 } from '../../types/rag';
 import { FileResponse } from 'types/rag/FileResponse';
 
 const RAG_ENGINE_PATH = '/library/files';
 
 export class RAGEngine extends APIResource {
-  async create(
-    file: string,
-    body: UploadFileRequest,
-    options?: Models.RequestOptions,
-  ): Promise<UploadFileResponse>;
-
-  async create(
-    file: File,
-    body: UploadFileRequest,
-    options?: Models.RequestOptions,
-  ): Promise<UploadFileResponse>;
 
   async create(
-    file: FilePathOrFileObject,
     body: UploadFileRequest,
     options?: Models.RequestOptions,
   ): Promise<UploadFileResponse> {
+    const {file, ...bodyWithoutFile} = body
     return this.client.upload<Models.UnifiedFormData, UploadFileResponse>(RAG_ENGINE_PATH, file, {
-      body: body,
+      body: bodyWithoutFile,
       ...options,
     } as Models.RequestOptions<Models.UnifiedFormData>) as Promise<UploadFileResponse>;
   }
@@ -49,15 +37,15 @@ export class RAGEngine extends APIResource {
     ) as Promise<null>;
   }
 
-  list(body: ListFilesFilters | null, options?: Models.RequestOptions): Promise<FileResponse[]> {
+  list(body?: ListFilesFilters, options?: Models.RequestOptions): Promise<FileResponse[]> {
     return this.client.get<ListFilesFilters | null, FileResponse[]>(RAG_ENGINE_PATH, {
       query: body,
       ...options,
     } as Models.RequestOptions<ListFilesFilters | null>) as Promise<FileResponse[]>;
   }
 
-  update(fileId: string, body: UpdateFileRequest, options?: Models.RequestOptions): Promise<null> {
-    return this.client.put<UpdateFileRequest, null>(`${RAG_ENGINE_PATH}/${fileId}`, {
+  update(body: UpdateFileRequest, options?: Models.RequestOptions): Promise<null> {
+    return this.client.put<UpdateFileRequest, null>(`${RAG_ENGINE_PATH}/${body.fileId}`, {
       body,
       ...options,
     } as Models.RequestOptions<UpdateFileRequest>) as Promise<null>;

src/types/API.ts

@@ -33,4 +33,3 @@ export type CrossPlatformReadableStream = ReadableStream<Uint8Array> | import('s
 export type UnifiedFormData = FormData | import('form-data');
 
 export type FormDataRequest = { formData: UnifiedFormData; headers: Headers };
-

src/types/rag/UpdateFileRequest.ts

@@ -0,0 +1,5 @@
+export interface UpdateFileRequest {
+  fileId: string;
+  labels?: string[] | null;
+  publicUrl?: string | null;
+}

src/types/rag/UploadFileRequest.ts

@@ -1,8 +1,8 @@
-export interface UpdateFileRequest {
-  labels?: string[] | null;
-  publicUrl?: string | null;
-}
+import { FilePathOrFileObject } from "./FilePathOrFileObject";
 
-export interface UploadFileRequest extends UpdateFileRequest {
+export interface UploadFileRequest {
+  file: FilePathOrFileObject
   path?: string | null;
+  labels?: string[] | null;
+  publicUrl?: string | null;
 }

src/types/rag/index.ts

@@ -14,6 +14,6 @@ export { type UploadFileResponse } from './UploadFileResponse';
 
 export { type ListFilesFilters } from './ListFilesFilters';
 
-export { type UpdateFileRequest } from './UploadFileRequest';
+export { type UpdateFileRequest } from './UpdateFileRequest';
 
 export { type FilePathOrFileObject } from './FilePathOrFileObject';

tests/unittests/resources/rag-engine.test.ts

@@ -31,12 +31,12 @@ describe('RAGEngine', () => {
 
   it('should upload a file and return the fileId', async () => {
     const fileInput = 'path/to/file.txt';
-    const body = { path: 'label' };
+    const body = { file: fileInput, path: 'label' };
     const expectedResponse = { fileId: '12345' };
 
     mockClient.upload.mockResolvedValue(expectedResponse);
 
-    const response = await ragEngine.create(fileInput, body, options);
+    const response = await ragEngine.create(body);
 
     expect(mockClient.upload).toHaveBeenCalledWith(
       '/library/files',
@@ -77,11 +77,11 @@ describe('RAGEngine', () => {
 
   it('should update a file by ID and return null', async () => {
     const fileId = '12345';
-    const body = { labels: ['test'], publicUrl: 'https://example.com' };
+    const body = { fileId, labels: ['test'], publicUrl: 'https://example.com' };
 
     mockClient.put.mockResolvedValue(null);
 
-    const response = await ragEngine.update(fileId, body, options);
+    const response = await ragEngine.update(body);
 
     expect(mockClient.put).toHaveBeenCalledWith(
       `/library/files/${fileId}`,