Azure OpenAI görüntü ve ses REST API başvurusu (2024-10-21)

Bu makalede, GA sürümünde openAI 2024-10-21 Azure için görüntü oluşturma ve ses (konuşma) veri düzlemi çıkarımı REST API işlemleri belgelenmiştir. Sohbet tamamlamaları, eklemeler, tamamlamalar ve diğer tüm işlemler için openai REST API başvurusunun resmi Azure bakın.

API belirtimleri

Azure OpenAI modelleri ve kaynaklarıyla yönetmek ve etkileşim üç ana API yüzeyine bölünmüştür:

• Kontrol düzlemi
• Veri düzlemi - yazarlık
• Veri düzlemi - çıkarım

Her API yüzeyi/spesifikasyonu, farklı bir Azure OpenAI yetenekleri setini kapsar. Her API'nin kendine özgü önizleme ve kararlı/genel erişilebilir (GA) API sürümleri vardır. Şu anda ön izleme sürümleri genellikle aylık bir ritm izlemektedir.

Authentication

Azure OpenAI, kimlik doğrulama için iki yöntem sunar. API Anahtarları veya Microsoft Entra ID'si kullanabilirsiniz.

• API Anahtarı Doğrulama: Bu tür kimlik doğrulama için, tüm API talepleri HTTP başlığında API Anahtarını api-key içermelidir. Quickstart, bu tür kimlik doğrulama ile aramaların nasıl yapılacağına dair rehberlik sağlar.

• Microsoft Entra ID kimlik doğrulama: Bir Microsoft Entra token kullanarak API çağrısını kimlik doğrulaması yapabilirsiniz. Kimlik doğrulama tokenları, bir talebe başlık Authorization olarak dahil edilir. Sağlanan belirteç, örneğin , ile gelmelidirBearerBearer YOUR_AUTH_TOKEN. Microsoft Entra ID<doğrulama rehberimizi okuyabilirsiniz>.

REST API sürümleme

Servis API'leri sorgu parametresi kullanılarak api-version versiyonlandırılır. Tüm sürümler YYYY-MM-DD tarih yapısını takip eder. Örneğin:

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

Veri düzlemi çıkarımı

Bu makalenin geri kalanı, Azure OpenAI veri düzlemi çıkarım belirtimi 2024-10-21olan GA sürümündeki görüntü ve ses işlemlerini kapsar.

Önizleme görüntüsü ve ses işlemleri için bkz. önizleme görüntüsü ve ses REST API başvurusu.

Transkripsiyonlar - Yarat

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

Sesi giriş diline aktarır.

URI Parametreleri

İstek Başlığı

İstek Gövdesi

İçerik Türü: çok parçalı form-verisi

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

Examples

Örnek

Verilen konuşulmuş ses verilerinden transkribe metin ve ilgili meta verileri alır.

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

Yanıtlar: Durum Kodu: 200

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

Örnek

Verilen konuşulmuş ses verilerinden transkribe metin ve ilgili meta verileri alır.

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

Yanıtlar: Durum Kodu: 200

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

Çeviriler - Yarat

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

Giriş sesi İngilizce metne transkribe eder ve çevirir.

URI Parametreleri

İstek Başlığı

İstek Gövdesi

İçerik Türü: çok parçalı form-verisi

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

Examples

Örnek

İngilizce transkribe metni ve ilgili meta verileri sağlanan konuşulan ses verilerinden alır.

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

Yanıtlar: Durum Kodu: 200

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

Örnek

İngilizce transkribe metni ve ilgili meta verileri sağlanan konuşulan ses verilerinden alır.

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

Yanıtlar: Durum Kodu: 200

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

Görüntü oluşturma

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

Verilen bir dall-e model dağıtımında metin başlığından bir dizi görüntü üretir

URI Parametreleri

İstek Başlığı

İstek Gövdesi

İçerik Türü: application/json

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

Durum Kodu: varsayılan

Açıklama: Bir hata meydana geldi.

Examples

Örnek

Bir prompt verildiğinde görseller oluşturur.

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

Yanıtlar: Durum Kodu: 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

Sohbet, tamamlamalar, eklemeler ve diğer metin işlemleri tarafından kullanılan şema tanımları için OpenAI REST API başvurusu Azure bakın. Aşağıdaki şemalar bu sayfadaki görüntü ve ses işlemlerini destekler.

innerErrorCode

İç hata nesnesi için hata kodları.

Açıklama: İç hata nesnesi için hata kodları.

Tür: dize

Varsayılan:

Enum Adı: InnerErrorCode

Sabit Listesi Değerleri:

dalleErrorResponse

dalleError

dalleInnerError

İç hata ve ek detaylar.

içerik filtresi ciddiyet sonucu

içerik filtresi algılandı sonucu

dalleFiltreSonuçları

İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.

sesli yanıt

Çeviri veya transkripsiyon yanıtı response_format json olduğunda

audioVerboseResponse

Çeviri veya transkripsiyon yanıtı response_format verbose_json

audioResponseFormat

Çıktının formatını tanımlar.

Açıklama: Çıktının formatını tanımlar.

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

• JSON
• text
• srt
• verbose_json
• vtt

görüntü kalitesi

Üretilecek görüntünün kalitesi.

Açıklama: Oluşturulacak görüntünün kalitesi.

Tür: dize

Varsayılan: standart

Enum Adı: Kalite

Sabit Listesi Değerleri:

imagesResponseFormat

Oluşturulan görüntülerin geri dönüş biçimi.

Açıklama: Oluşturulan görüntülerin geri gönderildiği format.

Tür: dize

Varsayılan: url

Enum Adı: ImagesResponseFormat

Sabit Listesi Değerleri:

imageSize

Oluşturulan görüntülerin boyutu.

Açıklama: Oluşturulan görüntülerin boyutu.

Tür: dize

Varsayılan: 1024x1024

Enum Adı: Boyut

Sabit Listesi Değerleri:

imageStyle

Oluşturulan görüntülerin stili.

Açıklama: Oluşturulan görsellerin stili.

Tür: dize

Varsayılan: canlı

Enum Adı: Stil

Sabit Listesi Değerleri:

generateImagesResponse

Sonraki Adımlar

REST API ile modeller ve ince ayarlamalar hakkında bilgi edinin. OpenAI Azure destekleyen underlying modelleri hakkında daha fazla bilgi edinin.