@octomil/browser 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +168 -36
- package/dist/_generated/accelerator_type.d.ts +8 -0
- package/dist/_generated/accelerator_type.d.ts.map +1 -0
- package/dist/_generated/accelerator_type.js +10 -0
- package/dist/_generated/accelerator_type.js.map +1 -0
- package/dist/_generated/activation_policy.d.ts +7 -0
- package/dist/_generated/activation_policy.d.ts.map +1 -0
- package/dist/_generated/activation_policy.js +9 -0
- package/dist/_generated/activation_policy.js.map +1 -0
- package/dist/_generated/adapter_activation_state.d.ts +13 -0
- package/dist/_generated/adapter_activation_state.d.ts.map +1 -0
- package/dist/_generated/adapter_activation_state.js +15 -0
- package/dist/_generated/adapter_activation_state.js.map +1 -0
- package/dist/_generated/artifact_format.d.ts +11 -0
- package/dist/_generated/artifact_format.d.ts.map +1 -0
- package/dist/_generated/artifact_format.js +13 -0
- package/dist/_generated/artifact_format.js.map +1 -0
- package/dist/_generated/artifact_resource_kind.d.ts +16 -0
- package/dist/_generated/artifact_resource_kind.d.ts.map +1 -0
- package/dist/_generated/artifact_resource_kind.js +18 -0
- package/dist/_generated/artifact_resource_kind.js.map +1 -0
- package/dist/_generated/artifact_status.d.ts +21 -0
- package/dist/_generated/artifact_status.d.ts.map +1 -0
- package/dist/_generated/artifact_status.js +23 -0
- package/dist/_generated/artifact_status.js.map +1 -0
- package/dist/_generated/auth_method.d.ts +10 -0
- package/dist/_generated/auth_method.d.ts.map +1 -0
- package/dist/_generated/auth_method.js +12 -0
- package/dist/_generated/auth_method.js.map +1 -0
- package/dist/_generated/auth_type.d.ts +7 -0
- package/dist/_generated/auth_type.d.ts.map +1 -0
- package/dist/_generated/auth_type.js +9 -0
- package/dist/_generated/auth_type.js.map +1 -0
- package/dist/_generated/billing_interval.d.ts +5 -0
- package/dist/_generated/billing_interval.d.ts.map +1 -0
- package/dist/_generated/billing_interval.js +7 -0
- package/dist/_generated/billing_interval.js.map +1 -0
- package/dist/_generated/billing_plan.d.ts +47 -0
- package/dist/_generated/billing_plan.d.ts.map +1 -0
- package/dist/_generated/billing_plan.js +41 -0
- package/dist/_generated/billing_plan.js.map +1 -0
- package/dist/_generated/cloud_provider.d.ts +12 -0
- package/dist/_generated/cloud_provider.d.ts.map +1 -0
- package/dist/_generated/cloud_provider.js +14 -0
- package/dist/_generated/cloud_provider.js.map +1 -0
- package/dist/_generated/compatibility_level.d.ts +7 -0
- package/dist/_generated/compatibility_level.d.ts.map +1 -0
- package/dist/_generated/compatibility_level.js +9 -0
- package/dist/_generated/compatibility_level.js.map +1 -0
- package/dist/_generated/content_part_type.d.ts +7 -0
- package/dist/_generated/content_part_type.d.ts.map +1 -0
- package/dist/_generated/content_part_type.js +9 -0
- package/dist/_generated/content_part_type.js.map +1 -0
- package/dist/_generated/delivery_mode.d.ts +6 -0
- package/dist/_generated/delivery_mode.d.ts.map +1 -0
- package/dist/_generated/delivery_mode.js +8 -0
- package/dist/_generated/delivery_mode.js.map +1 -0
- package/dist/_generated/device_class.d.ts +7 -0
- package/dist/_generated/device_class.d.ts.map +1 -0
- package/dist/_generated/device_class.js +9 -0
- package/dist/_generated/device_class.js.map +1 -0
- package/dist/_generated/device_connectivity_status.d.ts +8 -0
- package/dist/_generated/device_connectivity_status.d.ts.map +1 -0
- package/dist/_generated/device_connectivity_status.js +10 -0
- package/dist/_generated/device_connectivity_status.js.map +1 -0
- package/dist/_generated/device_model_status.d.ts +14 -0
- package/dist/_generated/device_model_status.d.ts.map +1 -0
- package/dist/_generated/device_model_status.js +16 -0
- package/dist/_generated/device_model_status.js.map +1 -0
- package/dist/_generated/device_platform.d.ts +9 -0
- package/dist/_generated/device_platform.d.ts.map +1 -0
- package/dist/_generated/device_platform.js +11 -0
- package/dist/_generated/device_platform.js.map +1 -0
- package/dist/_generated/email_provider.d.ts +8 -0
- package/dist/_generated/email_provider.d.ts.map +1 -0
- package/dist/_generated/email_provider.js +10 -0
- package/dist/_generated/email_provider.js.map +1 -0
- package/dist/_generated/email_template.d.ts +11 -0
- package/dist/_generated/email_template.d.ts.map +1 -0
- package/dist/_generated/email_template.js +13 -0
- package/dist/_generated/email_template.js.map +1 -0
- package/dist/_generated/error_code.d.ts +52 -0
- package/dist/_generated/error_code.d.ts.map +1 -0
- package/dist/_generated/error_code.js +85 -0
- package/dist/_generated/error_code.js.map +1 -0
- package/dist/_generated/federated_participation_state.d.ts +25 -0
- package/dist/_generated/federated_participation_state.d.ts.map +1 -0
- package/dist/_generated/federated_participation_state.js +27 -0
- package/dist/_generated/federated_participation_state.js.map +1 -0
- package/dist/_generated/federated_round_state.d.ts +17 -0
- package/dist/_generated/federated_round_state.d.ts.map +1 -0
- package/dist/_generated/federated_round_state.js +19 -0
- package/dist/_generated/federated_round_state.js.map +1 -0
- package/dist/_generated/finish_reason.d.ts +7 -0
- package/dist/_generated/finish_reason.d.ts.map +1 -0
- package/dist/_generated/finish_reason.js +9 -0
- package/dist/_generated/finish_reason.js.map +1 -0
- package/dist/_generated/index.d.ts +17 -0
- package/dist/_generated/index.d.ts.map +1 -0
- package/dist/_generated/index.js +17 -0
- package/dist/_generated/index.js.map +1 -0
- package/dist/_generated/input_modality.d.ts +7 -0
- package/dist/_generated/input_modality.d.ts.map +1 -0
- package/dist/_generated/input_modality.js +9 -0
- package/dist/_generated/input_modality.js.map +1 -0
- package/dist/_generated/message_role.d.ts +7 -0
- package/dist/_generated/message_role.d.ts.map +1 -0
- package/dist/_generated/message_role.js +9 -0
- package/dist/_generated/message_role.js.map +1 -0
- package/dist/_generated/metric_views.d.ts +18 -0
- package/dist/_generated/metric_views.d.ts.map +1 -0
- package/dist/_generated/metric_views.js +22 -0
- package/dist/_generated/metric_views.js.map +1 -0
- package/dist/_generated/modality.d.ts +7 -0
- package/dist/_generated/modality.d.ts.map +1 -0
- package/dist/_generated/modality.js +9 -0
- package/dist/_generated/modality.js.map +1 -0
- package/dist/_generated/model_capability.d.ts +10 -0
- package/dist/_generated/model_capability.d.ts.map +1 -0
- package/dist/_generated/model_capability.js +12 -0
- package/dist/_generated/model_capability.js.map +1 -0
- package/dist/_generated/model_feature.d.ts +7 -0
- package/dist/_generated/model_feature.d.ts.map +1 -0
- package/dist/_generated/model_feature.js +9 -0
- package/dist/_generated/model_feature.js.map +1 -0
- package/dist/_generated/model_lifecycle.d.ts +7 -0
- package/dist/_generated/model_lifecycle.d.ts.map +1 -0
- package/dist/_generated/model_lifecycle.js +9 -0
- package/dist/_generated/model_lifecycle.js.map +1 -0
- package/dist/_generated/model_source_format.d.ts +9 -0
- package/dist/_generated/model_source_format.d.ts.map +1 -0
- package/dist/_generated/model_source_format.js +11 -0
- package/dist/_generated/model_source_format.js.map +1 -0
- package/dist/_generated/model_status.d.ts +7 -0
- package/dist/_generated/model_status.d.ts.map +1 -0
- package/dist/_generated/model_status.js +9 -0
- package/dist/_generated/model_status.js.map +1 -0
- package/dist/_generated/network_type.d.ts +7 -0
- package/dist/_generated/network_type.d.ts.map +1 -0
- package/dist/_generated/network_type.js +9 -0
- package/dist/_generated/network_type.js.map +1 -0
- package/dist/_generated/oauth_provider.d.ts +8 -0
- package/dist/_generated/oauth_provider.d.ts.map +1 -0
- package/dist/_generated/oauth_provider.js +10 -0
- package/dist/_generated/oauth_provider.js.map +1 -0
- package/dist/_generated/operation_state.d.ts +9 -0
- package/dist/_generated/operation_state.d.ts.map +1 -0
- package/dist/_generated/operation_state.js +11 -0
- package/dist/_generated/operation_state.js.map +1 -0
- package/dist/_generated/otlp_resource_attributes.d.ts +16 -0
- package/dist/_generated/otlp_resource_attributes.d.ts.map +1 -0
- package/dist/_generated/otlp_resource_attributes.js +17 -0
- package/dist/_generated/otlp_resource_attributes.js.map +1 -0
- package/dist/_generated/principal_type.d.ts +7 -0
- package/dist/_generated/principal_type.d.ts.map +1 -0
- package/dist/_generated/principal_type.js +9 -0
- package/dist/_generated/principal_type.js.map +1 -0
- package/dist/_generated/query_routing_tier.d.ts +6 -0
- package/dist/_generated/query_routing_tier.d.ts.map +1 -0
- package/dist/_generated/query_routing_tier.js +8 -0
- package/dist/_generated/query_routing_tier.js.map +1 -0
- package/dist/_generated/routing_policy.d.ts +7 -0
- package/dist/_generated/routing_policy.d.ts.map +1 -0
- package/dist/_generated/routing_policy.js +9 -0
- package/dist/_generated/routing_policy.js.map +1 -0
- package/dist/_generated/runtime_executor.d.ts +18 -0
- package/dist/_generated/runtime_executor.d.ts.map +1 -0
- package/dist/_generated/runtime_executor.js +20 -0
- package/dist/_generated/runtime_executor.js.map +1 -0
- package/dist/_generated/scope.d.ts +16 -0
- package/dist/_generated/scope.d.ts.map +1 -0
- package/dist/_generated/scope.js +18 -0
- package/dist/_generated/scope.js.map +1 -0
- package/dist/_generated/span_attributes.d.ts +25 -0
- package/dist/_generated/span_attributes.d.ts.map +1 -0
- package/dist/_generated/span_attributes.js +34 -0
- package/dist/_generated/span_attributes.js.map +1 -0
- package/dist/_generated/span_event_attributes.d.ts +23 -0
- package/dist/_generated/span_event_attributes.d.ts.map +1 -0
- package/dist/_generated/span_event_attributes.js +36 -0
- package/dist/_generated/span_event_attributes.js.map +1 -0
- package/dist/_generated/span_event_names.d.ts +42 -0
- package/dist/_generated/span_event_names.d.ts.map +1 -0
- package/dist/_generated/span_event_names.js +82 -0
- package/dist/_generated/span_event_names.js.map +1 -0
- package/dist/_generated/span_names.d.ts +17 -0
- package/dist/_generated/span_names.d.ts.map +1 -0
- package/dist/_generated/span_names.js +18 -0
- package/dist/_generated/span_names.js.map +1 -0
- package/dist/_generated/span_status_mapping.d.ts +8 -0
- package/dist/_generated/span_status_mapping.d.ts.map +1 -0
- package/dist/_generated/span_status_mapping.js +17 -0
- package/dist/_generated/span_status_mapping.js.map +1 -0
- package/dist/_generated/subscription_status.d.ts +11 -0
- package/dist/_generated/subscription_status.d.ts.map +1 -0
- package/dist/_generated/subscription_status.js +13 -0
- package/dist/_generated/subscription_status.js.map +1 -0
- package/dist/_generated/support_tier.d.ts +7 -0
- package/dist/_generated/support_tier.d.ts.map +1 -0
- package/dist/_generated/support_tier.js +9 -0
- package/dist/_generated/support_tier.js.map +1 -0
- package/dist/_generated/telemetry_class.d.ts +6 -0
- package/dist/_generated/telemetry_class.d.ts.map +1 -0
- package/dist/_generated/telemetry_class.js +8 -0
- package/dist/_generated/telemetry_class.js.map +1 -0
- package/dist/_generated/telemetry_events.d.ts +10 -0
- package/dist/_generated/telemetry_events.d.ts.map +1 -0
- package/dist/_generated/telemetry_events.js +18 -0
- package/dist/_generated/telemetry_events.js.map +1 -0
- package/dist/_generated/thermal_state.d.ts +7 -0
- package/dist/_generated/thermal_state.d.ts.map +1 -0
- package/dist/_generated/thermal_state.js +9 -0
- package/dist/_generated/thermal_state.js.map +1 -0
- package/dist/_generated/tool_call_tier.d.ts +7 -0
- package/dist/_generated/tool_call_tier.d.ts.map +1 -0
- package/dist/_generated/tool_call_tier.js +9 -0
- package/dist/_generated/tool_call_tier.js.map +1 -0
- package/dist/_generated/training_job_state.d.ts +23 -0
- package/dist/_generated/training_job_state.d.ts.map +1 -0
- package/dist/_generated/training_job_state.js +25 -0
- package/dist/_generated/training_job_state.js.map +1 -0
- package/dist/_generated/work_class.d.ts +6 -0
- package/dist/_generated/work_class.d.ts.map +1 -0
- package/dist/_generated/work_class.js +8 -0
- package/dist/_generated/work_class.js.map +1 -0
- package/dist/artifacts.d.ts +16 -0
- package/dist/artifacts.d.ts.map +1 -0
- package/dist/artifacts.js +16 -0
- package/dist/artifacts.js.map +1 -0
- package/dist/audio/audio-transcriptions.d.ts +31 -0
- package/dist/audio/audio-transcriptions.d.ts.map +1 -0
- package/dist/audio/audio-transcriptions.js +73 -0
- package/dist/audio/audio-transcriptions.js.map +1 -0
- package/dist/audio/index.d.ts +5 -0
- package/dist/audio/index.d.ts.map +1 -0
- package/dist/audio/index.js +3 -0
- package/dist/audio/index.js.map +1 -0
- package/dist/audio/octomil-audio.d.ts +9 -0
- package/dist/audio/octomil-audio.d.ts.map +1 -0
- package/dist/audio/octomil-audio.js +11 -0
- package/dist/audio/octomil-audio.js.map +1 -0
- package/dist/audio/transcription-types.d.ts +17 -0
- package/dist/audio/transcription-types.d.ts.map +1 -0
- package/dist/audio/transcription-types.js +6 -0
- package/dist/audio/transcription-types.js.map +1 -0
- package/dist/cache.js +1 -1
- package/dist/cache.js.map +1 -1
- package/dist/capabilities.d.ts +26 -0
- package/dist/capabilities.d.ts.map +1 -0
- package/dist/capabilities.js +68 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/chat.d.ts +109 -0
- package/dist/chat.d.ts.map +1 -0
- package/dist/chat.js +258 -0
- package/dist/chat.js.map +1 -0
- package/dist/configure.d.ts +18 -0
- package/dist/configure.d.ts.map +1 -0
- package/dist/configure.js +136 -0
- package/dist/configure.js.map +1 -0
- package/dist/control.d.ts +171 -0
- package/dist/control.d.ts.map +1 -0
- package/dist/control.js +317 -0
- package/dist/control.js.map +1 -0
- package/dist/device-auth.d.ts +1 -1
- package/dist/device-auth.d.ts.map +1 -1
- package/dist/device-auth.js +7 -7
- package/dist/device-auth.js.map +1 -1
- package/dist/device-context.d.ts +48 -0
- package/dist/device-context.d.ts.map +1 -0
- package/dist/device-context.js +92 -0
- package/dist/device-context.js.map +1 -0
- package/dist/devices.d.ts +17 -0
- package/dist/devices.d.ts.map +1 -0
- package/dist/devices.js +16 -0
- package/dist/devices.js.map +1 -0
- package/dist/embeddings.d.ts +19 -0
- package/dist/embeddings.d.ts.map +1 -0
- package/dist/embeddings.js +54 -0
- package/dist/embeddings.js.map +1 -0
- package/dist/experiments.d.ts +4 -3
- package/dist/experiments.d.ts.map +1 -1
- package/dist/experiments.js +5 -10
- package/dist/experiments.js.map +1 -1
- package/dist/federated-analytics.d.ts +65 -0
- package/dist/federated-analytics.d.ts.map +1 -0
- package/dist/federated-analytics.js +128 -0
- package/dist/federated-analytics.js.map +1 -0
- package/dist/federated.d.ts +10 -3
- package/dist/federated.d.ts.map +1 -1
- package/dist/federated.js +68 -15
- package/dist/federated.js.map +1 -1
- package/dist/gradient-cache.d.ts +21 -0
- package/dist/gradient-cache.d.ts.map +1 -0
- package/dist/gradient-cache.js +70 -0
- package/dist/gradient-cache.js.map +1 -0
- package/dist/index.cjs +34626 -723
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +64 -13
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +55 -13
- package/dist/index.js.map +1 -1
- package/dist/install-id.d.ts +32 -0
- package/dist/install-id.d.ts.map +1 -0
- package/dist/install-id.js +61 -0
- package/dist/install-id.js.map +1 -0
- package/dist/{model-loader.d.ts → model-manager.d.ts} +4 -4
- package/dist/model-manager.d.ts.map +1 -0
- package/dist/{model-loader.js → model-manager.js} +18 -14
- package/dist/model-manager.js.map +1 -0
- package/dist/models.d.ts +74 -0
- package/dist/models.d.ts.map +1 -0
- package/dist/models.js +113 -0
- package/dist/models.js.map +1 -0
- package/dist/monitoring-config.d.ts +8 -0
- package/dist/monitoring-config.d.ts.map +1 -0
- package/dist/monitoring-config.js +5 -0
- package/dist/monitoring-config.js.map +1 -0
- package/dist/monitoring.d.ts +10 -0
- package/dist/monitoring.d.ts.map +1 -0
- package/dist/monitoring.js +19 -0
- package/dist/monitoring.js.map +1 -0
- package/dist/octomil.d.ts +151 -16
- package/dist/octomil.d.ts.map +1 -1
- package/dist/octomil.js +456 -125
- package/dist/octomil.js.map +1 -1
- package/dist/octomil.min.js +48 -2840
- package/dist/octomil.min.js.map +4 -4
- package/dist/responses-runtime.d.ts +13 -0
- package/dist/responses-runtime.d.ts.map +1 -0
- package/dist/responses-runtime.js +2 -0
- package/dist/responses-runtime.js.map +1 -0
- package/dist/responses-tools.d.ts +18 -0
- package/dist/responses-tools.d.ts.map +1 -0
- package/dist/responses-tools.js +71 -0
- package/dist/responses-tools.js.map +1 -0
- package/dist/responses.d.ts +142 -0
- package/dist/responses.d.ts.map +1 -0
- package/dist/responses.js +549 -0
- package/dist/responses.js.map +1 -0
- package/dist/routing.d.ts +49 -0
- package/dist/routing.d.ts.map +1 -0
- package/dist/routing.js +221 -0
- package/dist/routing.js.map +1 -0
- package/dist/runtime/core/model-runtime.d.ts +19 -0
- package/dist/runtime/core/model-runtime.d.ts.map +1 -0
- package/dist/runtime/core/model-runtime.js +9 -0
- package/dist/runtime/core/model-runtime.js.map +1 -0
- package/dist/{inference.d.ts → runtime/engines/onnx-web/engine.d.ts} +7 -3
- package/dist/runtime/engines/onnx-web/engine.d.ts.map +1 -0
- package/dist/{inference.js → runtime/engines/onnx-web/engine.js} +21 -7
- package/dist/runtime/engines/onnx-web/engine.js.map +1 -0
- package/dist/runtime/engines/registry/engine-plugin.d.ts +11 -0
- package/dist/runtime/engines/registry/engine-plugin.d.ts.map +1 -0
- package/dist/runtime/engines/registry/engine-plugin.js +2 -0
- package/dist/runtime/engines/registry/engine-plugin.js.map +1 -0
- package/dist/runtime/engines/registry/engine-registry.d.ts +35 -0
- package/dist/runtime/engines/registry/engine-registry.d.ts.map +1 -0
- package/dist/runtime/engines/registry/engine-registry.js +74 -0
- package/dist/runtime/engines/registry/engine-registry.js.map +1 -0
- package/dist/runtime/index.d.ts +4 -0
- package/dist/runtime/index.d.ts.map +1 -0
- package/dist/runtime/index.js +2 -0
- package/dist/runtime/index.js.map +1 -0
- package/dist/secure-aggregation.d.ts.map +1 -1
- package/dist/secure-aggregation.js +3 -2
- package/dist/secure-aggregation.js.map +1 -1
- package/dist/server-api.d.ts +17 -0
- package/dist/server-api.d.ts.map +1 -0
- package/dist/server-api.js +56 -0
- package/dist/server-api.js.map +1 -0
- package/dist/settings.d.ts +20 -0
- package/dist/settings.d.ts.map +1 -0
- package/dist/settings.js +49 -0
- package/dist/settings.js.map +1 -0
- package/dist/silent-auth-config.d.ts +33 -0
- package/dist/silent-auth-config.d.ts.map +1 -0
- package/dist/silent-auth-config.js +29 -0
- package/dist/silent-auth-config.js.map +1 -0
- package/dist/streaming.d.ts +4 -3
- package/dist/streaming.d.ts.map +1 -1
- package/dist/streaming.js +15 -25
- package/dist/streaming.js.map +1 -1
- package/dist/sync-manager.d.ts +103 -0
- package/dist/sync-manager.d.ts.map +1 -0
- package/dist/sync-manager.js +314 -0
- package/dist/sync-manager.js.map +1 -0
- package/dist/telemetry.d.ts +99 -4
- package/dist/telemetry.d.ts.map +1 -1
- package/dist/telemetry.js +251 -13
- package/dist/telemetry.js.map +1 -1
- package/dist/text/octomil-text.d.ts +18 -0
- package/dist/text/octomil-text.d.ts.map +1 -0
- package/dist/text/octomil-text.js +20 -0
- package/dist/text/octomil-text.js.map +1 -0
- package/dist/training.d.ts +15 -0
- package/dist/training.d.ts.map +1 -0
- package/dist/training.js +35 -0
- package/dist/training.js.map +1 -0
- package/dist/transformers-local-runtime.d.ts +17 -0
- package/dist/transformers-local-runtime.d.ts.map +1 -0
- package/dist/transformers-local-runtime.js +356 -0
- package/dist/transformers-local-runtime.js.map +1 -0
- package/dist/types.d.ts +353 -25
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +146 -0
- package/dist/types.js.map +1 -1
- package/package.json +7 -6
- package/dist/inference.d.ts.map +0 -1
- package/dist/inference.js.map +0 -1
- package/dist/model-loader.d.ts.map +0 -1
- package/dist/model-loader.js.map +0 -1
- package/dist/rollouts.d.ts +0 -43
- package/dist/rollouts.d.ts.map +0 -1
- package/dist/rollouts.js +0 -114
- package/dist/rollouts.js.map +0 -1
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cloud embeddings via POST /api/v1/embeddings.
|
|
3
|
+
*
|
|
4
|
+
* Calls the Octomil embeddings endpoint and returns dense vectors
|
|
5
|
+
* suitable for semantic search, clustering, and RAG pipelines.
|
|
6
|
+
*/
|
|
7
|
+
import type { EmbeddingResult } from "./types.js";
|
|
8
|
+
/**
|
|
9
|
+
* Generate embeddings via the Octomil cloud endpoint.
|
|
10
|
+
*
|
|
11
|
+
* @param serverUrl - Base URL of the Octomil API (e.g. `"https://api.octomil.com"`).
|
|
12
|
+
* @param apiKey - Bearer token for authentication.
|
|
13
|
+
* @param modelId - Embedding model identifier (e.g. `"nomic-embed-text"`).
|
|
14
|
+
* @param input - A single string or array of strings to embed.
|
|
15
|
+
* @param signal - Optional AbortSignal for cancellation.
|
|
16
|
+
* @returns `EmbeddingResult` with dense vectors, model name, and usage.
|
|
17
|
+
*/
|
|
18
|
+
export declare function embed(serverUrl: string, apiKey: string, modelId: string, input: string | string[], signal?: AbortSignal): Promise<EmbeddingResult>;
|
|
19
|
+
//# sourceMappingURL=embeddings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"embeddings.d.ts","sourceRoot":"","sources":["../src/embeddings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAqB,MAAM,YAAY,CAAC;AAGrE;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CACzB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EACxB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,eAAe,CAAC,CAiD1B"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cloud embeddings via POST /api/v1/embeddings.
|
|
3
|
+
*
|
|
4
|
+
* Calls the Octomil embeddings endpoint and returns dense vectors
|
|
5
|
+
* suitable for semantic search, clustering, and RAG pipelines.
|
|
6
|
+
*/
|
|
7
|
+
import { OctomilError } from "./types.js";
|
|
8
|
+
/**
|
|
9
|
+
* Generate embeddings via the Octomil cloud endpoint.
|
|
10
|
+
*
|
|
11
|
+
* @param serverUrl - Base URL of the Octomil API (e.g. `"https://api.octomil.com"`).
|
|
12
|
+
* @param apiKey - Bearer token for authentication.
|
|
13
|
+
* @param modelId - Embedding model identifier (e.g. `"nomic-embed-text"`).
|
|
14
|
+
* @param input - A single string or array of strings to embed.
|
|
15
|
+
* @param signal - Optional AbortSignal for cancellation.
|
|
16
|
+
* @returns `EmbeddingResult` with dense vectors, model name, and usage.
|
|
17
|
+
*/
|
|
18
|
+
export async function embed(serverUrl, apiKey, modelId, input, signal) {
|
|
19
|
+
if (!serverUrl) {
|
|
20
|
+
throw new OctomilError("INVALID_INPUT", "serverUrl is required for embed()");
|
|
21
|
+
}
|
|
22
|
+
if (!apiKey) {
|
|
23
|
+
throw new OctomilError("INVALID_INPUT", "apiKey is required for embed()");
|
|
24
|
+
}
|
|
25
|
+
const url = `${serverUrl.replace(/\/+$/, "")}/api/v1/embeddings`;
|
|
26
|
+
let response;
|
|
27
|
+
try {
|
|
28
|
+
response = await fetch(url, {
|
|
29
|
+
method: "POST",
|
|
30
|
+
headers: {
|
|
31
|
+
"Content-Type": "application/json",
|
|
32
|
+
Authorization: `Bearer ${apiKey}`,
|
|
33
|
+
},
|
|
34
|
+
body: JSON.stringify({ model_id: modelId, input }),
|
|
35
|
+
signal,
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
catch (err) {
|
|
39
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `embed() request failed: ${String(err)}`, err);
|
|
40
|
+
}
|
|
41
|
+
if (!response.ok) {
|
|
42
|
+
throw new OctomilError("INFERENCE_FAILED", `embed() failed: HTTP ${response.status}`);
|
|
43
|
+
}
|
|
44
|
+
const data = (await response.json());
|
|
45
|
+
return {
|
|
46
|
+
embeddings: data.data.map((d) => d.embedding),
|
|
47
|
+
model: data.model,
|
|
48
|
+
usage: {
|
|
49
|
+
promptTokens: data.usage.prompt_tokens,
|
|
50
|
+
totalTokens: data.usage.total_tokens,
|
|
51
|
+
},
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=embeddings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"embeddings.js","sourceRoot":"","sources":["../src/embeddings.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,SAAiB,EACjB,MAAc,EACd,OAAe,EACf,KAAwB,EACxB,MAAoB;IAEpB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,YAAY,CACpB,eAAe,EACf,mCAAmC,CACpC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,YAAY,CAAC,eAAe,EAAE,gCAAgC,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,CAAC;IAEjE,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAC1B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,MAAM,EAAE;aAClC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAClD,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,2BAA2B,MAAM,CAAC,GAAG,CAAC,EAAE,EACxC,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,YAAY,CACpB,kBAAkB,EAClB,wBAAwB,QAAQ,CAAC,MAAM,EAAE,CAC1C,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAsB,CAAC;IAE1D,OAAO;QACL,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7C,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,KAAK,EAAE;YACL,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa;YACtC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;SACrC;KACF,CAAC;AACJ,CAAC"}
|
package/dist/experiments.d.ts
CHANGED
|
@@ -4,18 +4,19 @@
|
|
|
4
4
|
* Deterministic variant assignment, experiment config caching,
|
|
5
5
|
* and metric reporting for model experiments.
|
|
6
6
|
*/
|
|
7
|
-
import type { Experiment, ExperimentVariant
|
|
7
|
+
import type { Experiment, ExperimentVariant } from "./types.js";
|
|
8
|
+
import type { TelemetryReporter } from "./telemetry.js";
|
|
8
9
|
export declare class ExperimentsClient {
|
|
9
10
|
private readonly serverUrl;
|
|
10
11
|
private readonly apiKey?;
|
|
11
12
|
private readonly cacheTtlMs;
|
|
12
|
-
private readonly
|
|
13
|
+
private readonly telemetry?;
|
|
13
14
|
private experimentsCache;
|
|
14
15
|
constructor(options: {
|
|
15
16
|
serverUrl: string;
|
|
16
17
|
apiKey?: string;
|
|
17
18
|
cacheTtlMs?: number;
|
|
18
|
-
|
|
19
|
+
telemetry?: TelemetryReporter;
|
|
19
20
|
});
|
|
20
21
|
/** Fetch all active experiments (cached). */
|
|
21
22
|
getActiveExperiments(): Promise<Experiment[]>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experiments.d.ts","sourceRoot":"","sources":["../src/experiments.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,
|
|
1
|
+
{"version":3,"file":"experiments.d.ts","sourceRoot":"","sources":["../src/experiments.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAMxD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;IAE/C,OAAO,CAAC,gBAAgB,CAGR;gBAEJ,OAAO,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,iBAAiB,CAAC;KAC/B;IAOD,6CAA6C;IACvC,oBAAoB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IA4BnD,wCAAwC;IAClC,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAgBpE;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAiB9E,8DAA8D;IAC9D,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI7D;;;OAGG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAE,GAAG,IAAI,CAAC;IAczE,yCAAyC;IACnC,WAAW,CACf,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC;IAqBhB,kCAAkC;IAClC,UAAU,IAAI,IAAI;CAGnB"}
|
package/dist/experiments.js
CHANGED
|
@@ -12,13 +12,13 @@ export class ExperimentsClient {
|
|
|
12
12
|
serverUrl;
|
|
13
13
|
apiKey;
|
|
14
14
|
cacheTtlMs;
|
|
15
|
-
|
|
15
|
+
telemetry;
|
|
16
16
|
experimentsCache = null;
|
|
17
17
|
constructor(options) {
|
|
18
18
|
this.serverUrl = options.serverUrl;
|
|
19
19
|
this.apiKey = options.apiKey;
|
|
20
20
|
this.cacheTtlMs = options.cacheTtlMs ?? 5 * 60 * 1000; // 5 min
|
|
21
|
-
this.
|
|
21
|
+
this.telemetry = options.telemetry;
|
|
22
22
|
}
|
|
23
23
|
/** Fetch all active experiments (cached). */
|
|
24
24
|
async getActiveExperiments() {
|
|
@@ -32,7 +32,7 @@ export class ExperimentsClient {
|
|
|
32
32
|
headers["Authorization"] = `Bearer ${this.apiKey}`;
|
|
33
33
|
const response = await fetch(url, { headers });
|
|
34
34
|
if (!response.ok) {
|
|
35
|
-
throw new OctomilError("
|
|
35
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to fetch experiments: HTTP ${response.status}`);
|
|
36
36
|
}
|
|
37
37
|
const data = (await response.json());
|
|
38
38
|
this.experimentsCache = {
|
|
@@ -49,7 +49,7 @@ export class ExperimentsClient {
|
|
|
49
49
|
headers["Authorization"] = `Bearer ${this.apiKey}`;
|
|
50
50
|
const response = await fetch(url, { headers });
|
|
51
51
|
if (!response.ok) {
|
|
52
|
-
throw new OctomilError("
|
|
52
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to fetch experiment: HTTP ${response.status}`);
|
|
53
53
|
}
|
|
54
54
|
return (await response.json());
|
|
55
55
|
}
|
|
@@ -110,12 +110,7 @@ export class ExperimentsClient {
|
|
|
110
110
|
timestamp: Date.now(),
|
|
111
111
|
}),
|
|
112
112
|
});
|
|
113
|
-
this.
|
|
114
|
-
type: "experiment_metric",
|
|
115
|
-
model: experimentId,
|
|
116
|
-
metadata: { metricName, value },
|
|
117
|
-
timestamp: Date.now(),
|
|
118
|
-
});
|
|
113
|
+
this.telemetry?.reportExperimentMetric(experimentId, metricName, value);
|
|
119
114
|
}
|
|
120
115
|
/** Clear the experiment cache. */
|
|
121
116
|
clearCache() {
|
package/dist/experiments.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experiments.js","sourceRoot":"","sources":["../src/experiments.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"experiments.js","sourceRoot":"","sources":["../src/experiments.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG1C,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E,MAAM,OAAO,iBAAiB;IACX,SAAS,CAAS;IAClB,MAAM,CAAU;IAChB,UAAU,CAAS;IACnB,SAAS,CAAqB;IAEvC,gBAAgB,GAGb,IAAI,CAAC;IAEhB,YAAY,OAKX;QACC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;QAC/D,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACrC,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,oBAAoB;QACxB,IACE,IAAI,CAAC,gBAAgB;YACrB,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,EAC9D,CAAC;YACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC;QAC3C,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,mCAAmC,CAAC;QACjE,MAAM,OAAO,GAA2B,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;QACvE,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QAEpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,qCAAqC,QAAQ,CAAC,MAAM,EAAE,CACvD,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAkC,CAAC;QACtE,IAAI,CAAC,gBAAgB,GAAG;YACtB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,wCAAwC;IACxC,KAAK,CAAC,mBAAmB,CAAC,YAAoB;QAC5C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;QACvF,MAAM,OAAO,GAA2B,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;QACvE,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QAEpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,oCAAoC,QAAQ,CAAC,MAAM,EAAE,CACtD,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAe,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,UAAsB,EAAE,QAAgB;QACjD,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAElD,MAAM,MAAM,GAAG,mBAAmB,CAAC,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAE7D,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC1C,UAAU,IAAI,OAAO,CAAC,iBAAiB,CAAC;YACxC,IAAI,MAAM,GAAG,UAAU,EAAE,CAAC;gBACxB,OAAO,OAAO,CAAC;YACjB,CAAC;QACH,CAAC;QAED,2DAA2D;QAC3D,OAAO,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;IACrE,CAAC;IAED,8DAA8D;IAC9D,UAAU,CAAC,UAAsB,EAAE,QAAgB;QACjD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,IAAI,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAe,EACf,QAAgB;QAEhB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACtD,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY;gBAAE,SAAS;YAE5B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC/C,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;YACtC,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,WAAW,CACf,YAAoB,EACpB,UAAkB,EAClB,KAAa,EACb,QAAiB;QAEjB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,UAAU,CAAC;QAC/F,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QAEpE,MAAM,KAAK,CAAC,GAAG,EAAE;YACf,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,WAAW,EAAE,UAAU;gBACvB,KAAK;gBACL,SAAS,EAAE,QAAQ;gBACnB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,EAAE,sBAAsB,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED,kCAAkC;IAClC,UAAU;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC/B,CAAC;CACF;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,SAAS,mBAAmB,CAAC,KAAa;IACxC,IAAI,IAAI,GAAG,IAAI,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;AAC9B,CAAC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @octomil/browser — Federated analytics client
|
|
3
|
+
*
|
|
4
|
+
* Provides cross-site statistical analyses (descriptive stats, t-tests,
|
|
5
|
+
* chi-square, ANOVA) and query history for federation members.
|
|
6
|
+
*
|
|
7
|
+
* Matches the cross-platform SDK interface.
|
|
8
|
+
*/
|
|
9
|
+
import type { AnalyticsFilter, DescriptiveResult, TTestResult, ChiSquareResult, AnovaResult, AnalyticsQuery, AnalyticsQueryListResponse } from "./types.js";
|
|
10
|
+
export interface FederatedAnalyticsOptions {
|
|
11
|
+
/** Base URL of the Octomil server. */
|
|
12
|
+
serverUrl: string;
|
|
13
|
+
/** Optional API key for authenticated requests. */
|
|
14
|
+
apiKey?: string;
|
|
15
|
+
}
|
|
16
|
+
export interface DescriptiveOptions {
|
|
17
|
+
variable: string;
|
|
18
|
+
groupBy?: string;
|
|
19
|
+
groupIds?: string[];
|
|
20
|
+
includePercentiles?: boolean;
|
|
21
|
+
filters?: AnalyticsFilter;
|
|
22
|
+
}
|
|
23
|
+
export interface TTestOptions {
|
|
24
|
+
variable: string;
|
|
25
|
+
groupA: string;
|
|
26
|
+
groupB: string;
|
|
27
|
+
confidenceLevel?: number;
|
|
28
|
+
filters?: AnalyticsFilter;
|
|
29
|
+
}
|
|
30
|
+
export interface ChiSquareOptions {
|
|
31
|
+
variable1: string;
|
|
32
|
+
variable2: string;
|
|
33
|
+
groupIds?: string[];
|
|
34
|
+
confidenceLevel?: number;
|
|
35
|
+
filters?: AnalyticsFilter;
|
|
36
|
+
}
|
|
37
|
+
export interface AnovaOptions {
|
|
38
|
+
variable: string;
|
|
39
|
+
groupBy?: string;
|
|
40
|
+
groupIds?: string[];
|
|
41
|
+
confidenceLevel?: number;
|
|
42
|
+
postHoc?: boolean;
|
|
43
|
+
filters?: AnalyticsFilter;
|
|
44
|
+
}
|
|
45
|
+
export declare class FederatedAnalyticsClient {
|
|
46
|
+
private readonly serverUrl;
|
|
47
|
+
private readonly apiKey?;
|
|
48
|
+
constructor(options: FederatedAnalyticsOptions);
|
|
49
|
+
/** Run descriptive statistics across groups in the federation. */
|
|
50
|
+
descriptive(options: DescriptiveOptions): Promise<DescriptiveResult>;
|
|
51
|
+
/** Run a two-sample t-test between two groups. */
|
|
52
|
+
tTest(options: TTestOptions): Promise<TTestResult>;
|
|
53
|
+
/** Run a chi-square test of independence. */
|
|
54
|
+
chiSquare(options: ChiSquareOptions): Promise<ChiSquareResult>;
|
|
55
|
+
/** Run a one-way ANOVA test across groups. */
|
|
56
|
+
anova(options: AnovaOptions): Promise<AnovaResult>;
|
|
57
|
+
/** List past analytics queries. */
|
|
58
|
+
listQueries(limit?: number, offset?: number): Promise<AnalyticsQueryListResponse>;
|
|
59
|
+
/** Get a specific analytics query by ID. */
|
|
60
|
+
getQuery(queryId: string): Promise<AnalyticsQuery>;
|
|
61
|
+
private buildHeaders;
|
|
62
|
+
private post;
|
|
63
|
+
private get;
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=federated-analytics.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"federated-analytics.d.ts","sourceRoot":"","sources":["../src/federated-analytics.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,WAAW,EACX,cAAc,EACd,0BAA0B,EAC3B,MAAM,YAAY,CAAC;AAOpB,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAMD,qBAAa,wBAAwB;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;gBAErB,OAAO,EAAE,yBAAyB;IAS9C,kEAAkE;IAC5D,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAU1E,kDAAkD;IAC5C,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAUxD,6CAA6C;IACvC,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAUpE,8CAA8C;IACxC,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAexD,mCAAmC;IAC7B,WAAW,CACf,KAAK,GAAE,MAAW,EAClB,MAAM,GAAE,MAAU,GACjB,OAAO,CAAC,0BAA0B,CAAC;IAUtC,4CAA4C;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAUxD,OAAO,CAAC,YAAY;YAWN,IAAI;YAgBJ,GAAG;CAclB"}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @octomil/browser — Federated analytics client
|
|
3
|
+
*
|
|
4
|
+
* Provides cross-site statistical analyses (descriptive stats, t-tests,
|
|
5
|
+
* chi-square, ANOVA) and query history for federation members.
|
|
6
|
+
*
|
|
7
|
+
* Matches the cross-platform SDK interface.
|
|
8
|
+
*/
|
|
9
|
+
import { OctomilError } from "./types.js";
|
|
10
|
+
// ---------------------------------------------------------------------------
|
|
11
|
+
// Client
|
|
12
|
+
// ---------------------------------------------------------------------------
|
|
13
|
+
export class FederatedAnalyticsClient {
|
|
14
|
+
serverUrl;
|
|
15
|
+
apiKey;
|
|
16
|
+
constructor(options) {
|
|
17
|
+
this.serverUrl = options.serverUrl.replace(/\/+$/, "");
|
|
18
|
+
this.apiKey = options.apiKey;
|
|
19
|
+
}
|
|
20
|
+
// -----------------------------------------------------------------------
|
|
21
|
+
// Statistical Analyses
|
|
22
|
+
// -----------------------------------------------------------------------
|
|
23
|
+
/** Run descriptive statistics across groups in the federation. */
|
|
24
|
+
async descriptive(options) {
|
|
25
|
+
return this.post("/api/v1/analytics/descriptive", {
|
|
26
|
+
variable: options.variable,
|
|
27
|
+
group_by: options.groupBy ?? "device_group",
|
|
28
|
+
group_ids: options.groupIds ?? null,
|
|
29
|
+
include_percentiles: options.includePercentiles ?? true,
|
|
30
|
+
filters: options.filters ? serializeFilter(options.filters) : null,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/** Run a two-sample t-test between two groups. */
|
|
34
|
+
async tTest(options) {
|
|
35
|
+
return this.post("/api/v1/analytics/t-test", {
|
|
36
|
+
variable: options.variable,
|
|
37
|
+
group_a: options.groupA,
|
|
38
|
+
group_b: options.groupB,
|
|
39
|
+
confidence_level: options.confidenceLevel ?? 0.95,
|
|
40
|
+
filters: options.filters ? serializeFilter(options.filters) : null,
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
/** Run a chi-square test of independence. */
|
|
44
|
+
async chiSquare(options) {
|
|
45
|
+
return this.post("/api/v1/analytics/chi-square", {
|
|
46
|
+
variable_1: options.variable1,
|
|
47
|
+
variable_2: options.variable2,
|
|
48
|
+
group_ids: options.groupIds ?? null,
|
|
49
|
+
confidence_level: options.confidenceLevel ?? 0.95,
|
|
50
|
+
filters: options.filters ? serializeFilter(options.filters) : null,
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
/** Run a one-way ANOVA test across groups. */
|
|
54
|
+
async anova(options) {
|
|
55
|
+
return this.post("/api/v1/analytics/anova", {
|
|
56
|
+
variable: options.variable,
|
|
57
|
+
group_by: options.groupBy ?? "device_group",
|
|
58
|
+
group_ids: options.groupIds ?? null,
|
|
59
|
+
confidence_level: options.confidenceLevel ?? 0.95,
|
|
60
|
+
post_hoc: options.postHoc ?? true,
|
|
61
|
+
filters: options.filters ? serializeFilter(options.filters) : null,
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
// -----------------------------------------------------------------------
|
|
65
|
+
// Query History
|
|
66
|
+
// -----------------------------------------------------------------------
|
|
67
|
+
/** List past analytics queries. */
|
|
68
|
+
async listQueries(limit = 50, offset = 0) {
|
|
69
|
+
const params = new URLSearchParams({
|
|
70
|
+
limit: String(limit),
|
|
71
|
+
offset: String(offset),
|
|
72
|
+
});
|
|
73
|
+
return this.get(`/api/v1/analytics/queries?${params.toString()}`);
|
|
74
|
+
}
|
|
75
|
+
/** Get a specific analytics query by ID. */
|
|
76
|
+
async getQuery(queryId) {
|
|
77
|
+
return this.get(`/api/v1/analytics/queries/${encodeURIComponent(queryId)}`);
|
|
78
|
+
}
|
|
79
|
+
// -----------------------------------------------------------------------
|
|
80
|
+
// Internal helpers
|
|
81
|
+
// -----------------------------------------------------------------------
|
|
82
|
+
buildHeaders() {
|
|
83
|
+
const headers = {
|
|
84
|
+
Accept: "application/json",
|
|
85
|
+
"Content-Type": "application/json",
|
|
86
|
+
};
|
|
87
|
+
if (this.apiKey) {
|
|
88
|
+
headers["Authorization"] = `Bearer ${this.apiKey}`;
|
|
89
|
+
}
|
|
90
|
+
return headers;
|
|
91
|
+
}
|
|
92
|
+
async post(path, body) {
|
|
93
|
+
const url = `${this.serverUrl}${path}`;
|
|
94
|
+
const response = await fetch(url, {
|
|
95
|
+
method: "POST",
|
|
96
|
+
headers: this.buildHeaders(),
|
|
97
|
+
body: JSON.stringify(body),
|
|
98
|
+
});
|
|
99
|
+
if (!response.ok) {
|
|
100
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Analytics request failed: HTTP ${response.status}`);
|
|
101
|
+
}
|
|
102
|
+
return (await response.json());
|
|
103
|
+
}
|
|
104
|
+
async get(path) {
|
|
105
|
+
const url = `${this.serverUrl}${path}`;
|
|
106
|
+
const response = await fetch(url, {
|
|
107
|
+
method: "GET",
|
|
108
|
+
headers: this.buildHeaders(),
|
|
109
|
+
});
|
|
110
|
+
if (!response.ok) {
|
|
111
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Analytics request failed: HTTP ${response.status}`);
|
|
112
|
+
}
|
|
113
|
+
return (await response.json());
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
// ---------------------------------------------------------------------------
|
|
117
|
+
// Helpers
|
|
118
|
+
// ---------------------------------------------------------------------------
|
|
119
|
+
/** Serialize an AnalyticsFilter to snake_case for the API. */
|
|
120
|
+
function serializeFilter(filter) {
|
|
121
|
+
return {
|
|
122
|
+
start_time: filter.startTime ?? null,
|
|
123
|
+
end_time: filter.endTime ?? null,
|
|
124
|
+
device_platform: filter.devicePlatform ?? null,
|
|
125
|
+
min_sample_count: filter.minSampleCount ?? null,
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
//# sourceMappingURL=federated-analytics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"federated-analytics.js","sourceRoot":"","sources":["../src/federated-analytics.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAWH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA8C1C,8EAA8E;AAC9E,SAAS;AACT,8EAA8E;AAE9E,MAAM,OAAO,wBAAwB;IAClB,SAAS,CAAS;IAClB,MAAM,CAAU;IAEjC,YAAY,OAAkC;QAC5C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED,0EAA0E;IAC1E,uBAAuB;IACvB,0EAA0E;IAE1E,kEAAkE;IAClE,KAAK,CAAC,WAAW,CAAC,OAA2B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAoB,+BAA+B,EAAE;YACnE,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;YAC3C,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;YACnC,mBAAmB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;YACvD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;SACnE,CAAC,CAAC;IACL,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAc,0BAA0B,EAAE;YACxD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,OAAO,CAAC,MAAM;YACvB,OAAO,EAAE,OAAO,CAAC,MAAM;YACvB,gBAAgB,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;SACnE,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,SAAS,CAAC,OAAyB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAkB,8BAA8B,EAAE;YAChE,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;YACnC,gBAAgB,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;SACnE,CAAC,CAAC;IACL,CAAC;IAED,8CAA8C;IAC9C,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAc,yBAAyB,EAAE;YACvD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;YAC3C,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;YACnC,gBAAgB,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;YACjD,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YACjC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;SACnE,CAAC,CAAC;IACL,CAAC;IAED,0EAA0E;IAC1E,gBAAgB;IAChB,0EAA0E;IAE1E,mCAAmC;IACnC,KAAK,CAAC,WAAW,CACf,QAAgB,EAAE,EAClB,SAAiB,CAAC;QAElB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC;YACjC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;SACvB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,GAAG,CACb,6BAA6B,MAAM,CAAC,QAAQ,EAAE,EAAE,CACjD,CAAC;IACJ,CAAC;IAED,4CAA4C;IAC5C,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,GAAG,CACb,6BAA6B,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAC3D,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,mBAAmB;IACnB,0EAA0E;IAElE,YAAY;QAClB,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QACrD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,IAAI,CAAI,IAAY,EAAE,IAAa;QAC/C,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE;YAC5B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,kCAAkC,QAAQ,CAAC,MAAM,EAAE,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IACtC,CAAC;IAEO,KAAK,CAAC,GAAG,CAAI,IAAY;QAC/B,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE;SAC7B,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,kCAAkC,QAAQ,CAAC,MAAM,EAAE,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IACtC,CAAC;CACF;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,8DAA8D;AAC9D,SAAS,eAAe,CACtB,MAAuB;IAEvB,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI;QACpC,QAAQ,EAAE,MAAM,CAAC,OAAO,IAAI,IAAI;QAChC,eAAe,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI;QAC9C,gBAAgB,EAAE,MAAM,CAAC,cAAc,IAAI,IAAI;KAChD,CAAC;AACJ,CAAC"}
|
package/dist/federated.d.ts
CHANGED
|
@@ -6,7 +6,8 @@
|
|
|
6
6
|
* is delegated to user-provided training hooks since ONNX Runtime Web
|
|
7
7
|
* has limited training support.
|
|
8
8
|
*/
|
|
9
|
-
import type { TrainingConfig, FederatedRound, WeightMap
|
|
9
|
+
import type { TrainingConfig, FederatedRound, WeightMap } from "./types.js";
|
|
10
|
+
import type { TelemetryReporter } from "./telemetry.js";
|
|
10
11
|
/** Extract and compare model weights stored as named Float32Arrays. */
|
|
11
12
|
export declare class WeightExtractor {
|
|
12
13
|
/**
|
|
@@ -23,17 +24,23 @@ export declare class FederatedClient {
|
|
|
23
24
|
private readonly serverUrl;
|
|
24
25
|
private readonly apiKey?;
|
|
25
26
|
private readonly deviceId;
|
|
26
|
-
private readonly
|
|
27
|
+
private readonly telemetry?;
|
|
27
28
|
constructor(options: {
|
|
28
29
|
serverUrl: string;
|
|
29
30
|
apiKey?: string;
|
|
30
31
|
deviceId: string;
|
|
31
|
-
|
|
32
|
+
telemetry?: TelemetryReporter;
|
|
32
33
|
});
|
|
33
34
|
/** Fetch the current training round from the server. */
|
|
34
35
|
getTrainingRound(federationId: string): Promise<FederatedRound>;
|
|
35
36
|
/** Join a training round. */
|
|
36
37
|
joinRound(federationId: string, roundId: string): Promise<void>;
|
|
38
|
+
offers(): Promise<Record<string, unknown>>;
|
|
39
|
+
join(roundId: string, request?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
40
|
+
plan(planId: string): Promise<Record<string, unknown>>;
|
|
41
|
+
heartbeat(roundId: string, request?: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
42
|
+
uploadInitiate(roundId: string, request: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
43
|
+
uploadComplete(roundId: string, uploadId: string, request: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
37
44
|
/**
|
|
38
45
|
* Run local training using a user-provided step function.
|
|
39
46
|
*
|
package/dist/federated.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"federated.d.ts","sourceRoot":"","sources":["../src/federated.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,SAAS,
|
|
1
|
+
{"version":3,"file":"federated.d.ts","sourceRoot":"","sources":["../src/federated.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACV,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAMxD,uEAAuE;AACvE,qBAAa,eAAe;IAC1B;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,SAAS;IAoBnE,4DAA4D;IAC5D,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,SAAS;IAmBlE,mDAAmD;IACnD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM;CAU1C;AAMD,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAoB;gBAEnC,OAAO,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,iBAAiB,CAAC;KAC/B;IAOD,wDAAwD;IAClD,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAarE,6BAA6B;IACvB,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB/D,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAc1C,IAAI,CACR,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoB7B,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IActD,SAAS,CACb,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAoB7B,cAAc,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAiB7B,cAAc,CAClB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAiBnC;;;;;;OAMG;IACG,KAAK,CACT,cAAc,EAAE,SAAS,EACzB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC;QAAE,YAAY,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;IAuBzD,wDAAwD;IAClD,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;YAmCF,OAAO;IAcrB,OAAO,CAAC,YAAY;CAOrB"}
|
package/dist/federated.js
CHANGED
|
@@ -72,18 +72,18 @@ export class FederatedClient {
|
|
|
72
72
|
serverUrl;
|
|
73
73
|
apiKey;
|
|
74
74
|
deviceId;
|
|
75
|
-
|
|
75
|
+
telemetry;
|
|
76
76
|
constructor(options) {
|
|
77
77
|
this.serverUrl = options.serverUrl;
|
|
78
78
|
this.apiKey = options.apiKey;
|
|
79
79
|
this.deviceId = options.deviceId;
|
|
80
|
-
this.
|
|
80
|
+
this.telemetry = options.telemetry;
|
|
81
81
|
}
|
|
82
82
|
/** Fetch the current training round from the server. */
|
|
83
83
|
async getTrainingRound(federationId) {
|
|
84
84
|
const response = await this.request(`/api/v1/federations/${encodeURIComponent(federationId)}/rounds/current`);
|
|
85
85
|
if (!response.ok) {
|
|
86
|
-
throw new OctomilError("
|
|
86
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to fetch training round: HTTP ${response.status}`);
|
|
87
87
|
}
|
|
88
88
|
return (await response.json());
|
|
89
89
|
}
|
|
@@ -94,9 +94,69 @@ export class FederatedClient {
|
|
|
94
94
|
body: JSON.stringify({ device_id: this.deviceId }),
|
|
95
95
|
});
|
|
96
96
|
if (!response.ok) {
|
|
97
|
-
throw new OctomilError("
|
|
97
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to join round: HTTP ${response.status}`);
|
|
98
98
|
}
|
|
99
99
|
}
|
|
100
|
+
async offers() {
|
|
101
|
+
const response = await this.request(`/api/v1/federation/rounds/offers?deviceId=${encodeURIComponent(this.deviceId)}`, { method: "GET" });
|
|
102
|
+
if (!response.ok) {
|
|
103
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to fetch round offers: HTTP ${response.status}`);
|
|
104
|
+
}
|
|
105
|
+
return (await response.json());
|
|
106
|
+
}
|
|
107
|
+
async join(roundId, request = {}) {
|
|
108
|
+
const response = await this.request(`/api/v1/federation/rounds/${encodeURIComponent(roundId)}/join`, {
|
|
109
|
+
method: "POST",
|
|
110
|
+
body: JSON.stringify({
|
|
111
|
+
deviceId: this.deviceId,
|
|
112
|
+
...request,
|
|
113
|
+
}),
|
|
114
|
+
});
|
|
115
|
+
if (!response.ok) {
|
|
116
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to join federation round: HTTP ${response.status}`);
|
|
117
|
+
}
|
|
118
|
+
return (await response.json());
|
|
119
|
+
}
|
|
120
|
+
async plan(planId) {
|
|
121
|
+
const response = await this.request(`/api/v1/federation/plans/${encodeURIComponent(planId)}`, { method: "GET" });
|
|
122
|
+
if (!response.ok) {
|
|
123
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to fetch federation plan: HTTP ${response.status}`);
|
|
124
|
+
}
|
|
125
|
+
return (await response.json());
|
|
126
|
+
}
|
|
127
|
+
async heartbeat(roundId, request = {}) {
|
|
128
|
+
const response = await this.request(`/api/v1/federation/rounds/${encodeURIComponent(roundId)}/heartbeat`, {
|
|
129
|
+
method: "POST",
|
|
130
|
+
body: JSON.stringify({
|
|
131
|
+
deviceId: this.deviceId,
|
|
132
|
+
...request,
|
|
133
|
+
}),
|
|
134
|
+
});
|
|
135
|
+
if (!response.ok) {
|
|
136
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to send federation heartbeat: HTTP ${response.status}`);
|
|
137
|
+
}
|
|
138
|
+
return (await response.json());
|
|
139
|
+
}
|
|
140
|
+
async uploadInitiate(roundId, request) {
|
|
141
|
+
const response = await this.request(`/api/v1/federation/rounds/${encodeURIComponent(roundId)}/updates/initiate`, {
|
|
142
|
+
method: "POST",
|
|
143
|
+
body: JSON.stringify(request),
|
|
144
|
+
});
|
|
145
|
+
if (!response.ok) {
|
|
146
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to initiate upload: HTTP ${response.status}`);
|
|
147
|
+
}
|
|
148
|
+
return (await response.json());
|
|
149
|
+
}
|
|
150
|
+
async uploadComplete(roundId, uploadId, request) {
|
|
151
|
+
const response = await this.request(`/api/v1/federation/rounds/${encodeURIComponent(roundId)}/updates/${encodeURIComponent(uploadId)}/complete`, {
|
|
152
|
+
method: "POST",
|
|
153
|
+
body: JSON.stringify(request),
|
|
154
|
+
});
|
|
155
|
+
if (!response.ok) {
|
|
156
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to complete upload: HTTP ${response.status}`);
|
|
157
|
+
}
|
|
158
|
+
return (await response.json());
|
|
159
|
+
}
|
|
100
160
|
/**
|
|
101
161
|
* Run local training using a user-provided step function.
|
|
102
162
|
*
|
|
@@ -117,16 +177,9 @@ export class FederatedClient {
|
|
|
117
177
|
}
|
|
118
178
|
const delta = WeightExtractor.computeDelta(initialWeights, weights);
|
|
119
179
|
const durationMs = performance.now() - start;
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
durationMs,
|
|
124
|
-
metadata: {
|
|
125
|
-
epochs: config.epochs,
|
|
126
|
-
deltaNorm: WeightExtractor.l2Norm(delta),
|
|
127
|
-
},
|
|
128
|
-
timestamp: Date.now(),
|
|
129
|
-
});
|
|
180
|
+
const modelId = config.modelId ?? "unknown";
|
|
181
|
+
this.telemetry?.reportTrainingStarted(modelId, "local");
|
|
182
|
+
this.telemetry?.reportTrainingCompleted(modelId, "local", durationMs);
|
|
130
183
|
return { finalWeights: weights, delta };
|
|
131
184
|
}
|
|
132
185
|
/** Submit a weight update to the aggregation server. */
|
|
@@ -150,7 +203,7 @@ export class FederatedClient {
|
|
|
150
203
|
}),
|
|
151
204
|
});
|
|
152
205
|
if (!response.ok) {
|
|
153
|
-
throw new OctomilError("
|
|
206
|
+
throw new OctomilError("NETWORK_UNAVAILABLE", `Failed to submit update: HTTP ${response.status}`);
|
|
154
207
|
}
|
|
155
208
|
}
|
|
156
209
|
// -----------------------------------------------------------------------
|
package/dist/federated.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"federated.js","sourceRoot":"","sources":["../src/federated.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"federated.js","sourceRoot":"","sources":["../src/federated.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAOH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG1C,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E,uEAAuE;AACvE,MAAM,OAAO,eAAe;IAC1B;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAiB,EAAE,KAAgB;QACrD,MAAM,KAAK,GAAc,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM,IAAI,YAAY,CACpB,eAAe,EACf,kCAAkC,GAAG,IAAI,CAC1C,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4DAA4D;IAC5D,MAAM,CAAC,UAAU,CAAC,OAAkB,EAAE,KAAgB;QACpD,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,CAAC,CAAC;gBAAE,SAAS;YACjB,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;gBAChC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;gBAClC,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;YACvB,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,mDAAmD;IACnD,MAAM,CAAC,MAAM,CAAC,OAAkB;QAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAE,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;CACF;AAED,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E,MAAM,OAAO,eAAe;IACT,SAAS,CAAS;IAClB,MAAM,CAAU;IAChB,QAAQ,CAAS;IACjB,SAAS,CAAqB;IAE/C,YAAY,OAKX;QACC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACrC,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,iBAAiB,CACzE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,wCAAwC,QAAQ,CAAC,MAAM,EAAE,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAmB,CAAC;IACnD,CAAC;IAED,6BAA6B;IAC7B,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,OAAe;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,WAAW,kBAAkB,CAAC,OAAO,CAAC,OAAO,EACpG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;SACnD,CACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CAChD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,6CAA6C,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAChF,EAAE,MAAM,EAAE,KAAK,EAAE,CAClB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,sCAAsC,QAAQ,CAAC,MAAM,EAAE,CACxD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,IAAI,CACR,OAAe,EACf,UAAmC,EAAE;QAErC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,6BAA6B,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAC/D;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,GAAG,OAAO;aACX,CAAC;SACH,CACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,yCAAyC,QAAQ,CAAC,MAAM,EAAE,CAC3D,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAc;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,4BAA4B,kBAAkB,CAAC,MAAM,CAAC,EAAE,EACxD,EAAE,MAAM,EAAE,KAAK,EAAE,CAClB,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,yCAAyC,QAAQ,CAAC,MAAM,EAAE,CAC3D,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,SAAS,CACb,OAAe,EACf,UAAmC,EAAE;QAErC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,6BAA6B,kBAAkB,CAAC,OAAO,CAAC,YAAY,EACpE;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,GAAG,OAAO;aACX,CAAC;SACH,CACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,6CAA6C,QAAQ,CAAC,MAAM,EAAE,CAC/D,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAe,EACf,OAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,6BAA6B,kBAAkB,CAAC,OAAO,CAAC,mBAAmB,EAC3E;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,mCAAmC,QAAQ,CAAC,MAAM,EAAE,CACrD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAe,EACf,QAAgB,EAChB,OAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,6BAA6B,kBAAkB,CAAC,OAAO,CAAC,YAAY,kBAAkB,CAAC,QAAQ,CAAC,WAAW,EAC3G;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CACF,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,mCAAmC,QAAQ,CAAC,MAAM,EAAE,CACrD,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CACT,cAAyB,EACzB,MAAsB;QAEtB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QAEhD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YACnD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE;gBACnD,KAAK;gBACL,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC,CAAC,CAAC;YACH,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,eAAe,CAAC,YAAY,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACpE,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;QAE5C,IAAI,CAAC,SAAS,EAAE,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,YAAY,CAChB,YAAoB,EACpB,OAAe,EACf,KAAgB,EAChB,OAAgC;QAEhC,+CAA+C;QAC/C,MAAM,UAAU,GAAwD,EAAE,CAAC;QAC3E,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,UAAU,CAAC,GAAG,CAAC,GAAG;gBAChB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;gBACrB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;aACpB,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,uBAAuB,kBAAkB,CAAC,YAAY,CAAC,WAAW,kBAAkB,CAAC,OAAO,CAAC,SAAS,EACtG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,KAAK,EAAE,UAAU;gBACjB,OAAO;aACR,CAAC;SACH,CACF,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,YAAY,CACpB,qBAAqB,EACrB,iCAAiC,QAAQ,CAAC,MAAM,EAAE,CACnD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,WAAW;IACX,0EAA0E;IAElE,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,IAAkB;QACpD,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;QACrD,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,EAAE;YACvC,GAAG,IAAI;YACP,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,GAAI,IAAI,EAAE,OAAkC,EAAE;SACtE,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,OAAkB;QACrC,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACjD,IAAI,GAAG;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @octomil/browser — Gradient cache for federated learning resilience
|
|
3
|
+
*
|
|
4
|
+
* Uses IndexedDB to persist gradient deltas across page reloads and
|
|
5
|
+
* network interruptions. Unsubmitted gradients can be retried when
|
|
6
|
+
* connectivity is restored.
|
|
7
|
+
*/
|
|
8
|
+
import type { GradientCacheEntry } from "./types.js";
|
|
9
|
+
export declare class GradientCache {
|
|
10
|
+
private dbPromise;
|
|
11
|
+
private openDb;
|
|
12
|
+
/** Store a gradient entry in IndexedDB. */
|
|
13
|
+
store(entry: GradientCacheEntry): Promise<void>;
|
|
14
|
+
/** Retrieve a gradient entry by round ID. */
|
|
15
|
+
get(roundId: string): Promise<GradientCacheEntry | null>;
|
|
16
|
+
/** List all pending (unsubmitted) gradient entries. */
|
|
17
|
+
listPending(): Promise<GradientCacheEntry[]>;
|
|
18
|
+
/** Mark an entry as submitted. */
|
|
19
|
+
markSubmitted(roundId: string): Promise<void>;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=gradient-cache.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"gradient-cache.d.ts","sourceRoot":"","sources":["../src/gradient-cache.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAMrD,qBAAa,aAAa;IACxB,OAAO,CAAC,SAAS,CAAqC;IAEtD,OAAO,CAAC,MAAM;IAqBd,2CAA2C;IACrC,KAAK,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrD,6CAA6C;IACvC,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAU9D,uDAAuD;IACjD,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAWlD,kCAAkC;IAC5B,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAOpD"}
|