feat(provider): V4 type crate aimux-provider (phase 1 unit 1.6)

.github/workflows/ci.yml

@@ -4,7 +4,11 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
+    branches: [master, "exp/**"]
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
 
 env:
   CARGO_TERM_COLOR: always

Cargo.toml

@@ -2,6 +2,7 @@
 members = [
     "aimux-core",
     "aimux-ffi",
+    "aimux-provider",
     "aimux-provider-utils",
     "aimux-providers",
     "aimux-stream",

aimux-provider/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "aimux-provider"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+description = "AI SDK LanguageModelV4 specification types for aimux (design draft, not wired)"
+publish = false
+
+# #200 §2.1 constraint 1: no dependency on any other aimux crate.
+[dependencies]
+serde = { workspace = true }
+serde_json = { workspace = true }
+
+[lints]
+workspace = true

aimux-provider/src/call_options.rs

@@ -0,0 +1,129 @@
+//! `language-model-v4-call-options.ts`, tool definitions and tool choice.
+
+use std::collections::BTreeMap;
+
+use serde::{Deserialize, Serialize};
+
+use crate::{JsonObject, JsonValue, LanguageModelV4Prompt, SharedV4ProviderOptions};
+
+/// `LanguageModelV4CallOptions` without `abortSignal` (behaviour, not data).
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4CallOptions {
+    pub prompt: LanguageModelV4Prompt,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub max_output_tokens: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub temperature: Option<f64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub stop_sequences: Option<Vec<String>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub top_p: Option<f64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub top_k: Option<f64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub presence_penalty: Option<f64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub frequency_penalty: Option<f64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub response_format: Option<LanguageModelV4ResponseFormat>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub seed: Option<i64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub tools: Option<Vec<LanguageModelV4Tool>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub tool_choice: Option<LanguageModelV4ToolChoice>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub include_raw_chunks: Option<bool>,
+    /// A `None` value removes the header.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub headers: Option<BTreeMap<String, Option<String>>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub reasoning: Option<LanguageModelV4Reasoning>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_options: Option<SharedV4ProviderOptions>,
+}
+
+/// `responseFormat`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(tag = "type", rename_all = "kebab-case")]
+pub enum LanguageModelV4ResponseFormat {
+    Text,
+    Json {
+        /// JSON Schema 7.
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        schema: Option<JsonValue>,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        name: Option<String>,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        description: Option<String>,
+    },
+}
+
+/// `reasoning`.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum LanguageModelV4Reasoning {
+    ProviderDefault,
+    None,
+    Minimal,
+    Low,
+    Medium,
+    High,
+    Xhigh,
+}
+
+/// `LanguageModelV4FunctionTool | LanguageModelV4ProviderTool`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(tag = "type", rename_all = "kebab-case")]
+pub enum LanguageModelV4Tool {
+    Function(LanguageModelV4FunctionTool),
+    Provider(LanguageModelV4ProviderTool),
+}
+
+/// `LanguageModelV4FunctionTool`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4FunctionTool {
+    pub name: String,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+    /// JSON Schema 7.
+    pub input_schema: JsonValue,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub input_examples: Option<Vec<LanguageModelV4InputExample>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub strict: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_options: Option<SharedV4ProviderOptions>,
+}
+
+/// An `inputExamples` entry.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct LanguageModelV4InputExample {
+    pub input: JsonObject,
+}
+
+/// `LanguageModelV4ProviderTool`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ProviderTool {
+    /// `{provider}.{tool}`.
+    pub id: String,
+    pub name: String,
+    pub args: JsonObject,
+}
+
+/// `LanguageModelV4ToolChoice`.
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(
+    tag = "type",
+    rename_all = "kebab-case",
+    rename_all_fields = "camelCase"
+)]
+pub enum LanguageModelV4ToolChoice {
+    Auto,
+    None,
+    Required,
+    Tool { tool_name: String },
+}

aimux-provider/src/content.rs

