Azure OpenAI in Microsoft Foundry Models REST API-Referenz (Classic)

Zurzeit wird folgendes angezeigt:Foundry (klassische) Portalversion - Wechseln zur Version für das neue Foundry-Portal

In diesem Artikel werden die Datenebenen-Datenebenen-Ableitungs-REST-API-Vorgänge für Azure OpenAI in der 2024-10-21 GA-Version dokumentiert. Informationen zu Chatabschlussen, Einbettungen, Fertigstellungen und allen anderen Vorgängen finden Sie in der offiziellen Azure OpenAI REST-API-Referenz.

API-Spezifikationen

Die Verwaltung und Interaktion mit Azure OpenAI-Modellen und -Ressourcen ist auf drei Haupt-API-Oberflächen verteilt:

• Steuerebene
• Datenebene – Autoring
• Datenebene – Schlussfolgerung

Jede API-Oberfläche/Spezifikation kapselt einen anderen Satz von Azure OpenAI-Funktionen. Jede API hat ihren eigenen einzigartigen Satz von Vorschau- und stabilen/allgemein verfügbaren (GA) API-Releases. Preview-Veröffentlichungen folgen derzeit meist einem monatlichen Rhythmus.

Authentifizierung

Azure OpenAI bietet zwei Methoden zur Authentifizierung an. Du kannst entweder API-Schlüssel oder Microsoft Entra ID verwenden.

• API-Schlüssel-Authentifizierung: Für diese Art der Authentifizierung müssen alle API-Anfragen den API-Schlüssel im api-key HTTP-Header enthalten. Der Quickstart bietet Anleitungen, wie man mit dieser Art der Authentifizierung Anrufe tätigt.

• Microsoft Entra ID Authentifizierung: Sie können einen API-Aufruf mit einem Microsoft Entra-Token authentifizieren. Authentifizierungstoken sind in einer Anfrage als Header Authorization enthalten. Der bereitgestellte Token muss zum Beispiel von Bearervorangestellt werden, zum Beispiel Bearer YOUR_AUTH_TOKEN. Sie können unseren Anleitungsleitfaden zum Thema Authentifizierung mit Microsoft Entra ID lesen.

REST-API-Versionierung

Die Service-APIs werden mit dem Abfrageparameter api-version versioniert. Alle Versionen folgen der YYYY-MM-DD Datumsstruktur. Beispiel:

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

Inferenz der Datenebene

Der Rest dieses Artikels behandelt die Bild- und Audiovorgänge in der GA-Version der Azure OpenAI-Datenebenen-Ableitungsspezifikation. 2024-10-21

Informationen zu den Vorschaubild- und Audiovorgängen finden Sie in der Vorschaubild- und Audio-REST-API-Referenz.

Transkriptionen – Erstellen

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

Transkribiert Audio in die Eingabesprache.

URI-Parameter

Anfrage-Kopf

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Antworten

Statuscode: 200

Beschreibung: OK

Beispiele

Example

Erhält transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.

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

Antworten: Statuscode: 200

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

Example

Erhält transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.

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

Antworten: Statuscode: 200

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

Übersetzungen – Erstellen

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

Transkribiert und übersetzt Eingabeaudio in englischen Text.

URI-Parameter

Anfrage-Kopf

Anforderungstext

Content-Typ: mehrteilige Formulardaten (multipart/form-data)

Antworten

Statuscode: 200

Beschreibung: OK

Beispiele

Example

Erhält englischsprachigen transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.

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

Antworten: Statuscode: 200

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

Example

Erhält englischsprachigen transkribierten Text und zugehörige Metadaten aus bereitgestellten gesprochenen Audiodaten.

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

Antworten: Statuscode: 200

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

Bildgenerierung

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

Erzeugt eine Charge von Bildern aus einer Textunterschrift in einer gegebenen Dall-e-Modell-Bereitstellung

URI-Parameter

Anfrage-Kopf

Anforderungstext

Content-Type: application/json

Antworten

Statuscode: 200

Beschreibung: Ok

Statuscode: Standard

Beschreibung: Ein Fehler ist aufgetreten.

Beispiele

Example

Erstellt Bilder mit einem Prompt.

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

Antworten: Statuscode: 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
          }
        }
      }
    ]
  }
}

Komponenten

Die schemadefinitionen, die von Chats, Abschlussen, Einbettungen und anderen Textvorgängen verwendet werden, finden Sie in der referenz Azure OpenAI REST API. Die folgenden Schemas unterstützen die Bild- und Audiovorgänge auf dieser Seite.

innerErrorCode

Fehlercodes für das innere Fehlerobjekt.

Beschreibung: Fehlercodes für das innere Fehlerobjekt.

Typ: Zeichenfolge

Standard:

Enum-Name: InnerErrorCode

Enumerationswerte:

dalleErrorResponse

dalleError

dalleInnerError

Innerer Fehler mit zusätzlichen Details.

contentFilterSeverityResult

Ergebnis der Inhaltserkennungsfilterung

dalleFilterResults

Informationen über die Kategorie der Inhaltsfilterung (Hass, sexuell, Gewalt, self_harm), ob sie erkannt wurde, sowie das Schweregrad (very_low, niedrig, mittel, hoch im Maßstab, das die Intensität und das Risikoniveau schädlicher Inhalte bestimmt) und ob sie gefiltert wurden oder nicht. Informationen zu Jailbreak-Inhalten und Schimpfwörtern, ob sie erkannt wurden und ob sie gefiltert wurden oder nicht. Und Informationen zur Kundenblockliste, falls sie gefiltert wurde und deren ID.

Audio-Antwort

Übersetzungs- oder Transkriptionsantwort, wenn response_format json war

audioVerboseResponse

Übersetzungs- oder Transkriptionsantwort, wenn response_format verbose_json

audioResponseFormat

Definiert das Format der Ausgabe.

Beschreibung: Definiert das Format der Ausgabe.

Typ: Zeichenfolge

Standard:

Enumerationswerte:

• Json
• Text
• srt
• verbose_json
• vtt

imageQuality

Die Qualität des erzeugten Bildes.

Beschreibung: Die Qualität des erzeugten Bildes.

Typ: Zeichenfolge

Standard: Standard

Enum-Name: Qualität

Enumerationswerte:

imagesResponseFormat

Das Format, in dem die generierten Bilder zurückgegeben werden.

Beschreibung: Das Format, in dem die generierten Bilder zurückgegeben werden.

Typ: Zeichenfolge

Standard: URL

Enum-Name: ImagesResponseFormat

Enumerationswerte:

imageSize

Die Größe der generierten Bilder.

Beschreibung: Die Größe der generierten Bilder.

Typ: Zeichenfolge

Standard: 1024x1024

Enum-Name: Größe

Enumerationswerte:

imageStyle

Der Stil der generierten Bilder.

Beschreibung: Der Stil der generierten Bilder.

Typ: Zeichenfolge

Standard: lebendig

Enum-Name: Stil

Enumerationswerte:

generateImagesResponse

Nächste Schritte

Erfahren Sie mehr über Modelle und Feinabstimmungen mit der REST-API. Erfahren Sie mehr über die zugrundeliegenden Modelle, die Azure OpenAI antreiben.