Get Chat Completions - Get Chat Completions

Layanan:: AI Foundry

Versi API:: 2024-05-01-preview

Mendapatkan penyelesaian obrolan untuk pesan obrolan yang disediakan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan. Metode ini melakukan panggilan REST API ke rute /chat/completions pada titik akhir yang diberikan.

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resource	path	True	string	Nama sumber daya Azure AI Services, misalnya 'my-resource'
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
extra-parameters		ExtraParameters	Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON. Ini mengatur header permintaan HTTP `extra-parameters`.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
messages	True	ChatRequestMessage[]: ChatRequestAssistantMessage[] ChatRequestSystemMessage[] ChatRequestToolMessage[] ChatRequestUserMessage[]	Kumpulan pesan konteks yang terkait dengan permintaan penyelesaian obrolan ini. Penggunaan umum dimulai dengan pesan obrolan untuk peran Sistem yang memberikan instruksi untuk perilaku asisten, diikuti dengan pesan alternatif antara peran Pengguna dan Asisten.
frequency_penalty		number (float) minimum: -2 maximum: 2	Nilai yang memengaruhi probabilitas token yang dihasilkan muncul berdasarkan frekuensi kumulatifnya dalam teks yang dihasilkan. Nilai positif akan membuat token lebih kecil kemungkinannya muncul saat frekuensinya meningkat dan mengurangi kemungkinan model mengulangi pernyataan verbatim yang sama. Rentang yang didukung adalah [-2, 2].
max_tokens		integer (int32) minimum: 0	Jumlah maksimum token yang akan dihasilkan.
modalities		ChatCompletionsModality[]	Modalitas yang diizinkan untuk digunakan model untuk respons penyelesaian obrolan. Modalitas default adalah `text`. Menunjukkan kombinasi modalitas yang tidak didukung menghasilkan kesalahan 422.
model		string	ID model AI tertentu untuk digunakan, jika lebih dari satu model tersedia di titik akhir.
presence_penalty		number (float) minimum: -2 maximum: 2	Nilai yang memengaruhi probabilitas token yang dihasilkan muncul berdasarkan kehadiran yang ada dalam teks yang dihasilkan. Nilai positif akan membuat token lebih kecil kemungkinannya muncul ketika sudah ada dan meningkatkan kemungkinan model untuk menghasilkan topik baru. Rentang yang didukung adalah [-2, 2].
response_format		ChatCompletionsResponseFormat: ChatCompletionsResponseFormatJsonObject ChatCompletionsResponseFormatJsonSchema ChatCompletionsResponseFormatText	Objek yang menentukan format yang harus dihasilkan model. Pengaturan ke `{ "type": "json_schema", "json_schema": {...} }` memungkinkan Output Terstruktur yang memastikan model akan cocok dengan skema JSON yang Anda berikan. Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON, yang memastikan 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 melebihi `max_tokens` atau percakapan melebihi panjang konteks maksimum.
seed		integer (int64)	Jika ditentukan, sistem akan melakukan upaya terbaik untuk mengambil sampel secara deterministik sehingga permintaan berulang dengan seed dan parameter yang sama harus mengembalikan hasil yang sama. Determinisme tidak dijamin.
stop		string[]	Kumpulan urutan tekstual yang akan mengakhiri pembuatan penyelesaian.
stream		boolean	Nilai yang menunjukkan apakah penyelesaian obrolan harus dialirkan untuk permintaan ini.
temperature		number (float) minimum: 0 maximum: 1	Suhu pengambilan sampel untuk digunakan yang mengontrol kreativitas yang jelas dari penyelesaian yang dihasilkan. Nilai yang lebih tinggi akan membuat output lebih acak sementara nilai yang lebih rendah akan membuat hasil lebih fokus dan deterministik. Tidak disarankan untuk memodifikasi suhu dan top_p untuk permintaan penyelesaian yang sama karena interaksi kedua pengaturan ini sulit diprediksi. Rentang yang didukung adalah [0, 1].
tool_choice			Jika ditentukan, model akan mengonfigurasi alat mana yang disediakan yang dapat digunakannya untuk respons penyelesaian obrolan.
tools		ChatCompletionsToolDefinition[]	Daftar alat yang mungkin diminta model untuk dipanggil. Saat ini, hanya fungsi yang didukung sebagai alat. Model dapat merespons dengan permintaan panggilan fungsi dan memberikan argumen input dalam format JSON untuk fungsi tersebut.
top_p		number (float) minimum: 0 maximum: 1	Alternatif untuk pengambilan sampel dengan suhu yang disebut pengambilan sampel nukleus. Nilai ini menyebabkan model mempertimbangkan hasil token dengan massa probabilitas yang disediakan. Sebagai contoh, nilai 0,15 hanya akan menyebabkan token yang terdiri dari 15% massa probabilitas teratas untuk dipertimbangkan. Tidak disarankan untuk memodifikasi suhu dan top_p untuk permintaan penyelesaian yang sama karena interaksi kedua pengaturan ini sulit diprediksi. Rentang yang didukung adalah [0, 1].

