langchain_community.embeddings.mosaicml
.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。
- 参数embed_instruction: str= '表示该文档以供检索:'¶
用于嵌入文档的指令。
- 参数endpoint_url: str= 'https://models.hosted-on.mosaicml.hosting/instructor-xl/v1/predict'¶
要使用的端点URL。
- 参数mosaicml_api_token: Optional[str]= None¶
- 参数query_instruction: str= '表示该问题以检索支持文档:'¶
用于嵌入查询的指令。
- 参数retry_sleep: float= 1.0¶
如果遇到速率限制,尝试休眠多长时间。
- async aembed_documents(texts: List[str]) List[List[float]] ¶
异步嵌入搜索文档。
- 参数
texts (List[str]) – 要嵌入的文本列表。
- 返回
嵌入列表。
- 返回类型
List[List[float]]
- async aembed_query(text: str) List[float] ¶
异步嵌入查询文本。
- 参数
text (str) – 要嵌入的文本。
- 返回
嵌入。
- 返回类型
List[float]