core: allow artifact in create_retriever_tool #28903
Open
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
dosubot
bot
added
the
size:S
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
dosubot
bot
added
Ɑ: core
ianchi
force-pushed
the
retriever_tool
branch
from
eef8b40 to
c04c85d
Compare
efriis
reviewed
Dec 24, 2024
| [await aformat_document(doc, document_prompt) for doc in docs] | ||
| ) | ||
|
|
||
| if response_format == "content_and_artifact": | ||
| return (content, [doc.model_dump() for doc in docs]) |
There was a problem hiding this comment.
might make sense to just return docs as the artifact - any reason to dump here in particular?
There was a problem hiding this comment.
The reason is to always have the same type after deserialization.
As artifact has type Any when deserializing a ToolMessage from json or any other source (api call, DB, etc), Pydantic won't be able to do any "magic" to regenerate the artifact as a list[Document] but it will be a plain list[dict].
So, to be consistent and always have a dict I opted to dump.
Otherwise you need to add custom logic when deserializing to have consistent types.
| format_document(doc, document_prompt) for doc in docs | ||
| ) | ||
| if response_format == "content_and_artifact": | ||
| return (content, [doc.model_dump() for doc in docs]) |
There was a problem hiding this comment.
Same reasoning as above
| @@ -55,6 +66,7 @@ def create_retriever_tool( | |||
| *, | |||
| document_prompt: Optional[BasePromptTemplate] = None, | |||
| document_separator: str = "\n\n", | |||
| response_format: Literal["content", "content_and_artifact"] = "content", | |||
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.
Add option to return content and artifacts, to also be able to access the full info of the retrieved documents.
They are returned as a list of dicts in the
artifactsproperty if parameterresponse_formatis set to"content_and_artifact".Defaults to
"content"to keep current behavior.