langchain.embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings¶
- class langchain.embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings(*, client: Any = None, endpoint_name: str = '', region_name: str = '', credentials_profile_name: Optional[str] = None, content_handler: EmbeddingsContentHandler, model_kwargs: Optional[Dict] = None, endpoint_kwargs: Optional[Dict] = None)[source]¶
Bases:
BaseModel,EmbeddingsCustom Sagemaker Inference Endpoints.
To use, you must supply the endpoint name from your deployed Sagemaker model & the region where it is deployed.
To authenticate, the AWS client uses the following methods to automatically load credentials: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
If a specific credential profile should be used, you must pass the name of the profile from the ~/.aws/credentials file that is to be used.
Make sure the credentials / roles used have the required policies to access the Sagemaker endpoint. See: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html
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 content_handler: langchain.embeddings.sagemaker_endpoint.EmbeddingsContentHandler [Required]¶
The content handler class that provides an input and output transform functions to handle formats between LLM and the endpoint.
- param credentials_profile_name: Optional[str] = None¶
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. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
- param endpoint_kwargs: Optional[Dict] = None¶
Optional attributes passed to the invoke_endpoint function. See `boto3`_. docs for more info. .. _boto3: <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>
- param endpoint_name: str = ''¶
The name of the endpoint from the deployed Sagemaker model. Must be unique within an AWS Region.
- param model_kwargs: Optional[Dict] = None¶
Key word arguments to pass to the model.
- param region_name: str = ''¶
The aws region where the Sagemaker model is deployed, eg. us-west-2.
- embed_documents(texts: List[str], chunk_size: int = 64) List[List[float]][source]¶
Compute doc embeddings using a SageMaker Inference Endpoint.
- Parameters
texts – The list of texts to embed.
chunk_size – The chunk size defines how many input texts will be grouped together as request. If None, will use the chunk size specified by the class.
- Returns
List of embeddings, one for each text.
- embed_query(text: str) List[float][source]¶
Compute query embeddings using a SageMaker inference endpoint.
- Parameters
text – The text to embed.
- Returns
Embeddings for the text.