add docs for evaluating with attachments #540
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
baskaryan
reviewed
Nov 19, 2024
| outputs={"answer": "$123456"}, | ||
| attachments={ | ||
| # Each attachments is just a name with a mime type and the bytes content of the file | ||
| "pdf": ("application/pdf", Path("./foo_earnings.pdf").read_bytes()), |
There was a problem hiding this comment.
not related to this pr, but is it too late to change tuple -> dict? imo naming the values improves usability a lot, eg
attachments = [
{
"name": "my_pdf",
"mime_type": "applications/pdf",
"bytes": Path(...).read_bytes()
},
...
]is easier to read for me
There was a problem hiding this comment.
related to this pr, would be nice to download some real public pdf here to use. could just be https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
|
|
||
| # Evaluate an LLM application with attachments | ||
|
|
||
| Attachments allow you to associate large files with your examples. This allows you to evaluate RAG applications |
There was a problem hiding this comment.
maybe worth adding a sentence about why attachments are better than storing file in example inputs
There was a problem hiding this comment.
tried my best, but someone more well versed with the benefits should probably chime in
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 19, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
baskaryan
reviewed
Nov 20, 2024
docs/evaluation/how_to_guides/evaluation/evaluate_with_attachments.mdx
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.