[QUO-898] document metadata support/validation #7
Conversation
QUO-898 Add documents metadata to detections endpoint
Allow users to pass metadata about their documents (e.g. as a dictionary). For example - Tavily mentioned they want to report where documents are being retrieved from. |
quotientai/logger.ts
Outdated
| continue; | ||
| } else if (typeof doc === 'object' && doc !== null) { | ||
| if (!this.isValidLogDocument(doc)) { | ||
| throw new ValidationError("Documents must be a list of strings or dictionaries with 'page_content' and optional 'metadata' keys. Metadata keys must be strings"); |
There was a problem hiding this comment.
If a user sees this error, what should they do about it?
Whenever we raise an exception we should tell the user what to do in response (as part of the exception message), otherwise they're going to fumble and have to read more docs, read source code, ignore completely, etc
There was a problem hiding this comment.
Added some more actionable error msgs
There was a problem hiding this comment.
Awesome! Let’s make sure both messages are in sync in both clients
waldnzwrld
left a comment
waldnzwrld
left a comment
There was a problem hiding this comment.
You need to update all tests related to logs to include your new type and verify the behaviour you have introduced.
waldnzwrld
dismissed
their stale review
Tests have been added and my initial feedback has been tackled
|
@crekhari would you mind updating the example_logs.ts file for the new documents format as well. 😁 |
Fixed! Ill cut a new release after lunch. Lmk if theres any other changes needed |
Support document metadata