langchain_together.embeddings.TogetherEmbeddings

class langchain_together.embeddings.TogetherEmbeddings[来源]

基类:BaseModelEmbeddings

TogetherEmbeddings嵌入模型。

使用时,请设置环境变量TOGETHER_API_KEY为您的API密钥,或将它作为命名参数传递给构造函数。

示例

from langchain_together import TogetherEmbeddings

model = TogetherEmbeddings()

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

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

param allowed_special: Union[Literal['all'], Set[str]] = {}

尚未支持。

param chunk_size: int = 1000

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

尚未支持。

param default_headers: Optional[Mapping[str, str]] = None
param default_query: Optional[Mapping[str, object]] = None
param dimensions: Optional[int] = None

结果嵌入应具有的维度数量。

尚未支持。

参数:disallowed_special:Union[Literal['all'], Set[str], Sequence[str]] ='all'

尚未支持。

参数:embedding_ctx_length:int=4096

一次嵌入的最大标记数。

尚未支持。

参数:http_async_client:Optional[Any]=None

可选的httpx.AsyncClient。仅供异步调用。如果您想为同步调用指定自定义客户端,则必须还指定http_client。

参数:http_client:Optional[Any]=None

可选的httpx.Client。仅供同步调用。如果您想为异步调用指定自定义客户端,则必须还指定http_async_client。

参数:max_retries:int=2

生成时的最大重试次数。

参数:model:str='togethercomputer/m2-bert-80M-8k-retrieval'

要使用的嵌入模型名称。例如,使用 'togethercomputer/m2-bert-80M-8k-retrieval'。

参数:model_kwargs:Dict[str, Any] [Optional]

包含所有对于create调用有效但未明确指定的模型参数。

param request_timeout: Optional[Union[float, Tuple[float, float], Any]] = None (别名 'timeout')

到Together嵌入API的请求超时时间。可以是浮点数、httpx.Timeout或None。

param show_progress_bar: bool = False

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

尚未支持。

param skip_empty: bool = False

在嵌入时是否跳过空字符串或抛出错误。默认为不跳过。

尚未支持。

param together_api_base: str = 'https://api.together.ai/v1/' (别名 'base_url')

要使用的端点URL。

param together_api_key: Optional[SecretStr] = None (别名 'api_key')

Solar API的API密钥。

约束
  • 类型 = 字符串

  • writeOnly = True

  • 格式 = 密码

async aembed_documents(texts: List[str]) List[List[float]][来源]

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

参数

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

返回

嵌入列表,每个文本对应一个。

返回类型

列表[列表[float]]

async aembed_query(text: str) List[float][来源]

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

参数

text (字符串) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

列表[float]

embed_documents(texts: List[str]) List[List[float]][来源]

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

参数

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

返回

嵌入列表,每个文本对应一个。

返回类型

列表[列表[float]]

embed_query(text: str) List[float][来源]

使用查询模型嵌入文本。

参数

text (字符串) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

列表[float]

使用 TogetherEmbeddings 的示例