Bagikan melalui

Referensi utas Assistants API (Pratinjau)

  • Artikel

Catatan

  • Pencarian file dapat menyerap hingga 10.000 file per asisten - 500 kali lebih banyak dari sebelumnya. Solusi ini cepat, mendukung kueri paralel melalui pencarian multi-utas, dan fitur pemeringkatan ulang dan penulisan ulang kueri yang ditingkatkan.
    • Penyimpanan vektor adalah objek baru di API. Setelah file ditambahkan ke penyimpanan vektor, file secara otomatis diurai, dipotong, dan disematkan, dibuat siap untuk dicari. Penyimpanan vektor dapat digunakan di seluruh asisten dan utas, menyederhanakan manajemen dan penagihan file.
  • Kami telah menambahkan dukungan untuk tool_choice parameter yang dapat digunakan untuk memaksa penggunaan alat tertentu (seperti pencarian file, penerjemah kode, atau fungsi) dalam eksekusi tertentu.

Artikel ini menyediakan dokumentasi referensi untuk Python dan REST untuk Assistants API (Pratinjau) baru. Panduan langkah demi langkah yang lebih mendalam disediakan dalam panduan memulai.

Membuat utas

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

Buat utas.

Badan permintaan

Nama Tipe Wajib Deskripsi
messages array Opsional Daftar pesan untuk memulai utas.
metadata peta Opsional Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.
tool_resources object Opsional Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.

properti tool_resources

code_interpreter

Nama Tipe Deskripsi Default
file_ids array Daftar ID file yang disediakan untuk alat code_interpreter. Mungkin ada maksimal 20 file yang terkait dengan alat ini. []

file_search

Nama Tipe Deskripsi Default
vector_store_ids array Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas. []
vector_stores array Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas. []

Mengembalikan

Objek utas.

Contoh: membuat permintaan utas

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

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

Mengambil utas

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

Mengambil utas.

Parameter jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas yang akan diambil

Mengembalikan

Objek utas yang cocok dengan ID yang ditentukan.

Contoh: mengambil permintaan utas

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

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

Ubah utas

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

Memodifikasi utas.

Parameter Jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas yang akan diubah.

Badan permintaan

Nama Tipe Wajib Deskripsi
metadata peta Opsional Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.
tool_resources object Opsional Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.

Mengembalikan

Objek utas yang dimodifikasi cocok dengan ID yang ditentukan.

Contoh: mengubah permintaan utas

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-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)

Menghapus utas

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

Menghapus utas.

Parameter Jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas yang akan dihapus.

Mengembalikan

Status penghapusan.

Contoh: menghapus permintaan utas

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)

Objek utas

Bidang Jenis Deskripsi
id string Pengidentifikasi, yang dapat dirujuk di titik akhir API.
object string Jenis objek, yang selalu utas.
created_at Integer Tanda waktu Unix (dalam detik) saat utas dibuat.
metadata peta Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.