Skip to content

Variable: ToolProgressEventSchema

const ToolProgressEventSchema: ZodUnion<readonly [ZodUnion<readonly [ZodDiscriminatedUnion<[ZodObject<{ content: ZodString; conversation_id: ZodOptional<ZodString>; message_id: ZodOptional<ZodString>; space_id: ZodString; type: ZodLiteral<"question">; }, $strip>, ZodObject<{ conversation_id: ZodOptional<ZodString>; message: ZodObject<{ attachments: ZodOptional<…>; auto_regenerate_count: ZodOptional<…>; content: ZodString; conversation_id: ZodString; created_timestamp: ZodOptional<…>; error: ZodOptional<…>; feedback: ZodOptional<…>; id: ZodString; last_updated_timestamp: ZodOptional<…>; message_id: ZodString; query_result: ZodOptional<…>; space_id: ZodString; status: ZodOptional<…>; user_id: ZodOptional<…>; }, $strip>; message_id: ZodOptional<ZodString>; space_id: ZodString; type: ZodLiteral<"message">; }, $strip>, ZodObject<{ conversation_id: ZodOptional<ZodString>; message_id: ZodOptional<ZodString>; previous_status: ZodOptional<ZodUnion<readonly […, …, …, …, …, …, …, …, …, …]>>; space_id: ZodString; status: ZodUnion<readonly [ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>, ZodLiteral<…>]>; type: ZodLiteral<"status">; }, $strip>], "type">, ZodDiscriminatedUnion<[ZodObject<{ content: ZodString; conversationId: ZodOptional<ZodString>; messageId: ZodOptional<ZodString>; spaceId: ZodString; type: ZodLiteral<"started">; }, $strip>, ZodObject<{ answer: ZodOptional<ZodString>; conversationId: ZodOptional<ZodString>; messageId: ZodOptional<ZodString>; spaceId: ZodString; statementIds: ZodArray<ZodString>; status: ZodCustom<"ASKING_AI" | "CANCELLED" | "COMPLETED" | "EXECUTING_QUERY" | "FAILED" | "FETCHING_METADATA" | "FILTERING_CONTEXT" | "PENDING_WAREHOUSE" | "QUERY_RESULT_EXPIRED" | "SUBMITTED", "ASKING_AI" | "CANCELLED" | "COMPLETED" | "EXECUTING_QUERY" | "FAILED" | "FETCHING_METADATA" | "FILTERING_CONTEXT" | "PENDING_WAREHOUSE" | "QUERY_RESULT_EXPIRED" | "SUBMITTED">; type: ZodLiteral<"ask_genie_done">; }, $strip>, ZodObject<{ conversationId: ZodOptional<ZodString>; error: ZodString; messageId: ZodOptional<ZodString>; spaceId: ZodOptional<ZodString>; type: ZodLiteral<"error">; }, $strip>, ZodObject<{ dataItems: ZodNumber; items: ZodNumber; spaceId: ZodString; textItems: ZodNumber; type: ZodLiteral<"summary">; }, $strip>], "type">]>, ZodObject<{ detail: ZodOptional<ZodString>; groupId: ZodOptional<ZodString>; message: ZodString; status: ZodString; type: ZodLiteral<"tool_status">; url: ZodOptional<ZodString>; }, $strip>]>

Complete progress vocabulary rendered by the common tool-session pill.

  • type: Generic tool progress discriminator.
  • status: Machine-readable tool status.
  • message: Human-readable progress label.
  • url (optional): Related URL when the tool is reading a page.
  • groupId (optional): Identifier grouping one search with its result.
  • detail (optional): Optional secondary result detail.