`langchain_community.vectorstores.kinetica`.Kinetica¶

class langchain_community.vectorstores.kinetica.Kinetica(config: KineticaSettings, embedding_function: Embeddings, collection_name: str = 'langchain_kinetica_embeddings', schema_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN, pre_delete_collection: bool = False, logger: Optional[Logger] = None, relevance_score_fn: Optional[Callable[[float], float]] = None)[source]¶

Kinetica 向量存储。

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

参数

kinetica_settings – Kinetica 连接设置类。
embedding_function (Embeddings) – 任何实现 langchain.embeddings.base.Embeddings 接口的嵌入函数。
collection_name (str) – 要使用的集合的名称。（默认值：langchain）注意：这不是表的名称，而是集合的名称。表将在初始化存储时创建（如果不存在），因此，请确保用户具有创建表的正确权限。
distance_strategy (DistanceStrategy) – 要使用的距离策略。（默认值：COSINE）
pre_delete_collection (bool) – 如果为 True，则如果集合存在，将删除该集合。（默认值：False）。用于测试很有用。
engine_args – SQLAlchemy 的创建引擎参数。
config (KineticaSettings) –
schema_name (str) –
logger (Optional[logging.Logger]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

示例

from langchain_community.vectorstores import Kinetica, KineticaSettings
from langchain_community.embeddings.openai import OpenAIEmbeddings

kinetica_settings = KineticaSettings(
    host="http://127.0.0.1", username="", password=""
    )
COLLECTION_NAME = "kinetica_store"
embeddings = OpenAIEmbeddings()
vectorstore = Kinetica.from_documents(
    documents=docs,
    embedding=embeddings,
    collection_name=COLLECTION_NAME,
    config=kinetica_settings,
)

Kinetica 类的构造函数

参数

config (KineticaSettings) – KineticaSettings 实例
embedding_function (Embeddings) – 要使用的嵌入函数
collection_name (str, optional) – Kinetica 表名。默认为 _LANGCHAIN_DEFAULT_COLLECTION_NAME。
schema_name (str, optional) – Kinetica 表名。默认为 _LANGCHAIN_DEFAULT_SCHEMA_NAME。
distance_strategy (DistanceStrategy, optional) – _描述_. 默认为 DEFAULT_DISTANCE_STRATEGY。
pre_delete_collection (bool, optional) – _描述_. 默认为 False。
logger (Optional[logging.Logger], optional) – _描述_. 默认为 None。
relevance_score_fn (Optional[Callable[[float], float]]) –

属性

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

方法

`__init__`(config, embedding_function[, ...])	Kinetica 类的构造函数
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过嵌入并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_embeddings`(texts, embeddings[, ...])	将嵌入添加到向量存储。
`add_texts`(texts[, metadatas, ids])	运行更多文本通过嵌入并添加到向量存储。
`adelete`([ids])	异步按向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的 VectorStore。
`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])	异步返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	异步返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步返回范围在 [0, 1] 内的文档和相关性分数。
`asimilarity_search_with_score`(args, *kwargs)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`create_schema`()	创建一个新的 Kinetica schema
`create_tables_if_not_exists`()	创建表以存储文本和嵌入
`delete`([ids])	按向量 ID 或其他条件删除。
`delete_schema`()	删除 cascade 设置为 true 的 Kinetica schema。此方法将删除包含所有表的 schema。
`drop_tables`()	删除表
`from_documents`(documents, embedding[, ...])	将传入的 Document 列表添加到向量存储并返回它
`from_embeddings`(text_embeddings, embedding)	将传入的嵌入添加到向量存储并返回它
`from_texts`(texts, embedding[, metadatas, ...])	将传入的文本添加到向量存储并返回它
`get_by_ids`(ids, /)	按 ID 获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档
`max_marginal_relevance_search_with_score`(query)	返回使用最大边际相关性以及分数选择的文档。
`max_marginal_relevance_search_with_score_by_vector`(...)	返回使用最大边际相关性以及分数选择的文档
`search`(query, search_type, **kwargs)	返回与使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, filter])	使用 Kinetica 运行带距离的相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围在 [0, 1] 内的文档和相关性分数。
`similarity_search_with_score`(query[, k, filter])	返回与查询最相似的文档。
`similarity_search_with_score_by_vector`(embedding)
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(config: KineticaSettings, embedding_function: Embeddings, collection_name: str = 'langchain_kinetica_embeddings', schema_name: str = 'langchain', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN, pre_delete_collection: bool = False, logger: Optional[Logger] = None, relevance_score_fn: Optional[Callable[[float], float]] = None) → None[source]¶

Kinetica 类的构造函数

参数

