Skip to main content

inferlab_protocol/
lib.rs

1mod measurement_data_asset;
2mod wire;
3
4use schemars::generate::SchemaSettings;
5
6pub use measurement_data_asset::{
7    EvalPreparedSourceBinding, MeasurementDataAssetAcquiredSource,
8    MeasurementDataAssetCacheOutcome, MeasurementDataAssetCacheStore,
9    MeasurementDataAssetContentEntry, MeasurementDataAssetEffectiveSelection,
10    MeasurementDataAssetPreparationNextPhase, MeasurementDataAssetPreparationPhase,
11    MeasurementDataAssetPreparationRequest, MeasurementDataAssetPreparationResult,
12    MeasurementDataAssetReadiness, MeasurementDataAssetRemoteMetadataOutcome,
13    MeasurementDataAssetSourceBytesOutcome, MeasurementDataAssetSourceInput,
14    MeasurementDataAssetVerification, MeasurementDataFiles,
15};
16pub use wire::{
17    AdapterError, AdapterErrorCode, AdapterProtocol, AdapterRequest, AdapterResponse,
18    AdapterResult, AllocationLaunch, AuxiliaryModelInput, AuxiliaryModelKind,
19    AuxiliaryModelLocator, BenchAgenticAcquisitionOutcome, BenchAgenticBranchStats,
20    BenchAgenticCatalogInput, BenchAgenticResultEvidence, BenchAgenticRunEvidence,
21    BenchAgenticSourceInput, BenchAgenticSourceVerification, BenchArtifactLevelInput,
22    BenchCacheStartInput, BenchCaseInput, BenchClientRequest, BenchClientResult, BenchCorpusInput,
23    BenchDatasetCacheState, BenchDatasetCatalogInput, BenchDatasetFilterInput,
24    BenchDefinitionInput, BenchImageSamplingInput, BenchImageSourceInput, BenchImagesInput,
25    BenchInclusiveUniformInput, BenchLoadInput, BenchNativeInvocation, BenchPopulationInput,
26    BenchPopulationPreparationRequest, BenchPopulationPreparationResult,
27    BenchPrefixConditioningInput, BenchPrefixGeometrySummary, BenchPrefixSharingInput,
28    BenchPromptCacheObservation, BenchPromptInput, BenchPromptRouteInput,
29    BenchPromptTemplateProjection, BenchPromptTemplateSource, BenchPromptTokenReconciliation,
30    BenchPromptTokenTargetingSummary, BenchRandomShapeInput, BenchRenderingAuthorityInput,
31    BenchRequestRepresentationInput, BenchRequestSloInput, BenchRequestSloResult,
32    BenchRequestSourceInput, BenchRuntimeSessionResult, BenchSessionDatasetCatalogInput,
33    BenchSessionPhaseSummary, BenchSessionResultEvidence, BenchSessionSourceInput,
34    BenchSessionTemplateInput, BenchSessionTurnResult, BenchSharedSystemContentInput,
35    BenchSharedSystemContentSummary, BenchTokenCountSummary, BenchTokenDistributionKindInput,
36    BenchTokenSelectorInput, CaptureMechanism, CaptureTargetRequirement,
37    CaptureWindowControlEndpoint, CaptureWindowControlRequirement, CaptureWindowHttpActionSpec,
38    ClientEndpointInput, ClientStatus, EndpointAssignment, EndpointDeclaration, EndpointProtocol,
39    EndpointRequirement, EvalClientRequest, EvalClientResult, EvalDefinitionInput, EvalFailureKind,
40    EvalMetricComparison, EvalMetricGate, EvalMetricGateConclusion, EvalNormalizedMetric,
41    EvalPromptInput, EvalTaskSourceInput, EvalTrialSummary, FrontendCoRendering,
42    FrontendComponents, FrontendGatewayComponent, FrontendHandoff, FrontendPdRouterComponent,
43    FrontendProcessRole, GatewayFrontendBinding, GatewayPdRouterFrontendBinding, GatewayPlan,
44    GatewayTarget, HttpActionSpec, HttpMethod, HttpTargetRegistryReadiness, IntegrationIdentity,
45    KvTransferMechanism, LaunchFileDeclaration, MeasurementModelInput, MeasurementProtocol,
46    Parallelism, ParallelismAttention, ParallelismExperts, ParallelismOuter, PdRouterPlan,
47    PdRoutingPolicies, PlanServeInput, PlanServeResult, ProcessSpec,
48    PromptCacheReadZeroRepresentation, ProtocolVersion, RawArtifact, ReadinessProbe,
49    RenderInputDeclaration, RenderServeInput, RenderServeResult, RenderSource,
50    RenderedServeProcess, ServeModelInput, ServeProcessAllocation, ServeReplicaRequirement,
51    ServeRoleInput, ServeRoleKind, ServeRoleLink, ServeRoleResult, ServeTopology,
52    ServerMetricsEndpointInput, ServerMetricsEndpointRequirement, SettingValue,
53    SuppliedRenderInput, SyntheticAcceptanceCurveInput, SyntheticAcceptanceInput,
54    SyntheticAcceptanceOutcome, TargetEndpointScheme,
55};
56
57pub const PROTOCOL_SCHEMA_ID: &str = "https://inferlab.dev/schema/adapter-protocol/v11";
58pub const MEASUREMENT_SCHEMA_ID: &str = "https://inferlab.dev/schema/measurement-protocol/v1";
59pub const PROTOCOL_WIRE_SOURCE: &str = "crates/inferlab-protocol/src/wire.rs";
60pub const MEASUREMENT_WIRE_SOURCE: &str =
61    "crates/inferlab-protocol/src/wire.rs and measurement_data_asset.rs";
62
63#[must_use]
64pub fn protocol_schema() -> schemars::Schema {
65    schema_for::<AdapterProtocol>(PROTOCOL_SCHEMA_ID, PROTOCOL_WIRE_SOURCE)
66}
67
68#[must_use]
69pub fn measurement_schema() -> schemars::Schema {
70    schema_for::<MeasurementProtocol>(MEASUREMENT_SCHEMA_ID, MEASUREMENT_WIRE_SOURCE)
71}
72
73fn schema_for<T: schemars::JsonSchema>(id: &str, wire_source: &str) -> schemars::Schema {
74    let mut schema = SchemaSettings::draft2020_12()
75        .for_deserialize()
76        .into_generator()
77        .into_root_schema_for::<T>();
78    schema.ensure_object().insert("$id".to_owned(), id.into());
79    schema.ensure_object().insert(
80        "$comment".to_owned(),
81        format!("Generated from {wire_source}; do not edit.").into(),
82    );
83    schema
84}