Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add source metadata to bedrock retriever response #21349

Merged
merged 6 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions libs/community/langchain_community/retrievers/bedrock.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,16 @@ def _get_relevant_documents(
results = response["retrievalResults"]
documents = []
for result in results:
content = result["content"]["text"]
result.pop("content")
if "score" not in result:
result["score"] = 0
if "metadata" in result:
result["sourceMetadata"] = result.pop("metadata")
rozerarenu marked this conversation as resolved.
Show resolved Hide resolved
documents.append(
Document(
page_content=result["content"]["text"],
metadata={
"location": result["location"],
"score": result["score"] if "score" in result else 0,
},
page_content=content,
metadata=result,
)
)

Expand Down
60 changes: 60 additions & 0 deletions libs/community/tests/unit_tests/retrievers/test_bedrock.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
from unittest.mock import MagicMock

import pytest
from langchain_core.documents import Document

from langchain_community.retrievers import AmazonKnowledgeBasesRetriever


@pytest.fixture
def mock_client():
return MagicMock()


@pytest.fixture
def mock_retriever_config():
return {"vectorSearchConfiguration": {"numberOfResults": 4}}


@pytest.fixture
def amazon_retriever(mock_client, mock_retriever_config):
return AmazonKnowledgeBasesRetriever(
knowledge_base_id="test_kb_id",
retrieval_config=mock_retriever_config,
client=mock_client,
)


def test_create_client(amazon_retriever):
with pytest.raises(ImportError):
amazon_retriever.create_client({})


def test_get_relevant_documents(amazon_retriever, mock_client):
query = "test query"
mock_client.retrieve.return_value = {
"retrievalResults": [
{"content": {"text": "result1"}, "metadata": {"key": "value1"}},
{
"content": {"text": "result2"},
"metadata": {"key": "value2"},
"score": 1,
"location": "testLocation",
},
{"content": {"text": "result3"}},
]
}
documents = amazon_retriever._get_relevant_documents(query, run_manager=None)

assert len(documents) == 3
assert isinstance(documents[0], Document)
assert documents[0].page_content == "result1"
assert documents[0].metadata == {"score": 0, "sourceMetadata": {"key": "value1"}}
assert documents[1].page_content == "result2"
assert documents[1].metadata == {
"score": 1,
"sourceMetadata": {"key": "value2"},
"location": "testLocation",
}
assert documents[2].page_content == "result3"
assert documents[2].metadata == {"score": 0}