Caido
GuidesTutorialsReferenceConcepts

AI ​

AILanguageModelSettings ​

AILanguageModelSettings = object

Settings for AI language model.

Properties ​

capabilities? ​

optional capabilities: object

reasoning ​

reasoning: boolean

structured_output ​

structured_output: boolean

reasoning? ​

optional reasoning: AIReasoningSettings

AIProvider ​

AIProvider = ProviderV3 & (modelId: string, settings?: AILanguageModelSettings) => LanguageModelV3

Official AI Provider to be used by the ai library.

AIReasoningSettings ​

AIReasoningSettings = object

Settings for AI reasoning.

Properties ​

effort ​

effort: "low" | "medium" | "high"

AiSDK ​

AiSDK = object

Utilities to interact with AI.

Properties ​

createProvider() ​

createProvider: () => AIProvider

Creates a new AI provider instance that can be used with the ai library.

Returns ​

AIProvider

A provider instance compatible with the ai library.

getUpstreamProviders() ​

getUpstreamProviders: () => AIUpstreamProvider[]

Gets the list of configured upstream AI providers.

Returns ​

AIUpstreamProvider[]

An array of configured AI upstream providers.

AIUpstreamProvider ​

AIUpstreamProvider = object

AI upstream provider information. Only configured providers are returned.

Properties ​

api ​

api: AIUpstreamProviderApi

id ​

id: AIUpstreamProviderId

AIUpstreamProviderApi ​

AIUpstreamProviderApi = "ANTHROPIC" | "GEMINI" | "OPENAI_COMPLETION" | "OPENAI_RESPONSE" | "OPENROUTER"

The response API a provider speaks.

AIUpstreamProviderId ​

AIUpstreamProviderId = string

AI upstream provider ID.