OpenAI
此頁面由機器翻譯。查看原始英文文章。

在 API 平台中管理專案

建立及管理 API 專案,包括成員存取權、服務帳戶、API 金鑰、模型存取權、用量及支出上限。

更新日期:3 days ago

概覽

專案可用來組織 API 組織內的工作。你可以針對一組特定資源(例如模型、功能、對話串、助理、微調及儲存空間),透過專案管理存取權、設定模型和速率限制、建立服務帳戶,以及追蹤用量、帳單和支出上限。

組織擁有者可以在專案頁面查看所有使用中及已封存的專案。

Image

開始之前

你必須具有組織擁有者角色,才能建立專案。預設情況下,組織最多可建立 2,000 個專案。

如果組織使用合併計費,子組織會在組織選擇器中分別列出。你無法在子組織內建立專案。

若要切換組織,請開啟組織選擇器,並選取你要使用的組織。

Projects page with the organization switcher open, listing Personal and Staging organizations
Image

預設專案

每個組織都包含一個無法刪除的預設專案。該專案會繼承組織的完整設定。你可以設定其速率限制、虛擬模型權限及支出上限。

你無法直接將成員或服務帳戶加入預設專案。你可以依照本文的組織邀請步驟,在邀請他人加入組織時,一併授予預設專案的存取權。

建立專案

  1. 開啟專案選擇器,並選取建立專案。

  2. 輸入專案的名稱、說明和網站。

  3. 選取建立。

API platform project menu with Create project highlighted under Default project
Create a new project dialog in the API platform with fields for project name, use case, and business website

組織擁有者會自動加入新專案,成為專案擁有者。

瞭解角色和存取權

下表概述這些步驟涉及的組織擁有者與讀者角色,以及專案擁有者與成員角色。專案成員的權限與組織讀者類似。

角色範圍權限
擁有者組織建立及查看所有專案、使用者和 API 金鑰。在專案頁面監控專案。設定組織和專案的支出上限。授予存取其他使用者用量資訊的權限。封存專案。
讀者組織可被加入專案,並在這些專案中執行推論、使用資源及建立金鑰。無法建立專案或管理使用者。
擁有者專案擁有所有成員權限,還可以新增使用者、管理專案成員和設定、重新命名專案、設定專案支出上限,以及封存專案。
成員專案執行推論、使用資源、建立專案層級的金鑰,以及發出讀取或修改資料的 API 請求。

如需組織角色的詳細資訊,請參閱:組織角色。如需其他角色、自訂角色及完整權限的資訊,請參閱 API 角色與權限指南。

專案可見性

在這些標準角色的權限設定下,非組織擁有者的使用者只能查看自己所屬的專案。組織擁有者可以查看所有專案、成員及專案層級的 API 金鑰,並可存取專案頁面。

專案成員可以查看同一專案的其他成員,以及每位成員的角色。只有專案成員和組織擁有者可以查看該專案內建立或新增的微調模型、助理對話串及檔案。

你可以依需求加入任意數量的專案。在專案內建立的個人 API 金鑰,其使用範圍僅限於該專案及其資源。

資源使用範圍

檔案、助理、儲存空間和對話串的使用範圍僅限於所屬專案。不屬於該專案且不具管理員身分的成員,無法存取該專案的資源;資源也無法在專案之間移動。

預設專案中的微調模型則是例外:其他專案也可以存取這些模型。

管理專案成員

邀請他人加入組織

對方必須先加入你的組織,你才能將其加入專案。

邀請他人加入組織時,你可以在邀請表單中勾選相應選項,一併授予預設專案的存取權。如果不想授予預設專案的存取權,請勿勾選該選項。新加入組織的成員不會自動加入預設專案。

邀請他人前,不需要先建立另一個專案。你也可以在對方接受組織邀請後,再將其加入專案。

透過管理員 API 傳送的邀請須遵循 /organization/invites 端點的規則。

將組織成員加入專案

組織和專案擁有者可以新增成員:

  1. 前往組織設定。

  2. 選取專案,然後開啟成員。

  3. 選取 + 新增成員。

  4. 選取使用者,並指派成員或擁有者角色。

使用者清單會顯示組織中具有讀者角色的使用者。清單不包含服務帳戶。

Project members with Add team members dialog assigning a user the Member role

如果透過使用者介面或管理員 API 傳送邀請失敗,請先確認目標專案存在且未封存,再重新傳送邀請。

變更角色或移除成員

組織和專案擁有者可以變更使用者的專案角色,或將使用者從該專案移除。

  1. 前往組織設定。

  2. 選取專案,然後開啟成員。

  3. 將使用者的角色設為成員或擁有者,或選取移除以將其移除。

建立及管理服務帳戶

服務帳戶用於提供系統存取權,而非代表個別使用者。服務帳戶的使用範圍僅限於所屬專案。

建立服務帳戶需要服務帳戶管理權限。組織和專案擁有者具備這些權限。

建立服務帳戶

  1. 在專案選擇器中選取專案。

  2. 前往組織設定,並選取專案。

  3. 開啟成員,並選取 + 服務帳戶。

  4. 輸入由英文字母、數字和連字號組成的不重複服務帳戶 ID。

  5. 選取建立。

API platform project switcher open with options to create a project or manage projects

在專案層級建立的服務帳戶僅屬於該專案,無法在建立它們的專案之外使用。

Project Members page with Create a service account dialog after selecting the Service account option

