Class: Generation
Defined in: src/lib/logger/components/generation.ts:124 Represents an LLM generation or completion. The Generation class tracks the complete lifecycle of LLM requests, including input messages, model parameters, results, and any errors. It supports both chat and text completion formats. GenerationExample
Extends
Constructors
Constructor
new Generation(Defined in: src/lib/logger/components/generation.ts:148 Creates a new generation log entry.config,writer):Generation
Parameters
config
GenerationConfig
Configuration object defining the generation
writer
LogWriter
Log writer instance for persisting generation data
Returns
Generation
Example
Overrides
EvaluatableBaseContainer.constructor
Accessors
evaluate
Get Signature
get evaluate(): EvaluateContainer
Defined in: src/lib/logger/components/base.ts:248
Gets the evaluation methods for this container.
Example
Returns
EvaluateContainer
Evaluation methods for configuring and triggering evaluations
Inherited from
EvaluatableBaseContainer.evaluate
id
Get Signature
get id(): string
Defined in: src/lib/logger/components/base.ts:80
Gets the unique identifier for this container.
Returns
string
The container’s unique ID
Inherited from
EvaluatableBaseContainer.id
Methods
addAttachment()
addAttachment(Defined in: src/lib/logger/components/generation.ts:349 Adds an attachment to this generation (can be of typeattachment):void
file, data, or url).
Parameters
attachment
Attachment
The attachment to add (file, data, or URL)
Returns
void
void
Example
addMessages()
addMessages(Defined in: src/lib/logger/components/generation.ts:205 Adds additional messages to this generation’s conversation.messages):void
Parameters
messages
(ChatCompletionMessage | CompletionRequest)[]
Array of messages to add
Returns
void
void
Example
addMetadata()
addMetadata(Defined in: src/lib/logger/components/base.ts:124 Adds metadata to this container for additional context and debugging. Any data type could be added as the value in the metadata record.metadata):void
Parameters
metadata
Record<string, unknown>
Key-value pairs of metadata
Returns
void
void
Example
Inherited from
EvaluatableBaseContainer.addMetadata
addTag()
addTag(Defined in: src/lib/logger/components/base.ts:94 Adds a tag to this container for categorization and filtering.key,value):void
Parameters
key
string
The tag key
value
string
The tag value
Returns
void
void
Example
Inherited from
EvaluatableBaseContainer.addTag
data()
data(): any
Defined in: src/lib/logger/components/generation.ts:372
Returns the complete data representation of this generation.
Returns
any
Generation data.
Example
Overrides
EvaluatableBaseContainer.data
end()
end(): void
Defined in: src/lib/logger/components/base.ts:163
Marks this container as ended and records the end timestamp.
Returns
void
void
Example
Inherited from
EvaluatableBaseContainer.end
error()
error(Defined in: src/lib/logger/components/generation.ts:318 Records an error that occurred during this generation.error):void
Parameters
error
GenerationError
Error information including message, code, and type
Returns
void
void
Example
result()
result(Defined in: src/lib/logger/components/generation.ts:288 Records the successful result of this generation and ends it.result):void
Parameters
result
The completion result from the LLMChatCompletionResult | TextCompletionResult
Returns
void
void
Example
setModel()
setModel(Defined in: src/lib/logger/components/generation.ts:178 Updates the model being used for this generation.model):void
Parameters
model
string
The new model name or identifier
Returns
void
void
Example
setModelParameters()
setModelParameters(Defined in: src/lib/logger/components/generation.ts:252 Updates the model parameters for this generation.modelParameters):void
Parameters
modelParameters
Record<string, any>
Object containing model-specific parameters
Returns
void
void
Example
addAttachment_()
Defined in: src/lib/logger/components/generation.ts:361 Static method to add an attachment to any generation by ID.staticaddAttachment_(writer,id,attachment):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
attachment
Attachment
The attachment to add
Returns
void
void
addMessages_()
Defined in: src/lib/logger/components/generation.ts:226 Static method to add messages to any generation by ID.staticaddMessages_(writer,id,messages):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
messages
(ChatCompletionMessage | CompletionRequest)[]
Array of messages to add
Returns
void
void
addMetadata_()
Defined in: src/lib/logger/components/base.ts:144 Static method to add metadata to any container by ID.staticaddMetadata_(writer,entity,id,metadata):void
Parameters
writer
LogWriter
The log writer instance
entity
Entity
The entity type
id
string
The container ID
metadata
Record<string, unknown>
The metadata to add
Returns
void
void
Inherited from
EvaluatableBaseContainer.addMetadata_
addTag_()
Defined in: src/lib/logger/components/base.ts:108 Static method to add a tag to any container by ID.staticaddTag_(writer,entity,id,key,value):void
Parameters
writer
LogWriter
The log writer instance
entity
Entity
The entity type
id
string
The container ID
key
string
The tag key
value
string
The tag value
Returns
void
void
Inherited from
EvaluatableBaseContainer.addTag_
end_()
Defined in: src/lib/logger/components/base.ts:177 Static method to end any container by ID.staticend_(writer,entity,id,data?):void
Parameters
writer
LogWriter
The log writer instance
entity
Entity
The entity type
id
string
The container ID
data?
any
Optional additional data to include with the end event
Returns
void
void
Inherited from
EvaluatableBaseContainer.end_
error_()
Defined in: src/lib/logger/components/generation.ts:331 Static method to record an error for any generation by ID.staticerror_(writer,id,error):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
error
GenerationError
Error information
Returns
void
void
evaluate_()
Defined in: src/lib/logger/components/base.ts:260 Static method to get evaluation methods for any evaluatable container by ID.staticevaluate_(writer,entity,id):EvaluateContainer
Parameters
writer
LogWriter
The log writer instance
entity
Entity
The entity type
id
string
The container ID
Returns
EvaluateContainer
Evaluation methods for configuring and triggering evaluations
Inherited from
EvaluatableBaseContainer.evaluate_
result_()
Defined in: src/lib/logger/components/generation.ts:301 Static method to record a result for any generation by ID.staticresult_(writer,id,result):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
result
The completion resultChatCompletionResult | TextCompletionResult
Returns
void
void
setModel_()
Defined in: src/lib/logger/components/generation.ts:191 Static method to update the model for any generation by ID.staticsetModel_(writer,id,model):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
model
string
The new model name
Returns
void
void
setModelParameters_()
Defined in: src/lib/logger/components/generation.ts:264 Static method to update model parameters for any generation by ID.staticsetModelParameters_(writer,id,modelParameters):void
Parameters
writer
LogWriter
The log writer instance
id
string
The generation ID
modelParameters
Record<string, any>
Model parameters to update
Returns
void
void