langchain_community.retrievers.bedrock.AmazonKnowledgeBasesRetriever¶
class langchain_community.retrievers.bedrock.AmazonKnowledgeBasesRetriever[source]¶
Bases: BaseRetriever
A retriever class for Amazon Bedrock Knowledge Bases.
See https://aws.amazon.com/bedrock/knowledge-bases for more info.
Parameters
knowledge_base_id – Knowledge Base ID.
region_name – The aws region e.g., us-west-2.
Fallback to AWS_DEFAULT_REGION env variable or region specified in
~/.aws/config.
credentials_profile_name – The name of the profile in the ~/.aws/credentials
or ~/.aws/config files, which has either access keys or role information
specified. If not specified, the default credential profile or, if on an
EC2 instance, credentials from IMDS will be used.
client – boto3 client for bedrock agent runtime.
retrieval_config – Configuration for retrieval.
Example
from langchain_community.retrievers import AmazonKnowledgeBasesRetriever
retriever = AmazonKnowledgeBasesRetriever(
    knowledge_base_id="<knowledge-base-id>",
    retrieval_config={
        "vectorSearchConfiguration": {
            "numberOfResults": 4
        }
    },
)
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
param client: Any = None¶
param credentials_profile_name: Optional[str] = None¶
param endpoint_url: Optional[str] = None¶
param knowledge_base_id: str [Required]¶
param metadata: Optional[Dict[str, Any]] = None¶
Optional metadata associated with the retriever. Defaults to None
This metadata will be associated with each call to this retriever,
and passed as arguments to the handlers defined in callbacks.