Azure referensi REST API gambar dan audio OpenAI (2024-10-21)

Artikel ini mencakup operasi REST API inferensi sarana data pembuatan gambar dan audio (ucapan) untuk Azure OpenAI dalam 2024-10-21 rilis GA. Untuk penyelesaian obrolan, penyematan, penyelesaian, dan semua operasi lainnya, lihat referensi resmi Azure OpenAI REST API.

Spesifikasi API

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

• Pesawat Kontrol
• Bidang data - penulisan
• Bidang data - inferensi

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

Important

Sekarang ada API inferensi pratinjau baru. Pelajari lebih lanjut di panduan siklus hidup API kami.

API	Rilis pratinjau terbaru	Rilis GA terbaru	Specifications	Description
Pesawat kontrol	2025-07-01-preview	2025-06-01	File spesifikasi teknis	API sarana kontrol digunakan untuk operasi seperti membuat sumber daya, penyebaran model, dan tugas manajemen sumber daya tingkat tinggi lainnya. Sarana kontrol juga mengatur apa yang mungkin dilakukan dengan kemampuan seperti Azure Resource Manager, Bicep, Terraform, dan Azure CLI.
Bidang data	v1 preview	v1	File spesifikasi teknis	API bidang data mengontrol operasi inferensi dan penurunan.

Authentication

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

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

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

Penerapan versi REST API

API layanan diversi menggunakan api-version parameter kueri. 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 bidang data

Sisa artikel ini mencakup operasi gambar dan audio dalam rilis GA dari spesifikasi inferensi bidang data OpenAI Azure, 2024-10-21.

Untuk operasi pratinjau gambar dan audio, lihat gambar pratinjau dan referensi REST API audio.

Transkripsi - Buat

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

Menyalin audio ke dalam bahasa input.

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (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
ID penempatan	path	Yes	string	ID penyebaran model ucapan ke teks. Untuk informasi tentang model yang didukung, lihat [/azure/ai-foundry/openai/concepts/models#audio-models].
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Description	Required	Default
berkas	string	Objek file audio untuk ditranskripsikan.	Yes
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus sesuai 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, sedangkan 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 tercapai.	No	0
bahasa	string	Bahasa audio input. Memasok bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Description
application/json	audioResponse atau audioVerboseResponse
text/plain	string	Teks yang ditranskripsi dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Examples

Example

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

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

Tanggapan: Kode Status: 200

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

Example

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

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

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

Tanggapan: 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-21

Mentranskripsikan dan menerjemahkan audio input ke dalam teks bahasa Inggris.

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (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
ID penempatan	path	Yes	string	ID penyebaran model transkripsi yang disebarkan. Untuk informasi tentang model yang didukung, lihat [/azure/ai-foundry/openai/concepts/models#audio-models].
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Description	Required	Default
berkas	string	File audio yang akan diterjemahkan.	Yes
minta	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, sedangkan 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 tercapai.	No	0

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Description
application/json	audioResponse atau audioVerboseResponse
text/plain	string	Teks yang ditranskripsi dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Examples

Example

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

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

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

Tanggapan: Kode Status: 200

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

Example

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

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

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

Tanggapan: Kode Status: 200

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

Pembuatan gambar

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

Menghasilkan kumpulan gambar dari keterangan teks pada penyebaran model dall-e tertentu

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (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
ID penempatan	path	Yes	string	ID penyebaran model dall-e yang disebarkan.
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Description	Required	Default
minta	string	Deskripsi teks dari gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Yes
n	integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024x1024
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

Responses

Kode Status: 200

Deskripsi: Ok

Content-Type	Tipe	Description
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Content-Type	Tipe	Description
application/json	dalleErrorResponse

Examples

Example

Membuat gambar yang diberi perintah.

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

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

Tanggapan: 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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

Untuk definisi skema yang digunakan oleh obrolan, penyelesaian, penyematan, dan operasi teks lainnya, lihat referensi Azure OpenAI REST API. Skema berikut mendukung operasi gambar dan audio di halaman ini.

innerErrorCode

Kode kesalahan untuk objek kesalahan dalam.

Deskripsi: Kode kesalahan untuk objek kesalahan dalam.

Jenis: teks

Default:

Nama Enum: InnerErrorCode

Nilai Enum:

Nilai	Description
Pelanggaran Kebijakan AI yang Bertanggung Jawab	Perintah tersebut melanggar salah satu aturan filter konten lainnya.

dalleErrorResponse

Nama	Tipe	Description	Required	Default
galat	dalleError		No

dalleError

Nama	Tipe	Description	Required	Default
param	string		No
jenis	string		No
inner_error	dalleInnerError	Kesalahan batin dengan detail tambahan.	No

dalleInnerError

Kesalahan batin dengan detail tambahan.

Nama	Tipe	Description	Required	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), apakah telah terdeteksi, serta tingkat keparahan (skala very_low, rendah, sedang, tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan apakah telah disaring atau belum. Informasi tentang konten jailbreak dan kata-kata kotor, apakah sudah terdeteksi, dan apakah sudah disaring atau belum. Dan informasi tentang daftar blokir pelanggan, jika sudah disaring dan id-nya.	No
petunjuk_direvisi	string	Prompt yang digunakan untuk menghasilkan gambar, jika ada revisi pada prompt.	No

HasilTingkatKeparahanPenyaringanKonten

Nama	Tipe	Description	Required	Default
filtered	Boolean		Yes
severity	string		No

Hasil Deteksi Penyaringan Konten

Nama	Tipe	Description	Required	Default
filtered	Boolean		Yes
detected	Boolean		No

dalleFilterResults

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

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No
profanity	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No

audioResponse

Respons terjemahan atau transkripsi ketika response_format adalah json

Nama	Tipe	Description	Required	Default
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsi.	Yes

audioVerboseResponse

Respons terjemahan atau transkripsi saat response_format verbose_json

Nama	Tipe	Description	Required	Default
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsi.	Yes
tugas	string	Jenis tugas audio.	No
bahasa	string	Bahasa.	No
duration	number	Durasi.	No
segments	array		No

audioResponseFormat

Menentukan format output.

Deskripsi: Menentukan format output.

Jenis: teks

Default:

Nilai Enum:

• json
• kirim pesan teks
• SRT
• verbose_json
• vtt

imageQuality

Kualitas gambar yang akan dihasilkan.

Deskripsi: Kualitas gambar yang akan dihasilkan.

Jenis: teks

Default: standar

Nama Enum: Kualitas

Nilai Enum:

Nilai	Description
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 ditampilkan.

Jenis: teks

Default: url

Nama Enum: ImagesResponseFormat

Nilai Enum:

Nilai	Description
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: teks

Default: 1024x1024

Nama Enum: Ukuran

Nilai Enum:

Nilai	Description
1792x1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1792x1024 piksel.
1024x1792	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1792 piksel.
1024x1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1024 piksel.

imageStyle

Gaya gambar yang dihasilkan.

Deskripsi: Gaya gambar yang dihasilkan.

Jenis: teks

Default: vivid

Nama Enum: Gaya

Nilai Enum:

Nilai	Description
Jelas	Vivid menciptakan gambar yang hiper-realistis dan dramatis.
alami	Natural menciptakan gambar yang lebih alami dan kurang hiper-realistis.

generateImagesResponse

Nama	Tipe	Description	Required	Default
Dibuat	integer	Stempel waktu unix saat operasi dibuat.	Yes
data	array	Data hasil operasi, jika berhasil	Yes

Langkah berikutnya

Pelajari tentang model dan penyempurnaan dengan REST API. Pelajari selengkapnya tentang model underlying yang mendukung Azure OpenAI.