如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .md ,即可取得該頁面的 Markdown 版本。
主要導覽
主題

管理工作階段

尋找工作階段、處理必要動作,以及刪除已儲存的工作。

將每個工作階段的 ID 存入應用程式的資料存放區。你可以使用這個 ID 取得工作階段的目前狀態、處理智慧體發出的請求,或刪除工作階段。

尋找工作階段

列出專案中的工作階段,即可瀏覽先前的工作。你可以使用 SDK 的分頁輔助函式取得後續各頁的資料。

列出工作階段並取得下一頁
from openai import OpenAI

client = OpenAI()
page = client.beta.agents.sessions.list(limit=20)
print(page.to_json())
if page.has_next_page():
    page = page.get_next_page()
    print(page.to_json())

檢視工作階段

取得工作階段後,即可查看其狀態、智慧體設定、環境和 required_actions。呼叫時,請傳入 API 用戶端和該對話的工作階段 ID。

取得工作階段
# Pass your saved session ID to this helper.
def retrieve_session(client: OpenAI, session_id: str):
    return client.beta.agents.sessions.retrieve(session_id)

如需完整的回應結構描述,請參閱取得工作階段的 API 參考文件。

處理必要動作

工作階段的狀態為 requires_action 時,應用程式必須先執行必要動作,工作才能繼續。收到 agent.session.requires_action 事件時,請取得該工作階段,並逐一檢查 required_actions 中的項目。

  • function_call: 執行 name 指定的函式,並傳入 arguments 中的引數。使用該動作的 turn_id 和 call_id,在同一個工作階段中回傳結果。請參閱函式工具。
  • environment_connection: 連線至 environment_id 指定的環境。請參閱連線至環境。

應用程式收到事件時,就知道該檢查工作階段。取得工作階段後,就能確認要執行哪些動作。應用程式重新啟動或串流連線中斷後,請取得工作階段,查看是否有待處理的動作。處理完畢後,請繼續追蹤事件,以得知該回合的結果。

若要查看已儲存的訊息、工具呼叫和回合結果,請參閱取得項目與回合。若要確認哪個智慧體執行了某項指令,請參閱觀察任務委派情形。

刪除工作階段

當應用程式不再需要某個工作階段時,請將其刪除。刪除後,該工作階段會從 API 中移除。底層資料的清理作業可能會以非同步方式繼續執行。

刪除工作階段
# Replace the illustrative IDs and URLs below with your own resource values.

from openai import OpenAI


def delete_session(client: OpenAI, session_id: str):
    return client.beta.agents.sessions.delete(session_id)


if __name__ == "__main__":
    result = delete_session(OpenAI(), "sess_123")
    print(result.to_json())

若要停止目前的工作並保留對話,請取消進行中的回合。如需瞭解刪除工作階段時 API 會回傳哪些資料,請參閱刪除工作階段的 API 參考文件。