Respons

Nama	Jenis	Deskripsi
200 OK	ChatCompletions	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

ChatCompletions

Permintaan telah berhasil.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Audio modality chat completion

maximum set chat completion

minimum set chat completion

Audio modality chat completion

Permintaan sampel

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text",
    "audio"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    },
    {
      "role": "assistant",
      "content": null,
      "audio": {
        "id": "abcdef1234"
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    }
  ],
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "seed": 21,
  "model": "my-model-name"
}

Respon sampel

Kode status:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1696522361,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16,
    "completion_tokens_details": {
      "audio_tokens": 5,
      "total_tokens": 5
    },
    "prompt_tokens_details": {
      "audio_tokens": 10,
      "cached_tokens": 0
    }
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": null,
        "audio": {
          "id": "abcdef1234",
          "format": "wav",
          "data": "<base64 encoded audio data>",
          "expires_at": 1896522361,
          "transcript": "This is a sample transcript"
        }
      }
    }
  ]
}

maximum set chat completion

Permintaan sampel

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    },
    {
      "role": "assistant",
      "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594."
    },
    {
      "role": "user",
      "content": "Ist it proved?"
    }
  ],
  "frequency_penalty": 0,
  "stream": true,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "max_tokens": 255,
  "response_format": {
    "type": "text"
  },
  "stop": [
    "<|endoftext|>"
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "my-function-name",
        "description": "A function useful to know if a theroem is proved or not"
      }
    }
  ],
  "seed": 21,
  "model": "my-model-name"
}

Respon sampel

Kode status:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 18,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16
  },
  "choices": [
    {
      "index": 7,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "yrobmilsrugmbwukmzo",
            "type": "function",
            "function": {
              "name": "my-function-name",
              "arguments": "{ \"arg1\": \"value1\", \"arg2\": \"value2\" }"
            }
          }
        ]
      }
    }
  ]
}

minimum set chat completion

Permintaan sampel

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

{
  "messages": [
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    }
  ]
}

Respon sampel

Kode status:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 205,
    "completion_tokens": 5,
    "total_tokens": 210
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594"
      }
    }
  ]
}

Definisi

