Referensi pratinjau REST API Layanan Azure OpenAI

Artikel ini menyediakan detail tentang titik akhir REST API inferensi untuk Azure OpenAI.

Spesifikasi API

Mengelola dan berinteraksi dengan model dan sumber daya Azure OpenAI dibagi di tiga permukaan API utama:

• Sarana kontrol
• Bidang data - penulisan
• Bidang data - inferensi

Setiap permukaan/spesifikasi API merangkum serangkaian kemampuan Azure OpenAI yang berbeda. Setiap API memiliki serangkaian pratinjau uniknya sendiri dan rilis API stabil/tersedia secara umum (GA). Rilis pratinjau saat ini cenderung mengikuti irama bulanan.

API	Rilis pratinjau terbaru	Rilis GA terbaru	Spesifikasi	Deskripsi
Sarana kontrol	2024-06-01-preview	2024-10-01	File spesifikasi	Azure OpenAI berbagi sarana kontrol umum dengan semua Layanan Azure AI lainnya. API sarana kontrol digunakan untuk hal-hal seperti membuat sumber daya Azure OpenAI, penyebaran model, dan tugas manajemen sumber daya tingkat lebih tinggi lainnya. Sarana kontrol juga mengatur apa yang mungkin dilakukan dengan kemampuan seperti Azure Resource Manager, Bicep, Terraform, dan Azure CLI.
Bidang data - penulisan	2024-10-01-preview	2024-10-21	File spesifikasi	API penulisan sarana data mengontrol penyempurnaan, pengunggahan file, pekerjaan penyerapan, batch, dan kueri tingkat model tertentu
Bidang data - inferensi	2024-10-01-preview	2024-10-21	File spesifikasi	API inferensi bidang data menyediakan kemampuan/titik akhir inferensi untuk fitur seperti penyelesaian, penyelesaian obrolan, penyematan, ucapan/bisikan, pada data Anda, Dall-e, asisten, dll.

Autentikasi

Azure OpenAI menyediakan dua metode untuk autentikasi. Anda dapat menggunakan Kunci API atau ID Microsoft Entra.

• Autentikasi Kunci API: Untuk jenis autentikasi ini, semua permintaan API harus menyertakan Kunci API di api-key header HTTP. Mulai Cepat menyediakan panduan tentang cara melakukan panggilan dengan jenis autentikasi ini.

• Autentikasi ID Microsoft Entra: Anda dapat mengautentikasi panggilan API menggunakan token Microsoft Entra. Token autentikasi disertakan dalam permintaan sebagai header Authorization. Nilai token yang diberikan harus didahului dengan Bearer, contohnya Bearer YOUR_AUTH_TOKEN. Anda dapat membaca panduan cara mengautentikasi dengan MICROSOFT Entra ID.

Penerapan versi REST API

API layanan diterapkan versinya menggunakan parameter kueri api-version. Semua versi mengikuti struktur tanggal YYYY-MM-DD. Contohnya:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Inferensi sarana data

Sisa artikel mencakup rilis pratinjau terbaru dari spesifikasi inferensi sarana data Azure OpenAI, 2024-10-01-preview. Artikel ini mencakup dokumentasi untuk kemampuan pratinjau terbaru seperti asisten, utas, dan penyimpanan vektor.

Jika Anda mencari dokumentasi tentang rilis GA API terbaru, lihat API inferensi sarana data GA terbaru

Penyelesaian - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-01-preview

Membuat penyelesaian untuk perintah yang disediakan, parameter, dan model yang dipilih.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string atau array	Perintah untuk menghasilkan penyelesaian untuk, dikodekan sebagai string, array string, array token, atau array array token. Perhatikan bahwa <|endoftext|> adalah pemisah dokumen yang dilihat model selama pelatihan, jadi jika permintaan tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Ya
best_of	Integer	best_of Menghasilkan sisi server penyelesaian dan mengembalikan "terbaik" (yang dengan probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Ketika digunakan dengan n, best_of mengontrol jumlah penyelesaian kandidat dan n menentukan berapa banyak untuk mengembalikan â€" best_of harus lebih besar dari n. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
echo	Boolean	Gema mengembalikan perintah selain penyelesaian	No	Salah
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer GPT) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan. Sebagai contoh, Anda dapat meneruskan {"50256": -100} untuk mencegah <token |endoftext|> dihasilkan.	No	Tidak
logprobs	Integer	Sertakan probabilitas log pada logprobs token output yang paling mungkin, serta token yang dipilih. Misalnya, jika logprobs adalah 5, API akan mengembalikan daftar lima token yang paling mungkin. API akan selalu mengembalikan logprob token sampel, sehingga mungkin ada hingga logprobs+1 elemen dalam respons. Nilai maksimum untuk logprobs adalah 5.	No	Tidak
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah max_tokens tidak dapat melebihi panjang konteks model.	No	16
n	Integer	Berapa banyak penyelesaian yang dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
seed	Integer	Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	No
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	No
stream	Boolean	Apakah akan kembali melakukan streaming pada kemajuan parsial. Jika diatur, token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan streaming dihentikan oleh pesandata: [DONE].	No	Salah
Akhiran	string	Akhiran yang muncul setelah penyelesaian teks yang disisipkan. Parameter ini hanya didukung untuk gpt-3.5-turbo-instruct.	No	Tidak
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	createCompletionResponse	Mewakili respons penyelesaian dari API. Catatan: objek respons yang dialirkan dan tidak dialirkan memiliki bentuk yang sama (tidak seperti titik akhir obrolan).

Kode Status: default

Deskripsi: Layanan tidak tersedia

Tipe-Konten	Jenis	Keterangan
application/json	errorResponse

Contoh

Contoh

Membuat penyelesaian untuk perintah yang disediakan, parameter, dan model yang dipilih.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Respons: Kode Status: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Penyematan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-01-preview

Dapatkan representasi vektor dari input tertentu yang dapat dengan mudah dikonsumsi oleh model dan algoritma pembelajaran mesin.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
input	string atau array	Masukkan teks untuk disematkan, dikodekan sebagai string atau array token. Untuk menyematkan beberapa input dalam satu permintaan, berikan array string atau array array token. Input tidak boleh melebihi token input maksimum untuk model (8.192 token untuk text-embedding-ada-002), tidak boleh berupa string kosong, dan array apa pun harus 2.048 dimensi atau kurang.	Ya
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
input_type	string	jenis input pencarian penyematan yang akan digunakan	No
encoding_format	string	Format untuk mengembalikan penyematan. Dapat berupa float atau base64. Default ke float.	No
ukuran	Integer	Jumlah dimensi yang harus dimiliki penyematan output yang dihasilkan. Hanya didukung dalam text-embedding-3 model dan yang lebih baru.	No

Respons

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
model	string		Ya
data	array		Ya
penggunaan	object		Ya

Properti untuk penggunaan

prompt_tokens

Nama	Tipe	Deskripsi	Default
prompt_tokens	Integer

total_tokens

Nama	Tipe	Deskripsi	Default
total_tokens	Integer

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	object

Contoh

Contoh

Mengembalikan penyematan untuk perintah tertentu.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-01-preview