無論你從組織層級或專案層級設定建立服務帳戶,都適用相同的 ID 格式。

為專案建立的服務帳戶專屬於該專案,無法在專案之外使用。

儲存秘密金鑰

建立服務帳戶時,系統會立即建立 API 金鑰,並顯示其秘密金鑰。請妥善儲存秘密金鑰。你無法透過 OpenAI 帳戶再次查看這組金鑰。如果遺失,請產生新的金鑰。

Members page with Save your key modal after creating a service account

預設情況下,服務帳戶金鑰可以讀取及寫入其所屬專案中的所有 API 資源。你可以稍後在專案的 API 金鑰設定中變更這些權限。

更新或移除服務帳戶

服務帳戶會與使用者一同顯示在專案的成員設定中。你可以使用與其他專案成員相同的角色變更和移除步驟,管理服務帳戶的專案存取權。

所有服務帳戶也會與使用者一同顯示在組織的成員頁面上,包括從組織層級和專案層級設定建立的帳戶。

在組織的成員選單中,你可以變更服務帳戶的角色,或選取移除。

OpenAI API Members settings with a service account role menu open for Reader or Owner

建立及管理 API 金鑰

每個專案都有自己的 API 金鑰:

  1. 前往組織設定。

  2. 選取專案,然後開啟 API 金鑰。

  3. 選取 + 建立新的秘密金鑰以建立金鑰,或選取現有金鑰旁的編輯圖示以變更權限。

API keys page for a project with the Create new secret key button highlighted

選擇金鑰權限

對於使用者擁有的金鑰,你可以在建立時設定權限,或稍後編輯:

  • 全部:完整權限。這是預設設定。

  • 受限:為特定資源或端點選擇權限範圍。可用選項依資源而異,可能包括無、讀取、寫入或特定請求的權限。

  • 唯讀:所有端點的讀取權限。

例如,受限金鑰可以不授予 /v1/assistants 端點的讀取和寫入存取權。

Create new secret key dialog in the API platform with Restricted permissions selected

建立服務帳戶金鑰需要服務帳戶管理權限。如果你看不到該選項,請要求組織或專案擁有者建立服務帳戶金鑰。建立金鑰的對話方塊不會為服務帳戶金鑰顯示這些權限控制項;請在建立後前往專案的 API 金鑰設定變更權限。

設定模型存取權和速率限制

管理專案速率限制需要管理權限。組織擁有者具備這些權限,專案擁有者也可以透過管理 API 管理專案速率限制。

  1. 前往組織設定。

  2. 選取專案,然後開啟限制。

  3. 使用模型使用設定,選擇專案可以使用哪些模型。

  4. 視需要為每個模型設定速率限制。

設定支出上限和警示

組織和專案層級都可以設定每月 API 支出上限。你必須具備管理相關組織或專案設定的權限,才能變更上限。

支出上限可用來監控支出,而不必停止請求。如果希望追蹤到的支出達到上限後,API 請求便無法成功,請開啟強制執行硬性上限。限制不會即時生效,因此記錄的支出可能會略高於設定金額。

支出警示會在達到門檻時通知你,但不會停止請求。

設定組織支出上限

  1. 前往組織設定。

  2. 開啟限制,並找到支出。

Project Limits page with organization budget controls, usage alerts, and model rate limits table

設定專案支出上限

  1. 前往組織設定。

  2. 選取專案,然後開啟限制。

  3. 設定每月支出上限及支出警示門檻的數值。

  4. 如果希望追蹤到的支出達到上限後停止 API 流量,請開啟強制執行硬性上限。

你也可以在此頁面變更模型使用設定。

管理支出警示

建立專案支出上限時,預設也會建立在支出達到上限 100% 時發出的警示。選取新增警示,即可新增其他門檻的警示。

組織和專案擁有者會收到專案支出警示。你可以在警示設定中新增其他電子郵件收件者。

Project Limits page with Add budget alert dialog set to notify at 90% budget usage

如需最新設定步驟及限制執行方式,請參閱支出上限指南。

查看用量和帳單

你可以依專案查看使用情況,並為個別專案查看帳單及設定支出上限。

能否存取專案的用量儀表板,取決於你的組織角色及用量儀表板可見性設定。僅具有專案擁有者身分並不代表擁有存取權。

Project setting for Usage dashboard visibility with Visible to organization owners selected

如果你無法查看專案的用量儀表板,請檢查可見性是否設為組織擁有者可見。

管理檔案儲存空間

每個專案的檔案儲存空間配額為 100 GB。如果超出配額,你可能會看到以下錯誤訊息:

你已超出檔案儲存空間配額。組織的檔案儲存上限為 100 GB。請縮減檔案大小或聯絡支援團隊。

刪除不再使用的檔案以釋出儲存空間。你可以透過 API 列出已儲存的檔案,找出不再需要的檔案。

封存專案

組織和專案擁有者可以從專案頁面或個別專案的設定封存專案。出現確認提示時,請輸入專案名稱。

封存是永久性的操作:已封存的專案無法還原。

若要查看已封存的專案,請開啟專案頁面上的已封存分頁。

API platform Projects page with the Archived tab selected to view archived projects

唯一的例外是,「預設專案」中的微調模型可從其他專案存取。

您已超出檔案儲存配額。組織的檔案上限為 100 GB。請縮減檔案大小或聯絡支援團隊。

專案無法刪除。OpenAI 會保留專案歷程記錄,以追蹤用量和帳單。

這篇文章有幫助嗎?