Models

模型端點可讓您以程式輔助方式列出可用模型，並擷取擴充中繼資料，例如支援的功能和內容視窗大小。詳情請參閱模型指南。

方法：models.get

取得特定 Model 的相關資訊，例如版本編號、符記限制、參數和其他中繼資料。如需詳細模型資訊，請參閱 Gemini 模型指南。

端點

get https://generativelanguage.googleapis.com/v1beta/{name=models/*}

這個網址使用 gRPC 轉碼語法。

路徑參數

name string

必要欄位。模型的資源名稱。

這個名稱應與 models.list 方法傳回的模型名稱相符。

格式：models/{model} 格式為 models/{model}。

要求主體

要求主體必須為空白。

要求範例

Python

import google.generativeai as genai

model_info = genai.get_model("models/gemini-1.5-flash-latest")
print(model_info)
models.py

貝殼

curl https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash?key=$GOOGLE_API_KEY
models.sh

回應主體

如果成功，回應主體會包含 Model 的執行例項。

方法：models.list

列出可透過 Gemini API 取得的 Model。

端點

get https://generativelanguage.googleapis.com/v1beta/models

這個網址使用 gRPC 轉碼語法。

查詢參數

pageSize integer

每頁傳回的 Models 數量上限。

如未指定，每個網頁會傳回 50 個型號。這個方法每頁最多會傳回 1000 個模型，即使您傳遞較大的 pageSize 也一樣。

pageToken string

從先前 models.list 呼叫收到的網頁權杖。

將一個要求傳回的 pageToken 做為下一個要求的引數，擷取下一頁。

進行分頁時，提供至 models.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

要求範例

Python

import google.generativeai as genai

print("List of models that support generateContent:\n")
for m in genai.list_models():
    if "generateContent" in m.supported_generation_methods:
        print(m.name)

print("List of models that support embedContent:\n")
for m in genai.list_models():
    if "embedContent" in m.supported_generation_methods:
        print(m.name)
models.py

貝殼

curl https://generativelanguage.googleapis.com/v1beta/models?key=$GOOGLE_API_KEY
models.sh

回應主體

來自 ListModel 的回應，其中包含分頁的模型清單。

如果成功，回應主體會含有以下結構的資料：

欄位
models[] object (Model)

傳回的模型。

nextPageToken string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。

如果省略這個欄位，就沒有後續頁面。

JSON 表示法 
{
  "models": [
    {
      object (Model)
    }
  ],
  "nextPageToken": string
}

REST 資源：models

資源：Model

生成式語言模型相關資訊。

欄位
name string

必要欄位。Model 的資源名稱。如要瞭解所有允許的值，請參閱「模型變化版本」。

格式：models/{model}，採用以下 {model} 命名慣例：

  • 「{baseModelId}-{version}」

範例：

  • models/gemini-1.5-flash-001
baseModelId string

必要欄位。基礎模型的名稱，會傳遞至產生要求。

範例：

  • gemini-1.5-flash
version string

必要欄位。模型的版本號碼。

這代表主要版本 (1.0 或 1.5)

displayName string

使用者可解讀的模型名稱。例如「Gemini 1.5 Flash」。

名稱的長度上限為 128 個半形字元，可使用任何 UTF-8 字元。

description string

模型的簡短說明。

inputTokenLimit integer

此模型允許的輸入符記數量上限。

outputTokenLimit integer

此模型可用的輸出符記數量上限。

supportedGenerationMethods[] string

模型支援的產生方法。

對應的 API 方法名稱會定義為 Pascal 大寫字母字串，例如 generateMessage 和 generateContent。

temperature number

控制輸出的隨機性。

值的範圍為 [0.0,maxTemperature] 以上 (包含 [0.0,maxTemperature])。值越高，回覆就會越多樣化；值越接近 0.0，模型產生的回覆就會越不令人意外。這個值會指定後端在呼叫模型時使用的預設值。

maxTemperature number

這個模型可使用的最高溫度。

topP number

適用於 Nucleus 取樣。

Nucleus 取樣會考慮機率總和至少為 topP 的最小詞元集合。這個值會指定後端在呼叫模型時使用的預設值。

topK integer

適用於 Top-k 取樣。

前 K 大取樣會考量機率最高的 topK 符記組合。這個值會指定後端在呼叫模型時使用的預設值。如果為空白，表示模型不會使用 top-k 取樣，且不允許使用 topK 做為產生參數。

JSON 表示法 
{
  "name": string,
  "baseModelId": string,
  "version": string,
  "displayName": string,
  "description": string,
  "inputTokenLimit": integer,
  "outputTokenLimit": integer,
  "supportedGenerationMethods": [
    string
  ],
  "temperature": number,
  "maxTemperature": number,
  "topP": number,
  "topK": integer
}