@@ -0,0 +1,231 @@
+//! `language-model-v4-content.ts` and the generate result: the V4 output
+//! layer.
+
+use serde::{Deserialize, Serialize};
+
+use crate::{
+    JsonObject, JsonValue, SharedV4Headers, SharedV4InlineFileData, SharedV4ProviderMetadata,
+    SharedV4Warning,
+};
+
+/// `LanguageModelV4Text`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4Text {
+    pub text: String,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4Reasoning`.
+pub type LanguageModelV4ReasoningContent = LanguageModelV4Text;
+
+/// `LanguageModelV4CustomContent`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4CustomContent {
+    /// `{provider}.{kind}`.
+    pub kind: String,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4File` / `LanguageModelV4ReasoningFile`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4File {
+    pub media_type: String,
+    pub data: SharedV4InlineFileData,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4ToolApprovalRequest`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ToolApprovalRequest {
+    pub approval_id: String,
+    pub tool_call_id: String,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4Source`, tagged by `sourceType`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(
+    tag = "sourceType",
+    rename_all = "kebab-case",
+    rename_all_fields = "camelCase"
+)]
+pub enum LanguageModelV4Source {
+    Url {
+        id: String,
+        url: String,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        title: Option<String>,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        provider_metadata: Option<SharedV4ProviderMetadata>,
+    },
+    Document {
+        id: String,
+        media_type: String,
+        title: String,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        filename: Option<String>,
+        #[serde(default, skip_serializing_if = "Option::is_none")]
+        provider_metadata: Option<SharedV4ProviderMetadata>,
+    },
+}
+
+/// `LanguageModelV4ToolCall`. `input` is the provider's argument text,
+/// unparsed (RFC-0042 §3.1/§3.2).
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ToolCall {
+    pub tool_call_id: String,
+    pub tool_name: String,
+    pub input: String,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_executed: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub dynamic: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4ToolResult`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ToolResult {
+    pub tool_call_id: String,
+    pub tool_name: String,
+    /// `NonNullable<JSONValue>`.
+    pub result: JsonValue,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub is_error: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub preliminary: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub dynamic: Option<bool>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+}
+
+/// `LanguageModelV4Content`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(tag = "type", rename_all = "kebab-case")]
+pub enum LanguageModelV4Content {
+    Text(LanguageModelV4Text),
+    Reasoning(LanguageModelV4ReasoningContent),
+    Custom(LanguageModelV4CustomContent),
+    ReasoningFile(LanguageModelV4File),
+    File(LanguageModelV4File),
+    ToolApprovalRequest(LanguageModelV4ToolApprovalRequest),
+    Source(LanguageModelV4Source),
+    ToolCall(LanguageModelV4ToolCall),
+    ToolResult(LanguageModelV4ToolResult),
+}
+
+/// `LanguageModelV4FinishReason`.
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub struct LanguageModelV4FinishReason {
+    pub unified: LanguageModelV4UnifiedFinishReason,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub raw: Option<String>,
+}
+
+/// `LanguageModelV4FinishReason['unified']`.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum LanguageModelV4UnifiedFinishReason {
+    Stop,
+    Length,
+    ContentFilter,
+    ToolCalls,
+    Error,
+    Other,
+}
+
+/// `LanguageModelV4Usage`.
+#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4Usage {
+    pub input_tokens: LanguageModelV4InputTokens,
+    pub output_tokens: LanguageModelV4OutputTokens,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub raw: Option<JsonObject>,
+}
+
+/// `LanguageModelV4Usage['inputTokens']`.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4InputTokens {
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub total: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub no_cache: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub cache_read: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub cache_write: Option<u64>,
+}
+
+/// `LanguageModelV4Usage['outputTokens']`.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4OutputTokens {
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub total: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub text: Option<u64>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub reasoning: Option<u64>,
+}
+
+/// `LanguageModelV4ResponseMetadata`.
+#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ResponseMetadata {
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub id: Option<String>,
+    /// ISO 8601 (`Date` on the TS side).
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub timestamp: Option<String>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub model_id: Option<String>,
+}
+
+/// `LanguageModelV4GenerateResult['request']`.
+#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
+pub struct LanguageModelV4RequestInfo {
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub body: Option<JsonValue>,
+}
+
+/// `LanguageModelV4GenerateResult['response']`.
+#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4ResponseInfo {
+    #[serde(flatten)]
+    pub metadata: LanguageModelV4ResponseMetadata,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub headers: Option<SharedV4Headers>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub body: Option<JsonValue>,
+}
+
+/// `LanguageModelV4GenerateResult`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LanguageModelV4GenerateResult {
+    pub content: Vec<LanguageModelV4Content>,
+    pub finish_reason: LanguageModelV4FinishReason,
+    pub usage: LanguageModelV4Usage,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub provider_metadata: Option<SharedV4ProviderMetadata>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub request: Option<LanguageModelV4RequestInfo>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub response: Option<LanguageModelV4ResponseInfo>,
+    pub warnings: Vec<SharedV4Warning>,
+}