TimescaleVector#

class langchain_community.vectorstores.timescalevector.TimescaleVector(service_url: str, embedding: Embeddings, collection_name: str = 'langchain_store', num_dimensions: int = 1536, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, logger: Logger | None = None, relevance_score_fn: Callable[[float], float] | None = None, time_partition_interval: timedelta | None = None, **kwargs: Any)[来源]#

Timescale Postgres 向量存储

要使用，您应该安装timescale_vector python包。

Parameters:

service_url (str) – Timescale云上的服务URL。
embedding (Embeddings) – 任何实现langchain.embeddings.base.Embeddings接口的嵌入函数。
collection_name (str) – 要使用的集合名称。（默认值：langchain_store）这将成为用于集合的表名。
distance_strategy (DistanceStrategy) – 使用的距离策略。(默认: COSINE)
pre_delete_collection (bool) – 如果为True，将在集合存在时删除集合。 (默认值: False)。对测试很有用。
num_dimensions (int)
logger (可选[logging.Logger])
relevance_score_fn (可选[Callable[[float], float]])
time_partition_interval (可选[timedelta])
kwargs (Any)

示例

from langchain_community.vectorstores import TimescaleVector
from langchain_community.embeddings.openai import OpenAIEmbeddings

SERVICE_URL = "postgres://tsdbadmin:<password>@<id>.tsdb.cloud.timescale.com:<port>/tsdb?sslmode=require"
COLLECTION_NAME = "state_of_the_union_test"
embeddings = OpenAIEmbeddings()
vectorestore = TimescaleVector.from_documents(
    embedding=embeddings,
    documents=docs,
    collection_name=COLLECTION_NAME,
    service_url=SERVICE_URL,
)

属性

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

方法