Nama	Deskripsi
AudioContentFormat	Representasi dari kemungkinan format audio untuk audio.
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChatChoice	Representasi penyelesaian permintaan tunggal sebagai bagian dari permintaan penyelesaian obrolan secara keseluruhan. Umumnya, pilihan `n` dihasilkan per prompt yang disediakan dengan nilai default 1. Batas token dan pengaturan lainnya dapat membatasi jumlah pilihan yang dihasilkan.
ChatCompletions	Representasi data respons dari permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan.
ChatCompletionsAudio	Representasi audio yang dihasilkan oleh model.
ChatCompletionsModality	Modalitas yang diizinkan untuk digunakan model untuk respons penyelesaian obrolan.
ChatCompletionsOptions	Informasi konfigurasi untuk permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan.
ChatCompletionsResponseFormatJsonObject	Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid. Perhatikan bahwa untuk mengaktifkan mode JSON, beberapa model AI mungkin juga mengharuskan Anda menginstruksikan model untuk menghasilkan JSON melalui sistem atau pesan pengguna.
ChatCompletionsResponseFormatJsonSchema	Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid, dengan skema JSON yang ditentukan oleh pemanggil.
ChatCompletionsResponseFormatJsonSchemaDefinition	Definisi skema JSON yang diperlukan dalam respons, dan metadata terkait.
ChatCompletionsResponseFormatText	Format respons untuk Penyelesaian Obrolan yang memancarkan respons teks. Ini adalah format respons default.
ChatCompletionsToolCall	Panggilan alat fungsi yang diminta oleh model AI.
ChatCompletionsToolDefinition	Definisi alat penyelesaian obrolan yang dapat memanggil fungsi.
ChatRequestAssistantMessage	Pesan obrolan permintaan yang mewakili respons atau tindakan dari asisten.
ChatRequestAudioReference	Referensi ke respons audio yang dihasilkan oleh model.
ChatRequestSystemMessage	Pesan obrolan permintaan yang berisi instruksi sistem yang memengaruhi bagaimana model akan menghasilkan respons penyelesaian obrolan.
ChatRequestToolMessage	Pesan obrolan permintaan yang mewakili output yang diminta dari alat yang dikonfigurasi.
ChatRequestUserMessage	Pesan obrolan permintaan yang mewakili input pengguna ke asisten.
ChatResponseMessage	Representasi pesan obrolan seperti yang diterima sebagai respons.
ChatRole	Deskripsi tujuan yang dimaksudkan dari pesan dalam interaksi penyelesaian obrolan.
CompletionsFinishReason	Representasi cara di mana respons penyelesaian disimpulkan.
CompletionsUsage	Representasi jumlah token yang diproses untuk permintaan penyelesaian. Hitungan mempertimbangkan semua token di seluruh perintah, pilihan, pilihan alternatif, generasi best_of, dan konsumen lainnya.
CompletionsUsageDetails	Perincian token yang digunakan dalam penyelesaian.
ExtraParameters	Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON.
FunctionCall	Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.
FunctionDefinition	Definisi fungsi yang ditentukan pemanggil yang dapat dipanggil penyelesaian obrolan sebagai respons terhadap input pengguna yang cocok.
PromptUsageDetails	Perincian token yang digunakan dalam riwayat perintah/obrolan.

AudioContentFormat

Enumeration

Representasi dari kemungkinan format audio untuk audio.

Nilai	Deskripsi
wav	Menentukan audio dalam format WAV.
mp3	Menentukan audio dalam format MP3.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

ChatChoice

Objek

Representasi penyelesaian permintaan tunggal sebagai bagian dari permintaan penyelesaian obrolan secara keseluruhan. Umumnya, pilihan n dihasilkan per prompt yang disediakan dengan nilai default 1. Batas token dan pengaturan lainnya dapat membatasi jumlah pilihan yang dihasilkan.

Nama	Jenis	Deskripsi
finish_reason	CompletionsFinishReason	Alasan bahwa pilihan penyelesaian obrolan ini menyelesaikan hasilnya.
index	integer (int32)	Indeks terurut yang terkait dengan pilihan penyelesaian obrolan ini.
message	ChatResponseMessage	Pesan obrolan untuk permintaan penyelesaian obrolan tertentu.

ChatCompletions

Objek

Representasi data respons dari permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan.

Nama	Jenis	Deskripsi
choices	ChatChoice[]	Kumpulan pilihan penyelesaian yang terkait dengan respons penyelesaian ini. Umumnya, pilihan `n` dihasilkan per prompt yang disediakan dengan nilai default 1. Batas token dan pengaturan lainnya dapat membatasi jumlah pilihan yang dihasilkan.
created	integer (unixtime)	Tanda waktu pertama yang terkait dengan aktivitas pembuatan untuk respons penyelesaian ini, diwakili sebagai detik sejak awal epoch Unix 00:00 pada 1 Jan 1970.
id	string	Pengidentifikasi unik yang terkait dengan respons penyelesaian obrolan ini.
model	string	Model yang digunakan untuk penyelesaian obrolan.
object	enum: chat.completion	Jenis objek respons, yang selalu `chat.completion`.
usage	CompletionsUsage	Informasi penggunaan untuk token yang diproses dan dihasilkan sebagai bagian dari operasi penyelesaian ini.

