langchain_community.vectorstores.yellowbrick.Yellowbrick

class langchain_community.vectorstores.yellowbrick.Yellowbrick(embedding: Embeddings, connection_string: str, table: str, *, schema: Optional[str] = None, logger: Optional[Logger] = None, drop: bool = False)[source]

Yellowbrick作为一个向量数据库。 例子：

使用Yellowbrick客户端进行初始化。 参数：

embedding：嵌入操作符 connection_string：格式为 ‘postgres://username:password@host:port/database’ table：用于存储/检索嵌入的表格

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

__init__(embedding, connection_string, table, *)

使用Yellowbrick客户端进行初始化。 参数： embedding：嵌入操作符 connection_string：格式为 'postgres://username:password@host:port/database' table：用于存储/检索嵌入的表格

aadd_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

aadd_texts(texts[, metadatas])

运行更多的文本通过嵌入，并添加到向量存储中。

add_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

add_texts(texts[, metadatas])

运行更多的文本通过嵌入，并添加到向量存储中。

adelete([ids])

根据向量ID或其他条件进行删除。

afrom_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

afrom_texts(texts, embedding[, metadatas])

返回从文本和嵌入初始化的VectorStore。

amax_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

amax_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

as_retriever(**kwargs)

返回从此VectorStore初始化的VectorStoreRetriever。

asearch(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

asimilarity_search(query[, k])

返回与查询最相似的文档。

asimilarity_search_by_vector(embedding[, k])

返回与嵌入向量最相似的文档。

asimilarity_search_with_relevance_scores(query)

返回文档和相关性分数在范围[0, 1]内，异步执行。

asimilarity_search_with_score(*args, **kwargs)

使用异步方式运行相似性搜索与距离。

create_index(index_params)

从现有向量创建索引

delete([ids, delete_all])

根据uuid删除向量。

drop(table[, schema, cursor])

辅助函数：丢弃数据。如果提供了游标，请使用它；否则，为操作获取一个新的游标。

drop_index(index_params)

删除一个索引

from_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

from_texts(texts, embedding[, metadatas, ...])

将文本添加到向量存储索引中。 参数： texts：要添加到向量存储的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 connection_string：Yellowbrick实例的URI embedding：嵌入函数 table：存储嵌入的表 kwargs：向量存储特定参数

max_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

max_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

migrate_schema_v1_to_v2()

search(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

similarity_search(query[, k])

使用Yellowbrick进行相似性搜索

similarity_search_by_vector(embedding[, k])

使用Yellowbrick根据向量执行相似性搜索

similarity_search_with_relevance_scores(query)

返回文档和相关性得分在[0, 1]范围内。

similarity_search_with_score(query[, k])

使用Yellowbrick进行相似性搜索

similarity_search_with_score_by_vector(embedding)

使用Yellowbrick进行向量的相似性搜索
Parameters

  • embedding (Embeddings) –

  • connection_string (str) –

  • table (str) –

  • schema (Optional[str]) –

  • logger (Optional[logging.Logger]) –

  • drop (bool) –

Return type

None

__init__(embedding: Embeddings, connection_string: str, table: str, *, schema: Optional[str] = None, logger: Optional[Logger] = None, drop: bool = False) → None[source]

使用Yellowbrick客户端进行初始化。 参数：

embedding：嵌入操作符 connection_string：格式为 ‘postgres://username:password@host:port/database’ table：用于存储/检索嵌入的表格

Parameters

  • embedding (Embeddings) –

  • connection_string (str) –

  • table (str) –

  • schema (Optional[str]) –

  • logger (Optional[Logger]) –

  • drop (bool) –

Return type

None

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]

运行更多的文本通过嵌入，并添加到向量存储中。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]

运行更多的文本通过嵌入，并添加到向量存储中。

参数:

texts: 要添加到向量存储中的字符串的可迭代对象。 metadatas: 与文本相关的元数据的可选列表。 kwargs: 向量存储特定的参数。

返回:

将文本添加到向量存储中的id列表。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]

根据向量ID或其他条件进行删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST

返回从文本和嵌入初始化的VectorStore。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

VST

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]

返回使用最大边际相关性选择的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

参数：
search_type（可选[str]）：定义Retriever应执行的搜索类型。

可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。

search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：

k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
Parameters

kwargs (Any) –

Return type

VectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

返回与查询最相似的文档。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]

返回与嵌入向量最相似的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性分数在范围[0, 1]内，异步执行。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似度分数）的列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]

使用异步方式运行相似性搜索与距离。

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

create_index(index_params: IndexParams) → None[source]

从现有向量创建索引

Parameters

index_params (IndexParams) –

Return type

None

delete(ids: Optional[List[str]] = None, delete_all: Optional[bool] = None, **kwargs: Any) → None[source]

根据uuid删除向量。

参数：

ids：要删除的id列表，其中每个id都是一个uuid字符串。

Parameters

  • ids (Optional[List[str]]) –

  • delete_all (Optional[bool]) –

  • kwargs (Any) –

Return type

None

drop(table: str, schema: Optional[str] = None, cursor: Optional['PgCursor'] = None) → None[source]

辅助函数：丢弃数据。如果提供了游标，请使用它；否则，为操作获取一个新的游标。

Parameters

  • table (str) –

  • schema (Optional[str]) –

  • cursor (Optional['PgCursor']) –

Return type

None

drop_index(index_params: IndexParams) → None[source]

删除一个索引

Parameters

index_params (IndexParams) –

Return type

None

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, connection_string: str = '', table: str = 'langchain', schema: str = 'public', drop: bool = False, **kwargs: Any) → Yellowbrick[source]

将文本添加到向量存储索引中。 参数：

texts：要添加到向量存储的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 connection_string：Yellowbrick实例的URI embedding：嵌入函数 table：存储嵌入的表 kwargs：向量存储特定参数

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • connection_string (str) –

  • table (str) –

  • schema (str) –

  • drop (bool) –

  • kwargs (Any) –

Return type

Yellowbrick

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

migrate_schema_v1_to_v2() → None[source]
Return type

None

search(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

使用Yellowbrick进行相似性搜索

参数：

query (str): 查询字符串 k (int, 可选): 要检索的前K个邻居。默认为4。

注意：请不要让最终用户填写此内容，并始终注意SQL注入。

返回：

List[Document]: 文档列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document][source]

使用Yellowbrick根据向量执行相似性搜索

参数：

embedding（List[float]）：查询嵌入 k（int，可选）：要检索的前K个邻居。默认为4。

注意：请不要让最终用户填写此内容，并始终注意SQL注入。

返回：

List[Document]：文档列表

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性得分在[0, 1]范围内。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似性得分）

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]][source]

使用Yellowbrick进行相似性搜索

参数：

query (str): 查询字符串 k (int, 可选): 要检索的前K个邻居。默认为4。

注意：请不要让最终用户填写此内容，并始终注意SQL注入。

返回：

List[Document]: (Document, 相似度) 列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Tuple[Document, float]][source]

使用Yellowbrick进行向量的相似性搜索

参数:

embedding (List[float]): 查询向量 k (int, optional): 要检索的前K个邻居。默认为4。

注意: 请不要让最终用户填写此内容，并始终注意SQL注入。

返回:

List[Document, float]: 文档列表和分数

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using Yellowbrick