GetFoundationModel - 获取基础模型信息--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

GetFoundationModel - 获取基础模型信息

最近更新时间：2024.10.21 10:58:39首次发布时间：2024.05.15 01:48:34

获取基础模型详细信息

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetFoundationModel	要执行的操作，取值：GetFoundationModel。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Name	String	是	test-foundation-model	基础模型名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Name	String	test-foundation-model	基础模型名称
Description	String	一条样例描述	基础模型描述
Introduction	String	一条模型介绍	基础模型介绍
VendorName	String	vendor_name	基础模型提供方名称
DisplayName	String	test-model	基础模型展示名
FeaturedImage	Object	-	基础模型显示图片
PrimaryVersion	String	1.0	基础模型主版本
AccessType	String	Public	基础模型访问模式。可指定值: Public 公开模型 Private 非公开模型
FoundationModelTag	Object	-	基础模型特定标签
Tags	Array of Object	-	基础模型绑定的标签
ProjectName	String	default	项目名称
CreateTime	String	2006-01-02T15:04:05Z07:00	基础模型创建时间，RFC3339格式
UpdateTime	String	2006-01-02T15:04:05Z07:00	基础模型更新时间，RFC3339格式

请求示例

POST /?Action=GetFoundationModel&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240514T125935Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Name": "test-foundation-model"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514205945172013199191467134",
    "Action": "GetFoundationModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Name": "test-foundation-model",
    "Description": "一条样例描述",
    "Introduction": "一条模型介绍",
    "VendorName": "vendor_name",
    "DisplayName": "test-model",
    "FeaturedImage": {
      "ObjectKey": "S6",
      "BucketName": "HMd3AI0Qtk"
    },
    "PrimaryVersion": "1.0",
    "AccessType": "Public",
    "FoundationModelTag": {
      "Languages": [
        "MyWisEPDOwb"
      ],
      "TaskTypes": [
        "jrP2OnqQxvA"
      ],
      "CustomizedTags": [
        "XX"
      ],
      "Domains": [
        "qdZtggWYIF"
      ],
      "UsedLibraries": [
        "wmD0DcjIbWe"
      ]
    },
    "Tags": [
      {
        "Key": "fok3iEEzKOZ",
        "Value": "ewCYfJcTR3"
      }
    ],
    "ProjectName": "default",
    "CreateTime": "2006-01-02T15:04:05Z07:00",
    "UpdateTime": "2006-01-02T15:04:05Z07:00"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。