共用方式為

小幫手 API （預覽） 線程參考

  • 發行項

注意

  • 檔案搜尋 可以擷取每個助理最多 10,000 個檔案 - 比之前多 500 倍。 其速度很快，可透過多線程搜尋支援平行查詢，以及增強重新撰寫和查詢重寫的功能。
    • 向量存放區是 API 中的新物件。 一旦檔案新增至向量存放區，它就會自動剖析、區塊化和內嵌，準備好進行搜尋。 向量存放區可以跨助理和線程使用，簡化檔案管理和計費。
  • 我們已新增參數的支援 tool_choice ，可用來強制在特定執行中使用特定工具（例如檔案搜尋、程式代碼解釋器或函式）。

本文提供新小幫手 API 的 Python 和 REST 參考檔（預覽）。 入門指南提供 更深入的逐步指引。

建立執行緒

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-05-01-preview

建立線程。

要求本文

名稱 類型​​ 必要 描述
messages 陣列 選擇性 要用來啟動線程的訊息清單。
metadata map 選擇性 可附加至物件的16個索引鍵/值組集合。 這對於以結構化格式儲存物件的其他資訊很有用。 索引鍵長度上限為 64 個字元，且值長度上限為 512 個字元。

傳回

線程物件。

範例：建立線程要求

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

empty_thread = client.beta.threads.create()
print(empty_thread)

擷取

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

擷取線程。

路徑參數

參數 類型​ 必要 描述
thread_id 字串 必要 要擷取之線程的標識碼

傳回

符合指定標識碼的線程物件。

範例：擷取線程要求

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

修改線程

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

修改線程。

路徑參數

參數 類型​ 必要 描述
thread_id 字串 必要 要修改之線程的標識碼。

要求本文

名稱 類型​​ 必要 描述
中繼資料 map 選擇性 可附加至物件的16個索引鍵/值組集合。 這對於以結構化格式儲存物件的其他資訊很有用。 索引鍵長度上限為 64 個字元，且值長度上限為 512 個字元。

傳回

符合指定標識碼的修改 線程物件 。

範例：修改線程要求

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

刪除線程

DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

刪除線程。

路徑參數

參數 類型​ 必要 描述
thread_id 字串 必要 要刪除之線程的識別碼。

傳回

刪除狀態。

範例：刪除線程要求

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

response = client.beta.threads.delete("thread_abc123")
print(response)

Thread 物件

欄位 類型 描述
id 字串 標識碼，可在 API 端點中參考。
object 字串 物件類型，一律為線程。
created_at 整數 建立線程時的 Unix 時間戳（以秒為單位）。
metadata map 可附加至物件的16個索引鍵/值組集合。 這對於以結構化格式儲存物件的其他資訊很有用。 索引鍵長度上限為 64 個字元，且值長度上限為 512 個字元。