Azure OpenAI in Microsoft Foundry Models REST API reference (classico)

Visualizzazione attualmente:Versione del portale - Passare alla versione per il nuovo portale foundry

Questo articolo illustra le operazioni dell'API REST per la generazione di immagini e l'inferenza del piano dati audio (voce) per Azure OpenAI nella 2024-10-21 versione ga. Per i completamenti delle chat, incorporamenti, completamenti e tutte le altre operazioni, vedere il riferimento ufficiale Azure API REST OpenAI.

Specifiche API

La gestione e l'interazione con i modelli e le risorse OpenAI di Azure sono suddivise in tre superfici API principali:

• Piano di controllo
• Piano dati - authoring
• Piano dati - inferenza

Ogni superficie/specifica API racchiude un diverso insieme di funzionalità di Azure OpenAI. Ogni API ha un proprio set unico di versioni di anteprima e di API stabili/generalmente disponibili (GA). Le uscite in anteprima tendono attualmente a seguire un ritmo mensile.

Authentication

Azure OpenAI fornisce due metodi di autenticazione. Puoi usare sia API Keys che Microsoft Entra ID.

• Autenticazione della chiave API: Per questo tipo di autenticazione, tutte le richieste API devono includere la chiave API nell'intestazione api-key HTTP. Il Quickstart fornisce indicazioni su come effettuare chiamate con questo tipo di autenticazione.

• Microsoft Entra ID: Puoi autenticare una chiamata API usando un token Microsoft Entra. I token di autenticazione sono inclusi in una richiesta come Authorization intestazione. Il token fornito deve essere preceduto da Bearer, ad esempio Bearer YOUR_AUTH_TOKEN. Puoi leggere la nostra guida pratica su autenticare con Microsoft Entra ID.

Versionamento delle API REST

Le API dei servizi sono versionate utilizzando il api-version parametro di query. Tutte le versioni seguono la struttura delle date YYYY-MM-DD. Per esempio:

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

Inferenza del piano dati

Il resto di questo articolo illustra le operazioni di immagine e audio nella versione ga della specifica di inferenza del piano dati OpenAI Azure, 2024-10-21.

Per le operazioni di anteprima di immagini e audio, vedere le informazioni di riferimento sull'immagine di anteprima e sull'API REST audio.

Trascrizioni - Create

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

Trascrive l'audio nella lingua di input.

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Responses

Codice di stato: 200

Descrizione: OK

Esempi

Example

Ottiene testo trascritto e metadati associati dai dati audio parlati forniti.

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

Risposte: Codice di stato: 200

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

Example

Ottiene testo trascritto e metadati associati dai dati audio parlati forniti.

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

Risposte: Codice di stato: 200

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

Traduzioni - Create

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

Trascrive e traduce l'audio in ingresso in testo inglese.

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Tipo di contenuto: multipart/form-data

Responses

Codice di stato: 200

Descrizione: OK

Esempi

Example

Ottiene testo trascritto in inglese e i metadati associati dai dati audio parlati forniti.

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

Risposte: Codice di stato: 200

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

Example

Ottiene testo trascritto in inglese e i metadati associati dai dati audio parlati forniti.

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

Risposte: Codice di stato: 200

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

Creazione di immagini

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

Genera un lotto di immagini da una didascalia di testo su una data distribuzione del modello dall-e

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Content-Type: application/json

Responses

Codice di stato: 200

Descrizione: Ok

Codice di stato: predefinito

Descrizione: Si è verificato un errore.

Esempi

Example

Crea immagini con un 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"
}

Risposte: Codice di stato: 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

Per le definizioni di schema usate da chat, completamenti, incorporamenti e altre operazioni di testo, vedere le informazioni di riferimento sull'API REST OpenAI Azure. Gli schemi seguenti supportano le operazioni di immagine e audio in questa pagina.

innerErrorCode

Codici di errore per l'oggetto di errore interno.

Descrizione: Codici di errore per l'oggetto di errore interno.

Tipo: string

Impostazione predefinita:

Nome Enum: InnerErrorCode

Valori enumerazione:

dalleErrorResponse

dalleError

dalleInnerError

Errore interiore con ulteriori dettagli.

contentFilterSeverityResult

contentFilterDetectedResult

dalleFilterResults

Informazioni sulla categoria di filtraggio dei contenuti (odio, sessuale, violenza, self_harm), se è stata rilevata, nonché sul livello di gravità (scala very_low, bassa, media, alta che determina l'intensità e il livello di rischio dei contenuti dannosi) e se è stata filtrata o meno. Informazioni sui contenuti e le parolacce del jailbreak, se sono stati rilevati e se sono stati filtrati o meno. E informazioni sulla lista dei clienti, se è stata filtrata e il suo id.

risposta audio

Risposta alla traduzione o trascrizione quando response_format era json

audioVerboseResponse

Risposta alla traduzione o trascrizione quando response_format era verbose_json

audioResponseFormat

Definisce il formato dell'output.

Descrizione: Definisce il formato dell'output.

Tipo: string

Impostazione predefinita:

Valori enumerazione:

• Json
• text
• srt
• verbose_json
• vtt

imageQuality

La qualità dell'immagine che verrà generata.

Descrizione: La qualità dell'immagine che verrà generata.

Tipo: string

Impostazione predefinita: standard

Nome Enum: Quality

Valori enumerazione:

imagesResponseFormat

Il formato in cui vengono restituite le immagini generate.

Descrizione: Il formato in cui vengono restituite le immagini generate.

Tipo: string

Impostazione predefinita: URL

Nome Enum: ImagesResponseFormat

Valori enumerazione:

imageSize

La dimensione delle immagini generate.

Descrizione: La dimensione delle immagini generate.

Tipo: string

Impostazione predefinita: 1024x1024

Nome Enum: Dimensione

Valori enumerazione:

imageStyle

Lo stile delle immagini generate.

Descrizione: Lo stile delle immagini generate.

Tipo: string

Impostazione predefinita: vivid

Nome Enum: Style

Valori enumerazione:

generateImagesResponse

Passaggi successivi

Informazioni sui modelli e sull'ottimizzazione con l'API REST. Scopri di più sui modelli sottostante che alimentano Azure OpenAI.