POST https://ark.cn-beijing.volcengineapi.com/?Action=GetFoundationModel&Version=2024-01-01
获取基础模型详细信息。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- Access Key 鉴权，请在 Access Key 管理 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
Name string 必选 | 基础模型名称
待查询的基础模型名称，作为唯一标识。
响应参数#
AccessType string | 可见性
基础模型的可见性。可指定值：
Public：公开模型，所有租户可访问。Private：非公开模型，仅授权租户可访问。
CreateTime string | 创建时间
基础模型创建时间，RFC3339 格式。
Description string | 内部描述
基础模型的内部描述，面向运营和管理场景。
DisplayDescription string | 展示描述
控制台展示用的简介描述。
DisplayName string | 展示名称
控制台展示用的基础模型名称。
FeaturedImage object | 展示图片
基础模型在控制台上的展示图片，存储于 TOS。
BucketName string | 存储桶名称
FeaturedImage.BucketName
TOS 存储桶名称。当前火山方舟仅支持华北 2-北京地域（cn-beijing）的存储桶。
ObjectKey string | 对象路径
FeaturedImage.ObjectKey
TOS 对象的存储路径。
FoundationModelTag object | 能力标签
基础模型的能力分类标签，包含语言、任务类型、领域等维度。
Domains string[] | 能力领域
FoundationModelTag.Domains
基础模型覆盖的能力领域列表。可指定值：
LLM：大语言模型Audio：语音大模型ComputerVision：视觉大模型MultiModal：多模态Embedding：向量模型VLM：视觉语言模型
Languages string[] | 支持语言
FoundationModelTag.Languages
基础模型支持的自然语言列表。
TaskTypes string[] | 支持任务类型
FoundationModelTag.TaskTypes
基础模型支持的任务类型列表。可指定值：
TextGeneration：文本生成VisualQuestionAnswering：图片内容理解TextToImage：文生图ImageToImage：图生图TextToVideo：文生视频ImageToVideo：图生视频TextTo3D：文生 3DImageTo3D：图生 3DVoiceClone：声音复刻TextToSpeech：文本转语音SpeechToText：语音转文本SpeechToSpeech：同声传译TextEmbedding：文本向量化ImageEmbedding：图像向量化MultimodalEmbedding：多模态向量化
UsedLibraries string[] | 依赖库
FoundationModelTag.UsedLibraries
基础模型依赖的库列表。
Introduction string | 用户介绍
面向用户展示的基础模型介绍文本。
Name string | 模型名称
基础模型唯一名称，全局唯一标识一个基础模型。
PrimaryVersion string | 主版本号
基础模型当前主推的版本号。
ProjectName string | 所属项目
基础模型所属的项目名称。
RegionWhiteList string[] | 可用地域
基础模型可用的地域白名单列表。
ResourceOrigin string | 资源来源
基础模型资源的来源标识。
ShortName string | 简短名称
基础模型的简短名称，用于紧凑展示。
Tags object[] | 自定义标签
用户自定义绑定到基础模型的键值标签列表。
Key string | 键名
Tags.Key
标签的键名。
Value string | 取值
Tags.Value
标签的取值。
UpdateTime string | 更新时间
基础模型最近更新时间，RFC3339 格式。
VendorName string | 提供方
基础模型的提供方名称。