config (KineticaSettings) – KineticaSettings 实例
embedding_function (Embeddings) – 要使用的嵌入函数
collection_name (str, optional) – Kinetica 表名。默认为 _LANGCHAIN_DEFAULT_COLLECTION_NAME。
schema_name (str, optional) – Kinetica 表名。默认为 _LANGCHAIN_DEFAULT_SCHEMA_NAME。
distance_strategy (DistanceStrategy, optional) – _描述_. 默认为 DEFAULT_DISTANCE_STRATEGY。
pre_delete_collection (bool, optional) – _描述_. 默认为 False。
logger (Optional[logging.Logger], optional) – _描述_. 默认为 None。
relevance_score_fn (Optional[Callable[[float], float]]) –

返回类型

None

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

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

参数

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

返回

添加的文本的 ID 列表。

引发

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

返回类型

List[str]

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

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

参数

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

返回

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

引发

ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果 ID 的数量与文本的数量不匹配。

返回类型

List[str]

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

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

参数

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

返回

添加的文本的 ID 列表。

引发

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

返回类型

List[str]

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

将嵌入添加到向量存储。

参数

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

返回类型

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 可选的元数据列表（JSON 数据），与文本关联。
ids (Optional[List[str]]) – 提供的文本的 ID（UUID）列表；如果为 None，则将生成 ID
kwargs (Any) – 向量存储特定参数

返回

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

返回类型

List[str]

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

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

参数

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

返回

如果删除成功，则为 True，否则为 False；如果未实现，则为 None。

返回类型

Optional[bool]

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

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

参数

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

返回

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

返回类型

VectorStore

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

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

参数

texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]¶

异步按 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: Document 列表。
返回类型: List[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]¶

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

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

参数

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

返回

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

返回类型

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

参数

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Dict[str, str]]) –
kwargs (Any) –

返回类型

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从该 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括：search_type (Optional[str]): 定义检索器应执行的搜索类型。

可以是 “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: 按文档元数据筛选

返回

VectorStore 的检索器类。

返回类型

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]¶

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

参数

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

返回

与查询最相似的 Document 列表。

引发

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

返回类型

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本。
k (int) – 要返回的 Document 数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的 Document 列表。

返回类型

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的 Document 数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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

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

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

参数

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

筛选检索到的文档结果集

返回

(doc, similarity_score) 元组的列表

返回类型

List[Tuple[Document, float]]

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

异步运行带距离的相似性搜索。

参数

*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。

返回

(doc, similarity_score) 元组的列表。

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

在 0.2.11 中添加。API 可能会发生变化。

以流式方式 Upsert 文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的 Document 的可迭代对象。
batch_size (int) – 每次 upsert 的批次大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包括所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包括 ids 以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

在 0.2.11 中添加。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 附加关键字参数。

返回

一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

create_schema() → None[source]¶

创建一个新的 Kinetica schema

返回类型: None

create_tables_if_not_exists() → Any[source]¶

创建表以存储文本和嵌入

返回类型: Any

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

按向量 ID 或其他条件删除。

参数

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

返回

如果删除成功，则为 True，否则为 False；如果未实现，则为 None。

返回类型

Optional[bool]

delete_schema() → None[source]¶

删除 cascade 设置为 true 的 Kinetica schema。此方法将删除包含所有表的 schema。

返回类型: None

drop_tables() → None[source]¶

删除表

返回类型: None

classmethod from_documents(documents: List[Document], embedding: Embeddings, config: KineticaSettings = KineticaSettings(host='http://127.0.0.1', port=9191, username=None, password=None, database='langchain', table='langchain_kinetica_embeddings', metric='l2'), metadatas: Optional[List[dict]] = None, collection_name: str = 'langchain_kinetica_embeddings', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, *, schema_name: str = 'langchain', **kwargs: Any) → Kinetica[source]¶

将传入的 Document 列表添加到向量存储并返回它

参数

cls (Type[Kinetica]) – Kinetica 类
texts (List[str]) – 生成嵌入的文本列表
embedding (Embeddings) – 嵌入列表
config (KineticaSettings) – KineticaSettings 实例
metadatas (Optional[List[dict]], optional) – 描述文本/文档的字典列表 JSON。默认为 None。
collection_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_COLLECTION_NAME。
schema_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_SCHEMA_NAME。
distance_strategy (DistanceStrategy, optional) – 距离策略，例如 l2、cosine 等。默认为 DEFAULT_DISTANCE_STRATEGY。
ids (Optional[List[str]], optional) – 每个文本/文档的 UUID 列表。默认为 None。
pre_delete_collection (bool, optional) – 指示是否要删除 Kinetica 模式。默认为 False。
documents (List[Document]) –
kwargs (Any) –

返回

一个 Kinetica 实例

返回类型

Kinetica

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, metadatas: Optional[List[dict]] = None, config: KineticaSettings = KineticaSettings(host='http://127.0.0.1', port=9191, username=None, password=None, database='langchain', table='langchain_kinetica_embeddings', metric='l2'), dimensions: int = Dimension.OPENAI, collection_name: str = 'langchain_kinetica_embeddings', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, *, schema_name: str = 'langchain', **kwargs: Any) → Kinetica[source]¶

