Interface ChatMessageFieldsWithRole

interface ChatMessageFieldsWithRole {
    additional_kwargs?: {
        function_call?: FunctionCall;
        tool_calls?: OpenAIToolCall[];
        [key: string]: unknown;
    };
    content: MessageContent;
    id?: string;
    name?: string;
    response_metadata?: Record<string, any>;
    role: string;
}

Hierarchy (view full)

Implemented by

Properties

additional_kwargs? content id? name? response_metadata? role

Properties

Optionaladditional_kwargs

additional_kwargs?: {
    function_call?: FunctionCall;
    tool_calls?: OpenAIToolCall[];
    [key: string]: unknown;
}

Type declaration

  • [key: string]: unknown
  • Optionalfunction_call?: FunctionCall

    Deprecated

    Use "tool_calls" field on AIMessages instead

  • Optionaltool_calls?: OpenAIToolCall[]

    Deprecated

    Use "tool_calls" field on AIMessages instead

content

content: MessageContent

Optionalid

id?: string

An optional unique identifier for the message. This should ideally be provided by the provider/model which created the message.

Optionalname

name?: string

Optionalresponse_metadata

response_metadata?: Record<string, any>

Response metadata. For example: response headers, logprobs, token counts, model name.

role

role: string

Settings

Member Visibility

On This Page

Properties