Assistants介紹

隨著OpenAI將Assistants助手API對外發佈，我們搭建個人知識庫變的如此簡單。開發者將自己的應用通過Assistants API與OpenAI對接，就可以讓每一位客戶擁有不一般體驗的個人知識庫。由於Assistants相關API有30+，本文只列舉完成一個最小功能閉環涉及的介面。關於Assistants的介紹，這裡借用官網的一張圖說明

Assistants Demo開發

以下只是介紹下如何開發一個簡單的助手Demo，針對每個步驟有詳細說明，感興趣的朋友可以參考自行實現客戶端。

• 1.上傳知識文件(File)，需要註意purpose參數需要設置為assistants，表示該文件用於助手。目前OpenAI官方要求單個文件不能超過512M。支持txt、pdf、docx、pptx、xlsx、csv、xml、json、java、c、python常見文件格式，並要求編碼格式為utf-8、utf-16、ascii其中的一種，詳情請查詢官網助手關於支持的文件類型的描述

curl --location --request POST 'https://gateway.ai.cloudflare.com/v1/2a2*****************60/******/openai/files' \
--header 'Authorization: Bearer sk-123' \
--form 'purpose="assistants"' \
--form 'file=@"C:\\Users\\admin\\Desktop\\三國演義（白話文版）.txt"'

• 2.創建助手(Assistants)，創建助手時需要指定助手名稱、提示詞、設置需要使用的工具、關聯的文件(目前每個助手限制最多20個文件，且單個文件不能超過2000000 tokens，如果文件比較多，建議合併後上傳)、以及使用的模型(本文選擇gpt-4-1106-preview)。本次示例中助手只開啟了工具中的檢索(Retrieval)功能，代碼解釋器(Code interpreter)和函數(Functions)未用到，後面有機會再聊。

curl --location --request POST 'https://gateway.ai.cloudflare.com/v1/2a26****************d560/*****/openai/assistants' \
--header 'Authorization: {{secretKey}}' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instructions": "您將擔任XY的高級內容分析師。XY是一位在小說創作領域具有豐富經驗的文學家。你的任務是基於XY上傳的小說，回答用戶問題，並提供深入見解。任務說明：1.當用戶提問時，仔細分析問題並基於XY上傳的小說給出回答;2.如果回答來自於上傳的小說，請提供小說的文件名稱;3.如果上傳的小說中沒有能回答用戶問題的參考內容，請直接回答\"我不知道\"。",
    "name": "內容分析師",
    "tools": [
        {
            "type": "retrieval"
        }
    ],
    "file_ids": [
        "file-0CocxG465dfsIUd4MKx0O8iG"
    ],
    "model": "gpt-4-1106-preview"
}'

• 3.創建線程(Thread)，您可以將線程理解為用戶與助手對話的上下文，它會記錄用戶與助手相互發送的message。

curl --location --request POST 'https://gateway.ai.cloudflare.com/v1/2a26**************d560/*****/openai/threads' \
--header 'Authorization: {{secretKey}}' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw ''

• 4.向助手發送信息(send message)，線程創建好之後，意味著當前用戶與助手對話的上下文已經建立完畢，用戶可以想助手發送消息了。由於線程會管理用戶與助手之間相互發送的message，所以每次用戶向助手發送消息時，只需要發送最新的message，而不必攜帶用戶發送的歷史消息，這樣邏輯更簡單，也節省tokens。

curl --location --request POST 'https://gateway.ai.cloudflare.com/v1/2a2*******************d560/******/openai/threads/thread_mAO9Gqfg4fdfgBVoMxOLXn/messages' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Authorization: {{secretKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "role": "user",
    "content": "你知道赤壁之戰嗎？"
}'

• 5.執行人機交互(Run)，消息發送完畢，是時候讓助手幹活了。關於Run的執行，裡面細節比較多，後面有機會聊。

curl --location --request POST 'https://gateway.ai.cloudflare.com/v1/2a265********************560/*****/openai/threads/thread_mAO9GqdfgdsfgerVoMxOLXn/runs' \
--header 'Authorization: {{secretKey}}' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "assistant_id": "asst_F4fnsdfgds42w9yJr2vZieb"
}'

• 6.查詢指定線程(Thread)下特定人機交互(Run)的執行狀態(status)。人機交互(Run)任務提交後，我們需要實時關註任務執行狀態，status狀態包括：queued、 in_progress、requires_action、cancelling、cancelled、failed、completed、expired。為了使Run狀態是最新的，你需要定時輪詢Run對象獲取最新的狀態。需要註意的是，如果Run處於completed狀態，標識當前人機交互(Run)已經執行完成，可以調用消息介面查詢助手返回的內容了。

curl --location --request GET 'https://gateway.ai.cloudflare.com/v1/2a26*******************d560/*****/openai/threads/thread_mAO9Gqmh4356fd7KBVoMxOLXn/runs/run_Nkx07ebg55LmUyJgx9' \
--header 'Authorization: {{secretKey}}' \
--header 'OpenAI-Beta: assistants=v1' \

• 7.查詢指定線程(Thread)的消息列表，返回的消息列表預設按時間降序排列，limit最大支持100。需要說明的是：Thread中可以存儲的message數量沒有限制，但是一旦message的大小超過模型的上下文視窗限制，Thread將嘗試包含儘可能多的適合上下文視窗的message並刪除最舊的message。

curl --location --request GET 'https://gateway.ai.cloudflare.com/v1/2a2*********************d560/******/openai/threads/thread_mAO9Gqm456fdYo7KBVoMxOLXn/messages?limit=20' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Authorization: {{secretKey}}' \

• 8.重覆步驟4、5、6、7，即可實現用戶與助手的多輪對話。本文中只介紹了介面調用的時序，至於具體實現有興趣的自己實現客戶端，這裡就不提供了。