Structs§
- Assistant
Message Item - Assistant-authored message within a thread.
- Attachment
- Attachment metadata included on thread items.
- Automatic
Thread Titling Param - Controls whether ChatKit automatically generates thread titles.
- Automatic
Thread Titling Param Args - Builder for
AutomaticThreadTitlingParam. - Chat
Session Automatic Thread Titling - Automatic thread title preferences for the session.
- Chat
Session Chatkit Configuration - ChatKit configuration for the session.
- Chat
Session File Upload - Upload permissions and limits applied to the session.
- Chat
Session History - History retention preferences returned for the session.
- Chat
Session Rate Limits - Active per-minute request limit for the session.
- Chat
Session Resource - Represents a ChatKit session and its resolved configuration.
- Chatkit
Configuration Param - Optional per-session configuration settings for ChatKit behavior.
- Chatkit
Configuration Param Args - Builder for
ChatkitConfigurationParam. - Chatkit
Workflow - Workflow metadata and state returned for the session.
- Chatkit
Workflow Tracing - Controls diagnostic tracing during the session.
- Client
Tool Call Item - Record of a client side tool invocation initiated by the assistant.
- Create
Chat Session Body - Parameters for provisioning a new ChatKit session.
- Create
Chat Session Request Args - Builder for
CreateChatSessionBody. - Deleted
Thread Resource - Confirmation payload returned after deleting a thread.
- Expires
After Param - Controls when the session expires relative to an anchor timestamp.
- Expires
After Param Args - Builder for
ExpiresAfterParam. - File
Annotation - Annotation that references an uploaded file.
- File
Annotation Source - Attachment source referenced by an annotation.
- File
Upload Param - Controls whether users can upload files.
- File
Upload Param Args - Builder for
FileUploadParam. - History
Param - Controls how much historical context is retained for the session.
- History
Param Args - Builder for
HistoryParam. - Inference
Options - Model and tool overrides applied when generating the assistant response.
- Rate
Limits Param - Controls request rate limits for the session.
- Rate
Limits Param Args - Builder for
RateLimitsParam. - Response
Output Text - Assistant response text accompanied by optional annotations.
- Task
Group Item - Collection of workflow tasks grouped together in the thread.
- Task
Group Task - Task entry that appears within a TaskGroup.
- Task
Item - Task emitted by the workflow to show progress and status updates.
- Thread
Item List Resource - A paginated list of thread items rendered for the ChatKit API.
- Thread
List Resource - A paginated list of ChatKit threads.
- Thread
Resource - Represents a ChatKit thread and its current status.
- Tool
Choice - Tool selection that the assistant should honor when executing the item.
- UrlAnnotation
- Annotation that references a URL.
- UrlAnnotation
Source - URL backing an annotation entry.
- User
Message Item - User-authored messages within a thread.
- Widget
Message Item - Thread item that renders a widget payload.
- Workflow
Param - Workflow reference and overrides applied to the chat session.
- Workflow
Param Args - Builder for
WorkflowParam. - Workflow
Tracing Param - Controls diagnostic tracing during the session.
- Workflow
Tracing Param Args - Builder for
WorkflowTracingParam.
Enums§
- Annotation
- Annotation object describing a cited source.
- Attachment
Type - Attachment discriminator.
- Chat
Session Status - Current lifecycle state of the session.
- Client
Tool Call Status - Execution status for the tool call.
- Task
Type - Subtype for the task.
- Thread
Item - The thread item - discriminated union based on type field.
- Thread
Status - Current status for the thread.
- User
Message Content - Content blocks that comprise a user message.