@ouraihub/aether-contracts 0.0.0-stage → 0.1.0

package/src/generated/Model.ts

@@ -0,0 +1,58 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ModelPricing } from "./ModelPricing";
+import type { ModelType } from "./ModelType";
+import type { ReasoningConfig } from "./ReasoningConfig";
+import type { TypeSource } from "./TypeSource";
+
+/**
+ * A selected model of an endpoint.
+ */
+export type Model = { 
+/**
+ * Upstream model identifier.
+ */
+id: string, 
+/**
+ * Intended model capability.
+ */
+modelType: ModelType, 
+/**
+ * Origin of the capability declaration.
+ */
+typeSource: TypeSource, 
+/**
+ * Configured context window in tokens.
+ */
+contextWindow: number | null, 
+/**
+ * Configured maximum output tokens.
+ */
+maxOutput: number | null, 
+/**
+ * Image input support.
+ */
+canVision: boolean, 
+/**
+ * Client-side tool support, unknown when absent.
+ */
+supportsTools: boolean | null, 
+/**
+ * User-declared reasoning parameters.
+ */
+reasoning: ReasoningConfig | null, 
+/**
+ * User-declared support for protocol-native web search.
+ */
+nativeWebSearch: boolean, 
+/**
+ * Display name; `None` = show the id.
+ */
+name: string | null, 
+/**
+ * Picker group; `None` = ungrouped.
+ */
+groupName: string | null, 
+/**
+ * User-declared prices (chat only).
+ */
+pricing: ModelPricing | null, };

package/src/generated/ModelFilter.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ModelType } from "./ModelType";
+
+/**
+ * Narrows [`crate::Store::model_options`]; `None` fields match everything.
+ */
+export type ModelFilter = { 
+/**
+ * Only this type.
+ */
+modelType?: ModelType, 
+/**
+ * Only models whose `supports_tools` equals this value.
+ */
+supportsTools?: boolean, };

package/src/generated/ModelOption.ts

@@ -0,0 +1,44 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ModelType } from "./ModelType";
+import type { ReasoningConfig } from "./ReasoningConfig";
+
+/**
+ * One entry of a model picker.
+ */
+export type ModelOption = { 
+/**
+ * Endpoint id.
+ */
+endpointId: string, 
+/**
+ * Model id.
+ */
+modelId: string, 
+/**
+ * `provider · endpoint · model`.
+ */
+label: string, 
+/**
+ * User display name of the model; `None` = not set.
+ */
+name: string | null, 
+/**
+ * Model type.
+ */
+modelType: ModelType, 
+/**
+ * Whether the model accepts tools; `None` = unknown.
+ */
+supportsTools: boolean | null, 
+/**
+ * Configured reasoning capabilities.
+ */
+reasoning: ReasoningConfig | null, 
+/**
+ * User-declared support for protocol-native web search.
+ */
+nativeWebSearch: boolean, 
+/**
+ * Image input support (inferred on fetch, user-editable in model settings).
+ */
+canVision: boolean, };

package/src/generated/ModelPricing.ts

@@ -0,0 +1,16 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Currency } from "./Currency";
+import type { PricingTier } from "./PricingTier";
+
+/**
+ * Tiered prices of one model.
+ */
+export type ModelPricing = { 
+/**
+ * Currency of every price.
+ */
+currency: Currency, 
+/**
+ * Tiers by strictly increasing `min_input_tokens`, starting at 0.
+ */
+tiers: Array<PricingTier>, };

package/src/generated/ModelRef.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Reference to one stored model, kept by the host for its own role settings.
+ */
+export type ModelRef = { 
+/**
+ * Endpoint id.
+ */
+endpointId: string, 
+/**
+ * Model id within the endpoint.
+ */
+modelId: string, };

package/src/generated/ModelSave.ts