ChatCompletionsAudio

Objek

Representasi audio yang dihasilkan oleh model.

Nama	Jenis	Deskripsi
data	string	Data audio yang dikodekan Base64
expires_at	integer (unixtime)	Tanda waktu Unix (dalam detik) tempat bagian audio kedaluwarsa dan tidak dapat dirujuk lagi oleh ID-nya dalam percakapan multi-giliran.
format	AudioContentFormat	Format konten audio. Jika format tidak disediakan, format akan cocok dengan format yang digunakan dalam permintaan audio input.
id	string	Pengidentifikasi unik untuk respons audio. Nilai ini dapat digunakan dalam pesan riwayat obrolan alih-alih meneruskan objek audio lengkap.
transcript	string	Transkrip file audio.

ChatCompletionsModality

Enumeration

Modalitas yang diizinkan untuk digunakan model untuk respons penyelesaian obrolan.

Nilai	Deskripsi
text	Model hanya diizinkan untuk menghasilkan teks.
audio	Model diizinkan untuk menghasilkan audio.

ChatCompletionsOptions

Objek

Informasi konfigurasi untuk permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan.

Nama	Jenis	Nilai default	Deskripsi
frequency_penalty	number (float) minimum: -2 maximum: 2	0	Nilai yang memengaruhi probabilitas token yang dihasilkan muncul berdasarkan frekuensi kumulatifnya dalam teks yang dihasilkan. Nilai positif akan membuat token lebih kecil kemungkinannya muncul saat frekuensinya meningkat dan mengurangi kemungkinan model mengulangi pernyataan verbatim yang sama. Rentang yang didukung adalah [-2, 2].
max_tokens	integer (int32) minimum: 0		Jumlah maksimum token yang akan dihasilkan.
messages	ChatRequestMessage[]: ChatRequestAssistantMessage[] ChatRequestSystemMessage[] ChatRequestToolMessage[] ChatRequestUserMessage[]		Kumpulan pesan konteks yang terkait dengan permintaan penyelesaian obrolan ini. Penggunaan umum dimulai dengan pesan obrolan untuk peran Sistem yang memberikan instruksi untuk perilaku asisten, diikuti dengan pesan alternatif antara peran Pengguna dan Asisten.
modalities	ChatCompletionsModality[]		Modalitas yang diizinkan untuk digunakan model untuk respons penyelesaian obrolan. Modalitas default adalah `text`. Menunjukkan kombinasi modalitas yang tidak didukung menghasilkan kesalahan 422.
model	string		ID model AI tertentu untuk digunakan, jika lebih dari satu model tersedia di titik akhir.
presence_penalty	number (float) minimum: -2 maximum: 2	0	Nilai yang memengaruhi probabilitas token yang dihasilkan muncul berdasarkan kehadiran yang ada dalam teks yang dihasilkan. Nilai positif akan membuat token lebih kecil kemungkinannya muncul ketika sudah ada dan meningkatkan kemungkinan model untuk menghasilkan topik baru. Rentang yang didukung adalah [-2, 2].
response_format	ChatCompletionsResponseFormat: ChatCompletionsResponseFormatJsonObject ChatCompletionsResponseFormatJsonSchema ChatCompletionsResponseFormatText		Objek yang menentukan format yang harus dihasilkan model. Pengaturan ke `{ "type": "json_schema", "json_schema": {...} }` memungkinkan Output Terstruktur yang memastikan model akan cocok dengan skema JSON yang Anda berikan. Pengaturan ke `{ "type": "json_object" }` memungkinkan mode JSON, yang memastikan 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 melebihi `max_tokens` atau percakapan melebihi panjang konteks maksimum.
seed	integer (int64)		Jika ditentukan, sistem akan melakukan upaya terbaik untuk mengambil sampel secara deterministik sehingga permintaan berulang dengan seed dan parameter yang sama harus mengembalikan hasil yang sama. Determinisme tidak dijamin.
stop	string[]		Kumpulan urutan tekstual yang akan mengakhiri pembuatan penyelesaian.
stream	boolean		Nilai yang menunjukkan apakah penyelesaian obrolan harus dialirkan untuk permintaan ini.
temperature	number (float) minimum: 0 maximum: 1	0.7	Suhu pengambilan sampel untuk digunakan yang mengontrol kreativitas yang jelas dari penyelesaian yang dihasilkan. Nilai yang lebih tinggi akan membuat output lebih acak sementara nilai yang lebih rendah akan membuat hasil lebih fokus dan deterministik. Tidak disarankan untuk memodifikasi suhu dan top_p untuk permintaan penyelesaian yang sama karena interaksi kedua pengaturan ini sulit diprediksi. Rentang yang didukung adalah [0, 1].
tool_choice			Jika ditentukan, model akan mengonfigurasi alat mana yang disediakan yang dapat digunakannya untuk respons penyelesaian obrolan.
tools	ChatCompletionsToolDefinition[]		Daftar alat yang mungkin diminta model untuk dipanggil. Saat ini, hanya fungsi yang didukung sebagai alat. Model dapat merespons dengan permintaan panggilan fungsi dan memberikan argumen input dalam format JSON untuk fungsi tersebut.
top_p	number (float) minimum: 0 maximum: 1	1	Alternatif untuk pengambilan sampel dengan suhu yang disebut pengambilan sampel nukleus. Nilai ini menyebabkan model mempertimbangkan hasil token dengan massa probabilitas yang disediakan. Sebagai contoh, nilai 0,15 hanya akan menyebabkan token yang terdiri dari 15% massa probabilitas teratas untuk dipertimbangkan. Tidak disarankan untuk memodifikasi suhu dan top_p untuk permintaan penyelesaian yang sama karena interaksi kedua pengaturan ini sulit diprediksi. Rentang yang didukung adalah [0, 1].

