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

在 API 平台管理專案

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

更新日期:4 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 會保留專案的歷史記錄,以追蹤用量及帳單。

這篇文章對你有幫助嗎?