@@ -0,0 +1,60 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ModelPricing } from "./ModelPricing";
+import type { ModelType } from "./ModelType";
+import type { ReasoningConfig } from "./ReasoningConfig";
+import type { TypeSource } from "./TypeSource";
+
+/**
+ * Model fields in a save request. `reasoning` is tri-state: omitted keeps the
+ * stored value, `null` turns it off, and an object replaces it. `name`, `groupName`
+ * and `pricing` replace the stored value (omitted = `null`).
+ */
+export type ModelSave = { 
+/**
+ * Upstream model identifier.
+ */
+id: string, 
+/**
+ * Intended model capability.
+ */
+modelType: ModelType, 
+/**
+ * Origin of the capability declaration.
+ */
+typeSource: TypeSource, 
+/**
+ * Configured context window in tokens.
+ */
+contextWindow: number | null, 
+/**
+ * Configured maximum output tokens.
+ */
+maxOutput: number | null, 
+/**
+ * Image input support.
+ */
+canVision: boolean, 
+/**
+ * Client-side tool support, unknown when absent.
+ */
+supportsTools: boolean | null, 
+/**
+ * Omit to keep, null to turn off, object to replace reasoning settings.
+ */
+reasoning?: ReasoningConfig | null, 
+/**
+ * User-declared support for protocol-native web search.
+ */
+nativeWebSearch: boolean, 
+/**
+ * Display name, at most 80 characters; blank = `None`.
+ */
+name: string | null, 
+/**
+ * Picker group, at most 80 characters; blank = `None`.
+ */
+groupName: string | null, 
+/**
+ * User-declared prices (chat only).
+ */
+pricing: ModelPricing | null, };

package/src/generated/ModelType.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * What a model is for.
+ */
+export type ModelType = "chat" | "image" | "video" | "tts" | "stt" | "embedding" | "rerank" | "unknown";

package/src/generated/PermissionMode.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * How much of the tool catalogue one run may use without asking; chosen per run, fixed
+ * once the run is accepted (docs/12 §5.1).
+ */
+export type PermissionMode = "default" | "plan" | "accept_edits" | "auto" | "full_access";

package/src/generated/Preview.ts

@@ -0,0 +1,50 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { PreviewAction } from "./PreviewAction";
+import type { PreviewCurrent } from "./PreviewCurrent";
+import type { SkillFileMeta } from "./SkillFileMeta";
+
+/**
+ * What the user confirms before install; `digest` must come back unchanged.
+ */
+export type Preview = { 
+/**
+ * `sha256` over the name, description, version, body, license and every packaged
+ * file (sorted by path).
+ */
+digest: string, 
+/**
+ * Frontmatter `name`.
+ */
+name: string, 
+/**
+ * Frontmatter `description`.
+ */
+description: string, 
+/**
+ * Frontmatter `version`.
+ */
+version: string | null, 
+/**
+ * Full body.
+ */
+body: string, 
+/**
+ * License text.
+ */
+license: string | null, 
+/**
+ * Uninterpreted frontmatter keys.
+ */
+extra: { [key in string]?: string }, 
+/**
+ * Packaged files, sorted by path.
+ */
+files: Array<SkillFileMeta>, 
+/**
+ * Install or replace.
+ */
+action: PreviewAction, 
+/**
+ * Present when `action` is `replace`.
+ */
+current: PreviewCurrent | null, };

package/src/generated/PreviewAction.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Whether confirming a preview installs a new skill or replaces one with the same name.
+ */
+export type PreviewAction = "install" | "replace";

package/src/generated/PreviewCurrent.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The installed skill a preview would replace.
+ */
+export type PreviewCurrent = { 
+/**
+ * Installed version.
+ */
+version: string | null, 
+/**
+ * Installed revision.
+ */
+revision: number, };

package/src/generated/PricingTier.ts

