system
function system(input, options?): objectCreates a system message entry
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
|
The system prompt |
|
|
|
Any additional options that will be directly passed to the model |
Returns
Section titled “Returns”object
a message entry
content
Section titled “content”content: string;The content of the message.
optional id: string;An ID to identify the item. This is optional by default. If a model provider absolutely requires this field, it will be validated on the model level.
providerData?
Section titled “providerData?”optional providerData: Record<string, any>;Additional optional provider specific data. Used for custom functionality or model provider specific fields.
role: "system";Representing a system message to the user
optional type: "message";Any item without a type is treated as a message