Class CodexToolCallChatResponseContent

Readonlykind

arguments

• get arguments(): undefined | string

  Returns undefined | string

confirmed

• get confirmed(): Promise<boolean>

  Returns Promise<boolean>

data

• get data(): undefined | Record<string, string>

  Returns undefined | Record<string, string>

finished

• get finished(): boolean

  Returns boolean

id

• get id(): undefined | string

  Returns undefined | string

name

• get name(): undefined | string

  Returns undefined | string

result

• get result(): ToolCallResult

  Returns ToolCallResult

whenFinished

• get whenFinished(): Promise<void>

  Returns Promise<void>

asDisplayString

• asDisplayString(): string

  Returns string

asString

• asString(): string

  Represents the content as a string. Returns undefined if the content is purely informational and/or visual and should not be included in the overall representation of the response.

  Returns string

cancelConfirmation

• cancelConfirmation(reason?: unknown): void

  Parameters

  • Optionalreason: unknown

  Returns void

complete

• complete(result: ToolCallResult): void

  Mark the tool call as completed with the given result.

  This is used to update the UI immediately when a tool finishes execution, without waiting for all parallel tool calls to complete. The language model batches tool results (via Promise.all) before yielding them to the stream, so without this early completion signal, the UI wouldn't update until all tools finish. The values set here will be overwritten by merge() when the language model eventually yields the results, but they should be identical.

  Parameters

  • result: ToolCallResult

  Returns void

confirm

• confirm(): void

  Confirm the tool execution

  Returns void

createConfirmationPromise

• createConfirmationPromise(): Promise<boolean>

  Returns Promise<boolean>

createFinishedPromise

• createFinishedPromise(): Promise<void>

  Returns Promise<void>

deny

• deny(reason?: string): void

  Parameters

  • Optionalreason: string

  Returns void

merge

• merge(
      nextChatResponseContent:
          | ToolCallChatResponseContent
          | ToolCallArgumentsDeltaContent,
  ): boolean

  Parameters

  • nextChatResponseContent: ToolCallChatResponseContent | ToolCallArgumentsDeltaContent

  Returns boolean

toLanguageModelMessage

• toLanguageModelMessage(): [ToolUseMessage, ToolResultMessage]

  Returns [ToolUseMessage, ToolResultMessage]

toSerializable

• toSerializable(): SerializableChatResponseContentData<ToolCallContentData>

  Returns SerializableChatResponseContentData<ToolCallContentData>