BedrockRerank#

class langchain_aws.document_compressors.rerank.BedrockRerank[source]#

Bases: BaseDocumentCompressor

Document compressor that uses AWS Bedrock Rerank API.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param aws_access_key_id: SecretStr | None [Optional]#

AWS access key id.

If provided, aws_secret_access_key must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

If not provided, will be read from ‘AWS_ACCESS_KEY_ID’ environment variable.

param aws_secret_access_key: SecretStr | None [Optional]#

AWS secret_access_key.

If provided, aws_access_key_id must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

If not provided, will be read from ‘AWS_SECRET_ACCESS_KEY’ environment variable.

param aws_session_token: SecretStr | None [Optional]#

AWS session token.

If provided, aws_access_key_id and aws_secret_access_key must also be provided. Not required unless using temporary credentials. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

If not provided, will be read from ‘AWS_SESSION_TOKEN’ environment variable.

param client: Any = None#

Bedrock client to use for compressing documents.

param config: Any = None#

An optional botocore.config.Config instance to pass to the client.

param credentials_profile_name: str | None [Optional]#

AWS profile for authentication, optional.

param endpoint_url: str | None = None (alias 'base_url')#

Needed if you don’t want to default to us-east-1 endpoint

param model_arn: str [Required]#

The ARN of the reranker model.

param region_name: str | None = None#

The aws region, e.g., us-west-2.

Falls back to AWS_REGION or AWS_DEFAULT_REGION env variable or region specified in ~/.aws/config in case it is not provided here.

param top_n: int | None = 3#

Number of documents to return.

async acompress_documents(documents: Sequence[Document], query: str, callbacks: Callbacks | None = None) → Sequence[Document]#

Async compress retrieved documents given the query context.

Parameters:

  • documents (Sequence[Document]) – The retrieved documents.

  • query (str) – The query context.

  • callbacks (Optional[Callbacks]) – Optional callbacks to run during compression.

Returns:

The compressed documents.

Return type:

Sequence[Document]

compress_documents(documents: Sequence[Document], query: str, callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None) → Sequence[Document][source]#

Compress documents using Bedrock’s rerank API.

Parameters:

  • documents (Sequence[Document]) – A sequence of documents to compress.

  • query (str) – The query to use for compressing the documents.

  • callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to run during the compression process.

Returns:

A sequence of compressed documents.

Return type:

Sequence[Document]

rerank(documents: Sequence[str | Document | dict], query: str, top_n: int | None = None, additional_model_request_fields: Dict[str, Any] | None = None) → List[Dict[str, Any]][source]#

Returns an ordered list of documents based on their relevance to the query.

Parameters:

  • query (str) – The query to use for reranking.

  • documents (Sequence[str | Document | dict]) – A sequence of documents to rerank.

  • top_n (int | None) – The number of top-ranked results to return. Defaults to self.top_n.

  • additional_model_request_fields (Dict[str, Any] | None) – Additional fields to pass to the model.

Returns:

A list of ranked documents with relevance scores.

Return type:

List[Dict[str, Any]]