Bagikan melalui

Referensi pesan 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 pesan

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

Buat pesan.

Parameter jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas untuk membuat pesan.

Badan permintaan

Nama Tipe Wajib Deskripsi
role string Wajib Peran entitas yang membuat pesan. Bisa user atau assistant. user menunjukkan pesan dikirim oleh pengguna aktual dan harus digunakan dalam banyak kasus untuk mewakili pesan yang dihasilkan pengguna. assistant menunjukkan pesan dihasilkan oleh asisten. Gunakan nilai ini untuk menyisipkan pesan dari asisten ke dalam percakapan.
content string Wajib Konten pesan.
attachments array Opsional Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.
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.

Mengembalikan

Objek pesan .

Contoh membuat permintaan pesan

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")
    )

thread_message = client.beta.threads.messages.create(
  "thread_abc123",
  role="user",
  content="How does AI work? Explain it in simple terms.",
)
print(thread_message)

Mencantumkan pesan

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

Mengembalikan daftar pesan untuk utas tertentu.

Parameter Jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas tempat pesan berada.

Parameter Kueri:

Nama Tipe Wajib Deskripsi
limit Integer Opsional - Default ke 20 Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order string Opsional - Default ke desc Urutkan urutan menurut tanda waktu created_at objek. naik untuk urutan naik dan turun untuk urutan turun.
after string Opsional Kursor untuk digunakan dalam penomoran halaman. setelah adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
run_id string Optionanl Filter pesan menurut ID eksekusi yang menghasilkannya.
before string Opsional Kursor untuk digunakan dalam penomoran halaman. sebelumnya adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.

Mengembalikan

Daftar objek pesan .

Contoh permintaan pesan daftar

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")
    )

thread_messages = client.beta.threads.messages.list("thread_abc123")
print(thread_messages.data)

Mengambil pesan

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

Mengambil file pesan.

Parameter jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas tempat pesan berada.
message_id string Wajib ID pesan yang akan diambil.

Mengembalikan

Objek pesan yang cocok dengan ID yang ditentukan.

Contoh mengambil permintaan pesan

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")
    )

message = client.beta.threads.messages.retrieve(
  message_id="msg_abc123",
  thread_id="thread_abc123",
)
print(message)

Ubah pesan

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

Memodifikasi pesan.

Parameter jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas tempat pesan berada.
message_id string Wajib ID pesan yang akan diubah.

Badan permintaan

Parameter 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.

Mengembalikan

Objek pesan yang dimodifikasi.

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")
    )

message = client.beta.threads.messages.update(
  message_id="msg_abc12",
  thread_id="thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123",
  },
)
print(message)

Hapus pesan

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

Menghapus pesan.

Parameter jalur

Parameter Tipe Wajib Deskripsi
thread_id string Wajib ID utas tempat pesan berada.
message_id string Wajib ID pesan yang akan diubah.

Mengembalikan

Status penghapusan objek pesan .

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")
    )

deleted_message = client.beta.threads.messages.delete(
  message_id="msg_abc12",
  thread_id="thread_abc123",
)
print(deleted_message)

Objek pesan

Mewakili pesan dalam utas.

Nama Tipe Deskripsi
id string Pengidentifikasi, yang dapat dirujuk di titik akhir API.
object string Jenis objek, yang selalu thread.message.
created_at Integer Tanda waktu Unix (dalam detik) saat pesan dibuat.
thread_id string ID utas tempat pesan ini berada.
role string Entitas yang menghasilkan pesan. Salah satu dari user atau assistant.
content array Konten pesan dalam array teks dan/atau gambar.
assistant_id string atau null Jika berlaku, ID asisten yang menulis pesan ini.
run_id string atau null Jika berlaku, ID eksekusi yang terkait dengan penulisan pesan ini.
file_ids array Daftar ID file yang harus digunakan asisten. Berguna untuk alat seperti pengambilan dan code_interpreter yang dapat mengakses file. Maksimal 10 file dapat dilampirkan ke pesan.
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.