BookendEmbeddings#

class langchain_community.embeddings.bookend.BookendEmbeddings[source]#

基础类:BaseModel, Embeddings

Bookend AI 的 sentence_transformers 嵌入模型。

示例

from langchain_community.embeddings import BookendEmbeddings

bookend = BookendEmbeddings(
    domain={domain}
    api_token={api_token}
    model_id={model_id}
)
bookend.embed_documents([
    "Please put on these earmuffs because I can't you hear.",
    "Baby wipes are made of chocolate stardust.",
])
bookend.embed_query(
    "She only paints with bold colors; she does not like pastels."
)

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

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

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

param api_token: str [Required]#

https://bookend.ai/申请一个API令牌以使用此嵌入模块。

param auth_header: dict [Optional]#
param domain: str [Required]#

https://bookend.ai/申请一个域名以使用此嵌入模块。

param model_id: str [Required]#

使用的嵌入模型ID。

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]][来源]#

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

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

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

Return type:

列表[列表[float]]

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

使用已部署的Bookend嵌入模型嵌入查询。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

文本的嵌入。

Return type:

列表[float]

使用 BookendEmbeddings 的示例