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

在 API 平台管理專案

更新日期:13 days ago

專案旨在讓客戶能夠整理其工作。機構可管理存取權與限制、配置服務帳戶(透過 UI),並在專案內受限的範圍中追蹤用量(例如模型、功能、threads、assistants、微調、儲存空間等)。用量活動可按專案細分,而用戶可按專案查看帳單及設定預算。

機構擁有者可在Projects 頁面查看所有進行中及已封存的專案。進一步了解API 平台中的用戶角色與權限

Image

誰可以建立專案?

只有機構擁有者可以建立專案。請參閱角色與權限了解更多資訊。

如要在機構之間切換,請將滑鼠移到頁面左上方的機構名稱上,然後從清單中選擇機構:

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

對於採用綜合計費方案的機構,子機構會分開識別。專案不能在子機構內建立。

Image

專案如何運作?

每個機構都包括一個「預設專案」,而且不能刪除。你可以設定速率限制、虛擬模型權限及支出預算(截至 2024 年 11 月)。它會繼承機構的完整設定,因此你不能直接向其中加入成員或服務帳戶。

如何建立專案?

首先,將滑鼠移到頁面左側角落的專案名稱上,然後選擇 Create project

API platform project menu with Create project highlighted under Default project

為你的專案提供名稱、描述和網站,然後選擇 Create

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

如何將用戶加入專案?

新加入的機構成員不會自動加入「預設專案」。新成員可在受邀加入機構時(啟用 "Invite to default project" 核取方塊),或在成員接受機構邀請後,再邀請加入專案。

透過 Admin API 邀請的用戶,會遵循/organization/invites 端點所述規則。

如果你在透過 UI 或 Admin API 邀請用戶加入專案時遇到錯誤,請先確認目標專案存在且未封存,然後再重新傳送邀請。

機構擁有者會自動成為在機構內建立之新專案的擁有者。

機構和專案中的不同用戶角色是甚麼?各自有哪些權限?

機構有「owner」和「reader」角色,而專案則有「owner」和「member」角色。專案成員相當於機構的 reader。請參閱下表,以了解每種用戶角色所附帶權限的更詳細說明。

角色範圍說明
Owner機構可建立/查看所有專案、所有用戶及所有 API 金鑰。可透過Projects 頁面監察機構內所有專案。可設定機構預算和專案預算。可授予他人查看機構用量資訊的權限。可封存專案。
Reader機構可在其專案中執行推論、使用資源及建立金鑰。可被加入專案。不能建立專案或管理用戶。
Owner專案可將其他用戶加入專案、重新命名專案,以及擁有 Member 的所有能力。可設定專案預算。可封存專案。
Member專案可在專案層級執行推論、使用資源及建立金鑰。

如果我不是機構中的 Owner,我可以存取甚麼?

不是機構 Owner 的用戶,只能看到自己是成員的專案。只有機構擁有者可在專案層級看到所有專案、成員及 API 金鑰,並可存取Projects 頁面

  • 只有專案成員(以及機構擁有者)可看到在該專案內建立的微調模型、任何已建立 Assistants 的 threads,或任何已加入的檔案。

  • 專案成員可看到該專案所有其他成員及其角色(即 Owner 或 Member)。

如何更新用戶的專案角色,或將用戶從專案中移除?

只有專案擁有者可以更新用戶的專案角色,或將用戶從專案中移除。請參閱角色與權限了解更多資訊。

若要更新專案中的用戶,請前往你的機構設定,選擇專案,然後按一下 Members。你可將每位成員的角色設為 MemberOwner。你也可選擇 Remove,將用戶從專案中移除。

甚麼是服務帳戶?它與一般用戶帳戶有何不同?

服務帳戶是為系統存取而設的擬似用戶,與個別用戶帳戶不同。只有機構及專案擁有者可以建立服務帳戶。

服務帳戶只限於專案範圍。

將成員加入專案

