All methods

Gemini API

開發人員可透過 Gemini API,使用 Gemini 模型建構生成式 AI 應用程式。Gemini 是 Google 最強大的模型,打從設計之初就具有多模態的特質。可歸納內容,完美解讀、操作及結合語言、圖片、音訊、影片和程式碼等不同類型的資訊。您可以使用 Gemini API 處理各種用途,例如推論文字和圖片內容、生成內容、對話式代理程式、摘要和分類系統等。

服務:generativelanguage.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫呼叫這項服務,請在發出 API 要求時使用下列資訊。

服務端點

服務端點是指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點。這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://generativelanguage.googleapis.com

REST 資源:v1beta.auth_tokens

方法
create POST /v1beta/auth_tokens
建立權杖,用於限制 BidiGenerateContent 工作階段的行為。

REST 資源:v1beta.batches

方法
cancel POST /v1beta/{name=batches/*}:cancel
開始非同步取消長時間執行的作業。
delete DELETE /v1beta/{name=batches/*}
刪除長時間執行的作業。
get GET /v1beta/{name=batches/*}
取得長時間執行的作業的最新狀態。
list GET /v1beta/{name=batches}
列出符合要求中指定篩選器的作業。
updateEmbedContentBatch PATCH /v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch
更新批次處理的 EmbedContent 要求。
updateGenerateContentBatch PATCH /v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch
更新批次處理的 GenerateContent 要求。

REST 資源:v1beta.cachedContents

方法
create POST /v1beta/cachedContents
建立 CachedContent 資源。
delete DELETE /v1beta/{name=cachedContents/*}
刪除 CachedContent 資源。
get GET /v1beta/{name=cachedContents/*}
讀取 CachedContent 資源。
list GET /v1beta/cachedContents
列出 CachedContents。
patch PATCH /v1beta/{cachedContent.name=cachedContents/*}
更新 CachedContent 資源 (只有到期時間可以更新)。

REST 資源:v1beta.fileSearchStores

方法
create POST /v1beta/fileSearchStores
建立空白的 FileSearchStore。
delete DELETE /v1beta/{name=fileSearchStores/*}
刪除 FileSearchStore。
get GET /v1beta/{name=fileSearchStores/*}
取得特定 FileSearchStore 的相關資訊。
importFile POST /v1beta/{fileSearchStoreName=fileSearchStores/*}:importFile
將 File 從檔案服務匯入至 FileSearchStore。
list GET /v1beta/fileSearchStores
列出使用者擁有的所有 FileSearchStores。

REST 資源:v1beta.fileSearchStores.documents

方法
delete DELETE /v1beta/{name=fileSearchStores/*/documents/*}
刪除 Document。
get GET /v1beta/{name=fileSearchStores/*/documents/*}
取得特定 Document 的相關資訊。
list GET /v1beta/{parent=fileSearchStores/*}/documents
列出 Corpus 中的所有 Document。

REST 資源:v1beta.fileSearchStores.operations

方法
get GET /v1beta/{name=fileSearchStores/*/operations/*}
取得長時間執行的作業的最新狀態。

REST 資源:v1beta.fileSearchStores.upload.operations

方法
get GET /v1beta/{name=fileSearchStores/*/upload/operations/*}
取得長時間執行的作業的最新狀態。

REST 資源:v1beta.files

方法
delete DELETE /v1beta/{name=files/*}
刪除 File。
get GET /v1beta/{name=files/*}
取得指定 File 的中繼資料。
list GET /v1beta/files
列出要求專案擁有的 File 中繼資料。
register POST /v1beta/files:register
向 FileService 註冊 Google Cloud Storage 檔案。

REST 資源:v1beta.media

方法
download GET /v1beta/{parent=environments/*}/files
從環境的快照擷取檔案中繼資料或目錄內容。
upload POST /v1beta/files
POST /upload/v1beta/files
建立 File。
uploadToFileSearchStore POST /v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
POST /upload/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
將資料上傳至 FileSearchStore,並在預先處理和分塊後,儲存在 FileSearchStore 文件中。

REST 資源:v1beta.models

方法
asyncBatchEmbedContent POST /v1beta/{batch.model=models/*}:asyncBatchEmbedContent
將一批 EmbedContent 要求排入批次處理佇列。
batchEmbedContents POST /v1beta/{model=models/*}:batchEmbedContents
從輸入 Content 產生多個嵌入向量,輸入包含以 EmbedContentRequest 物件表示的一批字串。
batchGenerateContent POST /v1beta/{batch.model=models/*}:batchGenerateContent
將一批 GenerateContent 要求排入批次處理佇列。
countTokens POST /v1beta/{model=models/*}:countTokens
在輸入 Content 上執行模型的斷詞工具,並傳回詞元數。
embedContent POST /v1beta/{model=models/*}:embedContent
使用指定的 Gemini 嵌入模型,從輸入 Content 生成文字嵌入向量。
generateContent POST /v1beta/{model=models/*}:generateContent
根據輸入內容 GenerateContentRequest 生成模型回覆。
get GET /v1beta/{name=models/*}
取得特定 Model 的相關資訊,例如版本號碼、權杖限制、參數和其他中繼資料。
list GET /v1beta/models
列出透過 Gemini API 提供的Model。
predict POST /v1beta/{model=models/*}:predict
執行預測要求。
predictLongRunning POST /v1beta/{model=models/*}:predictLongRunning
與 Predict 相同,但會傳回 LRO。
streamGenerateContent POST /v1beta/{model=models/*}:streamGenerateContent
根據輸入內容 GenerateContentRequest,從模型生成串流回應。

REST 資源:v1beta.interactions

方法
CreateCredential POST /v1beta/credentials
建立憑證。
CreateInteraction POST /v1beta/interactions
建立新的互動。
cancelInteractionById POST /v1beta/interactions/{id}/cancel
依 ID 取消互動。
ListCredentials GET /v1beta/credentials
列出專案的憑證。
GetCredential GET /v1beta/credentials/{id}
取得單一憑證的中繼資料 (不含密碼欄位)。
getInteractionById GET /v1beta/interactions/{id}
根據 `Interaction.id` 擷取單一互動的完整詳細資料。
UpdateCredential PATCH /v1beta/credentials/{id}
更新憑證。
DeleteCredential DELETE /v1beta/credentials/{id}
刪除憑證。
deleteInteraction DELETE /v1beta/interactions/{id}
依 ID 刪除互動。

REST 資源:v1beta.agents

方法
CreateAgent POST /v1beta/agents
建立新的 Agent (適用於 SDK 的型別版本)。
ListAgents GET /v1beta/agents
列出所有代理。
GetAgent GET /v1beta/agents/{id}
取得特定代理程式。
DeleteAgent DELETE /v1beta/agents/{id}
刪除代理程式。

REST 資源:v1beta.webhooks

方法
CreateWebhook POST /v1beta/webhooks
建立新的 Webhook。
PingWebhook POST /v1beta/webhooks/{id}:ping
將連線偵測事件傳送至 Webhook。
RotateSigningSecret POST /v1beta/webhooks/{id}:rotateSigningSecret
為 Webhook 產生新的簽署密鑰。
ListWebhooks GET /v1beta/webhooks
列出所有 Webhook。
GetWebhook GET /v1beta/webhooks/{id}
取得特定 Webhook。
UpdateWebhook PATCH /v1beta/webhooks/{id}
更新現有 Webhook。
DeleteWebhook DELETE /v1beta/webhooks/{id}
刪除 Webhook。

REST 資源:v1beta.triggers

方法
CreateTrigger POST /v1beta/triggers
建立新的觸發條件,在指定 cron 排程中叫用指定代理程式。
RunTrigger POST /v1beta/triggers/{trigger_id}/executions
立即執行觸發條件。
ListTriggers GET /v1beta/triggers
列出專案的觸發條件。
GetTrigger GET /v1beta/triggers/{id}
取得單一觸發條件的詳細資料。
ListTriggerExecutions GET /v1beta/triggers/{trigger_id}/executions
列出觸發程序的執行作業。
UpdateTrigger PATCH /v1beta/triggers/{id}
更新觸發條件。
DeleteTrigger DELETE /v1beta/triggers/{id}
刪除觸發條件。

REST 資源:v1beta.environments

方法
CreateEnvironment POST /v1beta/environments
建立環境。
ListEnvironments GET /v1beta/environments
列出環境。
GetEnvironmentFiles GET /v1beta/environments/{environment}/files/{path}
從環境的快照擷取檔案中繼資料或目錄內容。
GetEnvironment GET /v1beta/environments/{id}
取得環境。
StartEnvironmentFileUpload PUT /upload/v1beta/environments/{environment}/files/{path}
為環境工作區中的檔案啟動支援續傳的上傳作業。
DeleteEnvironment DELETE /v1beta/environments/{id}
刪除環境。