Class LengthBasedExampleSelector

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

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",
  }),
);

Hierarchy

Constructors

constructor

Properties

examplePrompt exampleTextLengths getTextLength maxLength examples

Methods

addExample calculateExampleTextLengths selectExamples toJSON toJSONNotImplemented fromExamples

Constructors

constructor

Properties

examplePrompt

examplePrompt: PromptTemplate<any, any>

exampleTextLengths

exampleTextLengths: number[] = []

getTextLength

getTextLength: ((text) => number) = getLengthBased

Type declaration

    • (text): number

    • Parameters

      • text: string

      Returns number

maxLength

maxLength: number = 2048

Protected examples

examples: Example[] = []

Methods

addExample

  • Adds an example to the list of examples and calculates its length.

    Parameters

    • example: Example

      The example to be added.

    Returns Promise<void>

    Promise that resolves when the example has been added and its length calculated.

calculateExampleTextLengths

  • Calculates the lengths of the examples.

    Parameters

    Returns Promise<number[]>

    Promise that resolves with an array of lengths of the examples.

selectExamples

  • Selects examples until the total length of the selected examples reaches the maxLength.

    Parameters

    • inputVariables: Example

      The input variables for the examples.

    Returns Promise<Example[]>

    Promise that resolves with an array of selected examples.

toJSON

toJSONNotImplemented

Static fromExamples

  • Creates a new instance of LengthBasedExampleSelector and adds a list of examples to it.

    Parameters

    Returns Promise<LengthBasedExampleSelector>

    Promise that resolves with a new instance of LengthBasedExampleSelector with the examples added.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc