Class: SemanticSimilarityExampleSelector
prompts.SemanticSimilarityExampleSelector
Base class for example selectors.
Implements
Constructors
constructor
• new SemanticSimilarityExampleSelector(data)
Parameters
| Name | Type |
|---|---|
data | Object |
data.exampleKeys? | string[] |
data.inputKeys? | string[] |
data.k? | number |
data.vectorStore | VectorStore |
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:22
Properties
exampleKeys
• Optional exampleKeys: string[]
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:18
inputKeys
• Optional inputKeys: string[]
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:20
k
• k: number = 4
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:16
vectorStore
• vectorStore: VectorStore
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:14
Methods
addExample
▸ addExample(example): Promise<void>
Parameters
| Name | Type |
|---|---|
example | Example |
Returns
Promise<void>
Implementation of
BaseExampleSelector.addExample
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:34
selectExamples
▸ selectExamples<T>(inputVariables): Promise<Example[]>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
inputVariables | Record<string, T> |
Returns
Promise<Example[]>
Implementation of
BaseExampleSelector.selectExamples
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:51
fromExamples
▸ Static fromExamples<C>(examples, embeddings, vectorStoreCls, options?): Promise<SemanticSimilarityExampleSelector>
Type parameters
| Name | Type |
|---|---|
C | extends typeof VectorStore |
Parameters
| Name | Type |
|---|---|
examples | Record<string, string>[] |
embeddings | Embeddings |
vectorStoreCls | C |
options | { inputKeys?: string[] ; k?: number } & Parameters<C["fromTexts"]>[3] |
Returns
Promise<SemanticSimilarityExampleSelector>
Defined in
langchain/src/prompts/selectors/SemanticSimilarityExampleSelector.ts:77