REST Resource: models

リソース: Model

生成言語モデルに関する情報。

JSON 表現
{
  "name": string,
  "baseModelId": string,
  "version": string,
  "displayName": string,
  "description": string,
  "inputTokenLimit": integer,
  "outputTokenLimit": integer,
  "supportedGenerationMethods": [
    string
  ],
  "temperature": number,
  "topP": number,
  "topK": integer
}
フィールド
name

string

必須。Model のリソース名。

形式: models/{model}{model} 命名規則:

  • 「{baseModelId}-{version}」

例:

  • models/chat-bison-001
baseModelId

string

必須。ベースモデルの名前。生成リクエストに渡します。

例:

  • chat-bison
version

string

必須。モデルのバージョン番号。

これはメジャーバージョンを

displayName

string

人が読める形式のモデル名。(「Chat Bison」など)。

名前は最大 128 文字で、UTF-8 文字を含めることができます。

description

string

モデルの簡単な説明。

inputTokenLimit

integer

このモデルで許可される入力トークンの最大数。

outputTokenLimit

integer

このモデルで使用可能な出力トークンの最大数。

supportedGenerationMethods[]

string

モデルでサポートされている生成方法。

メソッド名は、API メソッドに対応する generateMessage などのパスカルケースの文字列として定義されます。

temperature

number

出力のランダム性を制御します。

値は [0.0,1.0] 以上指定できます。値が 1.0 に近いほどばらつきのあるレスポンスが生成され、0.0 に近いほど、モデルからの想定外のレスポンスは少なくなります。この値は、モデルの呼び出し中にバックエンドで使用されるデフォルト値を指定します。

topP

number

核のサンプリングのため。

核のサンプリングでは、確率の合計が topP 以上の最小のトークンのセットが考慮されます。この値は、モデルの呼び出し中にバックエンドで使用されるデフォルト値を指定します。

topK

integer

トップ K サンプリングの場合。

トップ K のサンプリングでは、最も確率が高い topK 個のトークンのセットが考慮されます。この値は、モデルの呼び出し中にバックエンドで使用されるデフォルト値を指定します。空の場合は、モデルがトップ K サンプリングを使用せず、topK を生成パラメータとして使用できないことを示します。

Methods

batchEmbedContents

入力テキストを指定して、同期呼び出しでモデルから複数のエンベディングを生成します。

batchEmbedText

入力テキストを指定して、同期呼び出しでモデルから複数のエンベディングを生成します。

countMessageTokens

文字列に対してモデルのトークナイザを実行し、トークン数を返します。

countTextTokens

テキストに対してモデルのトークナイザを実行し、トークン数を返します。

countTokens

入力コンテンツに対してモデルのトークナイザを実行し、トークン数を返します。

embedContent

入力された Content に基づいて、モデルからエンベディングを生成します。

embedText

入力メッセージを受け取って、モデルからエンベディングを生成します。

generateAnswer

入力された GenerateAnswerRequest に基づいて、モデルから根拠のある回答を生成します。

generateContent

入力 GenerateContentRequest が与えられた場合に、モデルからレスポンスを生成します。

generateMessage

入力 MessagePrompt が与えられた場合に、モデルからレスポンスを生成します。

generateText

入力メッセージに対するモデルからレスポンスを生成します。

get

特定のモデルに関する情報を取得します。

list

API で使用可能なモデルを一覧表示します。

streamGenerateContent

入力 GenerateContentRequest が与えられた場合、モデルからストリーミングされたレスポンスを生成します。