langchain_community.embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings

langchain_community.embeddings.sagemaker_endpoint.SagemakerEndpointEmbeddings[源代码]

继承基类: BaseModel, Embeddings

自定义 SageMaker 推理端点。

使用时,您必须提供您部署的 SageMaker 模型的端点名称及其部署的区域。

为了进行身份验证,AWS 客户端使用以下方法来自动加载凭证: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

如果需要使用特定的凭证轮廓,必须传递要从 ~/.aws/credentials 文件中使用的轮廓名称。

请确保使用的凭证/角色具有访问 SageMaker 端点的所需策略。见: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html

通过解析和验证输入数据来创建一个新模型。

如果输入数据不能解析以形成有效的模型,将引发 ValidationError。

参数 client: Any = None
参数 content_handler [必需]

内容处理程序类,该类提供输入和输出转换函数,以处理 LLM 与端点之间的格式。

参数 credentials_profile_name [可选] [str]] = None

在 ~/.aws/credentials 或 ~/.aws/config 文件中的配置文件名称,该文件中指定了访问密钥或角色信息。如果不指定,则使用默认凭证配置文件或,如果在 EC2 实例上,则使用 IMDS 中的凭证。见: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

参数 endpoint_kwargs [可选] [Dict]] = None

传递给 invoke_endpoint 函数的可选属性。请参见 `boto3`_ 文档以获取更多信息。.. _boto3: <https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>

param endpoint_name: str = ''

部署的 Sagemaker 模型的端点名称。必须在 AWS 区域内唯一。

param model_kwargs : Optional[Dict] = None

传递给模型的关键字参数。

param region_name : str = ''

Sagemaker 模型部署的 AWS 区域,例如 us-west-2

async aembed_documents(texts: List[str]) List[List[float]]

异步嵌入搜索文档。

参数

texts (List[str]) – 要嵌入的文本列表。

返回

嵌入列表。

返回类型

List[List[float]]

async aembed_query(text: str) List[float]

异步 Embed 查询文本。

参数

text (str) – 要嵌入的文本。

返回

嵌入。

返回类型

List[float]

embed_documents(texts: List[str], chunk_size: int = 64) List[List[float]][source]

使用 SageMaker Inference Endpoint 计算文档嵌入。

参数
  • texts (列表[字符串]) – 要嵌入的文本列表。

  • chunk_size (整数) – 块大小定义了将有多少个输入文本作为请求分组在一起。如果为 None,将使用类中指定的块大小。

返回

嵌入列表,每个文本一个。

返回类型

List[List[float]]

embed_query(text: str) List[float][source]

使用 SageMaker 推理端点计算查询嵌入。

参数

text (字符串) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

List[float]

使用 SagemakerEndpointEmbeddings 的示例