REST Resource: tunedModels

资源:TunedModel

使用 ModelService.CreateTunedModel 创建的经微调的模型。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "tuningTask": {
    object (TuningTask)
  },

  // Union field source_model can be only one of the following:
  "tunedModelSource": {
    object (TunedModelSource)
  },
  "baseModel": string
  // End of list of possible types for union field source_model.
  "temperature": number,
  "topP": number,
  "topK": integer
}
字段
name

string

仅供输出。已调整的模型名称。创建时,系统会生成一个唯一的名称。示例:tunedModels/az2mb0bpw6i 如果在创建时设置了 displayName,则系统会通过以下方式设置名称的 ID 部分:将 displayName 的字词与连字符串联,并随机添加一个部分以确保唯一性。示例:displayName = "Sentence Translator" name = "tunedModels/sentence-translator-u3b7m"

displayName

string

可选。此模型在界面中显示的名称。显示名称不得超过 40 个字符(包括空格)。

description

string

可选。此模型的简短说明。

state

enum (State)

仅供输出。已调参模型的状态。

createTime

string (Timestamp format)

仅供输出。创建此模型时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅供输出。更新此模型时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

tuningTask

object (TuningTask)

必需。创建经调参的模型的调参任务。

联合字段 source_model。用作调参起点的模型。source_model 只能是下列其中一项:
tunedModelSource

object (TunedModelSource)

可选。将用作训练新模型的起点的 TunedModel。

baseModel

string

不可变。要调参的 Model 的名称。示例:models/text-bison-001

temperature

number

可选。控制输出的随机性。

值的范围在 [0.0,1.0](含)以上。值越接近 1.0,回答就越多样化,而值越接近 0.0,模型给出的回答一般越不出乎意料。

此值将默认值指定为创建模型时基本模型使用的模型。

topP

number

可选。用于 Nucleus 采样。

核采样考虑概率总和至少为 topP 的最小词元集。

此值将默认值指定为创建模型时基本模型使用的模型。

topK

integer

可选。用于 Top-k 采样。

Top-k 采样考虑 topK 集合中概率最高的词元。此值指定后端在调用模型时要使用的默认值。

此值将默认值指定为创建模型时基本模型使用的模型。

TunedModelSource

将经调优的模型用作训练新模型的来源。

JSON 表示法
{
  "tunedModel": string,
  "baseModel": string
}
字段
tunedModel

string

不可变。要用作训练新模型的起点的 TunedModel 的名称。示例:tunedModels/my-tuned-model

baseModel

string

仅供输出。此 TunedModel 的调参基础 Model 的名称。示例:models/text-bison-001

状态

已调参模型的状态。

枚举
STATE_UNSPECIFIED 默认值。此值未使用。
CREATING 正在创建模型。
ACTIVE 模型已准备就绪,可以使用了。
FAILED 未能创建模型。

TuningTask

创建经调参的模型的调参任务。

JSON 表示法
{
  "startTime": string,
  "completeTime": string,
  "snapshots": [
    {
      object (TuningSnapshot)
    }
  ],
  "trainingData": {
    object (Dataset)
  },
  "hyperparameters": {
    object (Hyperparameters)
  }
}
字段
startTime

string (Timestamp format)

仅供输出。开始对此模型进行调参时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

completeTime

string (Timestamp format)

仅供输出。完成此模型调参时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

snapshots[]

object (TuningSnapshot)

仅供输出。调参期间收集的指标。

trainingData

object (Dataset)

必需。仅限输入。不可变。模型训练数据。

hyperparameters

object (Hyperparameters)

不可变。控制调参过程的超参数。如果未提供,系统将使用默认值。

TuningSnapshot

记录单个调参步骤。

JSON 表示法
{
  "step": integer,
  "epoch": integer,
  "meanLoss": number,
  "computeTime": string
}
字段
step

integer

仅供输出。调整步骤。

epoch

integer

仅供输出。此步骤所属的周期。

meanLoss

number

仅供输出。这一步骤的训练样本的平均损失。

computeTime

string (Timestamp format)

仅供输出。计算此指标时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

数据集

用于训练或验证的数据集。

JSON 表示法
{

  // Union field dataset can be only one of the following:
  "examples": {
    object (TuningExamples)
  }
  // End of list of possible types for union field dataset.
}
字段
联合字段 dataset。内嵌数据或对数据的引用。dataset 只能是下列其中一项:
examples

object (TuningExamples)

可选。内嵌示例。

TuningExamples

一组调参示例。可以是训练数据或验证数据。

JSON 表示法
{
  "examples": [
    {
      object (TuningExample)
    }
  ]
}
字段
examples[]

object (TuningExample)

必需。示例。示例输入可以是文本或讨论内容,但一组中的所有样本都必须属于同一类型。

TuningExample

单个调参示例。

JSON 表示法
{
  "output": string,

  // Union field model_input can be only one of the following:
  "textInput": string
  // End of list of possible types for union field model_input.
}
字段
output

string

必需。预期的模型输出。

联合字段 model_input。此示例的模型输入。model_input 只能是下列其中一项:
textInput

string

可选。文本模型输入。

超参数

控制调参过程的超参数。如需了解详情,请访问 https://ai.google.dev/docs/model_tuning_guidance

JSON 表示法
{

  // Union field learning_rate_option can be only one of the following:
  "learningRate": number,
  "learningRateMultiplier": number
  // End of list of possible types for union field learning_rate_option.
  "epochCount": integer,
  "batchSize": integer
}
字段
联合字段 learning_rate_option。用于指定调整期间的学习速率的选项。learning_rate_option 只能是下列其中一项:
learningRate

number

可选。不可变。用于调参的学习速率超参数。如果未设置,系统将根据训练样本数计算默认值 0.001 或 0.0002。

learningRateMultiplier

number

可选。不可变。学习速率调节系数用于根据默认(推荐)值计算最终的学习速率。实际学习速率 := learningRateMultiplier * 默认学习速率 默认学习速率取决于基本模型和数据集大小。如果未设置此政策,系统将使用默认值 1.0。

epochCount

integer

不可变。训练周期数。一个周期指训练数据一次传递。如果未设置此政策,系统将使用默认值 5。

batchSize

integer

不可变。用于调参的批量大小超参数。如果未设置,系统将根据训练样本的数量使用默认值 4 或 16。

方法

create

创建经调整的模型。

delete

删除经调整的模型。

generateContent

根据输入 GenerateContentRequest 从模型生成回答。

generateText

根据输入消息,根据模型生成回复。

get

获取有关特定 TunedModel 的信息。

list

列出用户拥有的已调参模型。

patch

更新经调整的模型。

transferOwnership

转移已调参模型的所有权。