langchain 0.0.191 → 0.0.193

package/dist/prompts/chat.cjs

@@ -206,6 +206,16 @@ exports.ChatMessagePromptTemplate = ChatMessagePromptTemplate;
 /**
  * Class that represents a human message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = HumanMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
@@ -238,6 +248,16 @@ exports.AIMessagePromptTemplate = AIMessagePromptTemplate;
 /**
  * Class that represents a system message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
@@ -281,6 +301,17 @@ function _coerceMessagePromptTemplateLike(messagePromptTemplateLike) {
  * Class that represents a chat prompt. It extends the
  * BaseChatPromptTemplate and uses an array of BaseMessagePromptTemplate
  * instances to format a series of messages for a conversation.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   ["ai", "You are a helpful assistant."],
+ *   message,
+ * ]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 class ChatPromptTemplate extends BaseChatPromptTemplate {
     static lc_name() {

package/dist/prompts/chat.d.ts

@@ -115,6 +115,16 @@ export declare class ChatMessagePromptTemplate<RunInput extends InputValues = an
 /**
  * Class that represents a human message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = HumanMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export declare class HumanMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
     static lc_name(): string;
@@ -133,6 +143,16 @@ export declare class AIMessagePromptTemplate<RunInput extends InputValues = any>
 /**
  * Class that represents a system message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export declare class SystemMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
     static lc_name(): string;
@@ -159,6 +179,17 @@ export type BaseMessagePromptTemplateLike = BaseMessagePromptTemplate | BaseMess
  * Class that represents a chat prompt. It extends the
  * BaseChatPromptTemplate and uses an array of BaseMessagePromptTemplate
  * instances to format a series of messages for a conversation.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   ["ai", "You are a helpful assistant."],
+ *   message,
+ * ]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export declare class ChatPromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseChatPromptTemplate<RunInput, PartialVariableName> implements ChatPromptTemplateInput<RunInput, PartialVariableName> {
     static lc_name(): string;

package/dist/prompts/chat.js

@@ -197,6 +197,16 @@ export class ChatMessagePromptTemplate extends BaseMessageStringPromptTemplate {
 /**
  * Class that represents a human message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = HumanMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
@@ -227,6 +237,16 @@ export class AIMessagePromptTemplate extends BaseMessageStringPromptTemplate {
 /**
  * Class that represents a system message prompt template. It extends the
  * BaseMessageStringPromptTemplate.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const formatted = await message.format({ text: "Hello world!" });
+ *
+ * const chatPrompt = ChatPromptTemplate.fromMessages([message]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
@@ -269,6 +289,17 @@ function _coerceMessagePromptTemplateLike(messagePromptTemplateLike) {
  * Class that represents a chat prompt. It extends the
  * BaseChatPromptTemplate and uses an array of BaseMessagePromptTemplate
  * instances to format a series of messages for a conversation.
+ * @example
+ * ```typescript
+ * const message = SystemMessagePromptTemplate.fromTemplate("{text}");
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   ["ai", "You are a helpful assistant."],
+ *   message,
+ * ]);
+ * const formattedChatPrompt = await chatPrompt.invoke({
+ *   text: "Hello world!",
+ * });
+ * ```
  */
 export class ChatPromptTemplate extends BaseChatPromptTemplate {
     static lc_name() {

package/dist/prompts/few_shot.cjs

@@ -9,6 +9,37 @@ const chat_js_1 = require("./chat.cjs");
  * Prompt template that contains few-shot examples.
  * @augments BasePromptTemplate
  * @augments FewShotPromptTemplateInput
+ * @example
+ * ```typescript
+ * const examplePrompt = PromptTemplate.fromTemplate(
+ *   "Input: {input}\nOutput: {output}",
+ * );
+ *
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ *
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt,
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ *
+ * // Format the dynamic prompt with the input 'rainy'
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ *
+ * ```
  */
 class FewShotPromptTemplate extends base_js_1.BaseStringPromptTemplate {
     constructor(input) {

package/dist/prompts/few_shot.d.ts

@@ -48,6 +48,37 @@ export interface FewShotPromptTemplateInput extends BasePromptTemplateInput<Inpu
  * Prompt template that contains few-shot examples.
  * @augments BasePromptTemplate
  * @augments FewShotPromptTemplateInput
+ * @example
+ * ```typescript
+ * const examplePrompt = PromptTemplate.fromTemplate(
+ *   "Input: {input}\nOutput: {output}",
+ * );
+ *
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ *
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt,
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ *
+ * // Format the dynamic prompt with the input 'rainy'
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ *
+ * ```
  */
 export declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {
     lc_serializable: boolean;

package/dist/prompts/few_shot.js

@@ -6,6 +6,37 @@ import { BaseChatPromptTemplate } from "./chat.js";
  * Prompt template that contains few-shot examples.
  * @augments BasePromptTemplate
  * @augments FewShotPromptTemplateInput
+ * @example
+ * ```typescript
+ * const examplePrompt = PromptTemplate.fromTemplate(
+ *   "Input: {input}\nOutput: {output}",
+ * );
+ *
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ *
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt,
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ *
+ * // Format the dynamic prompt with the input 'rainy'
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ *
+ * ```
  */
 export class FewShotPromptTemplate extends BaseStringPromptTemplate {
     constructor(input) {

package/dist/prompts/pipeline.cjs

@@ -8,6 +8,45 @@ const chat_js_1 = require("./chat.cjs");
  * different input variables. Includes methods for formatting these
  * prompts, extracting required input values, and handling partial
  * prompts.
+ * @example
+ * ```typescript
+ * const composedPrompt = new PipelinePromptTemplate({
+ *   pipelinePrompts: [
+ *     {
+ *       name: "introduction",
+ *       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
+ *     },
+ *     {
+ *       name: "example",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Here's an example of an interaction:
+ * Q: {example_q}
+ * A: {example_a}`,
+ *       ),
+ *     },
+ *     {
+ *       name: "start",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Now, do this for real!
+ * Q: {input}
+ * A:`,
+ *       ),
+ *     },
+ *   ],
+ *   finalPrompt: PromptTemplate.fromTemplate(
+ *     `{introduction}
+ * {example}
+ * {start}`,
+ *   ),
+ * });
+ *
+ * const formattedPrompt = await composedPrompt.format({
+ *   person: "Elon Musk",
+ *   example_q: `What's your favorite car?`,
+ *   example_a: "Tesla",
+ *   input: `What's your favorite social media site?`,
+ * });
+ * ```
  */
 class PipelinePromptTemplate extends base_js_1.BasePromptTemplate {
     static lc_name() {

package/dist/prompts/pipeline.d.ts

@@ -22,6 +22,45 @@ export type PipelinePromptTemplateInput<PromptTemplateType extends BasePromptTem
  * different input variables. Includes methods for formatting these
  * prompts, extracting required input values, and handling partial
  * prompts.
+ * @example
+ * ```typescript
+ * const composedPrompt = new PipelinePromptTemplate({
+ *   pipelinePrompts: [
+ *     {
+ *       name: "introduction",
+ *       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
+ *     },
+ *     {
+ *       name: "example",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Here's an example of an interaction:
+ * Q: {example_q}
+ * A: {example_a}`,
+ *       ),
+ *     },
+ *     {
+ *       name: "start",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Now, do this for real!
+ * Q: {input}
+ * A:`,
+ *       ),
+ *     },
+ *   ],
+ *   finalPrompt: PromptTemplate.fromTemplate(
+ *     `{introduction}
+ * {example}
+ * {start}`,
+ *   ),
+ * });
+ *
+ * const formattedPrompt = await composedPrompt.format({
+ *   person: "Elon Musk",
+ *   example_q: `What's your favorite car?`,
+ *   example_a: "Tesla",
+ *   input: `What's your favorite social media site?`,
+ * });
+ * ```
  */
 export declare class PipelinePromptTemplate<PromptTemplateType extends BasePromptTemplate> extends BasePromptTemplate {
     static lc_name(): string;

package/dist/prompts/pipeline.js

@@ -5,6 +5,45 @@ import { ChatPromptTemplate } from "./chat.js";
  * different input variables. Includes methods for formatting these
  * prompts, extracting required input values, and handling partial
  * prompts.
+ * @example
+ * ```typescript
+ * const composedPrompt = new PipelinePromptTemplate({
+ *   pipelinePrompts: [
+ *     {
+ *       name: "introduction",
+ *       prompt: PromptTemplate.fromTemplate(`You are impersonating {person}.`),
+ *     },
+ *     {
+ *       name: "example",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Here's an example of an interaction:
+ * Q: {example_q}
+ * A: {example_a}`,
+ *       ),
+ *     },
+ *     {
+ *       name: "start",
+ *       prompt: PromptTemplate.fromTemplate(
+ *         `Now, do this for real!
+ * Q: {input}
+ * A:`,
+ *       ),
+ *     },
+ *   ],
+ *   finalPrompt: PromptTemplate.fromTemplate(
+ *     `{introduction}
+ * {example}
+ * {start}`,
+ *   ),
+ * });
+ *
+ * const formattedPrompt = await composedPrompt.format({
+ *   person: "Elon Musk",
+ *   example_q: `What's your favorite car?`,
+ *   example_a: "Tesla",
+ *   input: `What's your favorite social media site?`,
+ * });
+ * ```
  */
 export class PipelinePromptTemplate extends BasePromptTemplate {
     static lc_name() {

package/dist/prompts/selectors/LengthBasedExampleSelector.cjs

@@ -12,6 +12,42 @@ function getLengthBased(text) {
  * A specialized example selector that selects examples based on their
  * length, ensuring that the total length of the selected examples does
  * not exceed a specified maximum length.
+ * @example
+ * ```typescript
+ * const exampleSelector = new LengthBasedExampleSelector(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   {
+ *     examplePrompt: new PromptTemplate({
+ *       inputVariables: ["input", "output"],
+ *       template: "Input: {input}\nOutput: {output}",
+ *     }),
+ *     maxLength: 25,
+ *   },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: new PromptTemplate({
+ *     inputVariables: ["input", "output"],
+ *     template: "Input: {input}\nOutput: {output}",
+ *   }),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(dynamicPrompt.format({ adjective: "big" }));
+ * console.log(
+ *   dynamicPrompt.format({
+ *     adjective:
+ *       "big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else",
+ *   }),
+ * );
+ * ```
  */
 class LengthBasedExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {

package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts

@@ -14,6 +14,42 @@ export interface LengthBasedExampleSelectorInput {
  * A specialized example selector that selects examples based on their
  * length, ensuring that the total length of the selected examples does
  * not exceed a specified maximum length.
+ * @example
+ * ```typescript
+ * const exampleSelector = new LengthBasedExampleSelector(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   {
+ *     examplePrompt: new PromptTemplate({
+ *       inputVariables: ["input", "output"],
+ *       template: "Input: {input}\nOutput: {output}",
+ *     }),
+ *     maxLength: 25,
+ *   },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: new PromptTemplate({
+ *     inputVariables: ["input", "output"],
+ *     template: "Input: {input}\nOutput: {output}",
+ *   }),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(dynamicPrompt.format({ adjective: "big" }));
+ * console.log(
+ *   dynamicPrompt.format({
+ *     adjective:
+ *       "big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else",
+ *   }),
+ * );
+ * ```
  */
 export declare class LengthBasedExampleSelector extends BaseExampleSelector {
     protected examples: Example[];

package/dist/prompts/selectors/LengthBasedExampleSelector.js

@@ -9,6 +9,42 @@ function getLengthBased(text) {
  * A specialized example selector that selects examples based on their
  * length, ensuring that the total length of the selected examples does
  * not exceed a specified maximum length.
+ * @example
+ * ```typescript
+ * const exampleSelector = new LengthBasedExampleSelector(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   {
+ *     examplePrompt: new PromptTemplate({
+ *       inputVariables: ["input", "output"],
+ *       template: "Input: {input}\nOutput: {output}",
+ *     }),
+ *     maxLength: 25,
+ *   },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: new PromptTemplate({
+ *     inputVariables: ["input", "output"],
+ *     template: "Input: {input}\nOutput: {output}",
+ *   }),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(dynamicPrompt.format({ adjective: "big" }));
+ * console.log(
+ *   dynamicPrompt.format({
+ *     adjective:
+ *       "big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else",
+ *   }),
+ * );
+ * ```
  */
 export class LengthBasedExampleSelector extends BaseExampleSelector {
     constructor(data) {

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs

@@ -11,6 +11,31 @@ function sortedValues(values) {
 /**
  * Class that selects examples based on semantic similarity. It extends
  * the BaseExampleSelector class.
+ * @example
+ * ```typescript
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: PromptTemplate.fromTemplate(
+ *     "Input: {input}\nOutput: {output}",
+ *   ),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ * ```
  */
 class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts

@@ -24,6 +24,31 @@ export type SemanticSimilarityExampleSelectorInput<V extends VectorStore = Vecto
 /**
  * Class that selects examples based on semantic similarity. It extends
  * the BaseExampleSelector class.
+ * @example
+ * ```typescript
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: PromptTemplate.fromTemplate(
+ *     "Input: {input}\nOutput: {output}",
+ *   ),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ * ```
  */
 export declare class SemanticSimilarityExampleSelector<V extends VectorStore = VectorStore> extends BaseExampleSelector {
     vectorStoreRetriever: VectorStoreRetriever<V>;

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js

@@ -8,6 +8,31 @@ function sortedValues(values) {
 /**
  * Class that selects examples based on semantic similarity. It extends
  * the BaseExampleSelector class.
+ * @example
+ * ```typescript
+ * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
+ *   [
+ *     { input: "happy", output: "sad" },
+ *     { input: "tall", output: "short" },
+ *     { input: "energetic", output: "lethargic" },
+ *     { input: "sunny", output: "gloomy" },
+ *     { input: "windy", output: "calm" },
+ *   ],
+ *   new OpenAIEmbeddings(),
+ *   HNSWLib,
+ *   { k: 1 },
+ * );
+ * const dynamicPrompt = new FewShotPromptTemplate({
+ *   exampleSelector,
+ *   examplePrompt: PromptTemplate.fromTemplate(
+ *     "Input: {input}\nOutput: {output}",
+ *   ),
+ *   prefix: "Give the antonym of every input",
+ *   suffix: "Input: {adjective}\nOutput:",
+ *   inputVariables: ["adjective"],
+ * });
+ * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
+ * ```
  */
 export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     constructor(data) {

package/dist/retrievers/amazon_kendra.cjs

@@ -7,6 +7,22 @@ const document_js_1 = require("../document.cjs");
 /**
  * Class for interacting with Amazon Kendra, an intelligent search service
  * provided by AWS. Extends the BaseRetriever class.
+ * @example
+ * ```typescript
+ * const retriever = new AmazonKendraRetriever({
+ *   topK: 10,
+ *   indexId: "YOUR_INDEX_ID",
+ *   region: "us-east-2",
+ *   clientOptions: {
+ *     credentials: {
+ *       accessKeyId: "YOUR_ACCESS_KEY_ID",
+ *       secretAccessKey: "YOUR_SECRET_ACCESS_KEY",
+ *     },
+ *   },
+ * });
+ *
+ * const docs = await retriever.getRelevantDocuments("How are clouds formed?");
+ * ```
  */
 class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
     static lc_name() {

package/dist/retrievers/amazon_kendra.d.ts

@@ -15,6 +15,22 @@ export interface AmazonKendraRetrieverArgs {
 /**
  * Class for interacting with Amazon Kendra, an intelligent search service
  * provided by AWS. Extends the BaseRetriever class.
+ * @example
+ * ```typescript
+ * const retriever = new AmazonKendraRetriever({
+ *   topK: 10,
+ *   indexId: "YOUR_INDEX_ID",
+ *   region: "us-east-2",
+ *   clientOptions: {
+ *     credentials: {
+ *       accessKeyId: "YOUR_ACCESS_KEY_ID",
+ *       secretAccessKey: "YOUR_SECRET_ACCESS_KEY",
+ *     },
+ *   },
+ * });
+ *
+ * const docs = await retriever.getRelevantDocuments("How are clouds formed?");
+ * ```
  */
 export declare class AmazonKendraRetriever extends BaseRetriever {
     static lc_name(): string;