ChatCompletionsResponseFormatJsonObject

Objek

Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid. Perhatikan bahwa untuk mengaktifkan mode JSON, beberapa model AI mungkin juga mengharuskan Anda menginstruksikan model untuk menghasilkan JSON melalui sistem atau pesan pengguna.

Nama	Jenis	Deskripsi
type	string: json_object	Jenis format respons yang digunakan untuk penyelesaian obrolan.

ChatCompletionsResponseFormatJsonSchema

Objek

Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid, dengan skema JSON yang ditentukan oleh pemanggil.

Nama	Jenis	Deskripsi
json_schema	ChatCompletionsResponseFormatJsonSchemaDefinition	Definisi skema JSON yang diperlukan dalam respons, dan metadata terkait.
type	string: json_schema	Jenis format respons yang digunakan untuk penyelesaian obrolan.

ChatCompletionsResponseFormatJsonSchemaDefinition

Objek

Definisi skema JSON yang diperlukan dalam respons, dan metadata terkait.

Nama	Jenis	Nilai default	Deskripsi
description	string		Deskripsi format respons, digunakan oleh model AI untuk menentukan cara menghasilkan respons dalam format ini.
name	string		Nama format respons. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.
schema			Definisi skema JSON
strict	boolean	False	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema yang tepat yang ditentukan di bidang `schema`. Hanya subset Skema JSON yang didukung saat `stricttrue`.

ChatCompletionsResponseFormatText

Objek

Format respons untuk Penyelesaian Obrolan yang memancarkan respons teks. Ini adalah format respons default.

Nama	Jenis	Deskripsi
type	string: text	Jenis format respons yang digunakan untuk penyelesaian obrolan.

ChatCompletionsToolCall

Objek

Panggilan alat fungsi yang diminta oleh model AI.

Nama	Jenis	Deskripsi
function	FunctionCall	Detail panggilan fungsi yang diminta oleh model AI.
id	string	ID panggilan alat.
type	enum: function	Jenis panggilan alat. Saat ini, hanya `function` yang didukung.

