`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: 任何实现`langchain.embeddings.base.Embeddings`接口的嵌入函数。 collection_name: 要使用的集合的名称。 (默认值: langchain)

注意: 这不是表的名称，而是集合的名称。在初始化存储时将创建表（如果不存在）因此，请确保用户有权限创建表。

distance_strategy: 要使用的距离策略。 (默认值: COSINE) pre_delete_collection: 如果为True，则如果存在将删除集合。

(默认值: False)。用于测试。

engine_args: SQLAlchemy的创建引擎参数。

示例:

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): _description_。: 默认为DEFAULT_DISTANCE_STRATEGY。

pre_delete_collection (bool, optional): _description_。默认为False。 logger (Optional[logging.Logger], optional): _description_。

默认为None。

Attributes

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

Methods

`__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。
`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_schema`()	创建一个新的Kinetica模式
`create_tables_if_not_exists`()	创建用于存储文本和嵌入向量的表格
`delete`([ids])	根据向量ID或其他条件进行删除。
`delete_schema`()	删除一个Kinetica模式，级联设置为`true` 此方法将删除一个包含所有表的模式。
`drop_tables`()	删除表格
`from_documents`(documents, embedding[, ...])	将传入的`Document`列表添加到向量存储中并返回
`from_embeddings`(text_embeddings, embedding)	将传入的嵌入添加到向量存储中并返回
`from_texts`(texts, embedding[, metadatas, ...])	将传入的文本添加到向量存储中并返回
`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)

Parameters

config (KineticaSettings) –
embedding_function (Embeddings) –
collection_name (str) –
schema_name (str) –
distance_strategy (DistanceStrategy) –
pre_delete_collection (bool) –
logger (Optional[logging.Logger]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

Return type

None

__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): _description_。: 默认为DEFAULT_DISTANCE_STRATEGY。

pre_delete_collection (bool, optional): _description_。默认为False。 logger (Optional[logging.Logger], optional): _description_。

默认为None。

Parameters

config (KineticaSettings) –
embedding_function (Embeddings) –
collection_name (str) –
schema_name (str) –
distance_strategy (DistanceStrategy) –
pre_delete_collection (bool) –
logger (Optional[Logger]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

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_embeddings(texts: Iterable[str], embeddings: List[List[float]], metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, **kwargs: Any) → List[str][source]¶

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

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

Parameters

texts (Iterable[str]) –
embeddings (List[List[float]]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
kwargs (Any) –

Return type

List[str]

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

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

参数:: texts: 要添加到向量存储中的字符串的可迭代对象。 metadatas: 与文本相关联的元数据（JSON数据）的可选列表。 ids: 提供的文本的ID（UUID）列表；如果为None，则将生成ID。 kwargs: 向量存储特定参数
返回:: 将文本添加到向量存储中后的ID列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
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

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

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

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

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

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

参数：: 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, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Dict[str, str]]) –
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]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → 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_schema() → None[source]¶

创建一个新的Kinetica模式

Return type: None

create_tables_if_not_exists() → Any[source]¶

创建用于存储文本和嵌入向量的表格

Return type: Any

delete(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]

delete_schema() → None[source]¶

删除一个Kinetica模式，级联设置为`true` 此方法将删除一个包含所有表的模式。

Return type: None

drop_tables() → None[source]¶

删除表格

Return type: 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, **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。 distance_strategy (DistanceStrategy, optional): 距离策略，例如l2、cosine等。默认为DEFAULT_DISTANCE_STRATEGY。 ids (Optional[List[str]], optional): 每个文本/文档的UUID列表。默认为None。 pre_delete_collection (bool, optional): 指示是否删除Kinetica模式。默认为False。
返回:: Kinetica: 一个`Kinetica`实例

Parameters

documents (List[Document]) –
embedding (Embeddings) –
config (KineticaSettings) –
metadatas (Optional[List[dict]]) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
kwargs (Any) –

Return type

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, **kwargs: Any) → Kinetica[source]¶

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

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

Parameters

text_embeddings (List[Tuple[str, List[float]]]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
config (KineticaSettings) –
dimensions (int) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
kwargs (Any) –

Return type

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, **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。 distance_strategy (DistanceStrategy, optional): 距离策略，例如l2、cosine等。默认为DEFAULT_DISTANCE_STRATEGY。 ids (Optional[List[str]], optional): 每个文本/文档的UUID列表。默认为None。 pre_delete_collection (bool, optional): 指示是否删除Kinetica模式。默认为False。
返回:: Kinetica: `Kinetica`实例

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
config (KineticaSettings) –
collection_name (str) –
distance_strategy (DistanceStrategy) –
ids (Optional[List[str]]) –
pre_delete_collection (bool) –
kwargs (Any) –

Return type

Kinetica

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): 要返回的文档数量。默认为4。 fetch_k (int): 要获取以传递给MMR算法的文档数量。

默认为20。

lambda_mult (float): 介于0和1之间的数字，确定结果之间多样性的程度，: 其中0对应于最大多样性，1对应于最小多样性。默认为0.5。

filter (Optional[Dict[str, str]]): 按元数据筛选。默认为None。

返回:

List[Document]: 通过最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Dict[str, str]]) –
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, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

返回使用最大边际相关性选择的文档到嵌入向量。

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

参数:

embedding (str): 要查找类似文档的文本。 k (int): 要返回的文档数量。默认为4。 fetch_k (int): 要获取以传递给MMR算法的文档数量。

默认为20。

lambda_mult (float): 0到1之间的数字，确定结果之间多样性的程度，: 0对应最大多样性，1对应最小多样性。默认为0.5。

filter (Optional[Dict[str, str]]): 按元数据筛选。默认为None。

返回:

List[Document]: 通过最大边际相关性选择的文档列表。

Parameters

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

Return type

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): 要返回的文档数量。默认为4。 fetch_k (int): 要获取以传递给MMR算法的文档数量。

默认为20。

lambda_mult (float): 0到1之间的数字，确定结果之间多样性的程度，: 0对应最大多样性，1对应最小多样性。默认为0.5。

filter (Optional[Dict[str, str]]): 按元数据过滤。默认为None。

返回：

List[Tuple[Document, float]]: 通过最大边际相关性选择的文档列表，: 以及每个文档的得分。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[dict]) –
kwargs (Any) –

Return type

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: 要查找相似文档的嵌入。 k (int): 要返回的文档数量。默认为4。 fetch_k (int): 要获取以传递给MMR算法的文档数量。默认为20。 lambda_mult (float): 0到1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filter (Optional[Dict[str, str]]): 按元数据筛选。默认为None。
返回：: List[Tuple[Document, float]]: 通过最大边际相关性选择的文档列表，以及每个文档的得分。

Parameters

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

Return type

List[Tuple[Document, float]]

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

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

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

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。
返回：: 与查询最相似的文档列表。

Parameters

query (str) –
k (int) –
filter (Optional[dict]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：: embedding: 要查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 filter (Optional[Dict[str, str]]): 按元数据筛选。默认为None。
返回：: 返回与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –
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, filter: Optional[dict] = None) → List[Tuple[Document, float]][source]¶

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

参数：: query：要查找相似文档的文本。 k：要返回的文档数量。默认为4。 filter（可选[Dict[str，str]]）：按元数据过滤。默认为无。
返回：: 返回与查询最相似的文档列表，以及每个文档的得分。

Parameters

query (str) –
k (int) –
filter (Optional[dict]) –

Return type

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

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –

Return type

List[Tuple[Document, float]]

langchain_community.vectorstores.kinetica.Kinetica¶

Examples using Kinetica¶

`langchain_community.vectorstores.kinetica`.Kinetica¶