Overview

Work in progress

This page is under construction. Most links will not work yet.

Cloud

AssistantCloud

Runtime API

Runtime Adapters

Attachment

AttachmentAdapter
SimpleImageAttachmentAdapter
SimpleTextAttachmentAdapter
CompositeAttachmentAdapter

Feedback

FeedbackAdapter

Speech

SpeechSynthesisAdapter
WebSpeechSynthesisAdapter

Highest Level Context Providers

<AssistantRuntimeProvider runtime={runtime} />

Context Provider

Provides: Assistant Context, Thread Context, Thread Composer Context

Thread

ThreadList

<TextContentPartProvider text={text} />

Context Provider

Provides: Text ContentPart Context

ContentPart

Assistant Context

The context available to components inside <AssistantRuntimeProvider />. You usually wrap your entire application in this context.

AssistantRuntime

Programmatically access the assistant's state and actions.

useAssistantRuntime

Instructions

Add system prompt instructions

useAssistantInstructions

Programmatically access the list of registered tool UIs (Experimental)

useToolUIs
useToolUIsStore

ThreadListPrimitive

Shows a list of threads and allows the user to switch between them.

<ThreadListPrimitive.Root />

<ThreadListPrimitive.New />

<ThreadListPrimitive.Items components={...} />

Context Provider

Provides: ThreadListItem Context

Thread Context

The context for a single thread. Currently always corresponds to the runtime's main thread.

ThreadRuntime

Programmatically access the thread's state and actions.

useThread
useThreadComposer
useThreadRuntime

ModelContext

useThreadModelContext

ThreadViewportStore

useThreadViewport
useThreadViewportStore

ThreadPrimitive

A conversation thread.

<ThreadPrimitive.Root />

<ThreadPrimitive.Viewport />

<ThreadPrimitive.Messages />

Context Provider

Provides: Message Context, Edit Composer Context

Message

<ThreadPrimitive.ScrollToBottom />

<ThreadPrimitive.Empty />

<ThreadPrimitive.If />

<ThreadPrimitive.Suggestion />

Composer

AssistantModalPrimitive

A floating modal that usually appears in the lower right corner of the screen. Common for support use cases.

<AssistantModalPrimitive.Root />

<AssistantModalPrimitive.Trigger />

<AssistantModalPrimitive.Anchor />

<AssistantModalPrimitive.Content />

Composer Context

Manages the state and actions for the message composer

ComposerRuntime

useComposer
useComposerRuntime

ComposerPrimitive

<ComposerPrimitive.Root />

<ComposerPrimitive.Input />

<ComposerPrimitive.Send />

<ComposerPrimitive.Cancel />

<ComposerPrimitive.Attachments />

Context Provider

Provides: Attachment Context

<ComposerPrimitive.AddAttachment />

ContentPart Context

Manages the state and actions for content parts within messages

ContentPartRuntime

useContentPart
useContentPartText
useContentPartReasoning
useContentPartRuntime

ContentPartPrimitive

<ContentPartPrimitive.Text />

MarkdownText

<MarkdownText />

Attachment Context

Manages the state and actions for attachments in messages and composer

AttachmentRuntime

useAttachment
useAttachmentRuntime

AttachmentPrimitive

<AttachmentPrimitive.Root />

<AttachmentPrimitive.Name />

<AttachmentPrimitive.Delete />

<AttachmentPrimitive.Thumb />

ThreadListItem Context

Manages the state and actions for individual thread list items

ThreadListItemRuntime

useThreadListItem
useThreadListItemRuntime

ThreadListItem

<ThreadListItemPrimitive.Root />

<ThreadListItemPrimitive.Trigger />

<ThreadListItemPrimitive.Name />

<ThreadListItemPrimitive.Archive />

<ThreadListItemPrimitive.Unarchive />

<ThreadListItemPrimitive.Delete />

<ThreadListItemPrimitive.Rename />

Utilities

useThreadViewportAutoscroll
useInlineRender

Overview

On this page