ChatCompletionsToolDefinition

Objek

Definisi alat penyelesaian obrolan yang dapat memanggil fungsi.

Nama	Jenis	Deskripsi
function	FunctionDefinition	Detail definisi fungsi untuk alat fungsi.
type	enum: function	Jenis alat. Saat ini, hanya `function` yang didukung.

ChatRequestAssistantMessage

Objek

Pesan obrolan permintaan yang mewakili respons atau tindakan dari asisten.

Nama	Jenis	Deskripsi
audio	ChatRequestAudioReference	Audio yang dihasilkan oleh respons sebelumnya dalam percakapan multi-giliran.
content	string	Konten pesan.
role	string: assistant	Peran obrolan yang terkait dengan pesan ini.
tool_calls	ChatCompletionsToolCall[]	Panggilan alat yang harus diselesaikan dan outputnya ditambahkan ke pesan input berikutnya untuk permintaan penyelesaian obrolan untuk diselesaikan seperti yang dikonfigurasi.

ChatRequestAudioReference

Objek

Referensi ke respons audio yang dihasilkan oleh model.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi unik untuk respons audio. Nilai ini sesuai dengan id penyelesaian audio sebelumnya.

ChatRequestSystemMessage

Objek

Pesan obrolan permintaan yang berisi instruksi sistem yang memengaruhi bagaimana model akan menghasilkan respons penyelesaian obrolan.

Nama	Jenis	Deskripsi
content	string	Isi pesan sistem.
role	string: system	Peran obrolan yang terkait dengan pesan ini.

ChatRequestToolMessage

Objek

Pesan obrolan permintaan yang mewakili output yang diminta dari alat yang dikonfigurasi.

Nama	Jenis	Deskripsi
content	string	Konten pesan.
role	string: tool	Peran obrolan yang terkait dengan pesan ini.
tool_call_id	string	ID panggilan alat diselesaikan oleh konten yang disediakan.

ChatRequestUserMessage

Objek

Pesan obrolan permintaan yang mewakili input pengguna ke asisten.

Nama	Jenis	Deskripsi
content		Konten pesan pengguna, dengan jenis input yang tersedia bervariasi menurut model yang dipilih.
role	string: user	Peran obrolan yang terkait dengan pesan ini.

ChatResponseMessage

Objek

Representasi pesan obrolan seperti yang diterima sebagai respons.

Nama	Jenis	Deskripsi
audio	ChatCompletionsAudio	Audio yang dihasilkan oleh model sebagai respons terhadap pesan jika model dikonfigurasi untuk menghasilkan audio.
content	string	Konten pesan.
role	ChatRole	Peran obrolan yang terkait dengan pesan.
tool_calls	ChatCompletionsToolCall[]	Panggilan alat yang harus diselesaikan dan outputnya ditambahkan ke pesan input berikutnya untuk permintaan penyelesaian obrolan untuk diselesaikan seperti yang dikonfigurasi.

ChatRole

Enumeration

Deskripsi tujuan yang dimaksudkan dari pesan dalam interaksi penyelesaian obrolan.

Nilai	Deskripsi
system	Peran yang menginstruksikan atau mengatur perilaku asisten.
developer	Peran yang memberikan instruksi untuk model yang diprioritaskan di depan pesan pengguna.
user	Peran yang menyediakan input untuk penyelesaian obrolan.
assistant	Peran yang memberikan respons terhadap input yang diinstruksikan sistem dan diminta pengguna.
tool	Peran yang mewakili aktivitas alat ekstensi dalam operasi penyelesaian obrolan.

CompletionsFinishReason

Enumeration

Representasi cara di mana respons penyelesaian disimpulkan.

Nilai	Deskripsi
stop	Penyelesaian berakhir secara normal dan mencapai akhir pembuatan token.
length	Penyelesaian batas token yang tersedia habis sebelum pembuatan dapat diselesaikan.
content_filter	Penyelesaian menghasilkan respons yang diidentifikasi sebagai kebijakan moderasi konten yang berpotensi sensitif.
tool_calls	Penyelesaian berakhir dengan model memanggil alat yang disediakan untuk output.

