Skip to content

Commit 0a564ec

Browse files
committed
CR. Streaming events. Update description for model and event Id
1 parent af3914e commit 0a564ec

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

agents/agents-core/src/commonMain/kotlin/ai/koog/agents/core/feature/model/events/llmStreamingEvents.kt

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ import kotlinx.serialization.Serializable
1212
* This event holds metadata related to the initiation of the LLM streaming process, including
1313
* details about the run, the input prompt, the model used, and the tools involved.
1414
*
15-
* @property runId Unique identifier for the LLM run.
16-
* @property prompt The input prompt provided for the LLM operation.
17-
* @property model The name or identifier of the language model being used.
18-
* @property tools A list of associated tools or resources that are part of the operation.
19-
* @property eventId Unique identifier for this type of event, defaulting to the name of the starting event class.
15+
* @property runId Unique identifier for the LLM run;
16+
* @property prompt The input prompt provided for the LLM operation;
17+
* @property model The description of the LLM model used during the call. Use the format: 'llm_provider:model_id';
18+
* @property tools A list of associated tools or resources that are part of the operation;
19+
* @property eventId A string representing the event type;
2020
* @property timestamp The time when the event occurred, represented in epoch milliseconds.
2121
*/
2222
@Serializable
@@ -36,10 +36,10 @@ public data class LLMStreamingStartingEvent(
3636
* frames of data are sent incrementally. The event contains details about the specific
3737
* frame received, as well as metadata related to the event's timing and identity.
3838
*
39-
* @property runId The unique identifier for the LLM run or session associated with this event.
39+
* @property runId The unique identifier for the LLM run or session associated with this event;
4040
* @property frame The frame data received as part of the streaming response. This can include textual
41-
* content, tool invocations, or signaling the end of the stream.
42-
* @property eventId A string representing the unique identifier of this event type.
41+
* content, tool invocations, or signaling the end of the stream;
42+
* @property eventId A string representing the event type;
4343
* @property timestamp The timestamp of when the event was created, represented in milliseconds since the Unix epoch.
4444
*/
4545
@Serializable
@@ -57,11 +57,10 @@ public data class LLMStreamingFrameReceivedEvent(
5757
* It includes information such as the unique identifier of the operation run, a detailed
5858
* error description, and inherits common properties such as event ID and timestamp.
5959
*
60-
* @property runId A unique identifier representing the specific operation or run in which the failure occurred.
60+
* @property runId A unique identifier representing the specific operation or run in which the failure occurred;
6161
* @property error An instance of [AIAgentError], containing information about the error encountered, including its
62-
* message, stack trace, and cause, if available.
63-
* @property eventId A string identifier representing the event type. By default, it is set to the simple class name
64-
* of the `LLMCallStartingEvent`.
62+
* message, stack trace, and cause, if available;
63+
* @property eventId A string representing the event type;
6564
* @property timestamp A timestamp indicating when the event occurred, represented in milliseconds since the Unix epoch.
6665
*/
6766
@Serializable
@@ -75,11 +74,11 @@ public data class LLMStreamingFailedEvent(
7574
/**
7675
* Represents an event that occurs when the streaming process of a Large Language Model (LLM) call is completed.
7776
*
78-
* @property runId The unique identifier of the LLM run.
79-
* @property prompt The prompt associated with the LLM call.
80-
* @property model The name of the LLM model used during the call.
81-
* @property tools A list of tools used or invoked during the LLM call.
82-
* @property eventId The identifier for this specific event, defaulting to the class name of `LLMCallStartingEvent`.
77+
* @property runId The unique identifier of the LLM run;
78+
* @property prompt The prompt associated with the LLM call;
79+
* @property model The description of the LLM model used during the call. Use the format: 'llm_provider:model_id';
80+
* @property tools A list of tools used or invoked during the LLM call;
81+
* @property eventId A string representing the event type;
8382
* @property timestamp The timestamp indicating when the event occurred, represented in milliseconds since the epoch, defaulting to the current system time.
8483
*/
8584
@Serializable

0 commit comments

Comments
 (0)