Interface LmTemplate

Represents a template for language modeling, detailing the structure and interaction elements of a conversation.

Example

const sampleTemplate: LmTemplate = {
 id: "alapaca",
 name: "Alpaca",
 system: {
   schema: "{system}",
   message: "Below is an instruction that describes a task. Write a response that appropriately completes the request.",
 },
 user: "### Instruction:\n{prompt}",
 assistant: "### Response:",
  linebreaks: {
    system: 2,
    user: 2,
  }
};

Hierarchy

  • LmTemplate

Properties

afterShot? assistant id linebreaks? name prefix? shots? stop? system? user

Properties

Optional afterShot

afterShot?: string

String to display after a shot

assistant

assistant: string

The default message template for the assistant.

id

id: string

The id slug of the template.

Optional linebreaks

linebreaks?: SpacingSlots

Optional specifications for line breaks between different message types.

This can be used to format the rendered conversation.

name

name: string

The name of the template.

Optional prefix

prefix?: string

A prefix like a bos token to insert before content

Optional shots

shots?: TurnBlock[]

Optional array of turn blocks representing back-and-forths between the user and the assistant.

Useful for simulating multi-turn interactions.

Optional stop

stop?: string[]

Optional array of strings that signal the end of a conversation.

These strings can be used to detect when a conversation should be terminated.

Optional system

system?: PromptBlock

Optional prompt block that represents system-level messages or instructions.

user

user: string

The default message template for the user.

Includes a {prompt} placeholder which can be programmatically replaced later.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc