AI Docs
API
Class References
Function References
- text
- textOptions
- combineStrategies
- convertMessagesToModelMessages
- convertZodToJsonSchema
- createReplayStream
- embedding
- generateMessageId
- maxIterations
- messages
- modelMessageToUIMessage
- modelMessagesToUIMessages
- normalizeToUIMessage
- parsePartialJSON
- summarize
- toServerSentEventsStream
- toServerSentEventsResponse
- toolDefinition
- uiMessageToModelMessages
- realtimeToken
- untilFinishReason
Interface References
- AIAdapter
- AIAdapterConfig
- AgentLoopState
- ApprovalRequestedStreamChunk
- AudioPart
- AudioVisualization
- BaseStreamChunk
- TextCompletionChunk
- TextOptions
- ChunkRecording
- ChunkStrategy
- ClientTool
- ContentPartSource
- ContentStreamChunk
- DefaultMessageMetadataByModality
- DocumentPart
- DoneStreamChunk
- EmbeddingOptions
- EmbeddingResult
- ErrorStreamChunk
- ImagePart
- InternalToolCallState
- JSONParser
- ModelMessage
- ProcessorResult
- ProcessorState
- RealtimeAdapter
- RealtimeClientOptions
- RealtimeConnection
- RealtimeMessage
- RealtimeSessionConfig
- RealtimeToken
- RealtimeTokenAdapter
- RealtimeTokenOptions
- ResponseFormat
- ServerTool
- StreamProcessorEvents
- StreamProcessorHandlers
- StreamProcessorOptions
- SummarizationOptions
- SummarizationResult
- TextPart
- ThinkingPart
- ThinkingStreamChunk
- Tool
- ToolCall
- ToolCallPart
- ToolCallStreamChunk
- ToolConfig
- ToolDefinition
- ToolDefinitionConfig
- ToolDefinitionInstance
- ToolInputAvailableStreamChunk
- ToolResultPart
- ToolResultStreamChunk
- UIMessage
- VideoPart
Type Alias References
- AgentLoopStrategy
- AnyClientTool
- TextStreamOptionsForModel
- TextStreamOptionsUnion
- ConstrainedContent
- ConstrainedModelMessage
- ContentPart
- ContentPartForModalities
- ExtractModalitiesForModel
- ExtractModelsFromAdapter
- InferToolInput
- InferToolName
- InferToolOutput
- MessagePart
- RealtimeEvent
- RealtimeMessagePart
- RealtimeMode
- RealtimeStatus
- ModalitiesArrayToUnion
- Modality
- StreamChunk
- StreamChunkType
- ToolCallState
- ToolResultState
Variable References
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference/interfaces/ProviderKeys.md
ProviderKeys
Defined in: packages/ai/src/byok/keyed.ts:25
Finds provider keys for a run. An agent reads it as ctx.keys. A host sets it on the binding and reads each user's own keys. Without a host, ctx.keys reads each provider's env names.
Properties#
adapter#
ts
adapter: <TAdapter>(adapter) => Promise<TAdapter>;Defined in: packages/ai/src/byok/keyed.ts:34
The adapter to call. A plain adapter comes back unchanged. A KeyedAdapter is built with the key from require.
Type Parameters#
TAdapter#
TAdapter
Parameters#
adapter#
TAdapter | KeyedAdapter<TAdapter>
Returns#
Promise<TAdapter>
get#
ts
get: (provider) => Promise<string | null>;Defined in: packages/ai/src/byok/keyed.ts:27
The key for provider, or null when there is none.
Parameters#
provider#
string | ByokProvider<string>
Returns#
Promise<string | null>
require#
ts
require: (provider) => Promise<string>;Defined in: packages/ai/src/byok/keyed.ts:29
The key for provider. Throws when there is none.
Parameters#
provider#
string | ByokProvider<string>
Returns#
Promise<string>