langchain_community.embeddings.aleph_alpha.AlephAlphaSymmetricSemanticEmbedding

class langchain_community.embeddings.aleph_alpha.AlephAlphaSymmetricSemanticEmbedding[源代码]

基类: AlephAlphaAsymmetricSemanticEmbedding

Aleph Alpha语义嵌入的对称版本。

主要区别在于这里,文档和查询都通过SemanticRepresentation.Symmetric进行嵌入。

from aleph_alpha import AlephAlphaSymmetricSemanticEmbedding

embeddings = AlephAlphaAsymmetricSemanticEmbedding(
    normalize=True, compress_to_size=128
)
text = "This is a test text"

doc_result = embeddings.embed_documents([text])
query_result = embeddings.embed_query(text)

通过解析和验证关键字参数输入数据创建一个新模型。

如果输入数据无法解析成有效的模型,则抛出ValidationError。

参数 aleph_alpha_api_key: Optional[str] = None

Aleph Alpha API的API密钥。

参数 compress_to_size: Optional[int] = None

返回的嵌入是否应保持为原始的5120维向量,或压缩为128维。

参数 contextual_control_threshold: Optional[int] = None

注意力控制参数仅适用于在请求中明确设置的标记。

参数 control_log_additive: bool = True

通过将控制因子的对数添加到注意力得分来对提示项目应用控制。

参数 host: str = 'https://api.aleph-alpha.com'

API主机的主机名。默认值是“https://api.aleph-alpha.com”)

param hosting: Optional[str] = None

确定请求可以在哪些数据中心进行处理。您可以将参数设置为“aleph-alpha”,也可以省略(默认为None)。如果没有设置此值,或者将其设置为None,我们将拥有最大的灵活性来处理您的请求,即在我们自己的数据中心和其他托管商的服务器上。选择此选项以实现最大可用性。将其设置为“aleph-alpha”将使我们只能在我们的数据中心中处理请求。选择此选项以提高最大数据隐私。

param model: str = 'luminous-base'

使用的模型名称。

param nice: bool = False

将此设置为True,将向API发送信号,表明您打算对其他用户友好,通过降低您的请求的优先级。

param normalize: bool = False

返回的嵌入是否应该规范化

param request_timeout_seconds: int = 305

requests 库的API调用中设置的客户端超时。服务器将在300秒后关闭所有请求,并返回内部服务器错误。

param total_retries: int = 8

在请求以某些可重试状态码失败的情况下进行重试的次数。如果最后的重试失败,则抛出相应的异常。请注意,重试之间应用指数退避,第一次重试后为0.5秒,每次重试翻倍。因此,在默认设置下, retains 63.5秒的总等待时间。

异步 aembed_documents(texts: List[str]) List[List[float]

异步嵌入搜索文档。

参数

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

返回

嵌入列表。

返回类型

List[List[float]]

异步 aembed_query(text: str) List[float]

异步嵌入查询文本。

参数

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

返回

嵌入结果。

返回类型

List[float]

embed_documents(texts: List[str]) List[List[float][source]

调用Aleph Alpha的文档端点。

参数

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

返回

每个文本对应的嵌入列表。

返回类型

List[List[float]]

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

调用Aleph Alpha的不对称查询嵌入端点 :param text: 待嵌入的文本。

返回

文本的嵌入。

参数

text (str) –

返回类型

List[float]

使用AlephAlphaSymmetricSemanticEmbedding的示例