diff --git a/src/canopy_server/api_models.py b/src/canopy_server/api_models.py index b6406a6b..530a2cb1 100644 --- a/src/canopy_server/api_models.py +++ b/src/canopy_server/api_models.py @@ -36,7 +36,7 @@ class ContextUpsertRequest(BaseModel): class ContextDeleteRequest(BaseModel): - document_ids: List[str] = Field(description="List of document ids to delete.") + document_ids: List[str] = Field(description="List of document IDs to delete.") class HealthStatus(BaseModel): diff --git a/src/canopy_server/app.py b/src/canopy_server/app.py index 9e016d35..1870cef6 100644 --- a/src/canopy_server/app.py +++ b/src/canopy_server/app.py @@ -114,7 +114,7 @@ def stringify_content(response: StreamingChatResponse): "/context/query", response_model=ContextContentResponse, responses={ - 500: {"description": "Failed to query the knowledgebase or Build the context"} + 500: {"description": "Failed to query the knowledge base or build the context"} }, ) async def query( @@ -149,8 +149,8 @@ async def upsert( request: ContextUpsertRequest = Body(...), ) -> SuccessUpsertResponse: """ - Upsert documents into the knowledgebase. Upserting is a way to add new documents or update existing ones. - Each document has a unique ID. If a document with the same ID already exists, it will be updated. + Upsert documents into the knowledge base. Upserting is a way to add new documents or update existing ones. + Each document has a unique ID. If a document with the same ID already exists, it is updated. The documents will be chunked and encoded, then the resulting encoded chunks will be sent to the Pinecone index in batches """ # noqa: E501