# message

Python API: `depthai_nodes.message`

DepthAI v3 的原生解析器消息和自定义消息。

解析器创建器返回原生 DepthAI 消息。该软件包需要 DepthAI 3.9 或更高版本，它提供了主机解析器使用的 Beta 消息类型。使用
[depthai_nodes.message.creators](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/creators.md)
从数组构造消息，使用
[depthai_nodes.message.utils](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/utils.md)
进行复制和检测几何。

目录

内容

 * [原生解析器消息](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message.md)
 * [自定义消息](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message.md)

## 原生解析器消息

创建器函数记录了每个有效负载所需的形状、坐标约定和值范围：

 * `dai.ImgDetections` 包含检测，包括可选的关键点和实例掩码；`dai.SpatialImgDetections` 添加了空间坐标。
 * `dai.SegmentationMask` 包含分割掩码。
 * `dai.beta.Classifications` 包含类名和分数，包括序列分类结果。
 * `dai.beta.Clusters` 和 `dai.beta.Cluster` 表示分组的 2D 点。
 * `dai.beta.Keypoints` 包含关键点和可选的骨架边缘。
 * `dai.beta.Lines` 和 `dai.beta.Line` 表示线条检测。
 * `dai.beta.Map2D` 存储数字地图，例如深度估计。
 * `dai.beta.Predictions` 和 `dai.beta.Prediction` 存储回归结果。
 * `dai.TrackedFeatures` 表示特征点和匹配。
 * `dai.ImgFrame` 和 `dai.NNData` 携带图像和嵌入张量。

## 自定义消息

[Collection](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/collection.md)
存储一种运行时类型的项目。使用 `append()` 或 `extend()` 添加项目。第一个项目建立接受的类型；最初为空的集合在填充时推断其类型。分配 `items` 验证替换列表，但直接修改返回的列表会绕过该验证。`copy()` 通过
`copy_message` 复制每个项目，并保留消息时间戳和序列号。

[GatheredData](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/gathered_data.md)
扩展了
[Collection](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/collection.md)，带有一个引用消息。分配
`reference_data`
会将其时间戳和序列号复制到消息中。[depthai_nodes.node.GatherData](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/node/gather_data.md)
通过匹配参考时间戳周围的消息来生成这些消息。

[SnapData](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/snap_data.md)
存储快照名称、包含图像和相关文件的 `dai.FileGroup`、可选标签和字符串元数据。将这些消息传递给
[depthai_nodes.node.SnapsUploader](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/node/snaps_uploader.md)，通过
Hub Events API 上传它们。

> **示例**
> 将检测与它们引用的帧分组：

```text
import depthai as dai
from depthai_nodes.message import GatheredData

frame = dai.ImgFrame()
detections = dai.ImgDetections()
batch = GatheredData(reference_data=frame, items=[detections])
assert batch.reference_data is frame
```

> **注意**
> 创建器函数填充有效负载。从管道发出消息的调用者还必须设置适当的时间戳、序列号和图像变换。原生消息副本可能共享像素存储；在修改复制的缓冲区之前，请参阅 [depthai_nodes.message.utils.copy_message](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/utils.md)。

## 子页面

 * [creators](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/creators.md)
 * [utils](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/utils.md)
 * [collection](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/collection.md)
 * [gathered_data](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/gathered_data.md)
 * [snap_data](/software-v3/ai-inference/inference/depthai-nodes/depthai-nodes-api-reference/message/snap_data.md)
