# 获取基础模型版本信息

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`POST https://ark.cn-beijing.volcengineapi.com/?Action=GetFoundationModelVersion&Version=2024-01-01`

获取基础模型版本信息

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### Body 参数

**FoundationModelName** `string` `必选` | 基础模型名称

待查询版本所属的基础模型名称。

**ModelVersion** `string` `必选` | 版本号

待查询的基础模型版本号。

## 响应参数

**ActiveConfigurationId** `string` | 生效配置 ID

当前生效的版本配置 ID。

**Configuration** `object` | 生效配置

当前生效配置的详细信息。

**AppSettings** `object` | 应用配置

`Configuration.AppSettings`

模型体验应用相关配置。

**Greeting** `string` | 问候语

`Configuration.AppSettings.Greeting`

应用首次交互的问候语文本。

**MaxInputTokenLength** `integer` | 最大输入长度

`Configuration.AppSettings.MaxInputTokenLength`

用户输入允许的最大 token 长度。

**Parameters** `object[]` | 参数配置

`Configuration.AppSettings.Parameters`

体验时可配置的模型参数列表。

**Name** `string` | 参数名称

`Configuration.AppSettings.Parameters.Name`

参数唯一名称。

**Type** `string` | 参数类型

`Configuration.AppSettings.Parameters.Type`

参数数据类型。可指定值：`Int`、`Bool`、`Float`、`String`。

**DefaultValue** `string` | 默认值

`Configuration.AppSettings.Parameters.DefaultValue`

参数的默认取值。

**Description** `string` | 说明

`Configuration.AppSettings.Parameters.Description`

参数的说明文本。

**DisplayName** `string` | 展示名

`Configuration.AppSettings.Parameters.DisplayName`

控制台展示用的参数名。

**Max** `string` | 最大值

`Configuration.AppSettings.Parameters.Max`

参数允许的最大值。

**Min** `string` | 最小值

`Configuration.AppSettings.Parameters.Min`

参数允许的最小值。

**Options** `string[]` | 可选值

`Configuration.AppSettings.Parameters.Options`

参数的枚举可选值列表。

**Prompts** `object[]` | 预置提示词

`Configuration.AppSettings.Prompts`

体验应用的预置提示词列表。

**Message** `string` | 提示词内容

`Configuration.AppSettings.Prompts.Message`

预置提示词文本内容。

**Scenario** `string` | 适用场景

`Configuration.AppSettings.Prompts.Scenario`

预置提示词适用的场景标识。

**SystemPrompt** `object` | 系统提示词

`Configuration.AppSettings.SystemPrompt`

系统提示词相关配置。

**Message** `string` | 提示词内容

`Configuration.AppSettings.SystemPrompt.Message`

系统提示词文本内容。

**MaxInputTokenLength** `number` | 最大 token 长度

`Configuration.AppSettings.SystemPrompt.MaxInputTokenLength`

系统提示词允许的最大 token 长度。

**ModificationAllowed** `boolean` | 允许修改

`Configuration.AppSettings.SystemPrompt.ModificationAllowed`

体验时是否允许用户修改系统提示词。

**CustomizationJobSettings** `object` | 精调配置

`Configuration.CustomizationJobSettings`

模型精调任务相关配置。

**ContinuePretrainSettings** `object` | 增量预训练

`Configuration.CustomizationJobSettings.ContinuePretrainSettings`

增量预训练任务配置。

**Enabled** `boolean` | 是否开启

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Enabled`

当前训练类型是否开启。

**Parameters** `object[]` | 训练参数

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters`

训练任务可配置的参数列表。

**Name** `string` | 参数名称

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Name`

参数唯一名称。

**Type** `string` | 参数类型

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Type`

参数数据类型。可指定值：`Bool`、`Int`、`Float`、`String`。

**DefaultValue** `string` | 默认值

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.DefaultValue`

参数的默认取值。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Description`

参数的说明文本。