如你按一下 + Add member 按鈕,你會看到機構中角色為 Reader 的用戶清單。若你想加入目前不在你機構內的用戶,則需要先將他們加入機構(如你不想給予這些用戶更廣泛的存取權,可保持 'Add to Default Project" 核取方塊為未選取)。此清單不會包括服務帳戶。在這一步,你可選擇他們的角色為 OwnerMember

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

當你加入團隊成員時,必須為他們指派 Member Owner 角色。專案成員可發出讀取或修改資料的 API 請求,而專案擁有者亦可修改專案設定和專案預算,並管理專案成員。請參閱角色與權限了解更多資訊。

如何為專案建立服務帳戶

首先,在導覽列的下拉選單中選擇你想建立服務帳戶的專案:

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

然後前往你的機構設定 -> Project -> Members -> 按一下 + Service account

在專案層級建立的服務帳戶僅屬於該專案,不能在其建立所在專案以外使用。

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

命名服務帳戶

無論你是在機構層級建立服務帳戶,還是建立專屬於某個專案的服務帳戶,在建立服務帳戶時,你都可以建立由字母、數字及連字號組成的獨特服務帳戶 ID,以便輕鬆識別該服務帳戶。

儲存服務帳戶 API 金鑰

選擇 Create 按鈕後,系統會立即為服務帳戶建立 API 金鑰,並顯示 secret key。請將此 secret key 儲存在安全可靠的位置。基於安全理由,你之後將無法透過 OpenAI 帳戶再次查看它。若你遺失此 secret key,便需要重新產生新的金鑰。

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

服務帳戶 API 金鑰預設具有讀取及寫入該專案所有 API 資源的權限。這些權限可在你專案的 API Keys 設定中更新。

服務帳戶會與專案成員一同列於你專案的成員設定頁面。請參閱此處,了解更多有關在你專案的成員設定頁面中更新或移除服務帳戶存取權的資訊。

所有專案及機構中的服務帳戶,都會與你的人類用戶一同顯示於機構層級的成員頁面

服務帳戶的管理方式與一般帳戶相同。在 Organization -> Members 選單中,你可移除服務帳戶或更新其角色:

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

如何管理機構專案中的 API 金鑰?

你可在每個專案的設定頁面建立和管理該專案的 API 金鑰。在你的機構設定中,選擇專案,然後按一下 API Keys

若要建立新的 secret key,請選擇 + Create new secret key。你也可選擇 secret key 旁的編輯圖示以編輯其權限。

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

你可在建立新 secret key 時,或透過編輯現有金鑰,為每個 API 金鑰設定權限。

共有三個權限層級:All、Restricted 及 Read Only。

  • All — secret key 具有完整權限。這是預設設定。

  • Restricted — 讓用戶可為每個端點設定 None、Read 及 Write 權限。

    • 例如,你可以建立一個 API 金鑰,明確不具備對 /v1/assistants 端點的 Read 或 Write 權限:

      Create new secret key dialog in the API platform with Restricted permissions selected
  • Read Only — 所有端點均設為 Read 權限。

屬於多個專案或機構的用戶,其存取權如何管理?

用戶可按需要成為多個專案的成員。在專案內,用戶可產生個人 API 金鑰,而該金鑰的範圍及權限只限於存取該專案及其資源。

如何為機構的專案設定和管理速率限制?

只有機構擁有者可以設定和管理專案層級的速率限制。請參閱角色與權限了解更多資訊。

在你的機構設定中,按一下你想更新的專案,然後在導覽清單的 Project 區段中選擇 Limits你可在此頁面更新 Model Usage

Model usage 可讓你設定專案可使用哪些模型,而每個模型亦可按需要設定速率限制

如何為機構的專案設定和管理預算?

只有機構的擁有者及專案的擁有者可以設定和管理專案預算。請參閱角色與權限了解更多資訊。若要變更機構層級的限制,請前往你的機構設定,按一下 Limits,然後向下捲動至 Usage limits

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

若要設定專案限制,請前往你的機構設定,按一下你想更新的專案,然後選擇 Limits。你可更新 Monthly budgetNotification threshold Model Usage

設定每月預算可讓你為專案建立軟性支出門檻。當用量在某個曆月(UTC)內超過此限制時,API 請求仍會繼續處理,不會中斷。此功能旨在透過預算警示協助你監察用量,但不會對支出施加硬性上限。建立專案預算時,系統預設會在 100% 門檻建立警示。你亦可按一下 Add Alert 來設定不同門檻的額外預算警示。

請注意,機構擁有者及專案擁有者將一律收到這些訊息,而且此設定無法自訂。

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

如何刪除或封存專案?

專案可透過新的專案清單頁面,或個別專案的設定頁面進行封存。專案一經封存便無法還原。繼續封存時,系統會提示你輸入專案名稱以繼續。

你可在同一個專案清單頁面的「Archived」分頁查看所有已封存專案的清單。

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

無法刪除專案;我們會保留所有專案的歷史記錄,以確保用量及計費追蹤的連續性。

我的機構可擁有的專案數量有上限嗎?

機構預設最多可建立 2,000 個專案。

資源可以跨專案共用嗎?

專案資源(例如檔案、assistants、儲存空間或 threads)均限定於該專案範圍內,專案外的非管理成員無法存取。此外,資源亦不能在專案之間移動。

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

每個專案的檔案儲存配額是多少?

OpenAI 目前支援每個專案最多 100 GB 的檔案儲存配額。

如超出此配額,你會看到以下錯誤:

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

我們建議你刪除帳戶中儲存而未使用的檔案。作為參考,你可使用 API查看及列出檔案

我是專案擁有者,為何看不到我專案的 Usage Dashboard?

專案 Usage Dashboard 的可見性與用戶在專案內的角色無關。相反,它取決於你在機構中的角色 https://platform.openai.com/settings/organization/data-controls/visibility 的設定。

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

如果你無法看到 Usage Dashboard,這項設定很可能設為 "Visible to organization owners"。

這篇文章對你有幫助嗎?