{
 "input": [
  "this is a test"
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Penyelesaian obrolan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

Membuat penyelesaian untuk pesan obrolan

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesandata: [DONE].	No	Salah
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	No
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran. Ini hanya didukung dalam model seri o1. Akan memperluas dukungan ke model lain dalam rilis API mendatang.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	No	Tidak
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
data_sources	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	No
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika true, mengembalikan probabilitas log dari setiap token output yang content dikembalikan di dari message.	No	Salah
top_logprobs	Integer	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. logprobs harus diatur ke true jika parameter ini digunakan.	No
n	Integer	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Perhatikan bahwa Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. 1 Pertahankan n untuk meminimalkan biaya.	No	1
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	ResponseFormatText atau ResponseFormatJsonObject atau ResponseFormatJsonSchema	Objek yang menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4o mini, GPT-4 Turbo dan semua model GPT-3.5 Turbo yang lebih baru dari gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang menjamin model akan cocok dengan skema JSON yang Anda berikan. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No
seed	Integer	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	No
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	No	Tidak
alat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan model input JSON. Maksimal 128 fungsi didukung.	No
tool_choice	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi demi tool_choice. Mengontrol fungsi (jika ada) mana yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. none adalah default ketika tidak ada fungsi yang ada. auto adalah default jika fungsi ada.	No
fungsi	array	Tidak digunakan lagi demi tools. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	createChatCompletionResponse atau createChatCompletionStreamResponse

Kode Status: default

Deskripsi: Layanan tidak tersedia

Tipe-Konten	Jenis	Keterangan
application/json	errorResponse

Contoh

Contoh

Membuat penyelesaian untuk perintah yang disediakan, parameter, dan model yang dipilih.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian berdasarkan data Azure Search dan identitas terkelola yang ditetapkan sistem.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian berdasarkan data vektor gambar Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian berdasarkan data vektor Azure Search, pesan asisten sebelumnya, dan identitas terkelola yang ditetapkan pengguna.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian untuk Azure Cosmos DB yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian untuk Mongo DB yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian untuk Elasticsearch yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian untuk sumber daya Pinecone yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkripsi - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview

Mentranskripsikan audio ke dalam bahasa input.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model bisikan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	Objek file audio yang akan ditranskripsikan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	No	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No
timestamp_granularities[]	array	Granularitas tanda waktu untuk mengisi transkripsi ini. response_format harus diatur verbose_json untuk menggunakan granularitas tanda waktu. Salah satu atau kedua opsi ini didukung: word, atau segment. Catatan: Tidak ada latensi tambahan untuk tanda waktu segmen, tetapi menghasilkan tanda waktu kata menimbulkan latensi tambahan.	No	['segmen']

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	audioResponse atau audioVerboseResponse
text/plain	string	Teks yang ditranskripsikan dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Contoh

Contoh

Mendapatkan teks yang ditranskripsikan dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Contoh

Mendapatkan teks yang ditranskripsikan dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Terjemahan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview

Mentranskripsikan dan terjemahkan audio input ke dalam teks bahasa Inggris.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model bisikan yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	File audio yang akan diterjemahkan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	No	0

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	audioResponse atau audioVerboseResponse
text/plain	string	Teks yang ditranskripsikan dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Contoh

Contoh

Mendapatkan teks yang ditranskripsikan bahasa Inggris dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Contoh

Mendapatkan teks yang ditranskripsikan bahasa Inggris dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Ucapan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

Menghasilkan audio dari teks input.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model tts yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Wajib diisi	Default
input	string	Teks yang akan disintesis audio. Panjang maksimum adalah 4.096 karakter.	Ya
Suara	enum	Suara yang digunakan untuk sintesis ucapan. Nilai yang mungkin: paduan, echo, fable, onyx, nova, shimmer	Ya
response_format	enum	Format untuk mensintesis audio masuk. Nilai yang mungkin: mp3, opus, aac, flac, wav, pcm	No
kecepatan	number	Kecepatan audio yang disintesis. Pilih nilai dari 0.25 ke 4.0. 1.0 adalah defaultnya.	No	1.0

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/octet-stream	string

Contoh

Contoh

Mensintesis audio dari teks yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Respons: Kode Status: 200

{
  "body": "101010101"
}

Pembuatan gambar - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-01-preview

Menghasilkan batch gambar dari keterangan teks pada penyebaran model DALLE tertentu

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
deployment-id	jalan	Ya	string	Id penyebaran model dalle yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Ya
n	Integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024 x 1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	No	url
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	No	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	No	Jelas

Respons

Kode Status: 200

Deskripsi: Ok

Tipe-Konten	Jenis	Keterangan
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Tipe-Konten	Jenis	Keterangan
application/json	dalleErrorResponse

Contoh

Contoh

Membuat gambar yang diberi perintah.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Respons: Kode Status: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Daftar - Asisten

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Mengembalikan daftar asisten.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listAssistantsResponse

Contoh

Contoh

Mengembalikan daftar asisten.

GET https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Buat - Asisten

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

Buat asisten dengan model dan instruksi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
model			Ya
nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	No
description	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	No
petunjuk	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	No
alat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	No	[]
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID file yang disediakan untuk alat ini 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 asisten ini. Mungkin ada maksimal satu penyimpanan vektor yang terpasang pada asisten.
vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke asisten ini. Mungkin ada maksimal satu penyimpanan vektor yang terpasang pada asisten.

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	assistantObject	Mewakili yang assistant dapat memanggil model dan menggunakan alat.

Contoh

Contoh

Buat asisten dengan model dan instruksi.

POST https://{endpoint}/openai/assistants?api-version=2024-10-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Dapatkan - Asisten

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Mengambil asisten.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
assistant_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	assistantObject	Mewakili yang assistant dapat memanggil model dan menggunakan alat.

Contoh

Contoh

Mengambil asisten.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modifikasi - Asisten

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Memodifikasi asisten.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
assistant_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
model			No
nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	No
description	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	No
petunjuk	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 32.768 karakter.	No
alat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	No	[]
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Mengambil alih daftar ID file yang tersedia untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	[]

file_search

Nama	Tipe	Deskripsi	Default
vector_store_ids	array	Mengambil alih penyimpanan vektor yang terpasang pada asisten ini. Mungkin ada maksimal satu penyimpanan vektor yang terpasang pada asisten.

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	assistantObject	Mewakili yang assistant dapat memanggil model dan menggunakan alat.

Contoh

Contoh

Memodifikasi asisten.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Hapus - Asisten

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Menghapus asisten.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
assistant_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	deleteAssistantResponse

Contoh

Contoh

Menghapus asisten.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Buat - Utas

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

Buat utas.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
pesan	array	Daftar pesan untuk memulai utas.	No
tool_resources	object	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.	No
metadata	object	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.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID file yang disediakan untuk alat ini 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 satu penyimpanan vektor yang terpasang pada utas.

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	threadObject	Mewakili utas yang berisi pesan.

Contoh

Contoh

Membuat utas.

POST https://{endpoint}/openai/threads?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Dapatkan - Utas

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Mengambil utas.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	threadObject	Mewakili utas yang berisi pesan.

Contoh

Contoh

Mengambil utas.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modifikasi - Utas

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Memodifikasi utas.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_resources	object	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.	No
metadata	object	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.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID File yang disediakan untuk alat ini 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 satu penyimpanan vektor yang terpasang pada utas.

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	threadObject	Mewakili utas yang berisi pesan.

Contoh

Contoh

Memodifikasi utas.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Hapus - Utas

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Menghapus utas.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	deleteThreadResponse

Contoh

Contoh

Menghapus utas.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Daftar - Pesan

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Mengembalikan daftar pesan untuk utas tertentu.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
run_id	pertanyaan	No	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listMessagesResponse

Contoh

Contoh

Daftar Pesan

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Buat - Pesan

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

Buat pesan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	string	Peran entitas yang membuat pesan. Nilai yang diizinkan meliputi: - 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.	Ya
konten	string	Konten pesan.	Ya
Lampiran	array	Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.	No
metadata	object	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.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	messageObject	Mewakili pesan dalam utas.

Contoh

Contoh

Buat pesan.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Get - Message

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Mengambil pesan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
message_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	messageObject	Mewakili pesan dalam utas.

Contoh

Contoh

Mengambil pesan.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Ubah - Pesan

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

Memodifikasi pesan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
message_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
metadata	object	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.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	messageObject	Mewakili pesan dalam utas.

Contoh

Contoh

Mengubah pesan.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Buat - Utas Dan Jalankan

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

Buat utas dan jalankan dalam satu permintaan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Ya
rangkaian	createThreadRequest		No
model	string	Nama penyebaran model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	No
petunjuk	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
alat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	No	Tidak
max_prompt_tokens	Integer	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
max_completion_tokens	Integer	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	No
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	No
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

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

file_search

Nama	Tipe	Deskripsi	Default
vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Mungkin ada maksimal satu penyimpanan vektor yang terpasang pada asisten.

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Buat utas dan jalankan dalam satu permintaan.

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Daftar - Berjalan

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Mengembalikan daftar eksekusi milik utas.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listRunsResponse

Contoh

Contoh

Mengembalikan daftar eksekusi milik utas.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Buat - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

Buat eksekusi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Ya
model	string	ID Model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	No
petunjuk	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
additional_instructions	string	Menambahkan instruksi tambahan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.	No
additional_messages	array	Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.	No
alat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No
max_prompt_tokens	Integer	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
max_completion_tokens	Integer	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	No
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	No
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Buat eksekusi.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-01-preview

{
 "assistant_id": "asst_abc123"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Dapatkan - Jalankan

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Mengambil eksekusi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Mendapatkan eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modifikasi - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

Memodifikasi eksekusi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
metadata	object	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.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Memodifikasi eksekusi.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Kirim - Output Alat Untuk Dijalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

Ketika eksekusi memiliki status: "requires_action" dan required_action.type adalah submit_tool_outputs, titik akhir ini dapat digunakan untuk mengirimkan output dari panggilan alat setelah semuanya selesai. Semua output harus dikirimkan dalam satu permintaan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_outputs	array	Daftar alat yang outputnya sedang dikirimkan.	Ya
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Ketika eksekusi memiliki status: "requires_action" dan required_action.type adalah submit_tool_outputs, titik akhir ini dapat digunakan untuk mengirimkan output dari panggilan alat setelah semuanya selesai. Semua output harus dikirimkan dalam satu permintaan.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Batal - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

Membatalkan eksekusi yaitu in_progress.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runObject	Mewakili eksekusi yang dijalankan pada utas.

Contoh

Contoh

Membatalkan eksekusi yaitu in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Daftar - Jalankan Langkah

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

Mengembalikan daftar langkah eksekusi milik eksekusi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listRunStepsResponse

Contoh

Contoh

Mengembalikan daftar langkah eksekusi milik eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Dapatkan - Jalankan Langkah

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

Mengambil langkah eksekusi.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
thread_id	jalan	Ya	string
run_id	jalan	Ya	string
step_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	runStepObject	Mewakili langkah dalam eksekusi eksekusi.

Contoh

Contoh

Mengambil langkah eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Daftar - Toko Vektor

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Mengembalikan daftar penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listVectorStoresResponse

Contoh

Contoh

Mengembalikan daftar penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Buat - Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Buat penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_ids	array	Daftar ID file yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	No
nama	string	Nama toko vektor.	No
expires_after	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	No
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak ada.	No
metadata	object	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.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreObject	Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search

Contoh

Contoh

Membuat penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Mengambil penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreObject	Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search

Contoh

Contoh

Mengambil penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modifikasi - Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Memodifikasi penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama toko vektor.	No
expires_after	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	No
metadata	object	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.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreObject	Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search

Contoh

Contoh

Memodifikasi penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

{
 "name": "Support FAQ"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Hapus - Penyimpanan Vektor

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Menghapus penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	deleteVectorStoreResponse

Contoh

Contoh

Menghapus penyimpanan vektor.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Daftar - File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Mengembalikan daftar file penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
filter	pertanyaan	No	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listVectorStoreFilesResponse

Contoh

Contoh

Mengembalikan daftar file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Buat - File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

Buat file penyimpanan vektor dengan melampirkan File ke penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_id	string	ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	Ya
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreFileObject	Daftar file yang dilampirkan ke penyimpanan vektor.

Contoh

Contoh

Buat file penyimpanan vektor dengan melampirkan File ke penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-01-preview

{
 "file_id": "file-abc123"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Mengambil file penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
file_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreFileObject	Daftar file yang dilampirkan ke penyimpanan vektor.

Contoh

Contoh

Mengambil file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Hapus - File Penyimpanan Vektor

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Menghapus file penyimpanan vektor. Ini akan menghapus file dari penyimpanan vektor tetapi file itu sendiri tidak akan dihapus. Untuk menghapus file, gunakan titik akhir file penghapusan.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
file_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	deleteVectorStoreFileResponse

Contoh

Contoh

Menghapus file penyimpanan vektor. Ini akan menghapus file dari penyimpanan vektor tetapi file itu sendiri tidak akan dihapus. Untuk menghapus file, gunakan titik akhir file penghapusan.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Buat - Batch File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

Buat batch file penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_ids	array	Daftar ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	Ya
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreFileBatchObject	Batch file yang dilampirkan ke penyimpanan vektor.

Contoh

Contoh

Buat batch file penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Respons: Kode Status: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - Vector Store File Batch

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

Mengambil batch file penyimpanan vektor.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
batch_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreFileBatchObject	Batch file yang dilampirkan ke penyimpanan vektor.

Contoh

Contoh

Mengambil batch file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Batal - Batch File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

Batalkan batch file penyimpanan vektor. Upaya ini untuk membatalkan pemrosesan file dalam batch ini sesegera mungkin.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
batch_id	jalan	Ya	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	vectorStoreFileBatchObject	Batch file yang dilampirkan ke penyimpanan vektor.

Contoh

Contoh

Batalkan batch file penyimpanan vektor. Upaya ini untuk membatalkan pemrosesan file dalam batch ini sesegera mungkin.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Daftar - File Batch File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

Mengembalikan daftar file penyimpanan vektor dalam batch.

Parameter URI

Nama	Dalam	Wajib	Tipe	Deskripsi
titik akhir	jalan	Ya	string url	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
vector_store_id	jalan	Ya	string
batch_id	jalan	Ya	string
batas	pertanyaan	No	Integer
urutan	pertanyaan	No	string
setelah	pertanyaan	No	string
sebelumnya	pertanyaan	No	string
filter	pertanyaan	No	string
versi-api	pertanyaan	Ya	string

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	listVectorStoreFilesResponse

Contoh

Contoh

Mengembalikan daftar file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Komponen

errorResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
kesalahan	kesalahan		No

errorBase

Nama	Tipe	Deskripsi	Wajib diisi	Default
kode	string		No
pesan	string		No

kesalahan

Nama	Tipe	Deskripsi	Wajib diisi	Default
param	string		No
jenis	string		No
inner_error	innerError	Kesalahan dalam dengan detail tambahan.	No

innerError

Kesalahan dalam dengan detail tambahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

innerErrorCode

Kode kesalahan untuk objek kesalahan dalam.

Deskripsi: Kode kesalahan untuk objek kesalahan dalam.

Jenis: string

Default:

Nama Enum: InnerErrorCode

Nilai Enum:

Nilai	Deskripsi
ResponsibleAIPolicyViolation	Perintah melanggar salah satu aturan filter konten lainnya.

dalleErrorResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
kesalahan	dalleError		No

dalleError

Nama	Tipe	Deskripsi	Wajib diisi	Default
param	string		No
jenis	string		No
inner_error	dalleInnerError	Kesalahan dalam dengan detail tambahan.	No

dalleInnerError

Kesalahan dalam dengan detail tambahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No
revised_prompt	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	No

contentFilterCompletionTextSpan

Menjelaskan rentang dalam teks penyelesaian yang dihasilkan. Offset 0 adalah titik kode UTF32 pertama dari teks penyelesaian.

Nama	Tipe	Deskripsi	Wajib diisi	Default
completion_start_offset	Integer	Offset titik kode UTF32 yang memulai rentang.	Ya
completion_end_offset	Integer	Offset titik kode UTF32 pertama yang dikecualikan dari rentang. Bidang ini selalu sama dengan completion_start_offset untuk rentang kosong. Bidang ini selalu lebih besar dari completion_start_offset untuk rentang yang tidak ada.	Ya

contentFilterResultBase

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya

contentFilterSeverityResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
keparahan	string		No

contentFilterDetectedResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
terdeteksi	Boolean		No

contentFilterDetectedWithCitationResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
kutipan	object		No

Properti untuk kutipan

URL

Nama	Tipe	Deskripsi	Default
URL	string

lisensi

Nama	Tipe	Deskripsi	Default
lisensi	string

contentFilterDetectedWithCompletionTextSpansResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
detail	array		No

contentFilterIdResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
id	string		No

contentFilterResultsBase

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Deskripsi	Wajib diisi	Default
seksual	contentFilterSeverityResult		No
kekerasan	contentFilterSeverityResult		No
benci	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
Senonoh	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	No
kesalahan	errorBase		No

contentFilterPromptResults

Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Deskripsi	Wajib diisi	Default
seksual	contentFilterSeverityResult		No
kekerasan	contentFilterSeverityResult		No
benci	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
Senonoh	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	No
kesalahan	errorBase		No
Jailbreak	contentFilterDetectedResult		No
indirect_attack	contentFilterDetectedResult		No

contentFilterChoiceResults

Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang teks pihak ketiga dan kata-kata kocak, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Deskripsi	Wajib diisi	Default
seksual	contentFilterSeverityResult		No
kekerasan	contentFilterSeverityResult		No
benci	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
Senonoh	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	No
kesalahan	errorBase		No
protected_material_text	contentFilterDetectedResult		No
protected_material_code	contentFilterDetectedWithCitationResult		No
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		No

contentFilterDetailedResults

Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
detail	array		No

promptFilterResult

Hasil pemfilteran konten untuk satu permintaan dalam permintaan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
prompt_index	Integer		No
content_filter_results	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

promptFilterResults

Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.

Tidak ada properti yang ditentukan untuk komponen ini.

dalleContentFilterResults

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Deskripsi	Wajib diisi	Default
seksual	contentFilterSeverityResult		No
kekerasan	contentFilterSeverityResult		No
benci	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No

dalleFilterResults

Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Deskripsi	Wajib diisi	Default
seksual	contentFilterSeverityResult		No
kekerasan	contentFilterSeverityResult		No
benci	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
Senonoh	contentFilterDetectedResult		No
Jailbreak	contentFilterDetectedResult		No
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	No

chatCompletionsRequestCommon

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan data: [DONE] .	No	Salah
stop	string atau array	Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang diizinkan untuk jawaban yang dihasilkan. Secara default, jumlah token yang dapat dikembalikan model adalah (4096 - token prompt). Ini tidak kompatibel dengan model seri o1.	No	4096
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran. Ini hanya didukung dalam model seri o1. Akan memperluas dukungan ke model lain dalam rilis API mendatang.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek json yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	No
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu Azure OpenAI memantau dan mendeteksi penyalahgunaan.	No

createCompletionRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string atau array	Perintah untuk menghasilkan penyelesaian untuk, dikodekan sebagai string, array string, array token, atau array array token. Perhatikan bahwa <|endoftext|> adalah pemisah dokumen yang dilihat model selama pelatihan, jadi jika permintaan tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Ya
best_of	Integer	best_of Menghasilkan sisi server penyelesaian dan mengembalikan "terbaik" (yang dengan probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Ketika digunakan dengan n, best_of mengontrol jumlah penyelesaian kandidat dan n menentukan berapa banyak untuk mengembalikan â€" best_of harus lebih besar dari n. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
echo	Boolean	Gema mengembalikan perintah selain penyelesaian	No	Salah
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer GPT) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan. Sebagai contoh, Anda dapat meneruskan {"50256": -100} untuk mencegah <token |endoftext|> dihasilkan.	No	Tidak
logprobs	Integer	Sertakan probabilitas log pada logprobs token output yang paling mungkin, serta token yang dipilih. Misalnya, jika logprobs adalah 5, API akan mengembalikan daftar 5 token yang paling mungkin. API akan selalu mengembalikan logprob token sampel, sehingga mungkin ada hingga logprobs+1 elemen dalam respons. Nilai maksimum untuk logprobs adalah 5.	No	Tidak
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah max_tokens tidak dapat melebihi panjang konteks model.	No	16
n	Integer	Berapa banyak penyelesaian yang dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
seed	Integer	Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	No
stop	string atau array	Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	No
stream	Boolean	Apakah akan kembali melakukan streaming pada kemajuan parsial. Jika diatur, token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan streaming dihentikan oleh pesandata: [DONE].	No	Salah
Akhiran	string	Akhiran yang muncul setelah penyelesaian teks yang disisipkan. Parameter ini hanya didukung untuk gpt-3.5-turbo-instruct.	No	Tidak
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No

createCompletionResponse

Mewakili respons penyelesaian dari API. Catatan: objek respons yang dialirkan dan tidak dialirkan memiliki bentuk yang sama (tidak seperti titik akhir obrolan).

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi unik untuk penyelesaian.	Ya
Pilihan	array	Daftar pilihan penyelesaian model yang dihasilkan untuk perintah input.	Ya
Dibuat	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian dibuat.	Ya
model	string	Model yang digunakan untuk penyelesaian.	Ya
prompt_filter_results	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	No
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	No
object	enum	Jenis objek, yang selalu "text_completion" Nilai yang mungkin: text_completion	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian.	No

createChatCompletionRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesandata: [DONE].	No	Salah
stop	string atau array	Hingga 4 urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	No
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran. Ini hanya didukung dalam model seri o1. Akan memperluas dukungan ke model lain dalam rilis API mendatang.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	No	Tidak
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
data_sources	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	No
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika true, mengembalikan probabilitas log dari setiap token output yang content dikembalikan di dari message.	No	Salah
top_logprobs	Integer	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. logprobs harus diatur ke true jika parameter ini digunakan.	No
n	Integer	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Perhatikan bahwa Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. 1 Pertahankan n untuk meminimalkan biaya.	No	1
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	ResponseFormatText atau ResponseFormatJsonObject atau ResponseFormatJsonSchema	Objek yang menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4o mini, GPT-4 Turbo dan semua model GPT-3.5 Turbo yang lebih baru dari gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang menjamin model akan cocok dengan skema JSON yang Anda berikan. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No
seed	Integer	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama seed dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	No
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	No	Tidak
alat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan model input JSON. Maksimal 128 fungsi didukung.	No
tool_choice	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi demi tool_choice. Mengontrol fungsi (jika ada) mana yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. none adalah default ketika tidak ada fungsi yang ada. auto adalah default jika fungsi ada.	No
fungsi	array	Tidak digunakan lagi demi tools. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	No

chatCompletionFunctions

Nama	Tipe	Deskripsi	Wajib diisi	Default
description	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	No
nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Ya
parameter	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan](/azure/ai-services/openai/how-to/function-calling) misalnya, dan referensi Skema JSON untuk dokumentasi tentang format. Menghilangkan mendefinisikan parameters fungsi dengan daftar parameter kosong.	No

chatCompletionFunctionCallOption

Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut.

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama fungsi yang akan dipanggil.	Ya

chatCompletionFunctionParameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan/ misalnya, dan referensi Skema JSON untuk dokumentasi tentang format.

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionRequestMessage

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestSystemMessage

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string atau array	Isi pesan sistem.	Ya
role	enum	Peran penulis pesan, dalam hal systemini . Nilai yang mungkin: sistem	Ya
nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	No

chatCompletionRequestUserMessage

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string atau array	Konten pesan pengguna.	Ya
role	enum	Peran penulis pesan, dalam hal userini . Nilai yang mungkin: pengguna	Ya
nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	No

chatCompletionRequestAssistantMessage

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string atau array	Isi pesan asisten. Diperlukan kecuali tool_calls atau function_call ditentukan.	No
penolakan	string	Pesan penolakan oleh asisten.	No
role	enum	Peran penulis pesan, dalam hal assistantini . Nilai yang mungkin: asisten	Ya
nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	No
tool_calls	chatCompletionMessageToolCalls	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	No
function_call	object	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

chatCompletionRequestToolMessage

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	enum	Peran penulis pesan, dalam hal toolini . Nilai yang mungkin: alat	Ya
konten	string atau array	Isi pesan alat.	Ya
tool_call_id	string	Panggilan alat yang direspons pesan ini.	Ya

chatCompletionRequestFunctionMessage

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	enum	Peran penulis pesan, dalam hal functionini . Nilai yang mungkin: fungsi	Ya
konten	string	Isi pesan fungsi.	Ya
nama	string	Nama fungsi yang akan dipanggil.	Ya

chatCompletionRequestSystemMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestUserMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestAssistantMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestToolMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestMessageContentPartText

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: teks	Ya
text	string	Isi teks.	Ya

chatCompletionRequestMessageContentPartImage

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: image_url	Ya
image_url	object		Ya

Properti untuk image_url

url

Nama	Tipe	Deskripsi	Default
url	string	Baik URL gambar atau data gambar yang dikodekan base64.

detail

Nama	Tipe	Deskripsi	Default
detail	string	Menentukan tingkat detail gambar. Pelajari lebih lanjut di panduan Visi.	auto

chatCompletionRequestMessageContentPartRefusal

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: penolakan	Ya
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Ya

azureChatExtensionConfiguration

Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya

azureChatExtensionType

Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.

Deskripsi: Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan
permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons.
Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.

Jenis: string

Default:

Nama Enum: AzureChatExtensionType

Nilai Enum:

Nilai	Deskripsi
azure_search	Mewakili penggunaan Azure Search sebagai ekstensi obrolan Azure OpenAI.
azure_cosmos_db	Mewakili penggunaan Azure Cosmos DB sebagai ekstensi obrolan Azure OpenAI.
elasticsearch	Mewakili penggunaan indeks Elasticsearch® sebagai ekstensi obrolan Azure OpenAI.
mongo_db	Mewakili penggunaan Mongo DB sebagai ekstensi obrolan Azure OpenAI.
pinecone	Mewakili penggunaan indeks Pinecone sebagai ekstensi obrolan Azure OpenAI.

azureSearchChatExtensionConfiguration

Representasi tertentu dari opsi yang dapat dikonfigurasi untuk Azure Search saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	azureSearchChatExtensionParameters	Parameter untuk Azure Search saat digunakan sebagai ekstensi obrolan Azure OpenAI.	No

azureSearchChatExtensionParameters

Parameter untuk Azure Search saat digunakan sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataSystemAssignedManagedIdentityAuthenticationOptions atau onYourDataUserAssignedManagedIdentityAuthenticationOptions atau onYourDataAccessTokenAuthenticationOptions		Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
max_search_queries	Integer	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	No
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	No	Salah
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
titik akhir	string	Jalur titik akhir absolut untuk digunakan sumber daya Azure Search.	Ya
index_name	string	Nama indeks yang akan digunakan sebagai tersedia di sumber daya Azure Search yang dirujuk.	Ya
fields_mapping	azureSearchIndexFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.	No
query_type	azureSearchQueryType	Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.	No
semantic_configuration	string	Konfigurasi semantik tambahan untuk kueri.	No
filter	string	Filter pencarian.	No
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource atau onYourDataIntegratedVectorizationSource		No
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	No

azureSearchIndexFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	No
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	No
image_vector_fields	array	Nama bidang yang mewakili data vektor gambar.	No

azureSearchQueryType

Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Deskripsi: Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Jenis: string

Default:

Nama Enum: AzureSearchQueryType

Nilai Enum:

Nilai	Deskripsi
sederhana	Mewakili pengurai kueri sederhana default.
semantik	Mewakili pengurai kueri semantik untuk pemodelan semantik tingkat lanjut.
Vektor	Mewakili pencarian vektor atas data komputasi.
vector_simple_hybrid	Mewakili kombinasi strategi kueri sederhana dengan data vektor.
vector_semantic_hybrid	Mewakili kombinasi pencarian semantik dan kueri data vektor.

azureCosmosDBChatExtensionConfiguration

Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Azure Cosmos DB saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	azureCosmosDBChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Azure Cosmos DB untuk MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Azure Cosmos DB untuk MongoDB vCore.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Autentikasi	onYourDataConnectionStringAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.	Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
max_search_queries	Integer	Jumlah maksimum kueri yang ditulis ulang yang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	No
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	No	Salah
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
database_name	string	Nama database MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
container_name	string	Nama kontainer sumber daya Azure Cosmos DB.	Ya
index_name	string	Nama indeks MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
fields_mapping	azureCosmosDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.	Ya
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Ya
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	No

azureCosmosDBFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Ya
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	Ya

elasticsearchChatExtensionConfiguration

Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Elasticsearch saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	elasticsearchChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi Elasticsearch® sebagai ekstensi obrolan Azure OpenAI.	No

elasticsearchChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi Elasticsearch® sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Autentikasi	onYourDataKeyAndKeyIdAuthenticationOptions atau onYourDataEncodedApiKeyAuthenticationOptions		Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
max_search_queries	Integer	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	No
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	No	Salah
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
titik akhir	string	Titik akhir Elasticsearch®.	Ya
index_name	string	Nama indeks Elasticsearch®.	Ya
fields_mapping	elasticsearchIndexFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch® yang dikonfigurasi.	No
query_type	elasticsearchQueryType	Jenis kueri pengambilan Elasticsearch® yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.	No
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource atau onYourDataModelIdVectorizationSource		No
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	No

elasticsearchIndexFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch® yang dikonfigurasi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	No
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	No

elasticsearchQueryType

Jenis kueri pengambilan Elasticsearch® yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Deskripsi: Jenis kueri pengambilan Elasticsearch® yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Jenis: string

Default:

Nama Enum: ElasticsearchQueryType

Nilai Enum:

Nilai	Deskripsi
sederhana	Mewakili pengurai kueri sederhana default.
Vektor	Mewakili pencarian vektor atas data komputasi.

mongoDBChatExtensionConfiguration

Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Mongo DB saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	mongoDBChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Mongo DB.	No

mongoDBChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Mongo DB.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Autentikasi	onYourDataUsernameAndPasswordAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan nama pengguna dan kata sandi.	Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
max_search_queries	Integer	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	No
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	No	Salah
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
titik akhir	string	Nama titik akhir kluster Mongo DB.	Ya
database_name	string	Nama database Mongo DB.	Ya
collection_name	string	Nama Koleksi Mongo DB.	Ya
app_name	string	Nama Aplikasi Mongo DB.	Ya
index_name	string	Nama indeks Mongo DB.	Ya
fields_mapping	mongoDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Mongo DB yang dikonfigurasi.	Ya
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Ya
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	No

mongoDBFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Mongo DB yang dikonfigurasi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Ya
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	Ya

pineconeChatExtensionConfiguration

Representasi tertentu dari opsi yang dapat dikonfigurasi untuk Pinecone saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	pineconeChatExtensionParameters	Parameter untuk mengonfigurasi ekstensi obrolan Azure OpenAI Pinecone.	No

pineconeChatExtensionParameters

Parameter untuk mengonfigurasi ekstensi obrolan Azure OpenAI Pinecone.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Autentikasi	onYourDataApiKeyAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.	Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
max_search_queries	Integer	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	No
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	No	Salah
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
lingkungan	string	Nama lingkungan Pinecone.	Ya
index_name	string	Nama indeks database Pinecone.	Ya
fields_mapping	pineconeFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Pinecone yang dikonfigurasi.	Ya
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Detail sumber vektorisasi, yang digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada nama penyebaran model penyematan internal di sumber daya Azure OpenAI yang sama.	Ya
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	No

pineconeFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Pinecone yang dikonfigurasi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Ya
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No

onYourDataAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onYourDataContextProperty

Properti konteks.

Deskripsi: Properti konteks.

Jenis: string

Default:

Nama Enum: OnYourDataContextProperty

Nilai Enum:

Nilai	Deskripsi
Kutipan	citationsProperti.
tujuan	intentProperti.
all_retrieved_documents	all_retrieved_documentsProperti.

onYourDataAuthenticationType

Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

Deskripsi: Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

Jenis: string

Default:

Nama Enum: OnYourDataAuthenticationType

Nilai Enum:

Nilai	Deskripsi
api_key	Autentikasi melalui kunci API.
String_koneksi	Autentikasi melalui string koneksi.
key_and_key_id	Autentikasi melalui pasangan KUNCI dan ID kunci.
encoded_api_key	Autentikasi melalui kunci API yang dikodekan.
access_token	Autentikasi melalui token akses.
system_assigned_managed_identity	Autentikasi melalui identitas terkelola yang ditetapkan sistem.
user_assigned_managed_identity	Autentikasi melalui identitas terkelola yang ditetapkan pengguna.
username_and_password	Autentikasi melalui nama pengguna dan kata sandi.

onYourDataApiKeyAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
kunci	string	Kunci API yang digunakan untuk autentikasi.	No

onYourDataConnectionStringAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
String_koneksi	string	string koneksi yang digunakan untuk autentikasi.	No

onYourDataKeyAndKeyIdAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci Elasticsearch dan pasangan ID kunci.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
kunci	string	Kunci Elasticsearch yang digunakan untuk autentikasi.	No
key_id	string	ID kunci Elasticsearch yang digunakan untuk autentikasi.	No

onYourDataEncodedApiKeyAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API yang dikodekan Elasticsearch.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
encoded_api_key	string	Kunci API yang dikodekan Elasticsearch untuk digunakan untuk autentikasi.	No

onYourDataAccessTokenAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan token akses.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
access_token	string	Token akses yang digunakan untuk autentikasi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan sistem.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan pengguna.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
managed_identity_resource_id	string	ID sumber daya identitas terkelola yang ditetapkan pengguna untuk digunakan untuk autentikasi.	No

onYourDataUsernameAndPasswordAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan nama pengguna dan kata sandi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
Nama pengguna	string	Nama pengguna yang digunakan untuk autentikasi.	No
kata sandi	string	Kata sandi. untuk digunakan untuk autentikasi.	No

onYourDataVectorizationSource

Representasi abstrak sumber vektorisasi untuk Azure OpenAI On Your Data dengan pencarian vektor.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya

onYourDataVectorizationSourceType

Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.

Deskripsi: Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan
pencarian vektor.

Jenis: string

Default:

Nama Enum: OnYourDataVectorizationSourceType

Nilai Enum:

Nilai	Deskripsi
titik akhir	Mewakili vektorisasi yang dilakukan oleh panggilan layanan publik ke model penyematan Azure OpenAI.
deployment_name	Mewakili nama penyebaran model Ada untuk digunakan. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi Pada Data Anda akan menggunakan penyebaran model ini melalui panggilan internal daripada yang publik, yang memungkinkan vektor cari bahkan di jaringan privat.
terpadu	Mewakili vektorizer terintegrasi yang ditentukan dalam sumber daya pencarian.
model_id	Mewakili ID model penyematan tertentu seperti yang didefinisikan dalam layanan pencarian. Saat ini hanya didukung oleh Elasticsearch®.

onYourDataEndpointVectorizationSource

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada panggilan titik akhir Azure OpenAI untuk penyematan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
titik akhir	string	Menentukan URL titik akhir sumber daya tempat penyematan harus diambil. Ini harus dalam format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Parameter kueri versi api tidak diizinkan.	No
Autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataAccessTokenAuthenticationOptions		No
ukuran	Integer	Jumlah dimensi yang harus dimiliki penyematan. Hanya didukung dalam text-embedding-3 model dan yang lebih baru.	No

onYourDataDeploymentNameVectorizationSource

Detail sumber vektorisasi, yang digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada nama penyebaran model penyematan internal di sumber daya Azure OpenAI yang sama.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
deployment_name	string	Menentukan nama penyebaran model yang akan digunakan untuk vektorisasi. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi On Your Data akan menggunakan penyebaran model ini melalui panggilan internal daripada yang publik, yang memungkinkan pencarian vektor bahkan di jaringan privat.	No
ukuran	Integer	Jumlah dimensi yang harus dimiliki penyematan. Hanya didukung dalam text-embedding-3 model dan yang lebih baru.	No

onYourDataIntegratedVectorizationSource

Mewakili vektorizer terintegrasi yang ditentukan dalam sumber daya pencarian.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya

onYourDataModelIdVectorizationSource

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada ID model layanan pencarian. Saat ini hanya didukung oleh Elasticsearch®.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
model_id	string	Menentukan ID model yang akan digunakan untuk vektorisasi. ID model ini harus ditentukan dalam layanan pencarian.	No

azureChatExtensionsMessageContext

Representasi informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam pembuatan respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi saat menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Kutipan	array	Hasil pengambilan sumber data, digunakan untuk menghasilkan pesan asisten dalam respons.	No
tujuan	string	Niat yang terdeteksi dari riwayat obrolan, digunakan untuk meneruskan ke giliran berikutnya untuk membawa konteks.	No
all_retrieved_documents	array	Semua dokumen yang diambil.	No

kutipan

informasi kutipan untuk pesan respons penyelesaian obrolan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string	Konten kutipan.	Ya
title	string	Judul kutipan.	No
url	string	URL kutipan.	No
jalur file	string	Jalur file kutipan.	No
chunk_id	string	ID gugus kutipan.	No
rerank_score	number	Skor rerank dari dokumen yang diambil.	No

retrievedDocument

Dokumen yang diambil.

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string	Konten kutipan.	Ya
title	string	Judul kutipan.	No
url	string	URL kutipan.	No
jalur file	string	Jalur file kutipan.	No
chunk_id	string	ID gugus kutipan.	No
rerank_score	number	Skor rerank dari dokumen yang diambil.	No
search_queries	array	Kueri pencarian yang digunakan untuk mengambil dokumen.	No
data_source_index	Integer	Indeks sumber data.	No
original_search_score	number	Skor pencarian asli dokumen yang diambil.	No
filter_reason	filterReason	Alasan pemfilteran dokumen yang diambil.	No

filterReason

Alasan pemfilteran dokumen yang diambil.

Deskripsi: Alasan pemfilteran dokumen yang diambil.

Jenis: string

Default:

Nama Enum: FilterReason

Nilai Enum:

Nilai	Deskripsi
skor	Dokumen difilter menurut ambang batas skor pencarian asli yang ditentukan oleh strictness konfigurasi.
rerank	Dokumen tidak difilter menurut ambang batas skor pencarian asli, tetapi difilter berdasarkan skor rerank dan top_n_documents konfigurasikan.

chatCompletionMessageToolCall

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	ID panggilan alat.	Ya
jenis	toolCallType	Jenis panggilan alat, dalam hal functionini .	Ya
fungsi	object	Fungsi yang dipanggil model.	Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

toolCallType

Jenis panggilan alat, dalam hal functionini .

Deskripsi: Jenis panggilan alat, dalam hal functionini .

Jenis: string

Default:

Nama Enum: ToolCallType

Nilai Enum:

Nilai	Deskripsi
fungsi	Jenis panggilan alat adalah fungsi.

chatCompletionRequestMessageTool

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_call_id	string	Panggilan alat yang direspons pesan ini.	No
konten	string	Isi pesan.	No

chatCompletionRequestMessageFunction

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	enum	Peran penulis pesan, dalam hal functionini . Nilai yang mungkin: fungsi	No
nama	string	Isi pesan.	No
konten	string	Isi pesan.	No

createChatCompletionResponse

Mewakili respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan input yang disediakan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi unik untuk penyelesaian obrolan.	Ya
prompt_filter_results	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	No
Pilihan	array	Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika n lebih besar dari 1.	Ya
Dibuat	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.	Ya
model	string	Model yang digunakan untuk penyelesaian obrolan.	Ya
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	No
object	enum	Jenis objek, yang selalu chat.completion. Nilai yang mungkin: chat.completion	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian.	No

createChatCompletionStreamResponse

Mewakili potongan yang dialirkan dari respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan input yang disediakan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi unik untuk penyelesaian obrolan. Setiap gugus memiliki ID yang sama.	Ya
Pilihan	array	Daftar pilihan penyelesaian obrolan. Dapat berisi lebih dari satu elemen jika n lebih besar dari 1.	Ya
Dibuat	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat. Setiap gugus memiliki tanda waktu yang sama.	Ya
model	string	Model untuk menghasilkan penyelesaian.	Ya
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	No
object	enum	Jenis objek, yang selalu chat.completion.chunk. Nilai yang mungkin: chat.completion.chunk	Ya

chatCompletionStreamResponseDelta

Delta penyelesaian obrolan yang dihasilkan oleh respons model yang dialirkan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	string	Isi pesan gugus.	No
function_call	object	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No
tool_calls	array		No
role	enum	Peran penulis pesan ini. Nilai yang mungkin: sistem, pengguna, asisten, alat	No
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

chatCompletionMessageToolCallChunk

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer		Ya
id	string	ID panggilan alat.	No
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	No
fungsi	object		No

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

chatCompletionStreamOptions

Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.

Nama	Tipe	Deskripsi	Wajib diisi	Default
include_usage	Boolean	Jika diatur, gugus tambahan akan dialirkan sebelum data: [DONE] pesan. Bidang usage pada gugus ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan choices bidang akan selalu menjadi array kosong. Semua gugus lainnya juga akan menyertakan usage bidang, tetapi dengan nilai null.	No

chatCompletionChoiceLogProbs

Catat informasi probabilitas untuk pilihan tersebut.

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	array	Daftar token konten pesan dengan informasi probabilitas log.	Ya
penolakan	array	Daftar token penolakan pesan dengan informasi probabilitas log.	No

chatCompletionTokenLogprob

Nama	Tipe	Deskripsi	Wajib diisi	Default
token	string	Token.	Ya
logprob	number	Probabilitas log dari token ini.	Ya
byte	array	Daftar bilangan bulat yang mewakili representasi UTF-8 byte dari token. Berguna dalam kasus di mana karakter diwakili oleh beberapa token dan representasi bytenya harus digabungkan untuk menghasilkan representasi teks yang benar. Bisa jadi null jika tidak ada representasi byte untuk token.	Ya
top_logprobs	array	Daftar token yang paling mungkin dan probabilitas lognya, pada posisi token ini. Dalam kasus yang jarang terjadi, mungkin ada kurang dari jumlah yang diminta top_logprobs dikembalikan.	Ya

chatCompletionResponseMessage

Pesan penyelesaian obrolan yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	chatCompletionResponseMessageRole	Peran penulis pesan respons.	Ya
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Ya
konten	string	Isi pesan.	Ya
tool_calls	array	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	No
function_call	chatCompletionFunctionCall	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No
context	azureChatExtensionsMessageContext	Representasi informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam generasi respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi ketika menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok.	No

chatCompletionResponseMessageRole

Peran penulis pesan respons.

Deskripsi: Peran penulis pesan respons.

Jenis: string

Default:

Nilai Enum:

• assistant

chatCompletionToolChoiceOption

Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionNamedToolChoice

Menentukan alat yang harus digunakan model. Gunakan untuk memaksa model memanggil fungsi tertentu.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	Ya
fungsi	object		Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

ParallelToolCalls

Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionMessageToolCalls

Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionFunctionCall

Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama fungsi yang akan dipanggil.	Ya
arguments	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Ya

completionUsage

Statistik penggunaan untuk permintaan penyelesaian.

Nama	Tipe	Deskripsi	Wajib diisi	Default
prompt_tokens	Integer	Jumlah token dalam perintah.	Ya
completion_tokens	Integer	Jumlah token dalam penyelesaian yang dihasilkan.	Ya
total_tokens	Integer	Jumlah total token yang digunakan dalam permintaan (prompt + completion).	Ya
prompt_tokens_details	object	Detail token perintah.	No
completion_tokens_details	object	Perincian token yang digunakan dalam penyelesaian.	No

Properti untuk prompt_tokens_details

cached_tokens

Nama	Tipe	Deskripsi	Default
cached_tokens	Integer	Jumlah token prompt yang di-cache.

Properti untuk completion_tokens_details

reasoning_tokens

Nama	Tipe	Deskripsi	Default
reasoning_tokens	Integer	Token yang dihasilkan oleh model untuk penalaran.

chatCompletionTool

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	Ya
fungsi	FunctionObject		Ya

FunctionParameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan referensi Skema JSON untuk dokumentasi tentang format.

Menghilangkan mendefinisikan parameters fungsi dengan daftar parameter kosong.

Tidak ada properti yang ditentukan untuk komponen ini.

FunctionObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
description	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	No
nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Ya
parameter	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan referensi Skema JSON untuk dokumentasi tentang format. Menghilangkan mendefinisikan parameters fungsi dengan daftar parameter kosong.	No
ketat	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan panggilan fungsi. Jika diatur ke true, model akan mengikuti skema yang tepat yang ditentukan di parameters bidang . Hanya subset Skema JSON yang didukung saat strict adalah true.	No	Salah

ResponseFormatText

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: text Nilai yang mungkin: teks	Ya

ResponseFormatJsonObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: json_object Nilai yang mungkin: json_object	Ya

ResponseFormatJsonSchemaSchemaSchema

Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseFormatJsonSchema

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: json_schema Nilai yang mungkin: json_schema	Ya
json_schema	object		Ya

Properti untuk json_schema

description

Nama	Tipe	Deskripsi	Default
description	string	Deskripsi untuk apa format respons, digunakan oleh model untuk menentukan cara merespons dalam format.

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama format respons. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.

skema

Nama	Tipe	Deskripsi	Default
skema	ResponseFormatJsonSchemaSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

ketat

Nama	Tipe	Deskripsi	Default
ketat	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema yang tepat yang ditentukan di schema bidang . Hanya subset Skema JSON yang didukung saat strict adalah true.	Salah

chatCompletionChoiceCommon

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer		No
finish_reason	string		No

createTranslationRequest

Permintaan terjemahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	File audio yang akan diterjemahkan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	No	0

audioResponse

Respons terjemahan atau transkripsi saat response_format adalah json

Nama	Tipe	Deskripsi	Wajib diisi	Default
text	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya

audioVerboseResponse

Respons terjemahan atau transkripsi saat response_format verbose_json

Nama	Tipe	Deskripsi	Wajib diisi	Default
text	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya
tugas	string	Jenis tugas audio.	No
bahasa	string	Bahasa.	No
durasi	number	Durasi.	No
segmen	array		No
Kata	array		No

audioResponseFormat

Menentukan format output.

Deskripsi: Menentukan format output.

Jenis: string

Default:

Nilai Enum:

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

Permintaan transkripsi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	Objek file audio yang akan ditranskripsikan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	No	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No
timestamp_granularities[]	array	Granularitas tanda waktu untuk mengisi transkripsi ini. response_format harus diatur verbose_json untuk menggunakan granularitas tanda waktu. Salah satu atau kedua opsi ini didukung: word, atau segment. Catatan: Tidak ada latensi tambahan untuk tanda waktu segmen, tetapi menghasilkan tanda waktu kata menimbulkan latensi tambahan.	No	['segmen']

audioSegment

Segmen transkripsi atau terjemahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	Integer	Pengidentifikasi segmen.	No
mencari	number	Offset segmen.	No
mulai	number	Offset mulai segmen.	No
akhir	number	Offset akhir segmen.	No
text	string	Teks segmentasi.	No
Token	array	Token teks.	No
suhu	number	Suhu.	No
avg_logprob	number	Probabilitas log rata-rata.	No
compression_ratio	number	Rasio kompresi.	No
no_speech_prob	number	Probabilitas 'tidak ada ucapan'.	No

audioWord

Transkripsi atau kata terjemahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
Kata	string	Word	No
mulai	number	Offset mulai word.	No
akhir	number	Offset akhir kata.	No

createSpeechRequest

Permintaan ucapan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
input	string	Teks yang akan disintesis audio. Panjang maksimum adalah 4096 karakter.	Ya
Suara	enum	Suara yang digunakan untuk sintesis ucapan. Nilai yang mungkin: paduan, echo, fable, onyx, nova, shimmer	Ya
response_format	enum	Format untuk mensintesis audio masuk. Nilai yang mungkin: mp3, opus, aac, flac, wav, pcm	No
kecepatan	number	Kecepatan audio yang disintesis. Pilih nilai dari 0.25 ke 4.0. 1.0 adalah defaultnya.	No	1.0

imageQuality

Kualitas gambar yang akan dihasilkan.

Deskripsi: Kualitas gambar yang akan dihasilkan.

Jenis: string

Default: standar

Nama Enum: Kualitas

Nilai Enum:

Nilai	Deskripsi
standar	Kualitas standar menciptakan gambar dengan kualitas standar.
Hd	Kualitas HD menciptakan gambar dengan detail yang lebih halus dan konsistensi yang lebih besar di seluruh gambar.

imagesResponseFormat

Format di mana gambar yang dihasilkan dikembalikan.

Deskripsi: Format di mana gambar yang dihasilkan dikembalikan.

Jenis: string

Default: url

Nama Enum: ImagesResponseFormat

Nilai Enum:

Nilai	Deskripsi
url	URL yang menyediakan akses sementara untuk mengunduh gambar yang dihasilkan.
b64_json	Gambar yang dihasilkan dikembalikan sebagai string yang dikodekan base64.

imageSize

Ukuran gambar yang dihasilkan.

Deskripsi: Ukuran gambar yang dihasilkan.

Jenis: string

Default: 1024x1024

Nama Enum: Ukuran

Nilai Enum:

Nilai	Deskripsi
256x256	Ukuran gambar yang dihasilkan yang diinginkan adalah 256x256 piksel. Hanya didukung untuk dall-e-2.
512 x 512	Ukuran gambar yang dihasilkan yang diinginkan adalah 512x512 piksel. Hanya didukung untuk dall-e-2.
1792x1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1792x1024 piksel. Hanya didukung untuk dall-e-3.
1024x1792	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1792 piksel. Hanya didukung untuk dall-e-3.
1024 x 1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1024 piksel.

imageStyle

Gaya gambar yang dihasilkan.

Deskripsi: Gaya gambar yang dihasilkan.

Jenis: string

Default: vivid

Nama Enum: Gaya

Nilai Enum:

Nilai	Deskripsi
Jelas	Vivid menciptakan gambar yang hiper-realistis dan dramatis.
alami	Alami menciptakan gambar yang lebih alami dan kurang hiper-realistis.

imageGenerationsRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4000 karakter.	Ya
n	Integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024 x 1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	No	url
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	No	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	No	Jelas

generateImagesResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
Dibuat	Integer	Tanda waktu unix saat operasi dibuat.	Ya
data	array	Data hasil operasi, jika berhasil	Ya

imageResult

Url gambar atau gambar yang dikodekan jika berhasil, dan kesalahan sebaliknya.

Nama	Tipe	Deskripsi	Wajib diisi	Default
url	string	Url gambar.	No
b64_json	string	Gambar yang dikodekan base64	No
content_filter_results	dalleContentFilterResults	Informasi tentang hasil pemfilteran konten.	No
revised_prompt	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	No
prompt_filter_results	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

line

Objek baris konten yang terdiri dari urutan elemen konten yang berdekatan, seperti kata dan tanda pilihan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
text	string		Ya
Mencakup	array	Array rentang yang mewakili objek yang terdeteksi dan informasi kotak pembatasnya.	Ya

jengkal

Objek rentang yang mewakili objek yang terdeteksi dan informasi kotak pembatasnya.

Nama	Tipe	Deskripsi	Wajib diisi	Default
text	string	Konten teks rentang yang mewakili objek yang terdeteksi.	Ya
offset	Integer	Offset karakter dalam teks tempat rentang dimulai. Offset ini didefinisikan sebagai posisi karakter pertama rentang, dihitung dari awal teks sebagai titik kode Unicode.	Ya
length	Integer	Panjang rentang dalam karakter, diukur dalam titik kode Unicode.	Ya
polygon	array	Array objek yang mewakili titik dalam poligon yang mencakup objek yang terdeteksi.	Ya

runCompletionUsage

Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan menjadi null jika eksekusi tidak dalam status terminal (yaitu in_progress, , queueddll.).

Nama	Tipe	Deskripsi	Wajib diisi	Default
completion_tokens	Integer	Jumlah token penyelesaian yang digunakan selama eksekusi.	Ya
prompt_tokens	Integer	Jumlah token prompt yang digunakan selama eksekusi.	Ya
total_tokens	Integer	Jumlah total token yang digunakan (prompt + completion).	Ya

runStepCompletionUsage

Statistik penggunaan yang terkait dengan langkah eksekusi. Nilai ini akan sementara null status langkah eksekusi adalah in_progress.

Nama	Tipe	Deskripsi	Wajib diisi	Default
completion_tokens	Integer	Jumlah token penyelesaian yang digunakan selama langkah eksekusi.	Ya
prompt_tokens	Integer	Jumlah token prompt yang digunakan selama langkah eksekusi.	Ya
total_tokens	Integer	Jumlah total token yang digunakan (prompt + completion).	Ya

assistantsApiResponseFormatOption

Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106.

Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid.

Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.

Komponen ini bisa menjadi salah satu hal berikut:

assistantsApiResponseFormat

Objek yang menjelaskan output model yang diharapkan. Jika json_object hanya function jenis tools yang diizinkan untuk diteruskan ke Jalankan. Jika text model dapat mengembalikan teks atau nilai apa pun yang diperlukan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Harus salah satu dari text atau json_object.	No	text

type Enum: AssistantsApiResponseFormat

Nilai	Deskripsi
text
json_object

assistantObject

Mewakili yang assistant dapat memanggil model dan menggunakan alat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu assistant.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat asisten dibuat.	Ya
nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Ya
description	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Ya
model	string	ID model yang akan digunakan. Anda dapat menggunakan API Daftar model untuk melihat semua model yang tersedia.	Ya
petunjuk	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	Ya
alat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, file_search, atau function.	Ya	[]
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	Ya
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

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

file_search

Nama	Tipe	Deskripsi	Default
vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Mungkin ada maksimal 1 toko vektor yang terpasang pada asisten.

enum objek: AssistantObjectType

Nilai	Deskripsi
assistant	Jenis objek, yang selalu asisten

createAssistantRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
model			Ya
nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	No
description	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	No
petunjuk	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	No
alat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	No	[]
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID file yang disediakan untuk alat ini 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 asisten ini. Mungkin ada maksimal 1 toko vektor yang terpasang pada asisten.
vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke asisten ini. Mungkin ada maksimal 1 toko vektor yang terpasang pada asisten.

modifyAssistantRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
model			No
nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	No
description	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	No
petunjuk	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 32768 karakter.	No
alat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	No	[]
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Mengambil alih daftar ID file yang tersedia untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	[]

file_search

Nama	Tipe	Deskripsi	Default
vector_store_ids	array	Mengambil alih penyimpanan vektor yang terpasang pada asisten ini. Mungkin ada maksimal 1 toko vektor yang terpasang pada asisten.

deleteAssistantResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string		Ya
dihapus	Boolean		Ya
object	string		Ya

enum objek: DeleteAssistantResponseState

Nilai	Deskripsi
assistant.deleted

listAssistantsResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

assistantToolsCode

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Jenis alat yang didefinisikan: code_interpreter	Ya

jenis Enum: assistantToolsCodeType

Nilai	Deskripsi
code_interpreter

assistantToolsFileSearch

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Jenis alat yang didefinisikan: file_search	Ya
file_search	object	Ambil alih untuk alat pencarian file.	No

Properti untuk file_search

max_num_results

Nama	Tipe	Deskripsi	Default
max_num_results	Integer	Jumlah maksimum hasil yang harus dihasilkan alat pencarian file. Defaultnya adalah 20 untuk model gpt-4* dan 5 untuk gpt-3.5-turbo. Angka ini harus antara 1 dan 50 inklusif. Perhatikan bahwa alat pencarian file mungkin menghasilkan lebih sedikit dari max_num_results hasil.

jenis Enum: assistantToolsFileSearchType

Nilai	Deskripsi
file_search

assistantToolsFileSearchTypeOnly

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Jenis alat yang didefinisikan: file_search	Ya

jenis Enum: assistantToolsFileSearchType

Nilai	Deskripsi
file_search

assistantToolsFunction

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Jenis alat yang didefinisikan: function	Ya
fungsi	object	Definisi fungsi.	Ya

Properti untuk fungsi

description

Nama	Tipe	Deskripsi	Default
description	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.

parameter

Nama	Tipe	Deskripsi	Default
parameter	chatCompletionFunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan referensi Skema JSON untuk dokumentasi tentang format.

jenis Enum: assistantToolsFunction

Nilai	Deskripsi
fungsi

truncationObject

Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Strategi pemotongan yang digunakan untuk utas. Default adalah auto. Jika diatur ke last_messages, utas akan dipotong ke n pesan terbaru di utas. Ketika diatur ke auto, pesan di tengah utas akan dihilangkan agar sesuai dengan panjang konteks model, max_prompt_tokens.	Ya
last_messages	Integer	Jumlah pesan terbaru dari utas saat membuat konteks untuk eksekusi.	No

type Enum: TruncationType

Nilai	Deskripsi
auto
last_messages

assistantsApiToolChoiceOption

Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.

Komponen ini bisa menjadi salah satu hal berikut:

assistantsNamedToolChoice

Menentukan alat yang harus digunakan model. Gunakan untuk memaksa model memanggil alat tertentu.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Jenis alat. Jika jenis adalah function, nama fungsi harus diatur	Ya
fungsi	object		No

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

jenis Enum: AssistantsNamedToolChoiceType

Nilai	Deskripsi
fungsi
code_interpreter
file_search

runObject

Mewakili eksekusi yang dijalankan pada utas.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu thread.run.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi dibuat.	Ya
thread_id	string	ID utas yang dijalankan sebagai bagian dari eksekusi ini.	Ya
assistant_id	string	ID asisten yang digunakan untuk eksekusi eksekusi ini.	Ya
status	string	Status eksekusi, yang dapat berupa queued, , in_progress, requires_action, cancelling, cancelled, failedcompleted, atau expired.	Ya
required_action	object	Detail tentang tindakan yang diperlukan untuk melanjutkan eksekusi. null Akan jika tidak ada tindakan yang diperlukan.	Ya
last_error	object	Kesalahan terakhir yang terkait dengan eksekusi ini. Akan terjadi null jika tidak ada kesalahan.	Ya
expires_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi akan kedaluwarsa.	Ya
started_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi dimulai.	Ya
cancelled_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi dibatalkan.	Ya
failed_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi gagal.	Ya
completed_at	Integer	Tanda waktu Unix (dalam detik) saat eksekusi selesai.	Ya
incomplete_details	object	Detail tentang mengapa eksekusi tidak lengkap. Akan jika null eksekusi tidak lengkap.	Ya
model	string	Model yang digunakan asisten untuk eksekusi ini.	Ya
petunjuk	string	Instruksi yang digunakan asisten untuk eksekusi ini.	Ya
alat	array	Daftar alat yang digunakan asisten untuk eksekusi ini.	Ya	[]
metadata	object	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.	Ya
penggunaan	runCompletionUsage	Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan menjadi null jika eksekusi tidak dalam status terminal (yaitu in_progress, , queueddll.).	Ya
suhu	number	Suhu pengambilan sampel yang digunakan untuk eksekusi ini. Jika tidak diatur, default ke 1.	No
top_p	number	Nilai pengambilan sampel nukleus yang digunakan untuk proses ini. Jika tidak diatur, default ke 1.	No
max_prompt_tokens	Integer	Jumlah maksimum token prompt yang ditentukan telah digunakan selama eksekusi.	Ya
max_completion_tokens	Integer	Jumlah maksimum token penyelesaian yang ditentukan telah digunakan selama eksekusi.	Ya
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Ya
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Ya
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Ya

Properti untuk required_action

jenis

Nama	Tipe	Deskripsi	Default
jenis	string	Untuk saat ini, ini selalu submit_tool_outputs.

submit_tool_outputs

Nama	Tipe	Deskripsi	Default
tool_calls	array	Daftar panggilan alat yang relevan.

Properti untuk last_error

kode

Nama	Tipe	Deskripsi	Default
kode	string	Salah satu dari server_error atau rate_limit_exceeded.

pesan

Nama	Tipe	Deskripsi	Default
pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.

Properti untuk incomplete_details

reason

Nama	Tipe	Deskripsi	Default
reason	string	Alasan mengapa eksekusi tidak lengkap. Ini akan menunjuk ke batas token tertentu yang tercapai selama eksekusi.

enum objek: runObjectType

Nilai	Deskripsi
thread.run	Jenis objek eksekusi yang selalu thread.run

status Enum: RunObjectStatus

Nilai	Deskripsi
Antri	Status antrean
in_progress	Status in_progress
requires_action	Status required_action
Membatalkan	Status pembatalan
cancelled	Status dibatalkan
gagal	Status gagal
selesai	Status selesai
kedaluwarsa	Status kedaluwarsa

createRunRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Ya
model	string	ID penyebaran Model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	No
petunjuk	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
additional_instructions	string	Menambahkan instruksi tambahan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.	No
additional_messages	array	Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.	No
alat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No
max_prompt_tokens	Integer	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
max_completion_tokens	Integer	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	No
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	No
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

listRunsResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

modifikasiRunRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
metadata	object	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.	No

submitToolOutputsRunRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_outputs	array	Daftar alat yang outputnya sedang dikirimkan.	Ya
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No

runToolCallObject

Objek panggilan alat

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	ID panggilan alat. ID ini harus dirujuk saat Anda mengirimkan output alat dalam menggunakan output alat Kirim untuk menjalankan titik akhir.	Ya
jenis	string	Jenis alat yang memanggil output diperlukan. Untuk saat ini, ini selalu function.	Ya
fungsi	object	Definisi fungsi.	Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi.

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen yang diharapkan model untuk Anda teruskan ke fungsi .

type Enum: RunToolCallObjectType

Nilai	Deskripsi
fungsi

createThreadAndRunRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Ya
rangkaian	createThreadRequest		No
model	string	Nama penyebaran model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	No
petunjuk	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
alat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	No
tool_resources	object	Sekumpulan sumber daya yang digunakan oleh alat asisten. 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.	No
metadata	object	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.	No
suhu	number	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	No	1
stream	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	No
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	No	Tidak
max_prompt_tokens	Integer	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
max_completion_tokens	Integer	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Eksekusi akan berupaya sebaik mungkin untuk hanya menggunakan jumlah token penyelesaian yang ditentukan, di beberapa belokan eksekusi. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	No
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	No
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	No
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4 Turbo dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No

Properti untuk tool_resources

code_interpreter

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

file_search

Nama	Tipe	Deskripsi	Default
vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Mungkin ada maksimal 1 toko vektor yang terpasang pada asisten.

threadObject

Mewakili utas yang berisi pesan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu thread.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat utas dibuat.	Ya
tool_resources	object	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.	Ya
metadata	object	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.	Ya

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID file yang disediakan untuk alat ini 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.

enum objek: ThreadObjectType

Nilai	Deskripsi
rangkaian	Jenis objek utas yang selalu thread

createThreadRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
pesan	array	Daftar pesan untuk memulai utas.	No
tool_resources	object	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.	No
metadata	object	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.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID file yang disediakan untuk alat ini 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.

modifikasiThreadRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_resources	object	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.	No
metadata	object	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.	No

Properti untuk tool_resources

code_interpreter

Nama	Tipe	Deskripsi	Default
file_ids	array	Daftar ID File yang disediakan untuk alat ini 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.

deleteThreadResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string		Ya
dihapus	Boolean		Ya
object	string		Ya

enum objek: DeleteThreadResponseObjectState

Nilai	Deskripsi
thread.deleted	Status objek respons utas penghapusan yaitu thread.deleted

listThreadsResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

messageObject

Mewakili pesan dalam utas.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu thread.message.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat pesan dibuat.	Ya
thread_id	string	ID utas tempat pesan ini berada.	Ya
status	string	Status pesan, yang dapat berupa in_progress, , incompleteatau completed.	Ya
incomplete_details	object	Pada pesan yang tidak lengkap, detail tentang mengapa pesan tidak lengkap.	Ya
completed_at	Integer	Tanda waktu Unix (dalam detik) saat pesan selesai.	Ya
incomplete_at	Integer	Tanda waktu Unix (dalam detik) saat pesan ditandai sebagai tidak lengkap.	Ya
role	string	Entitas yang menghasilkan pesan. Salah satu dari user atau assistant.	Ya
konten	array	Konten pesan dalam array teks dan/atau gambar.	Ya
assistant_id	string	Jika berlaku, ID asisten yang menulis pesan ini.	Ya
run_id	string	Jika berlaku, ID eksekusi yang terkait dengan penulisan pesan ini.	Ya
Lampiran	array	Daftar file yang dilampirkan ke pesan, dan alat tempat file ditambahkan.	Ya
metadata	object	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.	Ya

Properti untuk incomplete_details

reason

Nama	Tipe	Deskripsi	Default
reason	string	Alasan pesan tidak lengkap.

enum objek: MessageObjectType

Nilai	Deskripsi
thread.message	Jenis objek pesan yang merupakan thread.message

status Enum: MessageObjectStatus

Nilai	Deskripsi
in_progress
Lengkap
selesai

enum peran: MessageObjectRole

Nilai	Deskripsi
pengguna
assistant

messageDeltaObject

Mewakili delta pesan yaitu bidang yang diubah pada pesan selama streaming.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi pesan, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu thread.message.delta.	Ya
delta	object	Delta yang berisi bidang yang telah berubah pada Pesan.	Ya

Properti untuk delta

role

Nama	Tipe	Deskripsi	Default
role	string	Entitas yang menghasilkan pesan. Salah satu dari user atau assistant.

konten

Nama	Tipe	Deskripsi	Default
konten	array	Konten pesan dalam array teks dan/atau gambar.

enum objek: MessageDeltaObjectType

Nilai	Deskripsi
thread.message.delta

createMessageRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
role	string	Peran entitas yang membuat pesan. Nilai yang diizinkan meliputi: - 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.	Ya
konten	string	Konten pesan.	Ya
Lampiran	array	Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.	No
metadata	object	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.	No

peran Enum: CreateMessageRequestRole

Nilai	Deskripsi
pengguna
assistant

modifikasiMessageRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
metadata	object	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.	No

deleteMessageResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string		Ya
dihapus	Boolean		Ya
object	string		Ya

enum objek: DeleteMessageResponseObject

Nilai	Deskripsi
thread.message.deleted	Status hapus objek respons pesan

listMessagesResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

messageContentImageFileObject

Mereferensikan File gambar dalam konten pesan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu image_file.	Ya
image_file	object		Ya

Properti untuk image_file

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID File gambar dalam konten pesan.

ketik Enum: MessageContentImageFileObjectType

Nilai	Deskripsi
image_file	Jenis file gambar konten pesan

messageContentTextObject

Konten teks yang merupakan bagian dari pesan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu text.	Ya
text	object		Ya

Properti untuk teks

value

Nama	Tipe	Deskripsi	Default
value	string	Data yang membentuk teks.

anotasi

Nama	Tipe	Deskripsi	Default
anotasi	array

ketik Enum: messageContentTextObjectType

Nilai	Deskripsi
text	Tipe objek teks isi pesan

messageContentTextAnnotationsFileCitationObject

Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan asisten atau pesan. Dihasilkan ketika asisten menggunakan alat "pengambilan" untuk mencari file.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu file_citation.	Ya
text	string	Teks dalam konten pesan yang perlu diganti.	Ya
file_citation	object		Ya
start_index	Integer		Ya
end_index	Integer		Ya

Properti untuk file_citation

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID File tertentu tempat kutipan berasal.

type Enum: FileCitationObjectType

Nilai	Deskripsi
file_citation	Jenis objek kutipan file

messageContentTextAnnotationsFilePathObject

URL untuk file yang dihasilkan saat asisten menggunakan code_interpreter alat untuk menghasilkan file.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu file_path.	Ya
text	string	Teks dalam konten pesan yang perlu diganti.	Ya
file_path	object		Ya
start_index	Integer		Ya
end_index	Integer		Ya

Properti untuk file_path

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID file yang dihasilkan.

type Enum: FilePathObjectType

Nilai	Deskripsi
file_path	Jenis objek jalur file

messageDeltaContentImageFileObject

Mereferensikan File gambar dalam konten pesan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks bagian konten dalam pesan.	Ya
jenis	string	Selalu image_file.	Ya
image_file	object		No

Properti untuk image_file

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID File gambar dalam konten pesan.

ketik Enum: MessageDeltaContentImageFileObjectType

Nilai	Deskripsi
image_file

messageDeltaContentTextObject

Konten teks yang merupakan bagian dari pesan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks bagian konten dalam pesan.	Ya
jenis	string	Selalu text.	Ya
text	object		No

Properti untuk teks

value

Nama	Tipe	Deskripsi	Default
value	string	Data yang membentuk teks.

anotasi

Nama	Tipe	Deskripsi	Default
anotasi	array

type Enum: MessageDeltaContentTextObjectType

Nilai	Deskripsi
text

messageDeltaContentTextAnnotationsFileCitationObject

Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan asisten atau pesan. Dihasilkan ketika asisten menggunakan alat "file_search" untuk mencari file.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks anotasi di bagian konten teks.	Ya
jenis	string	Selalu file_citation.	Ya
text	string	Teks dalam konten pesan yang perlu diganti.	No
file_citation	object		No
start_index	Integer		No
end_index	Integer		No

Properti untuk file_citation

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID File tertentu tempat kutipan berasal.

kuotasi

Nama	Tipe	Deskripsi	Default
kuotasi	string	Kutipan spesifik dalam file.

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Nilai	Deskripsi
file_citation

messageDeltaContentTextAnnotationsFilePathObject

URL untuk file yang dihasilkan saat asisten menggunakan code_interpreter alat untuk menghasilkan file.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks anotasi di bagian konten teks.	Ya
jenis	string	Selalu file_path.	Ya
text	string	Teks dalam konten pesan yang perlu diganti.	No
file_path	object		No
start_index	Integer		No
end_index	Integer		No

Properti untuk file_path

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID file yang dihasilkan.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Nilai	Deskripsi
file_path

runStepObject

Mewakili langkah dalam eksekusi eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi langkah eksekusi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu assistant.run.step.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat langkah eksekusi dibuat.	Ya
assistant_id	string	ID asisten yang terkait dengan langkah eksekusi.	Ya
thread_id	string	ID utas yang dijalankan.	Ya
run_id	string	ID eksekusi yang merupakan bagian dari langkah eksekusi ini.	Ya
jenis	string	Jenis langkah eksekusi, yang dapat berupa message_creation atau tool_calls.	Ya
status	string	Status eksekusi, yang dapat berupa in_progress, , cancelled, failedcompleted, atau expired.	Ya
step_details	runStepDetailsMessageCreationObject atau runStepDetailsToolCallsObject	Detail langkah eksekusi.	Ya
last_error	object	Kesalahan terakhir yang terkait dengan langkah eksekusi ini. Akan terjadi null jika tidak ada kesalahan.	Ya
expired_at	Integer	Tanda waktu Unix (dalam detik) saat langkah eksekusi kedaluwarsa. Langkah dianggap kedaluwarsa jika eksekusi induk kedaluwarsa.	Ya
cancelled_at	Integer	Tanda waktu Unix (dalam detik) saat langkah eksekusi dibatalkan.	Ya
failed_at	Integer	Tanda waktu Unix (dalam detik) saat langkah eksekusi gagal.	Ya
completed_at	Integer	Tanda waktu Unix (dalam detik) saat langkah eksekusi selesai.	Ya
metadata	object	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.	Ya

Properti untuk last_error

kode

Nama	Tipe	Deskripsi	Default
kode	string	Salah satu dari server_error atau rate_limit_exceeded.

pesan

Nama	Tipe	Deskripsi	Default
pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.

enum objek: RunStepObjectType

Nilai	Deskripsi
assistant.run.step	Jenis objek, yang selalu assistant.run.step

ketik Enum: RunStepObjectType

Nilai	Deskripsi
message_creation	Langkah eksekusi message_creation
tool_calls	Langkah eksekusi tool_calls

status Enum: RunStepObjectStatus

Nilai	Deskripsi
in_progress	Status eksekusi in_progress
cancelled	Status eksekusi yang dibatalkan
gagal	Status eksekusi yang dibatalkan
selesai	Status eksekusi yang dibatalkan
kedaluwarsa	Status eksekusi yang dibatalkan

runStepDeltaObject

Mewakili delta langkah eksekusi yaitu bidang yang diubah pada langkah eksekusi selama streaming.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi langkah eksekusi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu thread.run.step.delta.	Ya
delta	object	Delta yang berisi bidang yang telah berubah pada langkah eksekusi.	Ya

Properti untuk delta

step_details

Nama	Tipe	Deskripsi	Default
step_details	runStepDeltaStepDetailsMessageCreationObject atau runStepDeltaStepDetailsToolCallsObject	Detail langkah eksekusi.

enum objek: RunStepDeltaObjectType

Nilai	Deskripsi
thread.run.step.delta

listRunStepsResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

runStepDetailsMessageCreationObject

Detail pembuatan pesan dengan langkah eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu message_creation.	Ya
message_creation	object		Ya

Properti untuk message_creation

message_id

Nama	Tipe	Deskripsi	Default
message_id	string	ID pesan yang dibuat oleh langkah eksekusi ini.

type Enum: RunStepDetailsMessageCreationObjectType

Nilai	Deskripsi
message_creation

runStepDeltaStepDetailsMessageCreationObject

Detail pembuatan pesan dengan langkah eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu message_creation.	Ya
message_creation	object		No

Properti untuk message_creation

message_id

Nama	Tipe	Deskripsi	Default
message_id	string	ID pesan yang dibuat oleh langkah eksekusi ini.

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Nilai	Deskripsi
message_creation

runStepDetailsToolCallsObject

Detail panggilan alat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu tool_calls.	Ya
tool_calls	array	Array alat yang memanggil langkah eksekusi terlibat. Ini dapat dikaitkan dengan salah satu dari tiga jenis alat: code_interpreter, retrieval atau function.	Ya

type Enum: RunStepDetailsToolCallsObjectType

Nilai	Deskripsi
tool_calls

runStepDeltaStepDetailsToolCallsObject

Detail panggilan alat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu tool_calls.	Ya
tool_calls	array	Array alat yang memanggil langkah eksekusi terlibat. Ini dapat dikaitkan dengan salah satu dari tiga jenis alat: code_interpreter, file_search atau function.	No

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Nilai	Deskripsi
tool_calls

runStepDetailsToolCallsCodeObject

Detail alat Penerjemah Kode yang menyebut langkah eksekusi terlibat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	ID panggilan alat.	Ya
jenis	string	Jenis panggilan alat. Ini akan selalu untuk code_interpreter jenis panggilan alat ini.	Ya
code_interpreter	object	Definisi panggilan alat Penerjemah Kode.	Ya

Properti untuk code_interpreter

input

Nama	Tipe	Deskripsi	Default
input	string	Input ke panggilan alat Penerjemah Kode.

output

Nama	Tipe	Deskripsi	Default
output	array	Output dari panggilan alat Penerjemah Kode. Penerjemah Kode dapat menghasilkan satu atau beberapa item, termasuk teks (logs) atau gambar (image). Masing-masing diwakili oleh jenis objek yang berbeda.

jenis Enum: RunStepDetailsToolCallsCodeObjectType

Nilai	Deskripsi
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Detail alat Penerjemah Kode yang menyebut langkah eksekusi terlibat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks panggilan alat dalam array panggilan alat.	Ya
id	string	ID panggilan alat.	No
jenis	string	Jenis panggilan alat. Ini akan selalu untuk code_interpreter jenis panggilan alat ini.	Ya
code_interpreter	object	Definisi panggilan alat Penerjemah Kode.	No

Properti untuk code_interpreter

input

Nama	Tipe	Deskripsi	Default
input	string	Input ke panggilan alat Penerjemah Kode.

output

Nama	Tipe	Deskripsi	Default
output	array	Output dari panggilan alat Penerjemah Kode. Penerjemah Kode dapat menghasilkan satu atau beberapa item, termasuk teks (logs) atau gambar (image). Masing-masing diwakili oleh jenis objek yang berbeda.

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Nilai	Deskripsi
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Output teks dari panggilan alat Penerjemah Kode sebagai bagian dari langkah eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu logs.	Ya
logs	string	Output teks dari panggilan alat Penerjemah Kode.	Ya

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Nilai	Deskripsi
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Output teks dari panggilan alat Penerjemah Kode sebagai bagian dari langkah eksekusi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks output dalam array output.	Ya
jenis	string	Selalu logs.	Ya
logs	string	Output teks dari panggilan alat Penerjemah Kode.	No

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Nilai	Deskripsi
logs

runStepDetailsToolCallsCodeOutputImageObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu image.	Ya
gambar	object		Ya

Properti untuk gambar

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID File gambar.

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Nilai	Deskripsi
gambar

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks output dalam array output.	Ya
jenis	string	Selalu image.	Ya
gambar	object		No

Properti untuk gambar

file_id

Nama	Tipe	Deskripsi	Default
file_id	string	ID file gambar.

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nilai	Deskripsi
gambar

runStepDetailsToolCallsFileSearchObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	ID objek panggilan alat.	Ya
jenis	string	Jenis panggilan alat. Ini akan selalu untuk file_search jenis panggilan alat ini.	Ya
file_search	object	Untuk saat ini, ini selalu akan menjadi objek kosong.	Ya

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Nilai	Deskripsi
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks panggilan alat dalam array panggilan alat.	Ya
id	string	ID objek panggilan alat.	No
jenis	string	Jenis panggilan alat. Ini akan selalu untuk retrieval jenis panggilan alat ini.	Ya
file_search	object	Untuk saat ini, ini selalu akan menjadi objek kosong.	Ya

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Nilai	Deskripsi
file_search

runStepDetailsToolCallsFunctionObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	ID objek panggilan alat.	Ya
jenis	string	Jenis panggilan alat. Ini akan selalu untuk function jenis panggilan alat ini.	Ya
fungsi	object	Definisi fungsi yang dipanggil.	Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi.

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen diteruskan ke fungsi .

output

Nama	Tipe	Deskripsi	Default
output	tali	Output fungsi. Ini akan terjadi null jika output belum dikirimkan.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Nilai	Deskripsi
fungsi

runStepDeltaStepDetailsToolCallsFunctionObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer	Indeks panggilan alat dalam array panggilan alat.	Ya
id	string	ID objek panggilan alat.	No
jenis	string	Jenis panggilan alat. Ini akan selalu untuk function jenis panggilan alat ini.	Ya
fungsi	object	Definisi fungsi yang dipanggil.	No

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi.

arguments

Nama	Tipe	Deskripsi	Default
arguments	string	Argumen diteruskan ke fungsi .

output

Nama	Tipe	Deskripsi	Default
output	tali	Output fungsi. Ini akan terjadi null jika output belum dikirimkan.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Nilai	Deskripsi
fungsi

vectorStoreExpirationAfter

Kebijakan kedaluwarsa untuk penyimpanan vektor.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jangkar	string	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku. Jangkar yang didukung: last_active_at.	Ya
days	Integer	Jumlah hari setelah waktu jangkar penyimpanan vektor akan kedaluwarsa.	Ya

jangkar Enum: VectorStoreExpirationAfterAnchor

Nilai	Deskripsi
last_active_at	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku.

vectorStoreObject

Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	enum	Jenis objek, yang selalu vector_store. Nilai yang mungkin: vector_store	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat penyimpanan vektor dibuat.	Ya
nama	string	Nama toko vektor.	Ya
usage_bytes	Integer	Jumlah total byte yang digunakan oleh file di penyimpanan vektor.	Ya
file_counts	object		Ya
status	string	Status penyimpanan vektor, yang dapat berupa expired, , in_progressatau completed. Status completed menunjukkan bahwa penyimpanan vektor siap digunakan.	Ya
expires_after	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	No
expires_at	Integer	Tanda waktu Unix (dalam detik) saat penyimpanan vektor akan kedaluwarsa.	No
last_active_at	Integer	Tanda waktu Unix (dalam detik) ketika penyimpanan vektor terakhir aktif.	Ya
metadata	object	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.	Ya

Properti untuk file_counts

in_progress

Nama	Tipe	Deskripsi	Default
in_progress	Integer	Jumlah file yang saat ini sedang diproses.

selesai

Nama	Tipe	Deskripsi	Default
selesai	Integer	Jumlah file yang berhasil diproses.

gagal

Nama	Tipe	Deskripsi	Default
gagal	Integer	Jumlah file yang gagal diproses.

cancelled

Nama	Tipe	Deskripsi	Default
cancelled	Integer	Jumlah file yang dibatalkan.

total

Nama	Tipe	Deskripsi	Default
total	Integer	Jumlah total file.

status Enum: VectorStoreObjectStatus

Nilai	Deskripsi
kedaluwarsa
in_progress
selesai

createVectorStoreRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_ids	array	Daftar ID file yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	No
nama	string	Nama toko vektor.	No
expires_after	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	No
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak ada.	No
metadata	object	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.	No

updateVectorStoreRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama toko vektor.	No
expires_after	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	No
metadata	object	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.	No

listVectorStoresResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

deleteVectorStoreResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string		Ya
dihapus	Boolean		Ya
object	string		Ya

enum objek: DeleteVectorStoreResponseObject

Nilai	Deskripsi
vector_store.deleted	Status objek respons penyimpanan vektor penghapusan

vectorStoreFileObject

Daftar file yang dilampirkan ke penyimpanan vektor.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu vector_store.file.	Ya
usage_bytes	Integer	Total penggunaan penyimpanan vektor dalam byte. Perhatikan bahwa ini mungkin berbeda dari ukuran file asli.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) saat file penyimpanan vektor dibuat.	Ya
vector_store_id	string	ID penyimpanan vektor tempat file dilampirkan.	Ya
status	string	Status file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled, atau failed. Status completed menunjukkan bahwa file penyimpanan vektor siap digunakan.	Ya
last_error	object	Kesalahan terakhir yang terkait dengan file penyimpanan vektor ini. Akan terjadi null jika tidak ada kesalahan.	Ya
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak ada.	No

Properti untuk last_error

kode

Nama	Tipe	Deskripsi	Default
kode	string	Salah satu dari server_error atau rate_limit_exceeded.

pesan

Nama	Tipe	Deskripsi	Default
pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.

enum objek: VectorStoreFileObjectType

Nilai	Deskripsi
vector_store.file

status Enum: VectorStoreFileObjectStatus

Nilai	Deskripsi
in_progress
selesai
cancelled
gagal

otherChunkingStrategyResponseParam

Ini dikembalikan ketika strategi penggugusan tidak diketahui. Biasanya, ini karena file diindeks sebelum chunking_strategy konsep diperkenalkan dalam API.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu other.	Ya

jenis Enum: OtherChunkingStrategyResponseParamType

Nilai	Deskripsi
lainnya

staticChunkingStrategyResponseParam

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	string	Selalu static.	Ya
statik	staticChunkingStrategy		Ya

type Enum: StaticChunkingStrategyResponseParamType

Nilai	Deskripsi
statik

staticChunkingStrategy

Nama	Tipe	Deskripsi	Wajib diisi	Default
max_chunk_size_tokens	Integer	Jumlah maksimum token di setiap gugus. Nilai defaultnya adalah 800. Nilai minimum adalah 100 dan nilai maksimumnya adalah 4096.	Ya
chunk_overlap_tokens	Integer	Jumlah token yang tumpang tindih di antara gugus. Nilai defaultnya adalah 400. Perhatikan bahwa tumpang tindih tidak boleh melebihi setengah dari max_chunk_size_tokens.	Ya

autoChunkingStrategyRequestParam

Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens dari 800 dan chunk_overlap_tokens dari 400.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Selalu auto. Nilai yang mungkin: otomatis	Ya

staticChunkingStrategyRequestParam

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Selalu static. Nilai yang mungkin: statis	Ya
statik	staticChunkingStrategy		Ya

chunkingStrategyRequestParam

Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.

Komponen ini bisa menjadi salah satu hal berikut:

createVectorStoreFileRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_id	string	ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	Ya
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	No

listVectorStoreFilesResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
object	string		Ya
data	array		Ya
first_id	string		Ya
last_id	string		Ya
has_more	Boolean		Ya

deleteVectorStoreFileResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string		Ya
dihapus	Boolean		Ya
object	string		Ya

enum objek: DeleteVectorStoreFileResponseObject

Nilai	Deskripsi
vector_store.file.deleted

vectorStoreFileBatchObject

Batch file yang dilampirkan ke penyimpanan vektor.

Nama	Tipe	Deskripsi	Wajib diisi	Default
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Ya
object	string	Jenis objek, yang selalu vector_store.file_batch.	Ya
created_at	Integer	Tanda waktu Unix (dalam detik) ketika batch file penyimpanan vektor dibuat.	Ya
vector_store_id	string	ID penyimpanan vektor tempat File dilampirkan.	Ya
status	string	Status batch file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled atau failed.	Ya
file_counts	object		Ya

Properti untuk file_counts

in_progress

Nama	Tipe	Deskripsi	Default
in_progress	Integer	Jumlah file yang saat ini sedang diproses.

selesai

Nama	Tipe	Deskripsi	Default
selesai	Integer	Jumlah file yang telah diproses.

gagal

Nama	Tipe	Deskripsi	Default
gagal	Integer	Jumlah file yang gagal diproses.

cancelled

Nama	Tipe	Deskripsi	Default
cancelled	Integer	Jumlah file yang dibatalkan.

total

Nama	Tipe	Deskripsi	Default
total	Integer	Jumlah total file.

enum objek: VectorStoreFileBatchObjectType

Nilai	Deskripsi
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Nilai	Deskripsi
in_progress
selesai
cancelled
gagal

createVectorStoreFileBatchRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
file_ids	array	Daftar ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search itu dapat mengakses file.	Ya
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	No

assistantStreamEvent

Mewakili peristiwa yang dipancarkan saat melakukan streaming Eksekusi.

Setiap peristiwa dalam aliran peristiwa yang dikirim server memiliki event properti dan data :

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Kami mengeluarkan peristiwa setiap kali objek baru dibuat, beralih ke status baru, atau sedang dialirkan di bagian (delta). Misalnya, kami memancarkan thread.run.created saat eksekusi baru dibuat, thread.run.completed saat eksekusi selesai, dan sebagainya. Saat Asisten memilih untuk membuat pesan selama eksekusi, kami memancarkan thread.message.created event, thread.message.in_progress peristiwa, banyak thread.message.delta peristiwa, dan akhirnya peristiwa thread.message.completed .

Kami dapat menambahkan peristiwa tambahan dari waktu ke waktu, jadi sebaiknya tangani peristiwa yang tidak diketahui dengan baik dalam kode Anda.

Komponen ini bisa menjadi salah satu hal berikut:

threadStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.created

Terjadi ketika utas baru dibuat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	threadObject	Mewakili utas yang berisi pesan.	Ya

Data: threadObject

Enum Peristiwa: ThreadStreamEventEnum

Nilai	Deskripsi
thread.created	Peristiwa yang dibuat utas

---

runStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.run.created

Terjadi ketika eksekusi baru dibuat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventCreated

Nilai	Deskripsi
thread.run.created

---

thread.run.queued

Terjadi saat eksekusi berpindah ke queued status.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventQueued

Nilai	Deskripsi
thread.run.queued

---

thread.run.in_progress

Terjadi ketika eksekusi berpindah ke in_progress status.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventInProgress

Nilai	Deskripsi
thread.run.in_progress

---

thread.run.requires_action

Terjadi saat eksekusi berpindah ke requires_action status.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventRequiresAction

Nilai	Deskripsi
thread.run.requires_action

---

thread.run.completed

Terjadi ketika eksekusi selesai.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventCompleted

Nilai	Deskripsi
thread.run.completed

---

thread.run.failed

Terjadi ketika eksekusi gagal.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventFailed

Nilai	Deskripsi
thread.run.failed

---

thread.run.cancelling

Terjadi saat eksekusi berpindah ke cancelling status.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventCancelling

Nilai	Deskripsi
thread.run.cancelling

---

thread.run.cancelled

Terjadi ketika eksekusi dibatalkan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventCancelled

Nilai	Deskripsi
thread.run.cancelled

---

thread.run.expired

Terjadi ketika eksekusi kedaluwarsa.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runObject	Mewakili eksekusi yang dijalankan pada utas.	Ya

Data: runObject

Enum Peristiwa: RunStreamEventExpired

Nilai	Deskripsi
thread.run.expired

---

runStepStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.run.step.created

Terjadi ketika langkah eksekusi dibuat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCreated

Nilai	Deskripsi
thread.run.step.created

---

thread.run.step.in_progress

Terjadi ketika langkah eksekusi berpindah ke status in_progress .

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventInProgress

Nilai	Deskripsi
thread.run.step.in_progress

---

thread.run.step.delta

Terjadi ketika bagian dari langkah eksekusi sedang dialirkan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepDeltaObject	Mewakili delta langkah eksekusi yaitu bidang yang diubah pada langkah eksekusi selama streaming.	Ya

Data: runStepDeltaObject

Enum Peristiwa: RunStepStreamEventDelta

Nilai	Deskripsi
thread.run.step.delta

---

thread.run.step.completed

Terjadi ketika langkah eksekusi selesai.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCompleted

Nilai	Deskripsi
thread.run.step.completed

---

thread.run.step.failed

Terjadi ketika langkah eksekusi gagal.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventFailed

Nilai	Deskripsi
thread.run.step.failed

---

thread.run.step.cancelled

Terjadi ketika langkah eksekusi dibatalkan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCancelled

Nilai	Deskripsi
thread.run.step.cancelled

---

thread.run.step.expired

Terjadi ketika langkah eksekusi kedaluwarsa.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Ya

Data: runStepObject

Enum Peristiwa: RunStepStreamEventExpired

Nilai	Deskripsi
thread.run.step.expired

---

messageStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.message.created

Terjadi saat pesan dibuat.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	messageObject	Mewakili pesan dalam utas.	Ya

Data: messageObject

Enum Peristiwa: MessageStreamEventCreated

Nilai	Deskripsi
thread.message.created

---

thread.message.in_progress

Terjadi ketika pesan berpindah ke status in_progress .

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	messageObject	Mewakili pesan dalam utas.	Ya

Data: messageObject

Enum Peristiwa: MessageStreamEventInProgress

Nilai	Deskripsi
thread.message.in_progress

---

thread.message.delta

Terjadi ketika bagian pesan sedang dialirkan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	messageDeltaObject	Mewakili delta pesan yaitu bidang yang diubah pada pesan selama streaming.	Ya

Data: messageDeltaObject

Enum Peristiwa: MessageStreamEventDelta

Nilai	Deskripsi
thread.message.delta

---

thread.message.completed

Terjadi ketika pesan selesai.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	messageObject	Mewakili pesan dalam utas.	Ya

Data: messageObject

Enum Peristiwa: MessageStreamEventCompleted

Nilai	Deskripsi
thread.message.completed

---

thread.message.incomplete

Terjadi ketika pesan berakhir sebelum selesai.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	messageObject	Mewakili pesan dalam utas.	Ya

Data: messageObject

Enum Peristiwa: MessageStreamEventIncomplete

Nilai	Deskripsi
thread.message.incomplete

---

errorEvent

Terjadi ketika terjadi kesalahan. Ini dapat terjadi karena kesalahan server internal atau waktu habis.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	kesalahan		Ya

event Enum: ErrorEventEnum

Nilai	Deskripsi
kesalahan

doneEvent

Terjadi saat aliran berakhir.

Nama	Tipe	Deskripsi	Wajib diisi	Default
event	string		Ya
data	string		Ya

event Enum: DoneEventEnum

Nilai	Deskripsi
selesai

enum data: DoneEventDataEnum

Nilai	Deskripsi
[SELESAI]

Langkah berikutnya

Pelajari tentang Model, dan penyempurnaan dengan REST API. Pelajari selengkapnya tentang model yang mendasari yang mendukung Azure OpenAI.