`langchain_core.example_selectors.semantic_similarity`.SemanticSimilarityExampleSelector¶

class langchain_core.example_selectors.semantic_similarity.SemanticSimilarityExampleSelector[源码]¶

基类: _VectorStoreExampleSelector

根据语义相似度选择示例。

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

如果输入数据无法解析为有效的模型，则引发 ValidationError。

参数 example_keys: Optional[List[str]]] = None¶: 可选的键，用于过滤示例。

参数 input_keys: Optional[List[str]]] = None¶: 可选的键，用于过滤输入。如果提供，搜索基于输入变量而不是所有变量。

参数 k : int = 4¶: 要选择的示例数量。

参数 vectorstore: VectorStore [必需]¶: 包含示例信息的 VectorStore。

参数 vectorstore_kwargs: Optional[Dict[str, Any]] = None¶: 传递到 vectorstore 中 similarity_search 函数的额外参数。

async aadd_example(example: Dict[str, str]) → str¶

异步将新示例添加到vectorstore。

参数: example (Dict[str, str]) – 一个字典，键是输入变量，值是它们的值。
返回值: 添加的示例的ID。
返回类型: str

add_example(example: Dict[str, str]) → str¶

将新示例添加到vectorstore。

参数: example (Dict[str, str]) – 一个字典，键是输入变量，值是它们的值。
返回值: 添加的示例的ID。
返回类型: str

async classmethod afrom_examples(examples: List[dict], embeddings: Embeddings, vectorstore_cls: Type[VectorStore], k: int = 4, input_keys: Optional[List[str]] = None, *, example_keys: Optional[List[str]] = None, vectorstore_kwargs: Optional[dict] = None, **vectorstore_cls_kwargs: Any) → SemanticSimilarityExampleSelector[source]¶

使用examples列表和嵌入异步创建k个short示例选择器。

根据查询相似度动态重新排列示例。

参数

examples (列表[字典]) – 用于提示的示例列表。
embeddings (嵌入) – 初始化的嵌入API接口，例如OpenAIEmbeddings()。
vectorstore_cls (类型[向量存储]) – 向量存储数据库接口类，例如FAISS。
k (整数) – 要选择的示例数量。默认为4。
input_keys (可选[列表[字符串]]) – 如果提供，则搜索基于输入变量，而不是所有变量。
example_keys (可选[列表[字符串]]) – 如果提供，则用于过滤示例的键。
vectorstore_kwargs (可选[字典]) – 传递给向量存储相似性搜索函数的额外参数。
vectorstore_cls_kwargs (任何类型) – 包含向量存储 URL 的可选 kwargs。

返回值

The ExampleSelector 实例化，由一个向量存储支持。

返回类型

SemanticSimilarityExampleSelector

异步 aselect_examples(input_variables: Dict[str, str]) → List[dict][source]¶

基于语义相似性异步选择示例。

参数: input_variables (字典[字符串，字符串]) – 用于搜索的输入变量。
返回值: 所选的示例。
返回类型: 列表[dict]

classmethod from_examples(examples: List[dict], embeddings: Embeddings, vectorstore_cls: Type[VectorStore], k: int = 4, input_keys: Optional[List[str]] = None, *, example_keys: Optional[List[str]] = None, vectorstore_kwargs: Optional[dict] = None, **vectorstore_cls_kwargs: Any) → SemanticSimilarityExampleSelector[source]¶

使用示例列表和嵌入创建k-shot示例选择器。