@agentskit/react β Type Aliases
API type aliases for @agentskit/react.
#Type Alias: AdapterFactory
AdapterFactory =
object
Defined in: core/dist/chat-C1aW2_Tp.d.ts:181
Factory that turns a request into a stream of model output.
#Param
request
Messages and model context for the response.
#Properties
#capabilities?
optionalcapabilities?:AdapterCapabilities
Defined in: core/dist/chat-C1aW2_Tp.d.ts:184
Optional capabilities hint. See AdapterCapabilities.
#createSource
createSource: (
request) =>StreamSource
Defined in: core/dist/chat-C1aW2_Tp.d.ts:182
#Parameters
request
#Returns
#Type Alias: MaybePromise<T>
MaybePromise<
T> =T|Promise<T>
Defined in: core/dist/message-8TsZHkTl.d.ts:4
Accept a value returned synchronously or through a promise.
#Type Parameters
#T
T
#Type Alias: MessageRole
MessageRole =
"user"|"assistant"|"system"|"tool"
Defined in: core/dist/message-8TsZHkTl.d.ts:227
Role assigned to a message in a conversation.
#Type Alias: MessageStatus
MessageStatus =
"pending"|"streaming"|"complete"|"error"
Defined in: core/dist/message-8TsZHkTl.d.ts:229
Lifecycle state of a message while it is created or processed.
#Type Alias: StreamStatus
StreamStatus =
"idle"|"streaming"|"complete"|"error"
Defined in: core/dist/chat-C1aW2_Tp.d.ts:5
State of a response stream.
#Type Alias: ToolCallStatus
ToolCallStatus =
"pending"|"running"|"complete"|"error"|"requires_confirmation"
Defined in: core/dist/message-8TsZHkTl.d.ts:99
Runtime state of a model-requested tool call.
#Type Alias: UsageMeterState
UsageMeterState =
"ok"|"warning"|"out"
Defined in: react/src/components/UsageMeter.tsx:12
Visual state of the usage meter: ok, warning, or out.