SparkLLM文本嵌入

class langchain_community.embeddings.sparkllm.SparkLLMTextEmbeddings

基础类：BaseModel, Embeddings

SparkLLM 嵌入模型集成。

Setup:

要使用，您应该设置环境变量“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"

Key init args — completion params:

api_key: Optional[str]

如果未提供，则自动从环境变量 SPARK_API_KEY 推断。

app_id: Optional[str]

如果未提供，则自动从环境变量SPARK_APP_ID推断。

api_secret: Optional[str]

如果未提供，则自动从环境变量 SPARK_API_SECRET 推断。

base_url: Optional[str]

API请求的基本URL路径。

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

实例化：

from langchain_community.embeddings import SparkLLMTextEmbeddings

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

Embed single text:

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, ...]

Embed multiple text:

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][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

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: SecretStr | None [Optional] (alias 'api_key')

如果未提供，则自动从环境变量 SPARK_API_KEY 推断。

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

如果未提供，则自动从环境变量SPARK_API_SECRET推断。

param spark_app_id: SecretStr [Optional] (alias 'app_id')

如果未提供，则自动从环境变量SPARK_APP_ID推断。

async aembed_documents(texts: list[str]) → list[list[float]]

异步嵌入搜索文档。

Parameters:

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

Returns:

嵌入列表。

Return type:

列表[列表[浮点数]]

async aembed_query(text: str) → list[float]

异步嵌入查询文本。

Parameters:

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

Returns:

嵌入。

Return type:

列表[浮点数]

embed_documents(texts: List[str]) → List[List[float]] | None

获取文档列表嵌入的公共方法。

Parameters:

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

Returns:

嵌入列表，每个文本对应一个，如果发生错误则为None。

Return type:

列表[列表[浮点数]] | 无

embed_query(text: str) → List[float] | None

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

Parameters:

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

Returns:

文本的嵌入，如果发生错误则为None。

Return type:

列表[float] | 无

使用 SparkLLMTextEmbeddings 的示例

• SparkLLM 文本嵌入

• iFlytek