@independo/inderun-contracts 0.4.0 → 0.5.0-rc.1

package/src/generated/provider-dynamic-capabilities.ts

@@ -0,0 +1,103 @@
+/* This file was generated from JSON Schema using quicktype. Do not edit by hand. */
+
+/**
+ * A provider's live capability check, evaluated on the current host when routing or when
+ * checkCapabilities() is called. Unlike the descriptor it can change between calls.
+ */
+export type ProviderDynamicCapabilities = {
+    /**
+     * Whether the provider is available and functional on this host right now.
+     */
+    available: boolean;
+    /**
+     * Whether cancellation is honored on this host right now. Absent inherits the static
+     * descriptor.cancel value: any value other than 'none' means available. Never null.
+     */
+    cancellationAvailable?: boolean;
+    /**
+     * Why the provider is unavailable, when available is false.
+     */
+    reason?: string;
+    /**
+     * Whether the provider can stream (Mode 2) on this host right now. Absent inherits the
+     * static descriptor.supports.streaming value; only set it when the host takes streaming
+     * away from a provider that otherwise declares it. Never null.
+     */
+    streamingAvailable?: boolean;
+    /**
+     * Why streaming is unavailable, when streamingAvailable is false. Absent lets the route
+     * planner synthesize a default message.
+     */
+    streamingUnavailableReason?: string;
+    /**
+     * Per-task overrides of the provider-level check, for tasks whose availability differs on
+     * this host, e.g. a voice that is not installed. Every field of an entry is optional and
+     * absent inherits the provider-level value; a false at either level wins.
+     */
+    taskCapabilities?: ProviderTaskAvailability[];
+    [property: string]: unknown;
+}
+
+/**
+ * The live check for one task kind.
+ */
+export type ProviderTaskAvailability = {
+    /**
+     * Whether the task can run on this host right now. Absent inherits the provider-level
+     * available. Never null.
+     */
+    available?: boolean;
+    /**
+     * Whether cancellation is honored for this task right now. Absent inherits. Never null.
+     */
+    cancellationAvailable?: boolean;
+    /**
+     * The task kind this entry describes.
+     */
+    kind: string;
+    /**
+     * BCP 47 locales available for this task right now. Absent means the provider cannot
+     * enumerate them.
+     */
+    locales?: string[];
+    /**
+     * Why the task is unavailable, when available is false.
+     */
+    reason?: string;
+    /**
+     * Whether the task can stream on this host right now. Absent inherits. Never null.
+     */
+    streamingAvailable?: boolean;
+    /**
+     * Why streaming is unavailable for this task, when streamingAvailable is false.
+     */
+    streamingUnavailableReason?: string;
+    /**
+     * Voices available for this task right now. Absent means the provider cannot enumerate
+     * them; a request that requires a voice then never routes to it.
+     */
+    voices?: ProviderVoice[];
+    [property: string]: unknown;
+}
+
+/**
+ * Provider-neutral traits of one available voice. Carries no provider voice identifier.
+ */
+export type ProviderVoice = {
+    gender?: VoiceGender;
+    /**
+     * BCP 47 locale the voice speaks.
+     */
+    locale: string;
+    /**
+     * Whether using the voice sends data off the device. Absent inherits the task's privacy
+     * posture.
+     */
+    networkRequired?: boolean;
+    [property: string]: unknown;
+}
+
+/**
+ * Perceived gender of a voice, as the platform reports it.
+ */
+export type VoiceGender = "female" | "male" | "neutral";

package/src/generated/route-plan.ts

@@ -34,9 +34,49 @@ export type RoutePlan = {
 export type Candidate = {
     order:      number;
     providerId: string;
+    /**
+     * The voice this candidate must use if it is attempted, chosen by the planner from the
+     * provider's dynamic voice inventory. It is the best voice that satisfies the request's
+     * locale, required voice traits and privacy — under local-required privacy always one that
+     * keeps data on the device — ranked by preferred gender, then exact locale region, then
+     * on-device before network. The adapter must use a voice with exactly these traits. Absent
+     * when the request names no locale or voice, or the provider does not list its voices; the
+     * adapter then chooses itself under the same rules.
+     */
+    voice?: ProviderVoice;
+    [property: string]: unknown;
+}
+
+/**
+ * The voice this candidate must use if it is attempted, chosen by the planner from the
+ * provider's dynamic voice inventory. It is the best voice that satisfies the request's
+ * locale, required voice traits and privacy — under local-required privacy always one that
+ * keeps data on the device — ranked by preferred gender, then exact locale region, then
+ * on-device before network. The adapter must use a voice with exactly these traits. Absent
+ * when the request names no locale or voice, or the provider does not list its voices; the
+ * adapter then chooses itself under the same rules.
+ *
+ * Provider-neutral traits of one available voice. Carries no provider voice identifier.
+ */
+export type ProviderVoice = {
+    gender?: VoiceGender;
+    /**
+     * BCP 47 locale the voice speaks.
+     */
+    locale: string;
+    /**
+     * Whether using the voice sends data off the device. Absent inherits the task's privacy
+     * posture.
+     */
+    networkRequired?: boolean;
     [property: string]: unknown;
 }
 
+/**
+ * Perceived gender of a voice, as the platform reports it.
+ */
+export type VoiceGender = "female" | "male" | "neutral";
+
 /**
  * Human-readable selection or failure explanation suitable for telemetry/debugging.
  */
@@ -63,7 +103,10 @@ export type Reason = {
      * statically declare Mode-2 streaming; 'streaming_unavailable' means it declares streaming
      * but the dynamic capability snapshot reports it cannot stream in the current host
      * environment. 'not_in_model_profile' means the request named a model profile that does not
-     * list this provider.
+     * list this provider. 'input_not_supported', 'output_delivery_not_supported',
+     * 'output_format_not_supported', 'locale_not_supported' and 'voice_not_available' mean the
+     * provider's task capability lacks an input kind, output delivery, media type, locale or
+     * voice the request requires.
      */
     code:    Code;
     message: string;
@@ -75,6 +118,9 @@ export type Reason = {
  * statically declare Mode-2 streaming; 'streaming_unavailable' means it declares streaming
  * but the dynamic capability snapshot reports it cannot stream in the current host
  * environment. 'not_in_model_profile' means the request named a model profile that does not
- * list this provider.
+ * list this provider. 'input_not_supported', 'output_delivery_not_supported',
+ * 'output_format_not_supported', 'locale_not_supported' and 'voice_not_available' mean the
+ * provider's task capability lacks an input kind, output delivery, media type, locale or
+ * voice the request requires.
  */
-export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile";
+export type Code = "task_not_supported" | "run_not_supported" | "streaming_not_supported" | "streaming_unavailable" | "privacy_constraint" | "cloud_constraint" | "offline" | "capability_unavailable" | "not_in_model_profile" | "input_not_supported" | "output_delivery_not_supported" | "output_format_not_supported" | "locale_not_supported" | "voice_not_available";