UpstageEmbeddings#

class langchain_upstage.embeddings.UpstageEmbeddings[source]#

基础类：BaseModel, Embeddings

UpstageEmbeddings 嵌入模型。

要使用，请设置环境变量 UPSTAGE_API_KEY 为您的 API 密钥，或者将其作为命名参数传递给构造函数。

示例

from langchain_upstage import UpstageEmbeddings

model = UpstageEmbeddings(model='solar-embedding-1-large')

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

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

param chunk_size: int = 1000#

每批嵌入的最大文本数量。

尚未支持。

param dimensions: int | None = None#

生成的输出嵌入应具有的维度数。

尚未支持。

param disallowed_special: Literal['all'] | Set[str] | Sequence[str] = 'all'#: 尚未支持。

param embedding_ctx_length: int = 4096#

一次嵌入的最大令牌数。

尚未支持。

param http_async_client: Any | None = None#: 可选的httpx.AsyncClient。仅用于异步调用。如果您希望为同步调用使用自定义客户端，则还必须指定http_client。

param http_client: Any | None = None#: 可选的httpx.Client。仅用于同步调用。如果您希望为异步调用使用自定义客户端，则还必须指定http_async_client。

param model: str [Required]#: 使用的嵌入模型名称。不要添加像-query和-passage这样的后缀。例如，使用‘solar-embedding-1-large’。

param model_kwargs: Dict[str, Any] [Optional]#: 保存任何适用于create调用但未明确指定的模型参数。

param request_timeout: float | Tuple[float, float] | Any | None = None (alias 'timeout')#: 请求Upstage嵌入API的超时时间。可以是浮点数、httpx.Timeout或None。

param show_progress_bar: bool = False#

是否在嵌入时显示进度条。

尚未支持。

param skip_empty: bool = False#

在嵌入时是否跳过空字符串或引发错误。默认情况下不跳过。

尚未支持。

param upstage_api_base: str | None [Optional] (alias 'base_url')#: 使用的端点URL。

param upstage_api_key: SecretStr [Optional] (alias 'api_key')#: 如果没有提供，则自动从环境中推断出UPSTAGE_API_KEY。

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

使用段落模型异步嵌入文档文本列表。

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

使用查询模型异步嵌入查询文本。

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

使用段落模型嵌入文档文本列表。

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

使用查询模型嵌入查询文本。