此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 类
  • Telemetry
  • 属性
  • ContextProvider
  • SystemContextProvider
Claude CodeCodexCursor
Luxonis 智能体工具包为你常用的编程智能体加载 Luxonis 上下文与技能,更快地基于 OAK 开发应用。
安装工具包
最后更新
Python API: luxonis_ml.telemetry.client

类

Telemetry

用于通过可插拔后端发出事件的遥测客户端。

方法

init
Python
1def __init__(library_name: str, *, source_component: str | None = None, library_version: str | None = None, config: TelemetryConfig | None = None, context_providers: list[ContextProvider] | None = None, system_context_providers: list[SystemContextProvider] | None = None):
初始化遥测客户端。参数
  • library_name (str): 发出遥测的库的名称,例如 "luxonis_ml"。
  • source_component (str | None): 事件上下文的可选发射器/组件名称。如果省略,则重用库名称。
  • library_version (str | None): 库的版本字符串。如果省略,则在可能的情况下从包元数据中解析。
  • config (TelemetryConfig | None): 要使用的遥测配置。如果省略,则从环境变量中读取值。
  • context_providers (list[ContextProvider] | None): 返回要附加到每个事件的额外上下文的可调用对象。
  • system_context_providers (list[SystemContextProvider] | None): 仅在请求系统元数据时返回额外上下文的可调用对象。
add_context_provider
Python
1def add_context_provider(provider: ContextProvider):
为所有事件注册上下文提供程序。
add_system_context_provider
Python
1def add_system_context_provider(provider: SystemContextProvider):
注册仅与系统元数据一起使用的上下文提供程序。
capture
Python
1def capture(event: str, properties: dict[str, Any] | None = None, *, allowlist: set[str] | None = None, include_system_metadata: bool | None = None, distinct_id: str | None = None):
捕获遥测事件。参数
  • event (str): 事件名称,例如 "train_started"。
  • properties (dict[str, Any] | None): 可选事件属性。值在发送前经过清理和编辑。
  • allowlist (set[str] | None): 如果设置,则仅包含这些属性键。
  • include_system_metadata (bool | None): 是否为此事件添加扩展系统元数据。如果省略,则使用配置默认值。
  • distinct_id (str | None): 可选的后端身份覆盖。如果省略,则默认为客户端的临时会话标识符。
extend_context_providers
Python
1def extend_context_providers(providers: list[ContextProvider] | None):
注册多个上下文提供程序。
extend_system_context_providers
Python
1def extend_system_context_providers(providers: list[SystemContextProvider] | None):
注册多个系统上下文提供程序。
flush
Python
1def flush(self):
刷新任何缓冲的遥测事件。
register_backend
Python
1def register_backend(name: str, backend_cls: type[TelemetryBackend]):
注册自定义后端类。参数
  • name (str): TelemetryConfig.backend 中使用的后端名称。名称以小写形式存储,因此查找会忽略大小写。
  • backend_cls (type[TelemetryBackend]): 使用 TelemetryConfig 实例化的后端类。
shutdown
Python
1def shutdown(self):
关闭后端并刷新待处理的遥测。

属性

config
is_enabled
library_name
library_version
source_component

属性

ContextProvider

SystemContextProvider