feat: FilePathOrFileObject

Author: amirai21

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

@@ -26,6 +26,14 @@ async function uploadQueryUpdateDelete() {
       { path: 'test10' },
     );
 
+    // const fileContent = Buffer.from('This is the content of the file.');
+    // const dummyFile = new File([fileContent], 'example.txt', { type: 'text/plain' });
+
+    // // Use the File object in the create method
+    // const uploadFileResponse: UploadFileResponse = await client.ragEngine.create(dummyFile, {
+    //   path: 'test10',
+    // });
+
     const fileId = uploadFileResponse.fileId;
     let file: FileResponse = await waitForFileProcessing(client, fileId);
     console.log(file);

src/AI21.ts

@@ -6,7 +6,7 @@ import { APIClient } from './APIClient';
 import { Headers } from './types';
 import * as Runtime from './runtime';
 import { ConversationalRag } from './resources/rag/conversationalRag';
-import { RAGEngine } from 'resources';
+import { RAGEngine } from './resources';
 
 export interface ClientOptions {
   baseURL?: string | undefined;

src/APIClient.ts

@@ -15,6 +15,7 @@ import { Fetch } from 'fetch';
 import { createReadStream } from 'fs';
 import { basename as getBasename } from 'path';
 import FormData from 'form-data';
+import { FilePathOrFileObject } from 'types/rag';
 
 const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
@@ -37,7 +38,6 @@ const appendBodyToFormData = (formData: FormData, body: Record<string, any>): vo
   }
 };
 
-export type FilePathOrFileObject = string | File;
 
 function makeFormDataFromFilePath(filePath: string): FormData {
   const formData = new FormData();
@@ -92,9 +92,6 @@ export abstract class APIClient {
     return this.makeRequest('delete', path, opts);
   }
 
-  upload<Req, Rsp>(path: string, file: string, opts?: RequestOptions<Req>): Promise<Rsp>;
-  upload<Req, Rsp>(path: string, file: File, opts?: RequestOptions<Req>): Promise<Rsp>;
-
   upload<Req, Rsp>(path: string, file: FilePathOrFileObject, opts?: RequestOptions<Req>): Promise<Rsp> {
     let formData: FormData;
 

src/resources/rag/ragEngine.ts

@@ -1,17 +1,29 @@
 import * as Models from '../../types';
 import { APIResource } from '../../APIResource';
-import { UploadFileResponse, UploadFileRequest, ListFilesFilters, UpdateFileRequest } from '../../types/rag';
+import { UploadFileResponse, UploadFileRequest, ListFilesFilters, UpdateFileRequest, FilePathOrFileObject } from '../../types/rag';
 import { FileResponse } from 'types/rag/FileResponse';
 
 const RAG_ENGINE_PATH = '/library/files';
 
 export class RAGEngine extends APIResource {
   create(
-    filePath: string,
+    file: string,
+    body: UploadFileRequest,
+    options?: Models.RequestOptions,
+  ): Promise<UploadFileResponse>;
+
+  create(
+    file: File,
+    body: UploadFileRequest,
+    options?: Models.RequestOptions,
+  ): Promise<UploadFileResponse>;
+
+  create(
+    file: FilePathOrFileObject,
     body: UploadFileRequest,
     options?: Models.RequestOptions,
   ): Promise<UploadFileResponse> {
-    return this.client.upload<UploadFileRequest, UploadFileResponse>(RAG_ENGINE_PATH, filePath, {
+    return this.client.upload<UploadFileRequest, UploadFileResponse>(RAG_ENGINE_PATH, file, {
       body: body,
       ...options,
     } as Models.RequestOptions<UploadFileRequest>) as Promise<UploadFileResponse>;

src/types/rag/FilePathOrFileObject.ts

@@ -0,0 +1 @@
+export type FilePathOrFileObject = string | File;

src/types/rag/index.ts

@@ -15,3 +15,5 @@ export { type UploadFileResponse } from './UploadFileResponse';
 export { type ListFilesFilters } from './ListFilesFilters';
 
 export { type UpdateFileRequest } from './UploadFileRequest';
+
+export { type FilePathOrFileObject } from './FilePathOrFileObject';