@@ -0,0 +1,26 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Prices per million tokens for rounds whose input reaches `min_input_tokens`.
+ */
+export type PricingTier = { 
+/**
+ * Lowest round input (cache included) this tier applies to; the first tier is 0.
+ */
+minInputTokens: number, 
+/**
+ * Uncached input price.
+ */
+input: number, 
+/**
+ * Output price (reasoning included).
+ */
+output: number, 
+/**
+ * Cache-read price; `None` = `input`.
+ */
+cacheRead: number | null, 
+/**
+ * Cache-write price; `None` = `input`.
+ */
+cacheWrite: number | null, };

package/src/generated/ProbeError.ts

@@ -0,0 +1,23 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ProbeErrorKind } from "./ProbeErrorKind";
+
+/**
+ * A probe failure shown next to the endpoint form.
+ */
+export type ProbeError = { 
+/**
+ * Failure kind.
+ */
+kind: ProbeErrorKind, 
+/**
+ * Upstream HTTP status.
+ */
+status: number | null, 
+/**
+ * Upstream text, masked, at most 300 characters.
+ */
+message: string | null, 
+/**
+ * i18n key such as `providers.hint.missing_v1`.
+ */
+hint: string | null, };

package/src/generated/ProbeErrorKind.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Why fetching the model list failed.
+ */
+export type ProbeErrorKind = "missing_key" | "unauthorized" | "not_found" | "rate_limited" | "status" | "timeout" | "connect" | "blocked_address" | "invalid_body";

package/src/generated/ProbeResult.ts

@@ -0,0 +1,26 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ProbeError } from "./ProbeError";
+import type { ProbedModel } from "./ProbedModel";
+import type { Protocol } from "./Protocol";
+
+/**
+ * Probe outcome: never a command error, so the UI can show `probeUrl` either way.
+ */
+export type ProbeResult = { 
+/**
+ * `GET` URL that was (or would be) requested.
+ */
+probeUrl: string, 
+/**
+ * Deduplicated, sorted models; empty on error.
+ */
+models: Array<ProbedModel>, 
+/**
+ * Set on failure.
+ */
+error: ProbeError | null, 
+/**
+ * `anthropic-messages` when listed `claude-*` models also answer on `/messages`
+ * while the endpoint uses another protocol (images and thinking work natively there).
+ */
+suggestedProtocol: Protocol | null, };

package/src/generated/ProbeTarget.ts

@@ -0,0 +1,27 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Protocol } from "./Protocol";
+
+/**
+ * What to probe: a stored endpoint, or an unsaved draft from the settings form (docs/11 §4).
+ */
+export type ProbeTarget = { "kind": "saved", 
+/**
+ * Endpoint id.
+ */
+endpointId: string, } | { "kind": "draft", 
+/**
+ * Base URL as typed.
+ */
+baseUrl: string, 
+/**
+ * Wire protocol.
+ */
+protocol: Protocol, 
+/**
+ * Endpoint being edited, if any.
+ */
+endpointId?: string, 
+/**
+ * Use only this key of `endpointId`; absent = rotate with failover.
+ */
+keyId?: string, };

package/src/generated/ProbedModel.ts

@@ -0,0 +1,62 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ModelPricing } from "./ModelPricing";
+import type { ModelType } from "./ModelType";
+import type { ReasoningConfig } from "./ReasoningConfig";
+import type { TypeSource } from "./TypeSource";
+
+/**
+ * A model found by a probe, with the inferred family group.
+ */
+export type ProbedModel = { 
+/**
+ * Family group for the picker, when known.
+ */
+group: string | null, 
+/**
+ * Upstream model identifier.
+ */
+id: string, 
+/**
+ * Intended model capability.
+ */
+modelType: ModelType, 
+/**
+ * Origin of the capability declaration.
+ */
+typeSource: TypeSource, 
+/**
+ * Configured context window in tokens.
+ */
+contextWindow: number | null, 
+/**
+ * Configured maximum output tokens.
+ */
+maxOutput: number | null, 
+/**
+ * Image input support.
+ */
+canVision: boolean, 
+/**
+ * Client-side tool support, unknown when absent.
+ */
+supportsTools: boolean | null, 
+/**
+ * User-declared reasoning parameters.
+ */
+reasoning: ReasoningConfig | null, 
+/**
+ * User-declared support for protocol-native web search.
+ */
+nativeWebSearch: boolean, 
+/**
+ * Display name; `None` = show the id.
+ */
+name: string | null, 
+/**
+ * Picker group; `None` = ungrouped.
+ */
+groupName: string | null, 
+/**
+ * User-declared prices (chat only).
+ */
+pricing: ModelPricing | null, };