`__init__`(service_url, embedding[, ...])
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
`aadd_embeddings`(texts, embeddings[, ...])	将嵌入添加到向量存储中。
`aadd_texts`(texts[, metadatas, ids])	通过嵌入运行更多文本并将其添加到向量存储中。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_embeddings`(texts, embeddings[, ...])	将嵌入添加到向量存储中。
`add_texts`(texts[, metadatas, ids])	通过嵌入运行更多文本并将其添加到向量存储中。
`adelete`([ids])	异步删除通过向量ID或其他条件。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
`afrom_embeddings`(text_embeddings, embedding)	从原始文档和预生成的嵌入向量构建TimescaleVector包装器。
`afrom_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
`aget_by_ids`(ids, /)	异步通过ID获取文档。
`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, filter, ...])	使用TimescaleVector进行带距离的相似性搜索。
`asimilarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步返回文档和相关度分数，范围在[0, 1]之间。
`asimilarity_search_with_score`(query[, k, ...])	返回与查询最相似的文档。
`asimilarity_search_with_score_by_vector`(...)
`create_index`([index_type])
`date_to_range_filter`(**kwargs)
`delete`([ids])	通过向量ID或其他条件删除。
`delete_by_metadata`(filter, **kwargs)	根据向量ID或其他条件删除。
`drop_index`()
`drop_tables`()
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_embeddings`(text_embeddings, embedding)	从原始文档和预生成的嵌入向量构建TimescaleVector包装器。
`from_existing_index`(embedding[, ...])	获取现有TimescaleVector存储的实例。此方法将返回存储的实例，而不会插入任何新的嵌入
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
`get_by_ids`(ids, /)	通过ID获取文档。
`get_service_url`(kwargs)
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`service_url_from_db_params`(host, port, ...)	从数据库参数返回连接字符串。
`similarity_search`(query[, k, filter, predicates])	使用TimescaleVector进行带距离的相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关分数，分数范围在[0, 1]之间。
`similarity_search_with_score`(query[, k, ...])	返回与查询最相似的文档。
`similarity_search_with_score_by_vector`(embedding)

__init__(service_url: str, embedding: Embeddings, collection_name: str = 'langchain_store', num_dimensions: int = 1536, distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, logger: Logger | None = None, relevance_score_fn: Callable[[float], float] | None = None, time_partition_interval: timedelta | None = None, **kwargs: Any) → None[源代码]#

Parameters:

service_url (str)
embedding (Embeddings)
collection_name (str)
num_dimensions (int)
distance_strategy (DistanceStrategy)
pre_delete_collection (bool)
logger (Logger | None)
relevance_score_fn (Callable[[float], float] | None)
time_partition_interval (timedelta | None)
kwargs (Any)

Return type:

无

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

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

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

async aadd_embeddings(texts: Iterable[str], embeddings: List[List[float]], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

将嵌入添加到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
embeddings (List[List[float]]) – 嵌入向量的列表的列表。
metadatas (List[dict] | None) – 与文本相关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Return type:

列表[str]

async aadd_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][来源]#

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

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Returns:

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

Return type:

列表[str]

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

在向量存储中添加或更新文档。

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

add_embeddings(texts: Iterable[str], embeddings: List[List[float]], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

将嵌入添加到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
embeddings (List[List[float]]) – 嵌入向量的列表的列表。
metadatas (List[dict] | None) – 与文本相关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Return type:

列表[str]

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

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

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
kwargs (Any) – 向量存储特定参数
ids (列表[字符串] | 无)

Returns:

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

Return type:

列表[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

通过向量ID或其他条件异步删除。

Parameters:

ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

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

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档列表。
embedding (Embeddings) – 使用的嵌入函数。
kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

VectorStore

async classmethod afrom_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: List[dict] | None = None, collection_name: str = 'langchain_store', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, pre_delete_collection: bool = False, **kwargs: Any) → TimescaleVector[source]#

从原始文档和预生成的嵌入构建TimescaleVector包装器。

返回从文档和嵌入初始化的VectorStore。需要Postgres连接字符串 “可以将其作为参数传递或者设置TIMESCALE_SERVICE_URL环境变量。

示例

from langchain_community.vectorstores import TimescaleVector
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
tvs = TimescaleVector.from_embeddings(text_embedding_pairs, embeddings)

Parameters:

text_embeddings (List[Tuple[str, List[float]]])
embedding (Embeddings)
metadatas (列表[字典] | 无)
collection_name (str)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
pre_delete_collection (bool)
kwargs (Any)

Return type:

TimescaleVector

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, collection_name: str = 'langchain_store', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, pre_delete_collection: bool = False, **kwargs: Any) → TimescaleVector[source]#

返回从文本和嵌入初始化的VectorStore。需要Postgres连接字符串 “要么将其作为参数传递要么设置TIMESCALE_SERVICE_URL环境变量。

Parameters:

文本 (列表[字符串])
embedding (Embeddings)
metadatas (列表[字典] | 无)
collection_name (str)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
pre_delete_collection (bool)
kwargs (Any)

Return type:

TimescaleVector

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本0.2.11中添加。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
kwargs (Any)

Returns:

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

Return type:

列表[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) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。

可以包括以下内容：

k: 返回的文档数量（默认：4） score_threshold: 最小相关性阈值

用于similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量: （默认：20）
lambda_mult: MMR返回结果的多样性；: 1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

VectorStoreRetriever

示例：

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

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

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

Parameters:

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

async asimilarity_search(query: str, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Document][来源]#

使用TimescaleVector进行带距离的相似性搜索。

Parameters:

query (str) – 要搜索的查询文本。
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询最相似的文档列表。

Return type:

列表[Document]

async asimilarity_search_by_vector(embedding: List[float] | None, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Document][source]#

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

Parameters:

embedding (可选[列表[浮点数]]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

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

异步返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

过滤检索到的文档集

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score(query: str, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score_by_vector(embedding: List[float] | None, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Parameters:

embedding (可选[列表[浮点数]])
k (整数)
filter (可选[联合[字典, 列表]])
predicates (可选[Predicates])
kwargs (Any)

Return type:

列表[元组[Document, 浮点数]]

create_index(index_type: IndexType | str = IndexType.TIMESCALE_VECTOR, **kwargs: Any) → None[source]#

Parameters:

index_type (联合[IndexType, str])
kwargs (Any)

Return type:

无

date_to_range_filter(**kwargs: Any) → Any[来源]#

Parameters:: kwargs (任意)
Return type:: 任何

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

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

Parameters:

ids (List[str] | None) – 要删除的ID列表。
**kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

delete_by_metadata(filter: Dict[str, str] | List[Dict[str, str]], **kwargs: Any) → bool | None[source]#

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

Parameters:

ids – 要删除的ID列表。
**kwargs (Any) – 子类可能使用的其他关键字参数。
filter (Dict[str, str] | List[Dict[str, str]])
**kwargs

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

drop_index() → None[source]#

Return type:: 无

drop_tables() → None[source]#

Return type:: 无

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

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

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档列表。
embedding (Embeddings) – 使用的嵌入函数。
kwargs (Any) – 额外的关键字参数。

Returns:

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

Return type:

VectorStore

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: List[dict] | None = None, collection_name: str = 'langchain_store', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, pre_delete_collection: bool = False, **kwargs: Any) → TimescaleVector[source]#

从原始文档和预生成的嵌入构建TimescaleVector包装器。

返回从文档和嵌入初始化的VectorStore。需要Postgres连接字符串 “可以将其作为参数传递或者设置TIMESCALE_SERVICE_URL环境变量。

示例

from langchain_community.vectorstores import TimescaleVector
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
tvs = TimescaleVector.from_embeddings(text_embedding_pairs, embeddings)

Parameters:

text_embeddings (List[Tuple[str, List[float]]])
embedding (Embeddings)
metadatas (列表[字典] | 无)
collection_name (str)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
pre_delete_collection (bool)
kwargs (Any)

Return type:

TimescaleVector

classmethod from_existing_index(embedding: Embeddings, collection_name: str = 'langchain_store', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, pre_delete_collection: bool = False, **kwargs: Any) → TimescaleVector[source]#

获取现有TimescaleVector存储的实例。此方法将返回存储的实例，而不会插入任何新的嵌入。

Parameters:

embedding (Embeddings)
collection_name (str)
distance_strategy (DistanceStrategy)
pre_delete_collection (bool)
kwargs (Any)

Return type:

TimescaleVector

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, collection_name: str = 'langchain_store', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, ids: List[str] | None = None, pre_delete_collection: bool = False, **kwargs: Any) → TimescaleVector[source]#

返回从文本和嵌入初始化的VectorStore。需要Postgres连接字符串 “要么将其作为参数传递要么设置TIMESCALE_SERVICE_URL环境变量。

Parameters:

文本 (列表[字符串])
embedding (Embeddings)
metadatas (列表[字典] | 无)
collection_name (str)
distance_strategy (DistanceStrategy)
ids (列表[字符串] | 无)
pre_delete_collection (bool)
kwargs (Any)

Return type:

TimescaleVector

get_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[Document]

在版本0.2.11中添加。

classmethod get_service_url(kwargs: Dict[str, Any]) → str[source]#

Parameters:: kwargs (Dict[str, Any])
Return type:: 字符串

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Return type:

列表[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]#

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

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

Parameters:

embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Return type:

列表[Document]

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

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

Parameters:

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

classmethod service_url_from_db_params(host: str, port: int, database: str, user: str, password: str) → str[source]#

从数据库参数返回连接字符串。

Parameters:

host (str)
port (int)
数据库 (str)
用户 (字符串)
password (str)

Return type:

字符串

similarity_search(query: str, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Document][来源]#

使用TimescaleVector进行带距离的相似性搜索。

Parameters:

query (str) – 要搜索的查询文本。
k (int) – 返回的结果数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询最相似的文档列表。

Return type:

列表[Document]

similarity_search_by_vector(embedding: List[float] | None, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Document][source]#

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

Parameters:

embedding (可选[列表[浮点数]]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score(query: str, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (可选[Dict[str, str]]) – 通过元数据进行过滤。默认为 None。
predicates (可选[Predicates])
kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score_by_vector(embedding: List[float] | None, k: int = 4, filter: dict | list | None = None, predicates: Predicates | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

Parameters:

embedding (可选[列表[浮点数]])
k (整数)
filter (可选[联合[字典, 列表]])
predicates (可选[Predicates])
kwargs (Any)

Return type:

列表[元组[Document, 浮点数]]

使用 TimescaleVector 的示例