将传入的嵌入添加到向量存储并返回它

参数

cls (Type[Kinetica]) – Kinetica 类
text_embeddings (List[Tuple[str, List[float]]]) – 文本列表和嵌入
embedding (Embeddings) – 嵌入列表
metadatas (Optional[List[dict]], optional) – 描述文本/文档的字典列表 JSON。默认为 None。
config (KineticaSettings) – KineticaSettings 实例
dimensions (int, optional) – 向量数据的维度，如果未传递，则将使用默认值。默认为 Dimension.OPENAI。
collection_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_COLLECTION_NAME。
schema_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_SCHEMA_NAME。
distance_strategy (DistanceStrategy, optional) – 距离策略，例如 l2、cosine 等。默认为 DEFAULT_DISTANCE_STRATEGY。
ids (Optional[List[str]], optional) – 每个文本/文档的 UUID 列表。默认为 None。
pre_delete_collection (bool, optional) – 指示是否要删除 Kinetica 模式。默认为 False。
kwargs (Any) –

返回

一个 Kinetica 实例

返回类型

Kinetica

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, config: KineticaSettings = KineticaSettings(host='http://127.0.0.1', port=9191, username=None, password=None, database='langchain', table='langchain_kinetica_embeddings', metric='l2'), collection_name: str = 'langchain_kinetica_embeddings', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN, ids: Optional[List[str]] = None, pre_delete_collection: bool = False, *, schema_name: str = 'langchain', **kwargs: Any) → Kinetica[source]¶

将传入的文本添加到向量存储并返回它

参数

cls (Type[Kinetica]) – Kinetica 类
texts (List[str]) – 生成嵌入的文本列表
embedding (Embeddings) – 嵌入列表
metadatas (Optional[List[dict]], optional) – 描述文本/文档的字典列表 JSON。默认为 None。
config (KineticaSettings) – KineticaSettings 实例
collection_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_COLLECTION_NAME。
schema_name (str, optional) – Kinetica 模式名称。默认为 _LANGCHAIN_DEFAULT_SCHEMA_NAME。
distance_strategy (DistanceStrategy, optional) – 距离策略，例如 l2、cosine 等。默认为 DEFAULT_DISTANCE_STRATEGY。
ids (Optional[List[str]], optional) – 每个文本/文档的 UUID 列表。默认为 None。
pre_delete_collection (bool, optional) – 指示是否要删除 Kinetica 模式。默认为 False。
kwargs (Any) –

返回

一个 Kinetica 实例

返回类型

Kinetica

get_by_ids(ids: Sequence[str], /) → List[Document]¶

按 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: Document 列表。
返回类型: List[Document]

0.2.11 版本新增功能。

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的 Document 数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，它决定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

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

返回类型

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

返回使用最大边际相关性选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和: 所选文档之间的多样性。

参数

embedding (str) – 用于查找相似文档的文本。
k (int) – 要返回的 Document 数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，它决定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

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

返回类型

List[Document]

max_marginal_relevance_search_with_score(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的 Document 数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，它决定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

通过最大边际: 相关性选择的文档列表以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回使用最大边际相关性以及分数选择的文档: 到嵌入向量。
最大边际相关性优化查询的相似性和: 所选文档之间的多样性。

参数

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的 Document 数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，它决定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

通过最大边际: 相关性选择的文档列表以及每个文档的分数。

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回

与查询最相似的 Document 列表。

引发

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

返回类型

List[Document]

similarity_search(query: str, k: int = 4, filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

使用 Kinetica 运行带距离的相似性搜索。

参数

query (str) – 要搜索的查询文本。
k (int) – 要返回的结果数。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

与查询最相似的 Document 列表。

返回类型

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的 Document 数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
kwargs (Any) –

返回

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

返回类型

List[Document]

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

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

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

参数

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

过滤检索到的文档结果集。

返回

(doc, similarity_score) 元组的列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的 Document 数量。默认为 4。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。

返回

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

返回类型

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

参数

embedding (List[float]) –
k (int) –
过滤器 (可选[字典]) –

返回类型

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta

在 0.2.11 中添加。API 可能会发生变化。

以流式方式更新插入文档。

参数

items (Iterable[Document]) – 要添加到向量数据库的文档的可迭代对象。
batch_size (int) – 每次 upsert 的批次大小。
kwargs (Any) – 额外的关键字参数。 kwargs 应该只包含所有文档共有的参数。（例如，索引超时，重试策略等）kwargs 不应包含 ID 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

在 0.2.11 中添加。API 可能会发生变化。

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

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 附加关键字参数。

返回

一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

langchain_community.vectorstores.kinetica.Kinetica¶

使用 Kinetica 的示例¶

`langchain_community.vectorstores.kinetica`.Kinetica¶