---
name: "saveAiVisualBoxInfo"
mode: "kit"
versionRequirements:
  - { name: "@tuya-miniapp/cloud-api", version: "1.0.5" }
---

## saveAiVisualBoxInfo

> [VERSION] @tuya-miniapp/cloud-api >= 1.0.5

### 描述

保存视觉魔方信息

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `params` | `SaveAiVisualBoxInfoParams` | 是 | - | 保存请求体，类型为 SaveAiVisualBoxInfoParams。顶层含家庭 gid、库存 stockId、可选魔方 visionBoxId。 |

### 引用对象

##### `interface` SaveAiVisualBoxInfoParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `gid` | `string` | 家庭 gid |
| `stockId` | `string` | 库存 id |
| `visionBoxId` | `string` | 视觉魔方 id（可选） |
| `visionBoxInfoContent` | `AiVisualBoxInfoContent` | 魔方业务配置：名称、状态、图生文、报告类型/语言、事件列表、场景等 |

##### `interface` AiVisualBoxInfoContent

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `visionBoxName` | `string` | 视觉魔方名称 |
| `visionBoxState` | `0 \| 1` | 视觉魔方状态 |
| `generateDescState` | `0 \| 1` | 图生文开关 |
| `reportTypeList` | `"ReportType.DAILY" \\| "ReportType.WEEKLY"[]` | 支持的报告类型列表 |
| `reportLangType` | `string` | 报告语言类型 |
| `visionBoxEventList` | `VisionBoxEvent[]` | 视觉魔方事件列表 |
| `sceneType` | `"SceneType.security" \\| "SceneType.album"` | 场景类型（安防 / 相册等） |

##### `enum` ReportType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `ReportType.DAILY` | `1` | 日报 |
| `ReportType.WEEKLY` | `2` | 周报 |

##### `enum` VisionEventType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `VisionEventType.PRESET` | `0` | 预置事件 |
| `VisionEventType.CUSTOM` | `1` | 自定义事件 |

##### `enum` SceneType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `SceneType.security` | `0` | 安防场景 |
| `SceneType.album` | `1` | 相册场景 |

##### `interface` VisionBoxEvent

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `eventCode` | `string` | 事件编码 |
| `eventValue` | `string` | 事件取值 |
| `eventType` | `"VisionEventType.PRESET" \\| "VisionEventType.CUSTOM"` | 事件类型（预置 / 自定义） |


### 示例代码

#### 请求示例

```typescript
import { saveAiVisualBoxInfo } from '@tuya-miniapp/cloud-api';

saveAiVisualBoxInfo({
  gid: '194137',
  stockId: 'stock-1',
  visionBoxId: 'vb-1',
  visionBoxInfoContent: {
    visionBoxName: '客厅魔方',
    visionBoxState: 1,
    generateDescState: 0,
    reportTypeList: [1],
    reportLangType: 'zh',
    visionBoxEventList: [],
    sceneType: 0,
  },
})
  .then((r) => console.log(r))
  .catch(console.error);
```

#### 返回示例

```json
1111
```