package/src/generated/Protocol.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Wire protocol of a model endpoint.
+ */
+export type Protocol = "anthropic-messages" | "openai-chat" | "openai-responses";

package/src/generated/Provider.ts

@@ -0,0 +1,31 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Endpoint } from "./Endpoint";
+
+/**
+ * A provider with its endpoints in display order.
+ */
+export type Provider = { 
+/**
+ * Provider id.
+ */
+id: string, 
+/**
+ * Display name.
+ */
+name: string, 
+/**
+ * Off = its models leave every picker and cannot run.
+ */
+enabled: boolean, 
+/**
+ * Free-form Markdown notes about this provider's models.
+ */
+notes: string, 
+/**
+ * Host preset this provider belongs to; preset providers cannot be deleted. `None` = user-created.
+ */
+presetId: string | null, 
+/**
+ * Endpoints in display order.
+ */
+endpoints: Array<Endpoint>, };

package/src/generated/ProviderSave.ts

@@ -0,0 +1,32 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { EndpointSave } from "./EndpointSave";
+
+/**
+ * A whole-provider save: endpoints missing from `endpoints` are deleted.
+ */
+export type ProviderSave = { 
+/**
+ * Existing provider id; absent = new provider.
+ */
+id?: string, 
+/**
+ * Display name, 1–80 characters.
+ */
+name: string, 
+/**
+ * Absent = keep (new providers start enabled).
+ */
+enabled?: boolean, 
+/**
+ * Markdown notes, at most 10000 characters; absent = keep.
+ */
+notes?: string, 
+/**
+ * New providers only: seed this host preset. A no-op returning the current list when the preset
+ * is already present; a same-named user provider adopts it instead of a duplicate.
+ */
+presetId?: string, 
+/**
+ * The complete endpoint list.
+ */
+endpoints: Array<EndpointSave>, };

package/src/generated/ReasoningConfig.ts

@@ -0,0 +1,20 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ReasoningDialect } from "./ReasoningDialect";
+import type { ReasoningEffort } from "./ReasoningEffort";
+
+/**
+ * User-declared reasoning capabilities of one model.
+ */
+export type ReasoningConfig = { 
+/**
+ * Request parameter dialect.
+ */
+dialect: ReasoningDialect, 
+/**
+ * Allowed explicit choices.
+ */
+efforts: Array<ReasoningEffort>, 
+/**
+ * Upper bound for budget-based reasoning.
+ */
+budgetTokens?: number, };

package/src/generated/ReasoningDialect.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Provider-specific reasoning request dialect.
+ */
+export type ReasoningDialect = "openai" | "anthropic-budget" | "anthropic-adaptive" | "thinking-type" | "qwen";

package/src/generated/ReasoningEffort.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Explicit per-run reasoning choice; default leaves provider controls untouched.
+ */
+export type ReasoningEffort = "default" | "none" | "auto" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";

package/src/generated/RunAccepted.ts

@@ -0,0 +1,18 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Accepted identity; events may arrive before this reply is delivered.
+ */
+export type RunAccepted = { 
+/**
+ * Service-generated identifier.
+ */
+runId: string, 
+/**
+ * Persisted conversation, when enabled.
+ */
+conversationId: string | null, 
+/**
+ * Persisted candidate, when enabled.
+ */
+turnId: string | null, };