Share via

Message interface

Package:
@microsoft/teams-ai

A message object sent to or received from an LLM.

Properties

action_calls

Optional. The action or tool to be called by the model when using 'tools' augmentation. In OpenAI, this is the tool_calls property returned from the model.
action_call_id

Optional. The id of the action called.
content

Text of the message.
context

The context used for the message.
function_call

Optional. A named function to call.
name

Optional. Name of the function that was called.
role

The messages role. Typically 'system', 'user', 'assistant', 'tool', 'function'.

Property Details

action_calls

Optional. The action or tool to be called by the model when using 'tools' augmentation. In OpenAI, this is the tool_calls property returned from the model.

action_calls?: ActionCall[]

Property Value

ActionCall[]

action_call_id

Optional. The id of the action called.

action_call_id?: string

Property Value

string

content

Text of the message.

content: undefined | TContent

Property Value

undefined | TContent

context

The context used for the message.

context?: MessageContext

Property Value

MessageContext

function_call

Optional. A named function to call.

function_call?: FunctionCall

Property Value

FunctionCall

name

Optional. Name of the function that was called.

name?: string

Property Value

string

role

The messages role. Typically 'system', 'user', 'assistant', 'tool', 'function'.

role: string

Property Value

string