# API 返回字段备注补充

这份文档用于补充 OpenAPI 返回示例里需要展示的“备注 | 类型”文案。

## 1. 用户返回结构 `UserInfo`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `users_convers_id` | `会话侧用户ID | string` |
| `users_id` | `用户业务ID | string` |
| `users_idtype` | `用户身份来源类型 | string` |
| `users_id_number` | `证件号 | string` |
| `users_type` | `用户类型 | string` |
| `users_name` | `用户姓名 | string` |
| `users_status` | `用户状态 | string` |
| `users_rank_level` | `等级 | number` |
| `users_auth_type` | `账户类型 | number` |
| `users_phone` | `手机号 | string` |
| `users_phone_masked` | `脱敏手机号 | string` |
| `users_level` | `用户等级 | string` |
| `users_level_name` | `用户等级名称 | string` |
| `users_tag` | `用户标签 | string` |
| `users_picture` | `用户头像附件ID | string` |
| `users_picture_url` | `用户头像文件流链接 | string` |
| `users_id_pic_a` | `证件正面附件ID | string` |
| `users_id_pic_a_url` | `证件正面文件流链接 | string` |
| `users_id_pic_b` | `证件反面附件ID | string` |
| `users_id_pic_b_url` | `证件反面文件流链接 | string` |
| `users_title_picture` | `资质附件ID | string` |
| `users_title_picture_url` | `资质文件流链接 | string` |
| `openid` | `全平台统一身份标识 | string` |
| `company_id` | `公司业务id | string` |
| `users_parent_id` | `上级用户业务id | string` |
| `users_promo_code` | `推广码 | string` |
| `usergroups_id` | `用户组业务id | string` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |

## 2. 公司返回结构 `CompanyInfo`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `company_id` | `公司业务id | string` |
| `company_name` | `公司名称 | string` |
| `company_type` | `公司类型 | string` |
| `company_entity` | `公司法人 | string` |
| `company_usci` | `统一社会信用代码 | string` |
| `company_nationality` | `国家名称 | string` |
| `company_nationality_code` | `国家编码 | string` |
| `company_province` | `省份名称 | string` |
| `company_province_code` | `省份编码 | string` |
| `company_city` | `城市名称 | string` |
| `company_city_code` | `城市编码 | string` |
| `company_district` | `区县名称 | string` |
| `company_district_code` | `区县编码 | string` |
| `company_postalcode` | `邮政编码 | string` |
| `company_add` | `公司地址 | string` |
| `company_status` | `公司状态 | string` |
| `company_level` | `公司等级 | string` |
| `company_owner_openid` | `公司所有者openid | string` |
| `company_remark` | `备注 | string` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |

## 3. 待你补充确认的字段

下面这些字段目前在已有 docs 中备注还不够稳定，如果你希望我继续把“所有接口返回示例”都改成这种风格，建议你先补充这几类字段的标准叫法：

- 系统类返回里各状态字段的最终业务叫法

你补完以后，我可以继续把剩余接口的返回示例全部统一成 `备注 | 类型` 风格。

## 3. 字典返回结构 `DictionaryRecord` / `DictionaryItem`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `system_dict_id` | `字典业务id | string` |
| `dict_name` | `词典名称 | string` |
| `dict_word_is_enabled` | `是否有效 | boolean` |
| `dict_word_parent_id` | `父级字典业务id | string` |
| `dict_word_remark` | `备注 | string` |
| `enum` | `枚举值 | string` |
| `description` | `枚举描述 | string` |
| `image` | `图片附件ID | string` |
| `imageUrl` | `图片文件流链接 | string` |
| `sortOrder` | `显示顺序 | integer` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |

## 4. 附件返回结构 `AttachmentRecord`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `attachments_id` | `附件业务id | string` |
| `attachments_link` | `PocketBase存储文件名 | string` |
| `attachments_url` | `附件文件流访问链接 | string` |
| `attachments_download_url` | `附件下载链接 | string` |
| `attachments_filename` | `原始文件名 | string` |
| `attachments_filetype` | `文件类型或MIME | string` |
| `attachments_size` | `附件大小 | number` |
| `attachments_owner` | `上传者业务id | string` |
| `attachments_md5` | `附件MD5码 | string` |
| `attachments_ocr` | `OCR识别结果 | string` |
| `attachments_status` | `附件状态 | string` |
| `attachments_remark` | `备注 | string` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |

## 5. 文档返回结构 `DocumentRecord`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `document_id` | `文档业务id | string` |
| `document_create` | `文档创建时间 | string` |
| `document_effect_date` | `文档生效日期 | string` |
| `document_expiry_date` | `文档到期日期 | string` |
| `document_type` | `文档类型 | string` |
| `document_title` | `文档标题 | string` |
| `document_subtitle` | `文档副标题 | string` |
| `document_summary` | `文档摘要 | string` |
| `document_content` | `正文内容 | string` |
| `document_image` | `图片附件ID串 | string` |
| `document_image_ids` | `图片附件ID列表 | array` |
| `document_image_urls` | `图片文件流链接列表 | array` |
| `document_image_url` | `第一张图片文件流链接 | string` |
| `document_video` | `视频附件ID串 | string` |
| `document_video_ids` | `视频附件ID列表 | array` |
| `document_video_urls` | `视频文件流链接列表 | array` |
| `document_video_url` | `第一个视频文件流链接 | string` |
| `document_file` | `文件附件ID串 | string` |
| `document_file_ids` | `文件附件ID列表 | array` |
| `document_file_urls` | `文件文件流链接列表 | array` |
| `document_file_url` | `第一个文件文件流链接 | string` |
| `document_owner` | `上传者openid | string` |
| `document_relation_model` | `关联机型标识 | string` |
| `document_keywords` | `关键词 | string` |
| `document_share_count` | `分享次数 | number` |
| `document_download_count` | `下载次数 | number` |
| `document_favorite_count` | `收藏次数 | number` |
| `document_status` | `文档状态 | string` |
| `document_embedding_status` | `文档嵌入状态 | string` |
| `document_embedding_error` | `文档错误原因 | string` |
| `document_embedding_lasttime` | `最后更新日期 | string` |
| `document_vector_version` | `向量版本号或模型名称 | string` |
| `document_product_categories` | `产品关联文档 | string` |
| `document_application_scenarios` | `筛选依据 | string` |
| `document_hotel_type` | `适用场景 | string` |
| `document_remark` | `备注 | string` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |

## 6. 文档历史返回结构 `DocumentHistoryRecord`

| 字段名 | 建议示例文案 |
| :--- | :--- |
| `pb_id` | `PocketBase记录主键 | string` |
| `doh_id` | `文档操作历史业务id | string` |
| `doh_document_id` | `关联文档业务id | string` |
| `doh_operation_type` | `操作类型 | string` |
| `doh_user_id` | `操作人业务id | string` |
| `doh_current_count` | `本次操作对应次数 | number` |
| `doh_remark` | `备注 | string` |
| `created` | `创建时间 | string` |
| `updated` | `更新时间 | string` |
