Skip to main content

Module shared

Module shared 

Source
Expand description

Types shared by every model interface: identifiers, provider options and metadata, warnings, headers, media types, file data and serde helpers.

Structs§

ApprovalId
Identifier of a tool approval request.
AudioFormat
Audio encoding and sample rate.
BatchId
Identifier of a provider batch job.
Headers
Request or response headers.
InvalidHeader
Error returned when a header name or value is invalid.
MediaType
An IANA media type such as image/png, or a top-level type such as image.
ModelId
Model identifier as understood by the provider, for example gpt-5.
PartId
Identifier of a text, reasoning or tool-input part within a stream.
ProviderId
Provider identifier, for example openai.responses or anthropic.messages.
ToolCallId
Identifier of a tool call, assigned by the provider.
ToolName
Name of a tool as exposed to the model.

Enums§

FileData
The payload of a file: inline bytes, a URL, a provider reference or an inline text document.
Warning
A non-fatal warning produced while preparing or executing a call.

Type Aliases§

ProviderMetadata
Provider-specific response metadata, grouped by provider key.
ProviderOptions
Provider-specific request options, grouped by provider key.
ProviderReference
Provider-side resource identifiers, keyed by provider name.