AttachmentRuntime

AttachmentRuntime state and actions for reading attachment data and controlling files inside assistant-ui messages and composers.

API Reference

AttachmentRuntime

path : AttachmentRuntimePath & { attachmentSource: TSource }

ref : string

threadSelector : AttachmentRuntime["path"]["threadSelector"]

attachmentSource : "message" | "edit-composer"

attachmentSelector : AttachmentRuntime["path"]["attachmentSelector"]

source : TSource

getState : () => AttachmentState & { source: TSource; }

remove : () => Promise<void>

subscribe : (callback: () => void) => Unsubscribe

AttachmentState

id : string

type : "image" | "document" | "file" | (string & {})

name : string

contentType ?: string

file ?: File

lastModified : number: The **`lastModified`** read-only property of the File interface provides the last modified date of the file as the number of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files without a known last modified date return the current date. MDN Reference
name : string: The **`name`** read-only property of the File interface returns the name of the file represented by a File object. For security reasons, the path is excluded from this property. MDN Reference
webkitRelativePath : string: The **`webkitRelativePath`** read-only property of the File interface contains a string which specifies the file's path relative to the directory selected by the user in an <input> element with its webkitdirectory attribute set. MDN Reference
size : number
type : string
arrayBuffer : () => Promise<ArrayBuffer>
bytes : () => Promise<Uint8Array<ArrayBuffer>>
slice : (start?: number, end?: number, contentType?: string) => Blob
stream : () => ReadableStream<Uint8Array<ArrayBuffer>>
text : () => Promise<string>

content ?: ThreadUserMessagePart[]

status : CompleteAttachmentStatus

source : "thread-composer"