CompletionsUsage

Objek

Representasi jumlah token yang diproses untuk permintaan penyelesaian. Hitungan mempertimbangkan semua token di seluruh perintah, pilihan, pilihan alternatif, generasi best_of, dan konsumen lainnya.

Nama	Jenis	Deskripsi
completion_tokens	integer (int32)	Jumlah token yang dihasilkan di semua emisi penyelesaian.
completion_tokens_details	CompletionsUsageDetails	Perincian token yang digunakan dalam penyelesaian.
prompt_tokens	integer (int32)	Jumlah token dalam permintaan yang disediakan untuk permintaan penyelesaian.
prompt_tokens_details	PromptUsageDetails	Perincian token yang digunakan dalam riwayat perintah/obrolan.
total_tokens	integer (int32)	Jumlah total token yang diproses untuk permintaan dan respons penyelesaian.

CompletionsUsageDetails

Objek

Perincian token yang digunakan dalam penyelesaian.

Nama	Jenis	Deskripsi
audio_tokens	integer (int32)	Jumlah token yang sesuai dengan input audio.
total_tokens	integer (int32)	Jumlah total token yang diproses untuk permintaan dan respons penyelesaian.

ExtraParameters

Enumeration

Mengontrol apa yang terjadi jika parameter tambahan, yang tidak ditentukan oleh REST API, diteruskan dalam payload permintaan JSON.

Nilai	Deskripsi
error	Layanan akan melakukan kesalahan jika mendeteksi parameter tambahan dalam payload permintaan. Ini adalah default layanan.
drop	Layanan akan mengabaikan (menghilangkan) parameter tambahan dalam payload permintaan. Ini hanya akan meneruskan parameter yang diketahui ke model AI back-end.
pass-through	Layanan ini akan meneruskan parameter tambahan ke model AI back-end.

FunctionCall

Objek

Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.

Nama	Jenis	Deskripsi
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 mungkin berhalusinasi parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.
name	string	Nama fungsi yang akan dipanggil.

FunctionDefinition

Objek

Definisi fungsi yang ditentukan pemanggil yang dapat dipanggil penyelesaian obrolan sebagai respons terhadap input pengguna yang cocok.

Nama	Jenis	Deskripsi
description	string	Deskripsi tentang apa yang dilakukan fungsi. Model akan menggunakan deskripsi ini saat memilih fungsi dan menginterpretasikan parameternya.
name	string	Nama fungsi yang akan dipanggil.
parameters		Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.

PromptUsageDetails

Objek

Perincian token yang digunakan dalam riwayat perintah/obrolan.

Nama	Jenis	Deskripsi
audio_tokens	integer (int32)	Jumlah token yang sesuai dengan input audio.
cached_tokens	integer (int32)	Jumlah total token yang di-cache.

Bagikan melalui

Get Chat Completions - Get Chat Completions

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

api-key

OAuth2Auth

Cakupan

Contoh

Audio modality chat completion

Permintaan sampel

Respon sampel

maximum set chat completion

Permintaan sampel

Respon sampel

minimum set chat completion

Permintaan sampel

Respon sampel

Definisi

AudioContentFormat

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ChatChoice

ChatCompletions

ChatCompletionsAudio

ChatCompletionsModality

ChatCompletionsOptions

ChatCompletionsResponseFormatJsonObject

ChatCompletionsResponseFormatJsonSchema

ChatCompletionsResponseFormatJsonSchemaDefinition

ChatCompletionsResponseFormatText

ChatCompletionsToolCall

ChatCompletionsToolDefinition

ChatRequestAssistantMessage

ChatRequestAudioReference

ChatRequestSystemMessage

ChatRequestToolMessage

ChatRequestUserMessage

ChatResponseMessage

ChatRole

CompletionsFinishReason

CompletionsUsage

CompletionsUsageDetails

ExtraParameters

FunctionCall

FunctionDefinition

PromptUsageDetails