Class Message

constructor

• new Message(role?, content?, model?): Message

• Creates a new Message instance.

  Parameters

  • role: ChatCompletionRequestMessageRoleEnum = "user"

    The role of who this message is from. Either "user", "assistant" or "system".

  • content: null | string = ""

    The content of the message.

  • model: string = ""

    The model used for processing this message.

  Returns Message

id

chatCompletionMessage

• get chatCompletionMessage(): CreateChatCompletionMessage | CreateChatCompletionFunctionCallMessage | CreateChatCompletionFunctionMessage

• JSON definition of the message as consumed by OpenAI's API.

  Returns CreateChatCompletionMessage | CreateChatCompletionFunctionCallMessage | CreateChatCompletionFunctionMessage

content

• get content(): null | string

• The content of the message.

  Returns null | string
• set content(content): void

• Parameters

  • content: null | string

  Returns void

flags

• get flags(): null | string[]

• The flags detected by OpenAI's moderation API. Only set after calling moderate.

  Returns null | string[]
• set flags(flags): void

• Parameters

  • flags: null | string[]

  Returns void

functionCall

• get functionCall(): undefined | {
      arguments: Record<string, any>;
      name: string;
  }

• Returns undefined | {
      arguments: Record<string, any>;
      name: string;
  }

• set functionCall(functionCall): void

• Parameters

  • functionCall: undefined | {
        arguments: Record<string, any>;
        name: string;
    }

  Returns void

isFlagged

• get isFlagged(): boolean

• Whether the message is flagged by OpenAI's moderation API. Always false unless moderate has been called.

  Returns boolean

isStreaming

• get isStreaming(): boolean

• Whether the message is currently being streamed.

  Returns boolean
• set isStreaming(isStreaming): void

• Parameters

  • isStreaming: boolean

  Returns void

model

• get model(): string

• The model used to generate this message.

  Returns string
• set model(model): void

• Parameters

  • model: string

  Returns void

name

• get name(): undefined | string

• Returns undefined | string

• set name(name): void

• Parameters

  • name: undefined | string

  Returns void

role

• get role(): ChatCompletionRequestMessageRoleEnum

• The role of who this message is from.

  Returns ChatCompletionRequestMessageRoleEnum
• set role(role): void

• Parameters

  • role: ChatCompletionRequestMessageRoleEnum

  Returns void

isCompletion

• isCompletion(): this is CompletionMessage

• Whether the message is a regular chat completion message

  Returns this is CompletionMessage

isFunction

• isFunction(): this is FunctionMessage

• Whether the message is a function call result by the user

  Returns this is FunctionMessage

isFunctionCall

• isFunctionCall(): this is FunctionCallMessage

• Whether the message is a function call by the assistant

  Returns this is FunctionCallMessage

moderate

• moderate(apiKey, requestOptions?): Promise<string[]>

• Call the OpenAI moderation API to check if the message is flagged. Only called once for the same content.

  Parameters

  • apiKey: string

    The OpenAI API key

  • requestOptions: {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    } = {}

    The request options to pass to fetch

    • Optional headers?: Record<string, string>

    • Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }

  Returns Promise<string[]>

  The flags applied on the message

offContentStream

• offContentStream(listener): void

• Removes a message streaming content listener, previously set with onContentStream.

  Parameters

  • listener: MessageContentStreamListener

    The previously added listener

  Returns void

  Remarks

  You do not need to call this method manually, as this listener automatically unsubscribes all listeners when streaming ends. You should use this if you want to unsubscribe a listener before streaming ends.

offStreaming

• offStreaming(listener): void

• Removes a message streaming listener, previously set with onStreamingUpdate.

  Parameters

  • listener: MessageStreamingListener

    The previously added listener

  Returns void

offStreamingStart

• offStreamingStart(listener): void

• Removes a message streaming start listener, previously set with onStreamingStart.

  Parameters

  • listener: MessageStreamingStartListener

    The previously added listener

  Returns void

offStreamingStop

• offStreamingStop(listener): void

• Removes a message streaming stop listener, previously set with onStreamingStop.

  Parameters

  • listener: MessageStreamingStopListener

    The previously added listener

  Returns void

offUpdate

• offUpdate(listener): void

• Removes a message update listener, previously set with onUpdate.

  Parameters

  • listener: MessageUpdateListener

    The previously added listener

  Returns void

onContentStream

• onContentStream(listener): (() => void)