**DisplayName** `string` | 展示名

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.DisplayName`

控制台展示用的参数名。

**IncrementalLearningLocked** `boolean` | 增量训练锁定

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.IncrementalLearningLocked`

增量训练时是否锁定参数值不可修改。

**Max** `string` | 最大值

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Max`

参数允许的最大值。

**Min** `string` | 最小值

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Min`

参数允许的最小值。

**Options** `string[]` | 可选值

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.Parameters.Options`

参数的枚举可选值列表。

**SupportPresetDatasets** `object[]` | 预置数据集

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.SupportPresetDatasets`

支持混入的预置数据集列表。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.SupportPresetDatasets.Description`

预置数据集说明。

**Labelled** `boolean` | 是否有标注

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.SupportPresetDatasets.Labelled`

预置数据集是否包含标注。

**Name** `string` | 数据集名称

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.SupportPresetDatasets.Name`

预置数据集名称。

**SampleCount** `integer` | 样本数量

`Configuration.CustomizationJobSettings.ContinuePretrainSettings.SupportPresetDatasets.SampleCount`

预置数据集的样本数量。

**LoraDPOSettings** `object` | DPO LoRA

`Configuration.CustomizationJobSettings.LoraDPOSettings`

DPO LoRA 训练任务配置。

**Enabled** `boolean` | 是否开启

`Configuration.CustomizationJobSettings.LoraDPOSettings.Enabled`

当前训练类型是否开启。

**Parameters** `object[]` | 训练参数

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters`

训练任务可配置的参数列表。

**Name** `string` | 参数名称

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Name`

参数唯一名称。

**Type** `string` | 参数类型

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Type`

参数数据类型。可指定值：`Bool`、`Int`、`Float`、`String`。

**DefaultValue** `string` | 默认值

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.DefaultValue`

参数的默认取值。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Description`

参数的说明文本。

**DisplayName** `string` | 展示名

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.DisplayName`

控制台展示用的参数名。

**IncrementalLearningLocked** `boolean` | 增量训练锁定

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.IncrementalLearningLocked`

增量训练时是否锁定参数值不可修改。

**Max** `string` | 最大值

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Max`

参数允许的最大值。

**Min** `string` | 最小值

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Min`

参数允许的最小值。

**Options** `string[]` | 可选值

`Configuration.CustomizationJobSettings.LoraDPOSettings.Parameters.Options`

参数的枚举可选值列表。

**SupportPresetDatasets** `object[]` | 预置数据集

`Configuration.CustomizationJobSettings.LoraDPOSettings.SupportPresetDatasets`

支持混入的预置数据集列表。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.LoraDPOSettings.SupportPresetDatasets.Description`

预置数据集说明。

**Labelled** `boolean` | 是否有标注

`Configuration.CustomizationJobSettings.LoraDPOSettings.SupportPresetDatasets.Labelled`

预置数据集是否包含标注。

**Name** `string` | 数据集名称

`Configuration.CustomizationJobSettings.LoraDPOSettings.SupportPresetDatasets.Name`

预置数据集名称。

**SampleCount** `integer` | 样本数量

`Configuration.CustomizationJobSettings.LoraDPOSettings.SupportPresetDatasets.SampleCount`

预置数据集的样本数量。

**LoraSettings** `object` | LoRA 配置

`Configuration.CustomizationJobSettings.LoraSettings`

LoRA 训练任务配置。

**Enabled** `boolean` | 是否开启

`Configuration.CustomizationJobSettings.LoraSettings.Enabled`

当前训练类型是否开启。

**Parameters** `object[]` | 训练参数

`Configuration.CustomizationJobSettings.LoraSettings.Parameters`

训练任务可配置的参数列表。

**Name** `string` | 参数名称

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Name`

参数唯一名称。

**Type** `string` | 参数类型

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Type`

参数数据类型。可指定值：`Bool`、`Int`、`Float`、`String`。

**DefaultValue** `string` | 默认值

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.DefaultValue`

参数的默认取值。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Description`

参数的说明文本。

**DisplayName** `string` | 展示名

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.DisplayName`

