Azure dokumentacja interfejsu API REST interfejsu API interfejsu OPENAI (2024-10-21)

Ten artykuł zawiera dokumenty dotyczące operacji interfejsu API REST generowania obrazów i dźwięku (mowy) na potrzeby operacji interfejsu API REST Azure OpenAI w wersji ogólnodostępnej2024-10-21. Aby uzyskać informacje na temat uzupełniania czatów, osadzania, uzupełniania i wszystkich innych operacji, zobacz oficjalną dokumentację interfejsu API REST platformy OpenAI Azure OpenAI.

Specyfikacje interfejsu API

Zarządzanie i interakcja z modelami i zasobami Azure OpenAI podzielone są na trzy główne powierzchnie API:

• Płaszczyzna sterowania
• Płaszczyzna danych – autorowanie
• Płaszczyzna danych – wnioskowanie

Każda powierzchnia/specyfikacja API zawiera inny zestaw możliwości Azure OpenAI. Każde API ma własny, unikalny zestaw wersji podglądowych oraz stabilnych/ogólnie dostępnych (GA) wersji API. Obecnie premierowe premiery mają tendencję do miesięcznego rytmu.

Authentication

Azure OpenAI oferuje dwie metody uwierzytelniania. Możesz użyć kluczy API lub Microsoft Entra ID.

• Uwierzytelnianie klucza API: W przypadku tego typu uwierzytelniania wszystkie żądania API muszą zawierać klucz API w nagłówku api-key HTTP. Quickstart zawiera wskazówki, jak wykonywać połączenia z tego typu uwierzytelnianiem.

• Microsoft Entra ID uwierzytelnianie: Możesz uwierzytelnić wywołanie API za pomocą tokena Microsoft Entra. Tokeny uwierzytelniające są zawarte w żądaniu jako nagłówek Authorization . Dostarczony token musi być poprzedzony Bearerprzez , na przykład Bearer YOUR_AUTH_TOKEN. Możesz przeczytać nasz przewodnik instrukcyjny dotyczący uwierzytelniania za pomocą Microsoft Entra ID.

Wersjonowanie REST API

API usług są wersjonowane za pomocą parametru api-version zapytania. Wszystkie wersje mają strukturę dat YYYY-MM-DD. Przykład:

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

Wnioskowanie na płaszczyźnie danych

W pozostałej części tego artykułu omówiono operacje obrazów i audio w wersji ogólnodostępnej specyfikacji wnioskowania płaszczyzny danych platformy Azure OpenAI, 2024-10-21.

Aby zapoznać się z operacjami obrazów i audio w wersji zapoznawczej, zobacz dokumentację interfejsu API REST podglądu i obrazu audio.

Transkrypcje - Stwórz

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

Transkrybuje dźwięk do języka wejściowego.

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod statusu: 200

Opis: OK

Examples

Przykład

Pobiera przepisany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

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

Odpowiedzi: Kod statusu: 200

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

Przykład

Pobiera przepisany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

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

Odpowiedzi: Kod statusu: 200

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

Tłumaczenia - Stwórz

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

Transkrybuje i tłumaczy wejście audio na tekst angielski.

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod statusu: 200

Opis: OK

Examples

Przykład

Otrzymuje transkrybowany tekst w języku angielskim oraz powiązane metadane z udostępnionych danych audio mówionych.

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

Odpowiedzi: Kod statusu: 200

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

Przykład

Otrzymuje transkrybowany tekst w języku angielskim oraz powiązane metadane z udostępnionych danych audio mówionych.

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

Odpowiedzi: Kod statusu: 200

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

Generowanie obrazu

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

Generuje partię obrazów z podpisu tekstowego przy danym wdrożeniu modelu dall-e

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod statusu: 200

Opis: Ok

Kod statusu: domyślny

Opis: Wystąpił błąd.

Examples

Przykład

Tworzy obrazy na podstawie promptu.

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

Odpowiedzi: Kod statusu: 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

Aby zapoznać się z definicjami schematu używanymi przez czat, uzupełnienia, osadzanie i inne operacje tekstowe, zobacz dokumentację interfejsu API REST platformy Azure OpenAI. Poniższe schematy obsługują operacje obrazów i audio na tej stronie.

innerErrorCode

Kody błędów dla wewnętrznego obiektu błędu.

Opis: Kody błędów dla wewnętrznego obiektu błędu.

Typ: ciąg

Domyślnie:

Nazwa enum: InnerErrorCode

Wartości enuma

dalleErrorResponse

dalleError

dalleInnerError

Błąd wewnętrzny z dodatkowymi szczegółami.

WynikPoziomuSurowościFiltraTreści

WykrytoWynikFiltruTreści

dalleFilterResults

Informacje o kategorii filtrowania treści (nienawiść, seksualność, przemoc self_harm), czy została wykryta, a także o poziomie nasilenia (very_low, niski, średni, wysoki skali decydującej o intensywności i ryzyku szkodliwych treści) oraz czy zostały one przefiltrowane, czy nie. Informacje o treściach jailbreakowych i przekleństwach, czy zostały wykryte oraz czy zostały przefiltrowane, czy nie. Oraz informacje o liście blokowanej klienta, czy została przefiltrowana i jej identyfikatorze.

odpowiedź dźwiękowa

Odpowiedź na tłumaczenie lub transkrypcję, gdy response_format był json

audioVerboseResponse

Odpowiedź tłumaczeniowa lub transkrypcja, gdy response_format była verbose_json

audioResponseFormat

Definiuje format wyjścia.

Opis: Definiuje format wyjścia.

Typ: ciąg

Domyślnie:

Wartości enuma

• JSON
• SMS
• srt
• verbose_json
• vtt

imageQuality

Jakość wygenerowanego obrazu.

Opis: Jakość wygenerowanego obrazu.

Typ: ciąg

Wartość domyślna: standardowa

Nazwa enum: Quality

Wartości enuma

imagesResponseFormat

Format, w którym zwracane są wygenerowane obrazy.

Opis: Format, w którym zwracane są wygenerowane obrazy.

Typ: ciąg

Ustawienie domyślne: adres URL

Nazwa enum: ImagesResponseFormat

Wartości enuma

imageSize

Rozmiar wygenerowanych obrazów.

Opis: Rozmiar wygenerowanych obrazów.

Typ: ciąg

Ustawienie domyślne: 1024x1024

Nazwa enum: Rozmiar

Wartości enuma

imageStyle

Styl generowanych obrazów.

Opis: Styl generowanych obrazów.

Typ: ciąg

Ustawienie domyślne: żywe

Nazwa enum: Styl

Wartości enuma

generateImagesResponse

Następne kroki

Dowiedz się więcej o modelach i dostrajaniu za pomocą interfejsu API REST. Dowiedz się więcej na temat modeli underlying, które zasilają Azure OpenAI.