火山引擎怎么用Pydantic定义模型返回结构_火山引擎Python结构化结果接收教程

小丽小哥_2832

小丽小哥_2832

2026-10-26

931人浏览

原创

Pydantic v1.x可自动校验火山引擎API响应字段类型、缺失项及嵌套结构,避免手动判断;需安装pydantic==1.10.12,逐层定义BaseModel子类(如PlayInfo→MediaItem→DescribeMediaListResponse),并为可选字段设默认值,最后用**resp_dict实例化解析并触发校验。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

火山引擎怎么用pydantic定义模型返回结构_火山引擎python结构化结果接收教程

在火山引擎API调用中,用Pydantic定义返回模型能自动校验字段类型、缺失项和嵌套结构,避免手动写if key in resp反复判断——尤其当接口返回几十个字段、含多层list/dict嵌套时,不定义模型极易因字段名拼错或类型不符导致运行时异常。

安装依赖并创建基础模型类

执行 pip install pydantic==1.10.12(注意:火山引擎多数SDK基于Python 3.7+,【必须用Pydantic v1.x,v2不兼容】)。

新建 models.py 文件,导入 BaseModel:

from pydantic import BaseModel

class BaseResponse(BaseModel): pass

定义单层响应结构(如获取实例列表)

方法一:直接继承 BaseModel 写字段

class InstanceItem(BaseModel):
  instance_id: str
  status: str
  cpu: int
  memory_mb: int

class ListInstancesResponse(BaseResponse):
  instances: list[InstanceItem]
  total_count: int

这一步不能漏掉 total_count 字段——火山引擎多数列表接口都带该字段,不声明会导致解析失败后静默丢弃整个响应。

处理带分页和嵌套对象的复杂响应

第一步:识别火山引擎文档中的实际JSON结构

比如/volc/vod/DescribeMediaList 接口返回中,media_list 是数组,每个元素含 play_info_list(也是数组),而 play_info_list 每项又有 definition、play_url、duration 等字段。

第二步:逐层建模,先定义最内层

火山引擎
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

下载

class PlayInfo(BaseModel):
  definition: str
  play_url: str
  duration: float

第三步:定义中间层 media 对象

class MediaItem(BaseModel):
  media_id: str
  title: str
  play_info_list: list[PlayInfo] = []

第四步:组合顶层响应

class DescribeMediaListResponse(BaseResponse):
  media_list: list[MediaItem]
  page_number: int
  page_size: int
  total_count: int

注意:play_info_list 声明为 list[PlayInfo] = [],否则当接口返回空数组或缺失该字段时会报 ValidationError。

用模型解析火山引擎SDK返回的原始字典

调用火山引擎 Python SDK 后,拿到的是 dict 类型响应体(不是 JSON 字符串)。

假设 resp_dict = volc_client.describe_media_list(...) 返回结果:

parsed = DescribeMediaListResponse(**resp_dict)

这一步会立即触发字段校验——如果 resp_dict 里 media_list 缺失,或某条 media 的 play_url 是 None,Pydantic 会抛出 ValidationError 并明确指出哪一层哪个字段出问题。

后续代码可安全使用 parsed.media_list[0].play_info_list[0].play_url,无需再 if 'play_url' in ... 判断。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1811

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4784

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1769

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

28477

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3427

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3427

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1223

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2663

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习