feat: add file management actions and loaders

- Introduced new actions for file management: delete and upload.
- Added loaders for retrieving and listing files.
- Updated the search action to include an optional filter parameter.
- Modified the manifest to include new actions and loaders.
- Removed the Content-Type header from API requests for better flexibility.

Author: pedrofrxncx

pinecone-assistant/actions/delete.ts

@@ -0,0 +1,35 @@
+import { AppContext } from "../mod.ts";
+
+export interface Props {
+  fileId: string;
+}
+
+/**
+ * @title Delete File
+ * @name Delete File
+ * @description Deletes a file from the assistant
+ */
+const action = async (
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+) => {
+  const response = await ctx.client
+    ["DELETE /assistant/files/:assistant_name/:assistant_file_id"]({
+      assistant_name: ctx.assistant,
+      assistant_file_id: props.fileId,
+    });
+
+  if (response.status !== 200) {
+    return {
+      success: false,
+      error: "Failed to delete file " + response.statusText,
+    };
+  }
+
+  return {
+    success: true,
+  };
+};
+
+export default action;

pinecone-assistant/actions/search.ts

@@ -6,6 +6,11 @@ export interface Props {
    */
   query: string;
 
+  /**
+   * @description Optionally filter which documents can be retrieved using the following metadata fields. Example: { "type": "faq_entry" }
+   */
+  filter?: string;
+
   /**
    * @description The number of context snippets to retrieve. Defaults to 15.
    */
@@ -21,7 +26,8 @@ interface QueryResult {
 
 /**
  * @title Get Context
- * @description Retrieves relevant document snippets from the assistant's knowledge base.Returns an array of text snippets from the most relevant documents. The snippets are formatted as JSON objects with the fields: - file_name: The name of the file containing the snippet - pages: The pages of the file containing the snippet - content: The snippet content You can use the 'top_k' parameter to control result count (default: 15). Recommended top_k: a few (5-8) for simple/narrow queries, 10-20 for complex/broad topics.
+ * @name Get Context
+ * @description Retrieves relevant document snippets from the assistant's knowledge base. Returns an array of text snippets from the most relevant documents. The snippets are formatted as JSON objects with the fields: - file_name: The name of the file containing the snippet - pages: The pages of the file containing the snippet - content: The snippet content You can use the 'top_k' parameter to control result count (default: 15). Recommended top_k: a few (5-8) for simple/narrow queries, 10-20 for complex/broad topics.
  */
 const action = async (
   props: Props,
@@ -35,6 +41,7 @@ const action = async (
       }, {
         body: {
           query: props.query,
+          filter: props.filter ? JSON.parse(props.filter) : undefined,
         },
       });
 

pinecone-assistant/actions/upload.ts

@@ -0,0 +1,98 @@
+import { AppContext } from "../mod.ts";
+
+export interface Props {
+  /**
+   * @description The URL of the file to upload
+   */
+  fileUrl?: string;
+
+  /**
+   * @description The content of the file to upload (text only)
+   */
+  fileContent?: string;
+
+  /**
+   * @description The optional name of the file with extension (if not provided, the file will be named "file-${timestamp}.txt")
+   */
+  fileName?: string;
+
+  /**
+   * @description The optional metadata to attach to the file
+   */
+  metadata?: string;
+}
+
+/**
+ * @title Upload File
+ * @name Upload File
+ * @description Uploads a file to the assistant
+ */
+const action = async (
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+) => {
+  if (!props.fileUrl && !props.fileContent) {
+    return {
+      success: false,
+      error: "No file URL or content provided",
+    };
+  }
+
+  let fileBuffer: ArrayBuffer | null = null;
+  let contentType: string | null = null;
+
+  if (props.fileUrl) {
+    const fileResponse = await fetch(props.fileUrl);
+    contentType = fileResponse.headers.get("content-type");
+    fileBuffer = await fileResponse.arrayBuffer();
+  }
+
+  if (props.fileContent) {
+    fileBuffer = new TextEncoder().encode(props.fileContent)
+      .buffer as ArrayBuffer;
+    contentType = "text/plain";
+  }
+
+  if (!fileBuffer) {
+    return {
+      success: false,
+      error:
+        "Could not create a file buffer from the provided file URL or content",
+    };
+  }
+
+  const file = new File(
+    [fileBuffer],
+    props.fileName || `file-${Date.now()}.txt`,
+    { type: contentType || "application/octet-stream" },
+  );
+
+  const formData = new FormData();
+  formData.append("file", file);
+
+  const response = await ctx.client
+    ["POST /assistant/files/:assistant_name"]({
+      assistant_name: ctx.assistant,
+      metadata: props.metadata,
+    }, {
+      body: formData,
+    });
+
+  const result = await response.json();
+  console.log({ result });
+
+  if (result.error_message) {
+    return {
+      success: false,
+      error: result.error_message,
+    };
+  }
+
+  return {
+    success: true,
+    file: result,
+  };
+};
+
+export default action;

pinecone-assistant/loaders/get.ts

@@ -0,0 +1,32 @@
+import { AppContext } from "../mod.ts";
+
+export interface Props {
+  fileId: string;
+  includeUrl?: boolean;
+}
+
+/**
+ * @title Get File Upload
+ * @name Get File Upload
+ * @description Gets a file upload from the assistant
+ */
+const loader = async (
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+) => {
+  const response = await ctx.client
+    ["GET /assistant/files/:assistant_name/:assistant_file_id"]({
+      assistant_name: ctx.assistant,
+      assistant_file_id: props.fileId,
+      include_url: props.includeUrl ?? true,
+    });
+
+  const result = await response.json();
+  return {
+    success: true,
+    file: result,
+  };
+};
+
+export default loader;

pinecone-assistant/loaders/list.ts

@@ -0,0 +1,29 @@
+import { AppContext } from "../mod.ts";
+
+export interface Props {
+  filter?: string;
+}
+
+/**
+ * @title List Files
+ * @name List Files
+ * @description Lists all files in the assistant
+ */
+const loader = async (
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+) => {
+  const response = await ctx.client["GET /assistant/files/:assistant_name"]({
+    assistant_name: ctx.assistant,
+    filter: props.filter,
+  });
+
+  const result = await response.json();
+  return {
+    success: true,
+    files: result.files,
+  };
+};
+
+export default loader;

pinecone-assistant/manifest.gen.ts

@@ -2,11 +2,21 @@
 // This file SHOULD be checked into source version control.
 // This file is automatically updated during development when running `dev.ts`.
 
-import * as $$$$$$$$$0 from "./actions/search.ts";
+import * as $$$$$$$$$0 from "./actions/delete.ts";
+import * as $$$$$$$$$1 from "./actions/search.ts";
+import * as $$$$$$$$$2 from "./actions/upload.ts";
+import * as $$$0 from "./loaders/get.ts";
+import * as $$$1 from "./loaders/list.ts";
 
 const manifest = {
+  "loaders": {
+    "pinecone-assistant/loaders/get.ts": $$$0,
+    "pinecone-assistant/loaders/list.ts": $$$1,
+  },
   "actions": {
-    "pinecone-assistant/actions/search.ts": $$$$$$$$$0,
+    "pinecone-assistant/actions/delete.ts": $$$$$$$$$0,
+    "pinecone-assistant/actions/search.ts": $$$$$$$$$1,
+    "pinecone-assistant/actions/upload.ts": $$$$$$$$$2,
   },
   "name": "pinecone-assistant",
   "baseUrl": import.meta.url,

pinecone-assistant/mod.ts

@@ -47,7 +47,6 @@ export default function App(
     base: props.host,
     headers: new Headers({
       "Api-Key": apiKey ?? "",
-      "Content-Type": "application/json",
       "X-Pinecone-API-Version": "2025-01-01",
     }),
   });

pinecone-assistant/utils/client.ts

@@ -1,8 +1,43 @@
-import { ChatContextRequest, ChatContextResponse } from "./types.ts";
+import {
+  ChatContextRequest,
+  ChatContextResponse,
+  FileListResponse,
+  FileUploadResponse,
+  GetFileUploadResponse,
+} from "./types.ts";
 
 export interface PineconeAPI {
   "POST /assistant/chat/:assistant_name/context": {
     response: ChatContextResponse;
+    searchParams?: {
+      filter?: Record<string, unknown>;
+    };
     body: ChatContextRequest;
   };
+
+  "GET /assistant/files/:assistant_name": {
+    response: FileListResponse;
+    searchParams?: {
+      filter?: string;
+    };
+  };
+
+  "GET /assistant/files/:assistant_name/:assistant_file_id": {
+    response: GetFileUploadResponse;
+    searchParams?: {
+      include_url?: boolean;
+    };
+  };
+
+  "DELETE /assistant/files/:assistant_name/:assistant_file_id": {
+    response: void;
+  };
+
+  "POST /assistant/files/:assistant_name": {
+    response: FileUploadResponse;
+    body: FormData;
+    searchParams?: {
+      metadata?: string;
+    };
+  };
 }

pinecone-assistant/utils/types.ts

@@ -1,12 +1,50 @@
 export interface ChatContextRequest {
   query: string;
+  filter?: Record<string, unknown>;
+}
+
+export interface FileUploadRequest {
+  form: FormData;
+}
+
+type FileStatus =
+  | "Processing"
+  | "Available"
+  | "Deleting"
+  | "ProcessingFailed"
+  | "Deleted";
+export interface FileUploadResponse {
+  name: string;
+  id: string;
+  metadata: Record<string, unknown> | null;
+  created_on: string;
+  updated_on: string;
+  status: FileStatus;
+  percent_done: number | null;
+  signed_url: string | null;
+  error_message: string | null;
+}
+
+export interface GetFileUploadResponse {
+  name: string;
+  id: string;
+  metadata: Record<string, unknown> | null;
+  created_on: string;
+  updated_on: string;
+  status: FileStatus;
+  percent_done: number | null;
+  signed_url: string | null;
+  error_message: string | null;
+}
+
+export interface FileListResponse {
+  files: FileReference[];
 }
 
 export interface FileReference {
-  status: string;
+  status: FileStatus;
   id: string;
   name: string;
-  size: number;
   metadata: null | Record<string, unknown>;
   updated_on: string;
   created_on: string;
@@ -16,13 +54,13 @@ export interface FileReference {
 }
 
 export interface Reference {
-  type: string;
+  type: "file";
   file: FileReference;
   pages: number[];
 }
 
 export interface Snippet {
-  type: string;
+  type: "file";
   content: string;
   score: number;
   reference: Reference;