Class: Llaminate

const mistral = new Llaminate({
  endpoint: Llaminate.MISTRAL,
  key: "12345-abcde-67890-fghij-klm",
  model: "mistral-small-latest",
  system: ["You are a sarcastic assistant who answers very briefly and bluntly."]
  rpm: 720
});

Classes

Llaminate

Members

(static, readonly) this.config

Properties:

Methods

(async) chat(configopt, callbackopt) → {Promise.<void>}

Parameters:

Returns:

Type

Promise.<void>

Example

// EXAMPLE: Starting a chat session with custom system messages
await mistral.chat({
  system: [
    "You are a helpful assistant who answers in the style of Shakespeare.",
    "Use flowery language and old English phrasing in your responses."
  ]
});

clear(messagesopt)

Parameters:

Returns:

Examples

// EXAMPLE 1: Populating and then clearing the history
mistral.complete("What's your name?"); // "John"
mistral.complete("How do you spell that?"); // "J-O-H-N"
mistral.clear();
mistral.complete("Tell me again?"); // "Tell you what again?"

// EXAMPLE 2: Clearing the history and initializing with new messages
mistral.complete("What's your name?"); // "John"
mistral.complete("How do you spell that?"); // "J-O-H-N"
const newHistory = [
  { role: Llaminate.SYSTEM, content: "You are a cat who can only speak in meows." },
  { role: Llaminate.USER, content: "What's your name?" }
];
mistral.clear(newHistory);
mistral.complete("Tell me again?"); // "Meow?"

(async) complete(prompt, configopt) → {Promise.<LlaminateResponse>}

Parameters:

Throws:

Returns:

Type

Promise.<LlaminateResponse>

Examples

// EXAMPLE 1: Simple prompt with default configuration
const response = await mistral.complete("What's the capital of France?");
console.log(response.message); // "Paris"

// EXAMPLE 2: System messages set through configuration
const response = await mistral.complete("What's the capital of France?",
  { system: [
    "You are a children's geography tutor.",
    "Always reply as if you are explaining to a child."
  ] } );

// EXAMPLE 3: An image attachment (supported depends on LLM model)
const response = await mistral.complete(
  "Generate a helpful HTML `alt` tag for this image.", {
  attachments: [ { type: Llaminate.JPEG, url: "https://example.com/image.jpg" } ]
});

// EXAMPLE 4: Prompt with a pre-rolled conversation history
const history = [
  { role: "user", content: "What's a good name for a houseplant?" },
  { role: "assistant", content: "How about Fernie Sanders?" },
  { role: "user", content: "Nice. Any other suggestions?" },
  { role: "assistant", content: "How about Leaf Erickson?" }
];
const prompt = "Great. What could be its nickname?";
const response = await mistral.complete(prompt, { history });

// EXAMPLE 5: Rolling the conversation history into the prompt
const messages = history.concat({ role: "user", content: prompt });
const response = await mistral.complete(messages);

export(windowopt) → {Array.<LlaminateMessage>}

Parameters:

Returns:

Type

Array.<LlaminateMessage>

Examples

// EXAMPLE 1: Exporting the entire history of messages
const history = mistral.export();
localStorage.setItem('mistral-history', JSON.stringify(history));

// EXAMPLE 2: Getting a window of recent messages
// Returns the last 5 user-assistant interactions and all system prompts
const history = mistral.export(5);
console.log(history.length);
// e.g. 14 = 5 user messages + 5 assistant replies (one that included a
// tool call) + 2 system prompts

(async, generator) stream(prompt, configopt) → {LlaminateResponse}

Parameters:

Throws:

Yields:

Type

LlaminateResponse

Examples

// EXAMPLE 1: Streaming the response to a simple prompt
const stream = mistral.stream("Tell me a joke and explain it.");
for await (const response of stream) {
  console.log(response.message);
}

// EXAMPLE 2: Streaming a response with a structured output
const stream = mistral.stream("Tell me a joke and explain it.", {
  schema: {
    type: "object",
    properties: {
      joke: {
        type: "string",
        description: "Your response to the user's query."
      },
      explanation: {
        type: "string",
        description: "Your internal thoughts about the user's query."
      },
    },
    required: ["joke", "explanation"],
    additionalProperties: false,
  }
});
for await (const response of stream) {
  // Initially streams as a string until the JSON schema can be validated
  console.log(response.message);
  console.log(response.message?.joke);
  console.log(response.message?.explanation);
}

(async, static) chat()