# telemetry

Python API: `hubai_sdk.utils.telemetry`

## Classes

| Name | Description |
| --- | --- |
| [`ApiKeySource`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
| [`CommandMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
| [`CommandName`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
| [`ConfigSource`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
| [`ConversionFlowStep`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`ConversionPhase`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
| [`FailureReason`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
| [`IdentifierType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) | |
| [`InvocationSurface`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`OperationName`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
|
[`OperationTelemetrySpec`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`QuantizationInputType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`TargetResource`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) | |
| [`TelemetryGroup`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) | |
| [`TelemetryResult`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
|
[`VisibilityFilterValue`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`VisibilityValue`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|

### class `ApiKeySource`

```python
class ApiKeySource(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `ARGUMENT` | `str` |  |
| `ENVIRONMENT` | `str` |  |
| `STORED_CREDENTIALS` | `str` |  |

### class `CommandMetadata`

```python
class CommandMetadata
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `command_group` | `TelemetryGroup` |  |
| `command_name` | `CommandName` |  |

### class `CommandName`

```python
class CommandName(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CONVERT` | `str` |  |
| `INSTANCE_CONFIG` | `str` |  |
| `INSTANCE_CREATE` | `str` |  |
| `INSTANCE_DELETE` | `str` |  |
| `INSTANCE_DOWNLOAD` | `str` |  |
| `INSTANCE_FILES` | `str` |  |
| `INSTANCE_INFO` | `str` |  |
| `INSTANCE_LIST` | `str` |  |
| `INSTANCE_UPLOAD` | `str` |  |
| `LOGIN` | `str` |  |
| `LOGOUT` | `str` |  |
| `MODEL_CREATE` | `str` |  |
| `MODEL_DELETE` | `str` |  |
| `MODEL_INFO` | `str` |  |
| `MODEL_LIST` | `str` |  |
| `MODEL_UPDATE` | `str` |  |
| `VARIANT_CREATE` | `str` |  |
| `VARIANT_DELETE` | `str` |  |
| `VARIANT_INFO` | `str` |  |
| `VARIANT_LIST` | `str` |  |

### class `ConfigSource`

```python
class ConfigSource(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `DIRECT_MODEL_INPUT` | `str` |  |
| `NN_ARCHIVE` | `str` |  |
| `YAML_CONFIG` | `str` |  |

### class `ConversionFlowStep`

```python
class ConversionFlowStep(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CONFIGURATION_RESOLVED` | `str` |  |
| `RESULT_RECORDED` | `str` |  |

### class `ConversionPhase`

```python
class ConversionPhase(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CONFIGURATION` | `str` |  |
| `DOWNLOAD` | `str` |  |
| `EXPORT` | `str` |  |
| `RESOURCE_SETUP` | `str` |  |
| `UPLOAD` | `str` |  |

### class `FailureReason`

```python
class FailureReason(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `API_ERROR` | `str` |  |
| `AUTH_ERROR` | `str` |  |
| `CONFIG_ERROR` | `str` |  |
| `CONFLICT` | `str` |  |
| `DOWNLOAD_ERROR` | `str` |  |
| `EXPORT_ERROR` | `str` |  |
| `NETWORK_ERROR` | `str` |  |
| `NOT_FOUND` | `str` |  |
| `SERVER_ERROR` | `str` |  |
| `TIMEOUT` | `str` |  |
| `UNKNOWN` | `str` |  |
| `UPLOAD_ERROR` | `str` |  |
| `USER_INTERRUPT` | `str` |  |
| `VALIDATION_ERROR` | `str` |  |

### class `IdentifierType`

```python
class IdentifierType(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `SLUG` | `str` |  |
| `UNKNOWN` | `str` |  |
| `UUID` | `str` |  |

### class `InvocationSurface`

```python
class InvocationSurface(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CLI` | `str` |  |
| `PYTHON_API` | `str` |  |

### class `OperationName`

```python
class OperationName(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CLIENT_INITIALIZE` | `str` |  |
| `CONVERT` | `str` |  |
| `INSTANCE_CONFIG_GET` | `str` |  |
| `INSTANCE_CREATE` | `str` |  |
| `INSTANCE_DELETE` | `str` |  |
| `INSTANCE_DOWNLOAD` | `str` |  |
| `INSTANCE_FILES_LIST` | `str` |  |
| `INSTANCE_GET` | `str` |  |
| `INSTANCE_UPLOAD` | `str` |  |
| `INSTANCES_LIST` | `str` |  |
| `MODEL_CREATE` | `str` |  |
| `MODEL_DELETE` | `str` |  |
| `MODEL_GET` | `str` |  |
| `MODEL_UPDATE` | `str` |  |
| `MODELS_LIST` | `str` |  |
| `VARIANT_CREATE` | `str` |  |
| `VARIANT_DELETE` | `str` |  |
| `VARIANT_GET` | `str` |  |
| `VARIANTS_LIST` | `str` |  |

### class `OperationTelemetrySpec`

```python
class OperationTelemetrySpec
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `identifier_param` | `str | None` |  |
| `operation_group` | `TelemetryGroup` |  |
| `operation_name` | `OperationName` |  |
| `success_builder` | `Callable[[dict[str, Any], Any], dict[str, Any]] | None` |  |
| `success_event` | `str | None` |  |
| `target_resource` | `TargetResource | None` |  |

### class `QuantizationInputType`

```python
class QuantizationInputType(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CUSTOM_ZIP` | `str` |  |
| `DATASET_ID` | `str` |  |
| `NONE` | `str` |  |
| `PREDEFINED_DOMAIN` | `str` |  |

### class `TargetResource`

```python
class TargetResource(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CONVERSION` | `str` |  |
| `INSTANCE` | `str` |  |
| `MODEL` | `str` |  |
| `VARIANT` | `str` |  |

### class `TelemetryGroup`

```python
class TelemetryGroup(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `AUTH` | `str` |  |
| `CLIENT` | `str` |  |
| `CONVERSION` | `str` |  |
| `INSTANCES` | `str` |  |
| `MODELS` | `str` |  |
| `VARIANTS` | `str` |  |

### class `TelemetryResult`

```python
class TelemetryResult(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `FAILED` | `str` |  |
| `INTERRUPTED` | `str` |  |
| `SUCCESS` | `str` |  |

### class `VisibilityFilterValue`

```python
class VisibilityFilterValue(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `ALL` | `str` |  |
| `PRIVATE` | `str` |  |
| `PUBLIC` | `str` |  |

### class `VisibilityValue`

```python
class VisibilityValue(str, Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `PRIVATE` | `str` |  |
| `PUBLIC` | `str` |  |
| `TEAM` | `str` |  |

## Functions

| Name | Description |
| --- | --- |
| [`bucket_file_size`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
| [`bucket_limit`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
|
[`bucket_max_quantization_images`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`bucket_nonzero_count`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`bucket_result_count`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`bucket_rvc2_shaves`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`bucket_yolo_class_count`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`bucket_zero_count`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_client_initialized_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_command_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_conversion_flow_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_conversion_result_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_conversion_summary`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_instance_created_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_instance_downloaded_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_instance_files_listed_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_instance_uploaded_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_instances_listed_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_model_created_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_model_identifier_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_model_updated_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_models_listed_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_variant_created_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`build_variants_listed_properties`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`capture_client_initialized`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`capture_conversion_configured`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`capture_conversion_result`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`capture_operation_result`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`command_metadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
|
[`command_result_from_exception`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`config_source_from_path`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`conversion_failure_reason`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`current_conversion_run_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`failure_reason_from_exception`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`file_extension`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) | |
|
[`get_component_telemetry`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`get_or_create_conversion_run_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`identifier_type`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|
|
[`instrument_hubai_cli`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`invocation_surface`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`pop_cli_failure_reason`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`quantization_input_type`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`record_cli_failure_reason`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
|
[`reset_conversion_run_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`sort_mode`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |  |
|
[`telemetry_operation`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`visibility_filter`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| |
| [`visibility_value`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
|

### function `bucket_file_size`

```python
def bucket_file_size(value: int) -> str
```

### function `bucket_limit`

```python
def bucket_limit(value: int) -> str
```

### function `bucket_max_quantization_images`

```python
def bucket_max_quantization_images(value: int) -> str
```

### function `bucket_nonzero_count`

```python
def bucket_nonzero_count(value: int) -> str
```

### function `bucket_result_count`

```python
def bucket_result_count(value: int) -> str
```

### function `bucket_rvc2_shaves`

```python
def bucket_rvc2_shaves(value: int) -> str
```

### function `bucket_yolo_class_count`

```python
def bucket_yolo_class_count(value: int) -> str
```

### function `bucket_zero_count`

```python
def bucket_zero_count(value: int) -> str
```

### function `build_client_initialized_properties`

```python
def build_client_initialized_properties(api_key_source: ApiKeySource) -> dict[str, Any]
```

### function `build_command_properties`

```python
def build_command_properties(
    *,
    command_name: CommandName,
    command_group: TelemetryGroup,
    result: TelemetryResult,
    duration_ms: int,
    failure_reason: FailureReason | None = None,
) -> dict[str, Any]
```

### function `build_conversion_flow_properties`

```python
def build_conversion_flow_properties(
    conversion_run_id: str,
    flow_step: ConversionFlowStep,
    properties: dict[str, Any],
) -> dict[str, Any]
```

### function `build_conversion_result_properties`

```python
def build_conversion_result_properties(
    *,
    result: TelemetryResult,
    duration_ms: int,
    failure_reason: FailureReason | None = None,
    downloaded_file_count: int | None = None,
) -> dict[str, Any]
```

### function `build_conversion_summary`

```python
def build_conversion_summary(
    *,
    target: str,
    config_source: ConfigSource,
    input_model_type: ModelType,
    invocation_surface: InvocationSurface,
    existing_model_reused: bool,
    existing_variant_reused: bool,
    quantization_mode: str | None,
    quantization_input_type: QuantizationInputType,
    max_quantization_images: int | None,
    yolo_version: str | None,
    yolo_class_names: list[str] | None,
    yolo_input_shape_provided: bool,
    tool_version_provided: bool,
    input_shape_provided: bool,
    download_output_dir_provided: bool,
    input_count: int,
    target_options: Mapping[str, Any],
) -> dict[str, Any]
```

### function `build_instance_created_properties`

```python
def build_instance_created_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_instance_downloaded_properties`

```python
def build_instance_downloaded_properties(
    arguments: dict[str, Any],
    result: Path,
) -> dict[str, Any]
```

### function `build_instance_files_listed_properties`

```python
def build_instance_files_listed_properties(
    arguments: dict[str, Any],
    result: list[Any],
) -> dict[str, Any]
```

### function `build_instance_uploaded_properties`

```python
def build_instance_uploaded_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_instances_listed_properties`

```python
def build_instances_listed_properties(
    arguments: dict[str, Any],
    result: list[Any],
) -> dict[str, Any]
```

### function `build_model_created_properties`

```python
def build_model_created_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_model_identifier_properties`

```python
def build_model_identifier_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_model_updated_properties`

```python
def build_model_updated_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_models_listed_properties`

```python
def build_models_listed_properties(
    arguments: dict[str, Any],
    result: list[Any],
) -> dict[str, Any]
```

### function `build_variant_created_properties`

```python
def build_variant_created_properties(
    arguments: dict[str, Any],
    _result: Any,
) -> dict[str, Any]
```

### function `build_variants_listed_properties`

```python
def build_variants_listed_properties(
    arguments: dict[str, Any],
    result: list[Any],
) -> dict[str, Any]
```

### function `capture_client_initialized`

```python
def capture_client_initialized(api_key_source: ApiKeySource)
```

### function `capture_conversion_configured`

```python
def capture_conversion_configured(conversion_run_id: str, properties: dict[str, Any])
```

### function `capture_conversion_result`

```python
def capture_conversion_result(conversion_run_id: str, properties: dict[str, Any])
```

### function `capture_operation_result`

```python
def capture_operation_result(
    *,
    spec: OperationTelemetrySpec,
    exc: BaseException | None,
    duration_ms: int,
    bound_arguments: dict[str, Any] | None = None,
)
```

### function `command_metadata`

```python
def command_metadata(command_path: str) -> CommandMetadata | None
```

### function `command_result_from_exception`

```python
def command_result_from_exception(exc: BaseException | None) -> TelemetryResult
```

### function `config_source_from_path`

```python
def config_source_from_path(
    path: str,
    *,
    is_archive: bool,
    is_yaml: bool,
) -> ConfigSource
```

### function `conversion_failure_reason`

```python
def conversion_failure_reason(
    exc: BaseException | None,
    *,
    phase: ConversionPhase,
) -> FailureReason | None
```

### function `current_conversion_run_id`

```python
def current_conversion_run_id() -> str | None
```

### function `failure_reason_from_exception`

```python
def failure_reason_from_exception(exc: BaseException | None) -> FailureReason | None
```

### function `file_extension`

```python
def file_extension(path: str | Path) -> str
```

### function `get_component_telemetry`

```python
def get_component_telemetry() -> Telemetry
```

### function `get_or_create_conversion_run_id`

```python
def get_or_create_conversion_run_id() -> str
```

### function `identifier_type`

```python
def identifier_type(identifier: UUID | str | None) -> IdentifierType | None
```

### function `instrument_hubai_cli`

```python
def instrument_hubai_cli(app: cyclopts.App)
```

### function `invocation_surface`

```python
def invocation_surface() -> InvocationSurface
```

### function `pop_cli_failure_reason`

```python
def pop_cli_failure_reason() -> FailureReason | None
```

### function `quantization_input_type`

```python
def quantization_input_type(
    quantization_data: str | None,
    *,
    custom_zip: bool = False,
) -> QuantizationInputType
```

### function `record_cli_failure_reason`

```python
def record_cli_failure_reason(exc: BaseException)
```

### function `reset_conversion_run_id`

```python
def reset_conversion_run_id(previous_value: str | None)
```

### function `sort_mode`

```python
def sort_mode(value: str, *, allowed: set[str]) -> str
```

### function `telemetry_operation`

```python
def telemetry_operation(
    spec: OperationTelemetrySpec,
) -> Callable[[Callable[..., Any]], Callable[..., Any]]
```

### function `visibility_filter`

```python
def visibility_filter(is_public: bool | None) -> VisibilityFilterValue
```

### function `visibility_value`

```python
def visibility_value(is_public: bool | None) -> VisibilityValue
```

## Module Attributes

| Name | Type | Description |
| --- | --- | --- |
|
[`CLIENT_INITIALIZED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
| [`COMMAND_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md) |
`str` | |
|
[`CONVERSION_CONFIGURED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`CONVERSION_FLOW_NAME`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`CONVERSION_RESULT_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`HUBAI_SDK_TELEMETRY_DEFAULTS`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| | |
|
[`INSTANCE_CONFIG_RETRIEVED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_CREATED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_DELETED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_DOWNLOAD_COMPLETED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_FILE_UPLOADED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_FILES_LISTED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCE_RETRIEVED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`INSTANCES_LISTED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`MODEL_CREATED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`MODEL_DELETED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`MODEL_RETRIEVED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`MODEL_UPDATED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`MODELS_LISTED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`OPERATION_RESULT_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`VARIANT_CREATED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`VARIANT_DELETED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`VARIANT_RETRIEVED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |
|
[`VARIANTS_LISTED_EVENT`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/telemetry.md)
| `str` | |

### constant `CLIENT_INITIALIZED_EVENT`

```python
CLIENT_INITIALIZED_EVENT: str = 'hubai_sdk_client_initialized'
```

### constant `COMMAND_EVENT`

```python
COMMAND_EVENT: str = 'hubai_sdk_command_ran'
```

### constant `CONVERSION_CONFIGURED_EVENT`

```python
CONVERSION_CONFIGURED_EVENT: str = 'hubai_sdk_conversion_configured'
```

### constant `CONVERSION_FLOW_NAME`

```python
CONVERSION_FLOW_NAME: str = 'hubai_sdk_conversion_lifecycle'
```

### constant `CONVERSION_RESULT_EVENT`

```python
CONVERSION_RESULT_EVENT: str = 'hubai_sdk_conversion_result_recorded'
```

### constant `HUBAI_SDK_TELEMETRY_DEFAULTS`

```python
HUBAI_SDK_TELEMETRY_DEFAULTS = TelemetryDefaults(
    enabled=True,
    backend='posthog',
    api_key='phc_ojEByaCiZZ5eigzaM43PaEVbfLfFDF5NgkXEMPabrT9a',
    endpoint='https://us.i.posthog.com',
)
```

### constant `INSTANCE_CONFIG_RETRIEVED_EVENT`

```python
INSTANCE_CONFIG_RETRIEVED_EVENT: str = 'hubai_sdk_instance_config_retrieved'
```

### constant `INSTANCE_CREATED_EVENT`

```python
INSTANCE_CREATED_EVENT: str = 'hubai_sdk_instance_created'
```

### constant `INSTANCE_DELETED_EVENT`

```python
INSTANCE_DELETED_EVENT: str = 'hubai_sdk_instance_deleted'
```

### constant `INSTANCE_DOWNLOAD_COMPLETED_EVENT`

```python
INSTANCE_DOWNLOAD_COMPLETED_EVENT: str = 'hubai_sdk_instance_download_completed'
```

### constant `INSTANCE_FILE_UPLOADED_EVENT`

```python
INSTANCE_FILE_UPLOADED_EVENT: str = 'hubai_sdk_instance_file_uploaded'
```

### constant `INSTANCE_FILES_LISTED_EVENT`

```python
INSTANCE_FILES_LISTED_EVENT: str = 'hubai_sdk_instance_files_listed'
```

### constant `INSTANCE_RETRIEVED_EVENT`

```python
INSTANCE_RETRIEVED_EVENT: str = 'hubai_sdk_instance_retrieved'
```

### constant `INSTANCES_LISTED_EVENT`

```python
INSTANCES_LISTED_EVENT: str = 'hubai_sdk_instances_listed'
```

### constant `MODEL_CREATED_EVENT`

```python
MODEL_CREATED_EVENT: str = 'hubai_sdk_model_created'
```

### constant `MODEL_DELETED_EVENT`

```python
MODEL_DELETED_EVENT: str = 'hubai_sdk_model_deleted'
```

### constant `MODEL_RETRIEVED_EVENT`

```python
MODEL_RETRIEVED_EVENT: str = 'hubai_sdk_model_retrieved'
```

### constant `MODEL_UPDATED_EVENT`

```python
MODEL_UPDATED_EVENT: str = 'hubai_sdk_model_updated'
```

### constant `MODELS_LISTED_EVENT`

```python
MODELS_LISTED_EVENT: str = 'hubai_sdk_models_listed'
```

### constant `OPERATION_RESULT_EVENT`

```python
OPERATION_RESULT_EVENT: str = 'hubai_sdk_operation_result_recorded'
```

### constant `VARIANT_CREATED_EVENT`

```python
VARIANT_CREATED_EVENT: str = 'hubai_sdk_variant_created'
```

### constant `VARIANT_DELETED_EVENT`

```python
VARIANT_DELETED_EVENT: str = 'hubai_sdk_variant_deleted'
```

### constant `VARIANT_RETRIEVED_EVENT`

```python
VARIANT_RETRIEVED_EVENT: str = 'hubai_sdk_variant_retrieved'
```

### constant `VARIANTS_LISTED_EVENT`

```python
VARIANTS_LISTED_EVENT: str = 'hubai_sdk_variants_listed'
```
