Initialize

Options for the `Lira` constructor

import { Lira } from 'lira'

const lira = new Lira({
  keys,
  store,
  loggers
})

keys

object

Set the API keys for the providers you want to use

Show properties

lira

string

Lira API key (in case you want to use Lira store endpoint)

anthropic

string

Anthropic API key

openai

string

OpenAI API key

store

object

Options to configure the storing of the message.

These options can be overridden by the options of the create method.

Show properties

disabled

boolean

default:"false"

Set to true to disable storing messages.

callback

(params: LiraMessageStore) => Promise<void> | void

Only if you want to use your custom callback to store the entire message object. The callback receives the following object as params:

{
  input: LiraMessageInputStore
  output?: LiraMessageOutputStore
  reqTime?: LiraMessageReqTimesStore
  error?: unknown
}

Visit the SDK store message for more information.

loggers

object

Configure the way Lira logs messages

Show properties

type

"prod" | "debug"

default:"prod"

Set to debug to enable the debug mode and see raw requests and responses to the providers

config

object

default:"console.log()"

Setting a custom callback lets you log the messages with your own monitoring system. Otherwise it will use console.log()

Show properties

all

(message: string) => Promise<void> | void

Callback to log all messages (will override the other callbacks)

debug

(message: string) => Promise<void> | void

Callback to log debug messages

warn

(message: string) => Promise<void> | void

Callback to log warn messages

error

(message: string) => Promise<void> | void

Callback to log error messages

Lira instance

Store

Generate

Options for the `Lira` constructor

Lira instance

Store

Generate

​Options for the Lira constructor

Options for the `Lira` constructor