ChatResponseMessage interface

Package:

@azure/openai

A representation of a chat message as received in a response.

Properties

content	The content of the message.
context	If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request.
functionCall	The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.
role	The chat role associated with the message.
toolCalls	The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.

Property Details

content

The content of the message.

content: null | string

Property Value

null | string

context

If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request.

context?: AzureChatExtensionsMessageContext

Property Value

AzureChatExtensionsMessageContext

functionCall

The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.

functionCall?: FunctionCall

Property Value

FunctionCall

role

The chat role associated with the message.

role: string

Property Value

string

toolCalls

The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.

toolCalls?: ChatCompletionsToolCallUnion[]

Property Value

ChatCompletionsToolCallUnion[]