Azure referencia de la API REST de audio y imagen de OpenAI (2024-10-21)

En este artículo se documentan las operaciones de api rest de generación de imágenes y audio (voz) para Azure OpenAI en la 2024-10-21 versión de disponibilidad general. Para las finalizaciones de chat, incrustaciones, finalizaciones y todas las demás operaciones, consulte la referencia oficial de la API rest de OpenAI Azure.

Especificaciones de API

La gestión e interacción con los modelos y recursos de OpenAI de Azure se divide en tres superficies principales de API:

• Plano de control
• Plano de datos - creación
• Plano de datos - inferencia

Cada superficie/especificación de API encapsula un conjunto diferente de capacidades de Azure OpenAI. Cada API tiene su propio conjunto único de versiones de vista previa y de APIs estables/disponibles en general (GA). Actualmente, los lanzamientos de vista previa tienden a seguir un ritmo mensual.

Authentication

Azure OpenAI ofrece dos métodos de autenticación. Puedes usar API Keys o Microsoft Entra ID.

• Autenticación de clave API: Para este tipo de autenticación, todas las solicitudes API deben incluir la clave API en la api-key cabecera HTTP. El Quickstart ofrece orientación sobre cómo realizar llamadas con este tipo de autenticación.

• Microsoft Entra ID: Puedes autenticar una llamada API usando un token Microsoft Entra. Los tokens de autenticación se incluyen en una solicitud como Authorization cabecera. El token proporcionado debe ir precedido por Bearer, por ejemplo Bearer YOUR_AUTH_TOKEN. Puedes leer nuestra guía práctica sobre autenticación con Microsoft Entra ID.

Versionado de la API REST

Las APIs de servicio se versionan usando el api-version parámetro de consulta. Todas las versiones siguen la estructura de fechas YYYY-MM-DD. Por ejemplo:

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

Inferencia en planos de datos

En el resto de este artículo se tratan las operaciones de imagen y audio en la versión de disponibilidad general de la especificación de inferencia del plano de datos openAI de Azure, 2024-10-21.

Para obtener la vista previa de las operaciones de imagen y audio, consulte la referencia de la API REST de audio y la imagen en versión preliminar.

Transcripciones - Create

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

Transcribe el audio al idioma de entrada.

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Responses

Código de estado: 200

Descripción: Aceptar

Examples

Example

Obtiene texto transcrito y metadatos asociados de los datos de audio hablado proporcionados.

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

Respuestas: Código de estado: 200

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

Example

Obtiene texto transcrito y metadatos asociados de los datos de audio hablado proporcionados.

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

Respuestas: Código de estado: 200

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

Traducciones - Create

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

Transcribe y traduce el audio de entrada a texto en inglés.

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Responses

Código de estado: 200

Descripción: Aceptar

Examples

Example

Obtiene texto transcrito en inglés y metadatos asociados a partir de los datos de audio hablado proporcionados.

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

Respuestas: Código de estado: 200

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

Example

Obtiene texto transcrito en inglés y metadatos asociados a partir de los datos de audio hablado proporcionados.

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

Respuestas: Código de estado: 200

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

Generación de imágenes

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

Genera un lote de imágenes a partir de un pie de foto en un despliegue dado de un modelo dall-e

Parámetros de URI

Encabezado de solicitud

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 200

Descripción: Ok

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

Example

Crea imágenes 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"
}

Respuestas: Código de estado: 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
          }
        }
      }
    ]
  }
}

Componentes

Para conocer las definiciones de esquema usadas por chat, finalizaciones, incrustaciones y otras operaciones de texto, consulte la referencia de la API rest de OpenAI Azure. Los siguientes esquemas admiten las operaciones de imagen y audio en esta página.

innerErrorCode

Códigos de error para el objeto de error interno.

Descripción: Códigos de error para el objeto de error interno.

Tipo: cadena

Valor predeterminado:

Nombre de Enum: InnerErrorCode

Valores de enumeración:

dalleErrorResponse

dalleError

dalleInnerError

Error interno con detalles adicionales.

contentFilterSeverityResult

contentFilterDetectedResult

dalleFilterResults

Información sobre la categoría de filtrado de contenido (odio, sexual, violencia, self_harm), si ha sido detectada, así como el nivel de gravedad (escala very_low, baja, media, alta que determina la intensidad y el nivel de riesgo del contenido dañino) y si ha sido filtrado o no. Información sobre contenido de jailbreak y palabrotas, si se ha detectado y si ha sido filtrado o no. Y información sobre la lista de clientes bloqueados, si ha sido filtrada y su identificación.

audioResponse

Respuesta de traducción o transcripción cuando response_format era json

audioVerboseResponse

Respuesta de traducción o transcripción cuando response_format estaba verbose_json

audioResponseFormat

Define el formato de la salida.

Descripción: Define el formato de la salida.

Tipo: cadena

Valor predeterminado:

Valores de enumeración:

• json
• Mensaje de texto
• srt
• verbose_json
• vtt

imageQuality

La calidad de la imagen que se generará.

Descripción: La calidad de la imagen que se generará.

Tipo: cadena

Valor predeterminado: estándar

Nombre Enum: Quality

Valores de enumeración:

imagesResponseFormat

El formato en el que se devuelven las imágenes generadas.

Descripción: El formato en el que se devuelven las imágenes generadas.

Tipo: cadena

Valor predeterminado: url

Nombre de Enum: ImágenesFormatoRespuesta

Valores de enumeración:

imageSize

El tamaño de las imágenes generadas.

Descripción: El tamaño de las imágenes generadas.

Tipo: cadena

Valor predeterminado: 1024x1024

Nombre de Enum: Tamaño

Valores de enumeración:

imageStyle

El estilo de las imágenes generadas.

Descripción: El estilo de las imágenes generadas.

Tipo: cadena

Valor predeterminado: vívido

Nombre de Enum: Style

Valores de enumeración:

generateImagesResponse

Pasos siguientes

Obtenga información sobre los modelos y la optimización con la API REST. Obtenga más información sobre los modelos underlying que potencian Azure OpenAI.