Skip to content
dbx tools

Variable: ToolProgressPartDataSchema

const ToolProgressPartDataSchema: ZodObject<{ event: ZodUnion<readonly [ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ content: ZodString; conversation_id: ZodOptional<…>; message_id: ZodOptional<…>; space_id: ZodString; type: ZodLiteral<…>; }, $strip>, ZodObject<{ conversation_id: ZodOptional<…>; message: ZodObject<…, …>; message_id: ZodOptional<…>; space_id: ZodString; type: ZodLiteral<…>; }, $strip>, ZodObject<{ conversation_id: ZodOptional<…>; message_id: ZodOptional<…>; previous_status: ZodOptional<…>; space_id: ZodString; status: ZodUnion<…>; type: ZodLiteral<…>; }, $strip>], "type">, ZodDiscriminatedUnion<[ZodObject<{ content: ZodString; conversationId: ZodOptional<…>; messageId: ZodOptional<…>; spaceId: ZodString; type: ZodLiteral<…>; }, $strip>, ZodObject<{ answer: ZodOptional<…>; conversationId: ZodOptional<…>; messageId: ZodOptional<…>; spaceId: ZodString; statementIds: ZodArray<…>; status: ZodCustom<…, …>; type: ZodLiteral<…>; }, $strip>, ZodObject<{ conversationId: ZodOptional<…>; error: ZodString; messageId: ZodOptional<…>; spaceId: ZodOptional<…>; type: ZodLiteral<…>; }, $strip>, ZodObject<{ dataItems: ZodNumber; items: ZodNumber; spaceId: ZodString; textItems: ZodNumber; type: ZodLiteral<…>; }, $strip>], "type">]>, ZodObject<{ detail: ZodOptional<ZodString>; groupId: ZodOptional<ZodString>; message: ZodString; status: ZodString; type: ZodLiteral<"tool_status">; url: ZodOptional<ZodString>; }, $strip>]>; toolCallId: ZodString; }, $strip>

Data attached to TOOL_PROGRESS_PART_TYPE.

ToolProgressPartData fields

Section titled “ToolProgressPartData fields”

Generic tool progress attached to one native tool call.

  • toolCallId: Native tool-call id receiving this progress event.
  • event: Progress event emitted by the running tool.
  • event.type: Generic tool progress discriminator.
  • event.status: Machine-readable tool status.
  • event.message: Human-readable progress label.
  • event.url (optional): Related URL when the tool is reading a page.
  • event.groupId (optional): Identifier grouping one search with its result.
  • event.detail (optional): Optional secondary result detail.