Skip to main content

switchyard_translation/
policy.rs

1// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2// SPDX-License-Identifier: Apache-2.0
3
4//! Policy knobs that control translation strictness and target capabilities.
5
6use serde::{Deserialize, Serialize};
7
8/// Controls whether known lossy conversions are allowed.
9#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize, Deserialize)]
10pub enum LossyConversionPolicy {
11    AllowWithDiagnostics,
12    Reject,
13}
14
15/// Controls how missing provider IDs are generated.
16#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
17pub enum DeterministicIdPolicy {
18    Preserve,
19    GenerateStable { prefix: String },
20}
21
22/// Controls whether exact source payloads are preserved for round trips.
23#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize, Deserialize)]
24pub enum PreservationPolicy {
25    /// Keep exact source bodies in the in-memory IR only.
26    InMemory,
27    /// Also embed a Switchyard metadata envelope in translated wire bodies.
28    ///
29    /// This enables multi-hop round trips through wire formats, but should be
30    /// used deliberately because provider APIs may reject or limit metadata.
31    Embed,
32    /// Do not store preservation metadata.
33    Disabled,
34}
35
36/// Capability constraints for the target model or provider profile.
37#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
38pub struct TargetCapabilities {
39    pub supports_tools: Option<bool>,
40    pub supports_images: Option<bool>,
41    pub supports_audio: Option<bool>,
42    pub supports_video: Option<bool>,
43    pub supports_files: Option<bool>,
44    pub supports_reasoning_effort: Option<bool>,
45    pub supports_json_schema_response_format: Option<bool>,
46    pub supports_parallel_tool_calls: Option<bool>,
47    pub supports_code_execution: Option<bool>,
48    pub supports_safety_settings: Option<bool>,
49    pub openai_compatible: Option<bool>,
50}
51
52/// End-to-end policy applied by request, response, and stream translation.
53#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
54pub struct TranslationPolicy {
55    pub lossy_conversion_policy: LossyConversionPolicy,
56    pub deterministic_ids: DeterministicIdPolicy,
57    pub preservation: PreservationPolicy,
58    pub target_capabilities: TargetCapabilities,
59}
60
61impl Default for TranslationPolicy {
62    fn default() -> Self {
63        Self {
64            lossy_conversion_policy: LossyConversionPolicy::AllowWithDiagnostics,
65            deterministic_ids: DeterministicIdPolicy::GenerateStable {
66                prefix: "sw".to_string(),
67            },
68            preservation: PreservationPolicy::InMemory,
69            target_capabilities: TargetCapabilities::default(),
70        }
71    }
72}