MosaicMLInstructorEmbeddings#

class langchain_community.embeddings.mosaicml.MosaicMLInstructorEmbeddings[source]#

基础类：BaseModel, Embeddings

MosaicML嵌入服务。

要使用，您应该设置环境变量 MOSAICML_API_TOKEN 为您的API令牌，或者将其作为命名参数传递给构造函数。

示例

from langchain_community.llms import MosaicMLInstructorEmbeddings
endpoint_url = (
    "https://models.hosted-on.mosaicml.hosting/instructor-large/v1/predict"
)
mosaic_llm = MosaicMLInstructorEmbeddings(
    endpoint_url=endpoint_url,
    mosaicml_api_token="my-api-key"
)

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

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

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

param embed_instruction: str = 'Represent the document for retrieval: '#: 用于嵌入文档的指令。

param endpoint_url: str = 'https://models.hosted-on.mosaicml.hosting/instructor-xl/v1/predict'#: 使用的端点URL。

param mosaicml_api_token: str | None = None#

param query_instruction: str = 'Represent the question for retrieving supporting documents: '#: 用于嵌入查询的指令。

param retry_sleep: float = 1.0#: 如果遇到速率限制，尝试睡眠多长时间

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]][source]#

使用MosaicML部署的instructor嵌入模型嵌入文档。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表，每个文本对应一个。
Return type:: 列表[列表[float]]

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

使用MosaicML部署的instructor嵌入模型嵌入查询。

Parameters:: 文本 (str) – 要嵌入的文本。
Returns:: 文本的嵌入。
Return type:: 列表[float]

使用 MosaicMLInstructorEmbeddings 的示例

MosaicML