QianfanEmbeddingsEndpoint#
- class langchain_community.embeddings.baidu_qianfan_endpoint.QianfanEmbeddingsEndpoint[source]#
基础类:
BaseModel
,Embeddings
百度千帆嵌入模型。
- Setup:
要使用,您应该安装
qianfan
python包,并设置环境变量QIANFAN_AK
,QIANFAN_SK
。pip install qianfan export QIANFAN_AK="your-api-key" export QIANFAN_SK="your-secret_key"
- Instantiate:
from langchain_community.embeddings import QianfanEmbeddingsEndpoint embeddings = QianfanEmbeddingsEndpoint()
- Embed:
# embed the documents vectors = embeddings.embed_documents([text1, text2, ...]) # embed the query vectors = embeddings.embed_query(text) # embed the documents with async vectors = await embeddings.aembed_documents([text1, text2, ...]) # embed the query with async vectors = await embeddings.aembed_query(text)
通过解析和验证来自关键字参数的输入数据来创建一个新模型。
如果输入数据无法验证以形成有效模型,则引发 [ValidationError][pydantic_core.ValidationError]。
self 被显式地设为仅位置参数,以允许 self 作为字段名称。
- param chunk_size: int = 16#
当输入多个文本时的块大小
- param client: Any = None#
千帆客户端
- param endpoint: str = ''#
千帆嵌入的端点,如果使用自定义模型则必填。
- param init_kwargs: Dict[str, Any] [Optional]#
初始化qianfan客户端的init kwargs,例如query_per_second,它与qianfan资源对象相关联以限制QPS
- param model: str | None = None#
模型名称 你可以从https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Nlks5zkzu获取
for now, we support Embedding-V1 and - Embedding-V1 (默认模型) - bge-large-en - bge-large-zh
预设模型映射到一个端点。 如果设置了endpoint,model将被忽略
- param model_kwargs: Dict[str, Any] [Optional]#
使用do进行模型调用时的额外参数。
- param qianfan_ak: SecretStr | None = None (alias 'api_key')#
千帆应用apikey
- param qianfan_sk: SecretStr | None = None (alias 'secret_key')#
千帆应用密钥
- async aembed_documents(texts: List[str]) List[List[float]] [source]#
异步嵌入搜索文档。
- Parameters:
文本 (列表[字符串]) – 要嵌入的文本列表。
- Returns:
嵌入列表。
- Return type:
列表[列表[float]]
- async aembed_query(text: str) List[float] [source]#
异步嵌入查询文本。
- Parameters:
文本 (str) – 要嵌入的文本。
- Returns:
嵌入。
- Return type:
列表[float]
- embed_documents(texts: List[str]) List[List[float]] [source]#
使用AutoVOT算法嵌入一系列文本文档。
- Parameters:
文本 (列表[字符串]) – 要嵌入的文本文档列表。
- Returns:
- 输入列表中每个文档的嵌入列表。
每个嵌入表示为一个浮点值列表。
- Return type:
列表[列表[浮点数]]
- embed_query(text: str) List[float] [来源]#
嵌入查询文本。
- Parameters:
文本 (str) – 要嵌入的文本。
- Returns:
嵌入。
- Return type:
列表[float]
- classmethod validate_environment(values: Dict) Dict [source]#
验证环境变量或配置文件中的qianfan_ak和qianfan_sk是否可用。
使用ak、sk、model、endpoint初始化千帆嵌入客户端
- Parameters:
values (Dict) – 包含配置信息的字典,必须包括
qianfan_sk (字段 的 qianfan_ak 和)
- Returns:
包含配置信息的字典。如果环境变量或配置文件中未提供qianfan_ak和qianfan_sk,则返回原始值;否则,返回包含qianfan_ak和qianfan_sk的值。
- Raises:
ValueError – 未找到qianfan包,请使用`pip install安装
qianfan` –
- Return type:
字典
使用 QianfanEmbeddingsEndpoint 的示例