`langchain_community.embeddings.sparkllm`.SparkLLMTextEmbeddings¶

class langchain_community.embeddings.sparkllm.SparkLLMTextEmbeddings[source]¶

基础：《code class="xref py py-class docutils literal notranslate">BaseModel，Embeddings

SparkLLM 集成嵌入模型。

配置

要使用，您需要设置环境变量“SPARK_APP_ID”,”SPARK_API_KEY”和“SPARK_API_SECRET”，或者在构造函数中将APP_ID、API_KEY和API_SECRET作为名称参数传递。

export SPARK_APP_ID="your-api-id"
export SPARK_API_KEY="your-api-key"
export SPARK_API_SECRET="your-api-secret"

关键初始化参数 — 完成参数

api_key：可选[str]: 如果没有提供，将自动从环境变量 SPARK_API_KEY 推断出来。
app_id：可选[str]: 如果没有提供，将自动从环境变量 SPARK_APP_ID 推断出来。
api_secret：可选[str]: 如果没有提供，将自动从环境变量 SPARK_API_SECRET 推断出来。
base_url：可选[str]: API请求的基础URL路径。

请参阅参数部分中的完整初始化参数列表及其描述。

实例化

from langchain_community.embeddings import SparkLLMTextEmbeddings

embed = SparkLLMTextEmbeddings(
    api_key="...",
    app_id="...",
    api_secret="...",
    # other
)

嵌入单个文本

input_text = "The meaning of life is 42"
embed.embed_query(input_text)

[-0.4912109375, 0.60595703125, 0.658203125, 0.3037109375, 0.6591796875, 0.60302734375, ...]

嵌入多个文本

input_texts = ["This is a test query1.", "This is a test query2."]
embed.embed_documents(input_texts)

[
    [-0.1962890625, 0.94677734375, 0.7998046875, -0.1971435546875, 0.445556640625, 0.54638671875, ...],
    [  -0.44970703125, 0.06585693359375, 0.7421875, -0.474609375, 0.62353515625, 1.0478515625, ...],
]

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

如果输入数据无法解析为有效模型，则抛出 ValidationError。

param base_url: str = 'https://emb-cn-huabei-1.xf-yun.com/'¶: API请求的基础URL路径

param domain: Literal['para', 'query'] = 'para'¶: 此参数用于指明这次嵌入属于哪一种嵌入。如果“para”（默认值），则属于文档嵌入。如果“query”，则属于查询嵌入。

param spark_api_key: Optional[SecretStr] = None (alias 'api_key')¶

如果没有提供，将自动从环境变量 SPARK_API_KEY 推断出来。

约束

类型 = 字符串
writeOnly = True
格式 = 密码

param spark_api_secret: Optional[SecretStr] = None (alias 'api_secret')¶

如果没有提供，将自动从环境变量 SPARK_API_SECRET 推断出来。

约束

类型 = 字符串
writeOnly = True
格式 = 密码

param spark_app_id: Optional[SecretStr] = None (别名为'app_id')¶

如果没有提供，将自动从环境变量 SPARK_APP_ID 推断出来。

约束

类型 = 字符串
writeOnly = True
格式 = 密码

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

异步嵌入文档文档。

参数: texts (列表[str]) – 要嵌入的文本列表。
返回: 嵌入列表。
返回类型: 列表[列表[float]]

async aembed_query(text: str) → List[float]¶

异步嵌入查询文本。

参数: text (str) – 要嵌入的文本。
返回: 嵌入。
返回类型: 列表[float]

embed_documents(texts: List[str]) → Optional[List[List[float]]][source]¶

公开方法，用于获取文档列表的嵌入。

参数: texts (列表[str]) – 要嵌入的文本列表。
返回: 嵌入列表，每个文本一个，如果发生错误则返回None。
返回类型: Optional[列表[列表[float]]]

embed_query(text: str) → Optional[List[float]][源代码]¶

获取单个查询文本嵌入的公共方法。

参数: text (str) – 需要嵌入的文本。
返回: 文本的嵌入，或在发生错误时为None。
返回类型: 可选[列表[浮点数]]

使用SparkLLMTextEmbeddings的示例¶

SparkLLM文本嵌入

langchain_community.embeddings.sparkllm.SparkLLMTextEmbeddings¶

使用SparkLLMTextEmbeddings的示例¶

`langchain_community.embeddings.sparkllm`.SparkLLMTextEmbeddings¶