Add possibility to change the description of a document

superagent-ai · Aug 7, 2023 · 3aae592 · 3aae592
1 parent 4d8c4a6
commit 3aae592
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 4 deletions.
diff --git a/app/api/documents.py b/app/api/documents.py
@@ -27,6 +27,7 @@ async def create_document(body: Document, token=Depends(JWTBearer())):
         document = prisma.document.create(
             {
                 "type": body.type,
+                "description": body.description,
                 "url": body.url,
                 "content": body.content,
                 "contentHash": content_hash,

diff --git a/app/lib/agents/base.py b/app/lib/agents/base.py
@@ -313,7 +313,7 @@ def _get_tools(self) -> list:
         embeddings = OpenAIEmbeddings()
 
         for agent_document in self.documents:
-            description = (
+            description = agent_document.document.description or (
                 f"useful for finding information about {agent_document.document.name}"
             )
             args_schema = DocumentInput if self.type == "OPENAI" else None

diff --git a/app/lib/models/document.py b/app/lib/models/document.py
@@ -4,6 +4,7 @@
 class Document(BaseModel):
     type: str
     url: str | None = None
+    description: str | None = None
     content: str | None = None
     name: str
     authorization: dict | None = None

diff --git a/prisma/migrations/20230807202052_document_description/migration.sql b/prisma/migrations/20230807202052_document_description/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Document" ADD COLUMN     "description" TEXT;
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -73,6 +73,7 @@ model Profile {
 
 model Document {
   id            String          @id @default(cuid()) @db.VarChar(255)
+  description   String?         @db.Text()
   userId        String          @db.VarChar(255)
   user          User            @relation(fields: [userId], references: [id])
   type          DocumentType    @default(TXT)

diff --git a/ui/app/documents/client-page.js b/ui/app/documents/client-page.js
@@ -150,11 +150,20 @@ export default function DocumentsClientPage({ data, session }) {
   };
 
   const onSubmit = async (values) => {
-    const { type, name, url, auth_type, auth_key, auth_value, ...metadata } =
-      values;
+    const {
+      type,
+      name,
+      description,
+      url,
+      auth_type,
+      auth_key,
+      auth_value,
+      ...metadata
+    } = values;
     const payload = {
       name,
       metadata,
+      description,
       type,
       url,
       authorization: auth_key && {
@@ -163,7 +172,6 @@ export default function DocumentsClientPage({ data, session }) {
         value: auth_value,
       },
     };
-    console.log(payload);
 
     if (selectedDocument) {
       await api.patchDocument(selectedDocument, payload);
@@ -218,6 +226,7 @@ export default function DocumentsClientPage({ data, session }) {
     setValue("name", document?.name);
     setValue("url", document?.url);
     setValue("type", document?.type);
+    setValue("description", document?.description);
     onOpen();
   };
 
@@ -357,6 +366,7 @@ export default function DocumentsClientPage({ data, session }) {
                   <FormControl isRequired isInvalid={errors?.name}>
                     <FormLabel>Name</FormLabel>
                     <Input
+                      placeholder="My document"
                       type="text"
                       {...register("name", { required: true })}
                     />
@@ -365,6 +375,20 @@ export default function DocumentsClientPage({ data, session }) {
                       <FormErrorMessage>Invalid name</FormErrorMessage>
                     )}
                   </FormControl>
+                  <FormControl isRequired isInvalid={errors?.description}>
+                    <FormLabel>Description</FormLabel>
+                    <Input
+                      type="text"
+                      placeholder="Useful for finding information about..."
+                      {...register("description", { required: true })}
+                    />
+                    <FormHelperText>
+                      What is this document useful for?
+                    </FormHelperText>
+                    {errors?.description && (
+                      <FormErrorMessage>Invalid description</FormErrorMessage>
+                    )}
+                  </FormControl>
                   {documentType === "URL" ? (
                     <FormControl
                       isRequired