控制台展示用的参数名。

**IncrementalLearningLocked** `boolean` | 增量训练锁定

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.IncrementalLearningLocked`

增量训练时是否锁定参数值不可修改。

**Max** `string` | 最大值

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Max`

参数允许的最大值。

**Min** `string` | 最小值

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Min`

参数允许的最小值。

**Options** `string[]` | 可选值

`Configuration.CustomizationJobSettings.LoraSettings.Parameters.Options`

参数的枚举可选值列表。

**SupportPresetDatasets** `object[]` | 预置数据集

`Configuration.CustomizationJobSettings.LoraSettings.SupportPresetDatasets`

支持混入的预置数据集列表。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.LoraSettings.SupportPresetDatasets.Description`

预置数据集说明。

**Labelled** `boolean` | 是否有标注

`Configuration.CustomizationJobSettings.LoraSettings.SupportPresetDatasets.Labelled`

预置数据集是否包含标注。

**Name** `string` | 数据集名称

`Configuration.CustomizationJobSettings.LoraSettings.SupportPresetDatasets.Name`

预置数据集名称。

**SampleCount** `integer` | 样本数量

`Configuration.CustomizationJobSettings.LoraSettings.SupportPresetDatasets.SampleCount`

预置数据集的样本数量。

**SftSettings** `object` | SFT 配置

`Configuration.CustomizationJobSettings.SftSettings`

SFT 训练任务配置。

**Enabled** `boolean` | 是否开启

`Configuration.CustomizationJobSettings.SftSettings.Enabled`

当前训练类型是否开启。

**Parameters** `object[]` | 训练参数

`Configuration.CustomizationJobSettings.SftSettings.Parameters`

训练任务可配置的参数列表。

**Name** `string` | 参数名称

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Name`

参数唯一名称。

**Type** `string` | 参数类型

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Type`

参数数据类型。可指定值：`Bool`、`Int`、`Float`、`String`。

**DefaultValue** `string` | 默认值

`Configuration.CustomizationJobSettings.SftSettings.Parameters.DefaultValue`

参数的默认取值。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Description`

参数的说明文本。

**DisplayName** `string` | 展示名

`Configuration.CustomizationJobSettings.SftSettings.Parameters.DisplayName`

控制台展示用的参数名。

**IncrementalLearningLocked** `boolean` | 增量训练锁定

`Configuration.CustomizationJobSettings.SftSettings.Parameters.IncrementalLearningLocked`

增量训练时是否锁定参数值不可修改。

**Max** `string` | 最大值

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Max`

参数允许的最大值。