• Adds a listener that is fired whenever the message content is updated during streaming. Also fires when streaming starts/ends.

  Parameters

  • listener: MessageContentStreamListener

    The listener to trigger when content changes during streaming

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

  Remarks

  Unlike the other listeners which behave like normal event listeners, this special listener is unsubscribed automatically when streaming ends. If this is not desired, use onUpdate and onStreamingStart/onStreamingStop instead.

onStreamingStart

• onStreamingStart(listener): (() => void)

• Adds a listener for message streaming start.

  Parameters

  • listener: MessageStreamingStartListener

    The listener to trigger when isStreaming is set to true

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onStreamingStop

• onStreamingStop(listener): (() => void)

• Adds a listener for message streaming stop.

  Parameters

  • listener: MessageStreamingStopListener

    The listener to trigger when isStreaming is set to false

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onStreamingUpdate

• onStreamingUpdate(listener): (() => void)

• Adds a listener for message streaming state changes.

  Parameters

  • listener: MessageStreamingListener

    The listener to trigger when isStreaming changes

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onUpdate

• onUpdate(listener): (() => void)

• Add a listener for message content changes.

  Parameters

  • listener: MessageUpdateListener

    The listener to trigger when content changes

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onceContentStream

• onceContentStream(listener): (() => void)

• Adds a listener that is fired only once whenever the message content is updated during streaming. Also fires when streaming starts/ends.

  Parameters

  • listener: MessageContentStreamListener

    The listener to trigger when content changes during streaming

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

  Remarks

  Unlike the other listeners which behave like normal event listeners, this special listener is unsubscribed automatically when streaming ends, regardless of whether it was called once or not. If this is not desired, use onceUpdate and onceStreamingStart/onceStreamingStop instead.

onceStreamingStart

• onceStreamingStart(listener): (() => void)

• Adds a listener that is called only once when the message streaming starts.

  Parameters

  • listener: MessageStreamingStartListener

    The listener to trigger when isStreaming is set to true

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onceStreamingStop

• onceStreamingStop(listener): (() => void)

• Adds a listener that is called only once when the message streaming stops.

  Parameters

  • listener: MessageStreamingStopListener

    The listener to trigger when isStreaming is set to false

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onceStreamingUpdate

• onceStreamingUpdate(listener): (() => void)

• Adds a listener that is called only once when the message streaming state changes.

  Parameters

  • listener: MessageStreamingListener

    The listener to trigger when isStreaming changes

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

onceUpdate

• onceUpdate(listener): (() => void)

• Add a listener that is called only once when the message content changes.

  Parameters

  • listener: MessageUpdateListener

    The listener to trigger when content changes

  Returns (() => void)

  An unsubscribe function for this listener

  • • (): void

    • Returns void

readContentFromStream

• readContentFromStream(response): Promise<void>

• Progessively adds content to the message from a streamed response type.

  Parameters

  • response: ReadableStream<any>

    The ReadableStream from the OpenAI API

  Returns Promise<void>

toJSON

• toJSON(): {
      content: null | string;
      flags?: null | string[];
      function_call?: { name: string; arguments: Record<string, any>; };
      id?: string;
      model?: string;
      name?: string;
      role: "function" | "user" | "assistant" | "system";
  }

• Serializes the message to JSON.

  Returns {
      content: null | string;
      flags?: null | string[];
      function_call?: { name: string; arguments: Record<string, any>; };
      id?: string;
      model?: string;
      name?: string;
      role: "function" | "user" | "assistant" | "system";
  }

  The Message as a JSON object.

  • content: null | string

  • Optional flags?: null | string[]

  • Optional function_call?: { name: string; arguments: Record<string, any>; }

  • Optional id?: string

  • Optional model?: string

  • Optional name?: string

  • role: "function" | "user" | "assistant" | "system"

Static fromJSON

• fromJSON(json): Message

• Creates a new Message instance from a serialized message.

  Parameters

  • json: {
        content: null | string;
        flags?: null | string[];
        function_call?: { name: string; arguments: Record<string, any>; };
        id?: string;
        model?: string;
        name?: string;
        role: "function" | "user" | "assistant" | "system";
    }

    The JSON object of the Message instance.

    • content: null | string

    • Optional flags?: null | string[]

    • Optional function_call?: { name: string; arguments: Record<string, any>; }

    • Optional id?: string

    • Optional model?: string

    • Optional name?: string

    • role: "function" | "user" | "assistant" | "system"

  Returns Message

  A new Message instance