**Min** `string` | 最小值

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Min`

参数允许的最小值。

**Options** `string[]` | 可选值

`Configuration.CustomizationJobSettings.SftSettings.Parameters.Options`

参数的枚举可选值列表。

**SupportPresetDatasets** `object[]` | 预置数据集

`Configuration.CustomizationJobSettings.SftSettings.SupportPresetDatasets`

支持混入的预置数据集列表。

**Description** `string` | 说明

`Configuration.CustomizationJobSettings.SftSettings.SupportPresetDatasets.Description`

预置数据集说明。

**Labelled** `boolean` | 是否有标注

`Configuration.CustomizationJobSettings.SftSettings.SupportPresetDatasets.Labelled`

预置数据集是否包含标注。

**Name** `string` | 数据集名称

`Configuration.CustomizationJobSettings.SftSettings.SupportPresetDatasets.Name`

预置数据集名称。

**SampleCount** `integer` | 样本数量

`Configuration.CustomizationJobSettings.SftSettings.SupportPresetDatasets.SampleCount`

预置数据集的样本数量。

**CreateTime** `string` | 创建时间

版本创建时间，RFC3339 格式。

**Description** `string` | 版本描述

该版本的描述信息。

**FoundationModelName** `string` | 基础模型名称

版本所属的基础模型名称。

**ModelVersion** `string` | 版本号

基础模型版本号。

**PublishTime** `string` | 发布时间

版本发布时间，RFC3339 格式。

**Status** `string` | 版本状态

版本生命周期状态。可指定值：

- `Unpublished`：未发布
- `Published`：已发布
- `Retiring`：下线中

**UpdateTime** `string` | 更新时间

版本最近更新时间，RFC3339 格式。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetFoundationModelVersion&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "FoundationModelName": "doubao-seed-2-0-pro"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20240514210046057210000044CEC5FF",
    "Action": "GetFoundationModelVersion",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "FoundationModelName": "doubao-seed-2-0-pro",
    "ModelVersion": "260215",
    "Description": "这是一条基础模型版本描述",
    "ActiveConfigurationId": "fmvc-20240914123456-abcde",
    "Configuration": {
      "AppSettings": {
        "Greeting": "你好，我是 Doubao 助手，很高兴为你服务。",
        "Parameters": [
          {
            "Type": "String",
            "Name": "temperature",
            "DisplayName": "温度",
            "Min": "0.0",
            "Max": "2.0",
            "Options": [
              "1.0"
            ],
            "DefaultValue": "1.0",
            "Description": "生成随机性控制 · 值越大输出越多样"
          }
        ],
        "Prompts": [
          {
            "Scenario": "chat",
            "Message": "请用简洁的语言总结以下内容"
          }
        ],
        "MaxInputTokenLength": 4096,
        "SystemPrompt": {
          "Message": "你是一个专业的 AI 助手，请根据用户问题给出准确、简洁的回答。",
          "ModificationAllowed": true,
          "MaxInputTokenLength": 1024
        }
      },
      "CustomizationJobSettings": {
        "SftSettings": {
          "Enabled": true,
          "SupportPresetDatasets": [
            {
              "Name": "通用中文对话数据集",
              "Description": "覆盖日常对话与问答场景的通用中文语料",
              "SampleCount": 461,
              "Labelled": false
            }
          ],
          "Parameters": [
            {
              "Type": "String",
              "Name": "learning_rate",
              "DisplayName": "学习率",
              "Min": "0.00001",
              "Max": "0.001",
              "Options": [
                "0.0001"
              ],
              "DefaultValue": "0.0001",
              "Description": "训练过程中权重更新的步长",
              "IncrementalLearningLocked": false
            }
          ]
        },
        "LoraSettings": {
          "Enabled": false,
          "SupportPresetDatasets": [
            {
              "Name": "LoRA 微调通用数据集",
              "Description": "面向 LoRA 微调的多领域通用语料",
              "SampleCount": 901,
              "Labelled": true
            }
          ],
          "Parameters": [
            {
              "Type": "String",
              "Name": "lora_rank",
              "DisplayName": "LoRA 秩",
              "Min": "1",
              "Max": "64",
              "Options": [
                "8"
              ],
              "DefaultValue": "8",
              "Description": "LoRA 低秩分解的秩大小 · 越大表达能力越强但训练成本越高",
              "IncrementalLearningLocked": false
            }
          ]
        },
        "ContinuePretrainSettings": {
          "Enabled": false,
          "SupportPresetDatasets": [
            {
              "Name": "通用增量预训练语料",
              "Description": "覆盖通用中英文语料的预训练数据",
              "SampleCount": 224,
              "Labelled": true
            }
          ],
          "Parameters": [
            {
              "Type": "String",
              "Name": "batch_size",
              "DisplayName": "批大小",
              "Min": "1",
              "Max": "128",
              "Options": [
                "16",
                "32",
                "64"
              ],
              "DefaultValue": "16",
              "Description": "每次训练迭代使用的样本数量",
              "IncrementalLearningLocked": false
            }
          ]
        }
      }
    },
    "Status": "Unpublished",
    "PublishTime": "2024-04-15T10:20:30Z",
    "CreateTime": "2024-04-01T11:54:41Z",
    "UpdateTime": "2024-05-14T20:59:45Z"
  }
}
```