Azure OpenAI en Microsoft Foundry Models authoring REST API preview reference

Este artículo ofrece detalles sobre los endpoints de la API REST de inferencia para Azure OpenAI.

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

Autoría de planos de datos

El resto del artículo trata sobre la versión previa de la especificación de inferencia de planos de datos de OpenAI Azure, 2025-04-01-preview.

Si busca documentación sobre la versión más reciente de la API de disponibilidad general, consulte la API de inferencia del plano de datos de disponibilidad general más reciente.

Lote - Lista

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Obtiene una lista de todos los lotes que posee el recurso OpenAI de Azure.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "object": "batch",
        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
        "endpoint": "/chat/completions",
        "errors": null,
        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
        "completion_window": "24h",
        "status": "completed",
        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
        "created_at": 1646126127,
        "in_progress_at": 1646126130,
        "expires_at": 1646126170,
        "finalizing_at": 1646126134,
        "completed_at": 1646126136,
        "failed_at": null,
        "expired_at": null,
        "cancelling_at": null,
        "cancelled_at": null,
        "request_counts": {
          "total": 500,
          "completed": 400,
          "failed": 100
        },
        "first_id": "batch_abc123",
        "last_id": "batch_abc456",
        "metadata": {
          "batch_description": "Evaluation job"
        }
      }
    ],
    "object": "list"
  }
}

Batch: Crear

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Crea y ejecuta un lote a partir de un archivo cargado de solicitudes.

La respuesta incluye detalles del trabajo en cola, incluyendo el estado del puesto.

El ID del archivo de resultado se añade a la respuesta una vez completada.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 201

Descripción: El lote ha sido creado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Respuestas: Código de Estado: 201

{
  "headers": {
    "deployment-enqueued-tokens": 1000,
    "deployment-maximum-enqueued-tokens": 5000
  },
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "validating",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 0,
      "completed": 0,
      "failed": 0
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Batch - Conseguir

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Obtiene detalles de un solo lote especificado por el id de lote dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "completed",
    "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
    "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": 1646126134,
    "completed_at": 1646126136,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 400,
      "failed": 100
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Batch - Cancelar

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Cancela el procesamiento del lote especificado por el id de lote dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El lote ha sido cancelado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "cancelling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1646126138,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 100,
      "failed": 5
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Completación almacenada - Lista

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Obtiene la lista de completados almacenados.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
        "model": "gpt-4o-mini-2024-07-18",
        "created": 1738193475,
        "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
        "usage": {
          "total_tokens": 25,
          "completion_tokens": 7,
          "prompt_tokens": 18
        },
        "seed": 123,
        "top_p": 1,
        "temperature": 1,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "system_fingerprint": "fp_f3927aa00d",
        "metadata": {
          "key_1": "val_1",
          "key_2": "val_2"
        },
        "choices": [
          {
            "index": 0,
            "message": {
              "content": "Hello, how are you?",
              "role": "assistant"
            },
            "finish_reason": "stop"
          }
        ]
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Completación almacenada - Obtener

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Recibe la completación almacenada por el id de completación almacenada dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Completación almacenada - Actualización

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Actualizar la completación almacenada con el id de completación almacenada dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Completación almacenada - Eliminar

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Eliminar la completación almacenada con el id de completación almacenada dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: La finalización almacenada fue eliminada con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion.deleted",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "deleted": true
  }
}

Completación almacenada - Getmessages

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Recibe los mensajes de completación almacenados por el id de completación almacenado dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "role": "user",
        "content": "Hello"
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Evaluación - Lista de compras

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Haz una lista de evaluaciones para un proyecto.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Lista de evaluaciones

Examples

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval",
        "id": "eval_6801694950848190b10968bb628b651d",
        "data_source_config": {
          "type": "custom",
          "schema": {
            "type": "object",
            "properties": {
              "item": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "A": {
                    "type": "string"
                  },
                  "B": {
                    "type": "string"
                  },
                  "C": {
                    "type": "string"
                  },
                  "D": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "item"
            ]
          }
        },
        "testing_criteria": [
          {
            "name": "string check",
            "type": "string_check",
            "input": "{{sample.output_text}}",
            "reference": "{{item.answer}}",
            "operation": "eq"
          }
        ],
        "name": "Math Quiz",
        "created_at": 1744922953,
        "metadata": {}
      }
    ],
    "first_id": "eval_6801694950848190b10968bb628b651d",
    "last_id": "eval_6801694950848190b10968bb628b651d",
    "has_more": false
  }
}

Evaluación - Crear

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

Crear la estructura de una evaluación que pueda utilizarse para probar el rendimiento de un modelo. Una evaluación es un conjunto de criterios de prueba y una fuente de datos. Después de crear una evaluación, puedes ejecutarla en diferentes modelos y parámetros de modelo. Apoyamos varios tipos de evaluadores y fuentes de datos.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 201

Descripción: Aceptar

Examples

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

{
 "name": "Math Quiz",
 "data_source_config": {
  "type": "custom",
  "include_sample_schema": true,
  "item_schema": {
   "type": "object",
   "properties": {
    "question": {
     "type": "string"
    },
    "A": {
     "type": "string"
    },
    "B": {
     "type": "string"
    },
    "C": {
     "type": "string"
    },
    "D": {
     "type": "string"
    },
    "answer": {
     "type": "string"
    }
   }
  }
 },
 "testing_criteria": [
  {
   "type": "string_check",
   "reference": "{{item.answer}}",
   "input": "{{sample.output_text}}",
   "operation": "eq",
   "name": "string check"
  }
 ]
}

Respuestas: Código de Estado: 201

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Evaluación - Eliminar

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Elimina una evaluación.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Eliminé con éxito la evaluación.

Código de estado: 404

Descripción: Evaluación no encontrada.

Examples

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "eval_id": "eval_6801694950848190b10968bb628b651d"
  }
}

Código de estado: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
  }
}

Evaluación - Obtén

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Pide una evaluación por ID.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: La evaluación

Examples

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Evaluación - Actualización

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Actualizar ciertas propiedades de una evaluación.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: La evaluación actualizada

Examples

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

{
 "name": "Updated Math Quiz",
 "metadata": {
  "description": "Updated description"
 }
}

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Updated Math Quiz",
    "created_at": 1744922953,
    "metadata": {
      "description": "Updated description"
    }
  }
}

Evaluación - Getrunlist

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Consigue una lista de las carreras para una evaluación.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Lista de carreras para la evaluación

Examples

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run",
        "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "report_url": "https://ai.azure.com/resource/evaluation",
        "status": "queued",
        "model": "gpt-4o-mini",
        "name": "Math quiz",
        "created_at": 1744923141,
        "result_counts": {
          "total": 0,
          "errored": 0,
          "failed": 0,
          "passed": 0
        },
        "per_model_usage": null,
        "per_testing_criteria_results": null,
        "data_source": {
          "type": "completions",
          "source": {
            "type": "file_content",
            "content": [
              {
                "item": {
                  "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
                  "A": "0",
                  "B": "4",
                  "C": "2",
                  "D": "6",
                  "answer": "B"
                }
              },
              {
                "item": {
                  "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
                  "A": "8",
                  "B": "2",
                  "C": "24",
                  "D": "120",
                  "answer": "C"
                }
              }
            ]
          },
          "input_messages": {
            "template": [
              {
                "type": "message",
                "role": "system",
                "content": {
                  "text": "Answer the question's with A, B, C, or D."
                }
              },
              {
                "type": "message",
                "role": "user",
                "content": {
                  "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
                }
              }
            ]
          },
          "model": "gpt-4o-mini",
          "sampling_params": {
            "seed": 42,
            "temperature": 1,
            "top_p": 1
          }
        },
        "error": null,
        "metadata": {}
      }
    ],
    "first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "has_more": false
  }
}

Evaluación - Crear ejecución

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Crea una nueva ejecución de evaluación. Este es el punto final que iniciará la corrección.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 201

Descripción: Creado con éxito una ejecución para la evaluación

Código de estado: 400

Descripción: Petición incorrecta (por ejemplo, falta un objeto de evaluación)

Examples

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

{
 "name": "Math quiz",
 "data_source": {
  "type": "completions",
  "source": {
   "type": "file_content",
   "content": [
    {
     "item": {
      "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
      "A": "0",
      "B": "4",
      "C": "2",
      "D": "6",
      "answer": "B"
     }
    },
    {
     "item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
     }
    }
   ]
  },
  "input_messages": {
   "type": "template",
   "template": [
    {
     "type": "message",
     "role": "system",
     "content": {
      "text": "Answer the question's with A, B, C, or D."
     }
    },
    {
     "type": "message",
     "role": "user",
     "content": {
      "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
     }
    }
   ]
  },
  "model": "gpt-4o-mini",
  "sampling_params": {
   "temperature": 1,
   "top_p": 1,
   "seed": 42
  }
 }
}

Respuestas: Código de Estado: 201

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Evaluación - Eliminación de la ejecución

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Elimina una prueba de evaluación.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Eliminado con éxito la ejecución de evaluación

Código de estado: 404

Descripción: Tirada no encontrada

Examples

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
  }
}

Código de estado: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
  }
}

Evaluación - Corre

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Haz que una evaluación sea realizada por ID.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: La ejecución de evaluación

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Evaluación - Cancelar ejecución

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Cancela una evaluación en curso.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El objeto de ejecución de evaluación cancelada

Examples

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "canceled",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Evaluación - Getrunoutputitems

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Obtén una lista de elementos de salida para una ejecución de evaluación.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Lista de elementos de salida para la ejecución de evaluación

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run.output_item",
        "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
        "created_at": 1744925265,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 1,
        "datasource_item": {
          "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
          "A": "8",
          "B": "2",
          "C": "24",
          "D": "120",
          "answer": "C"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 627,
            "completion_tokens": 546,
            "prompt_tokens": 81,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      },
      {
        "object": "eval.run.output_item",
        "id": "outputitem_6801724f54888190942ec66a197309dd",
        "created_at": 1744925263,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 0,
        "datasource_item": {
          "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
          "A": "0",
          "B": "4",
          "C": "2",
          "D": "6",
          "answer": "B"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 556,
            "completion_tokens": 487,
            "prompt_tokens": 69,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      }
    ],
    "first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "last_id": "outputitem_6801724f54888190942ec66a197309dd",
    "has_more": false
  }
}

Evaluación - Getrunoutputitem

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Haz una evaluación y ejecuta el ítem de salida por ID.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El ítem de salida de la ejecución de evaluación

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "eval.run.output_item",
    "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "created_at": 1744925265,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "status": "fail",
    "datasource_item_id": 1,
    "datasource_item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
    },
    "results": [
      {
        "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
        "sample": null,
        "passed": false,
        "score": 0
      }
    ],
    "sample": {
      "input": [
        {
          "role": "system",
          "content": "Answer the question's with A, B, C, or D."
        },
        {
          "role": "user",
          "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
        }
      ],
      "output": [
        {
          "role": "assistant",
          "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
        }
      ],
      "finish_reason": "stop",
      "model": "gpt-4o-mini-2024-07-18",
      "usage": {
        "total_tokens": 627,
        "completion_tokens": 546,
        "prompt_tokens": 81,
        "cached_tokens": 0
      },
      "error": null,
      "temperature": 1,
      "top_p": 1,
      "seed": 42
    }
  }
}

Archivos - Lista

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Obtiene una lista de todos los archivos propiedad del recurso Azure OpenAI.

Estos incluyen contenido subido por el usuario, como archivos con el propósito de "ajuste fino" para entrenar o validar modelos de ajuste fino, así como archivos generados por el servicio, como "resultados de ajuste fino", que contiene varias métricas para el trabajo de ajuste fino correspondiente.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "processed",
        "bytes": 140,
        "purpose": "fine-tune",
        "filename": "puppy.jsonl",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      },
      {
        "status": "processed",
        "bytes": 32423,
        "purpose": "fine-tune-results",
        "filename": "results.csv",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      }
    ],
    "object": "list"
  }
}

Archivos - Subida

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Crea una nueva entidad de archivo subiendo datos desde una máquina local. Los archivos subidos pueden, por ejemplo, usarse para entrenar o evaluar modelos ajustados finamente.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Responses

Código de estado: 201

Descripción: El archivo ha sido creado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Respuestas: Código de Estado: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Archivos - Importación

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Crea una nueva entidad de archivo importando datos de una URL proporcionada. Los archivos subidos pueden, por ejemplo, usarse para entrenar o evaluar modelos ajustados finamente.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 201

Descripción: El archivo ha sido creado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Respuestas: Código de Estado: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Archivos - Conseguir

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Obtiene detalles de un único archivo especificados por el id de archivo indicado, incluyendo estado, tamaño, propósito, etc.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Archivos - Eliminar

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Elimina el archivo con el id de archivo dado.

También se permite la eliminación si se utilizó un archivo, por ejemplo, como archivo de entrenamiento en un trabajo de ajuste fino.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El archivo fue eliminado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "object": "file",
    "deleted": true,
    "id": "file-181a1cbdcdcf4677ada87f63a0928099"
  }
}

Archivos - Obtener contenido

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Obtiene el contenido del archivo especificado por el id de archivo dado.

Los archivos pueden ser contenido subido por el usuario o generados por el servicio, como métricas de resultados de un trabajo de ajuste fino.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": "raw file content"
}

Ajuste fino - Lista

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Obtiene una lista de todos los trabajos de ajuste fino que posee el recurso Azure OpenAI. Los detalles que se devuelven para cada trabajo de ajuste fino incluyen, además de su identificador, el modelo base, archivos de entrenamiento y validación, hiperparámetros, marcas de tiempo, estado y eventos.

Los eventos se crean cuando cambia el estado del trabajo. Por ejemplo, en funcionamiento o completado, y cuando se suben los resultados.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "hyperparameters": {
          "n_epochs": -1
        },
        "integrations": [
          {
            "type": "wandb",
            "wandb": {
              "project": "custom-wandb-project",
              "tags": [
                "project:tag",
                "lineage"
              ]
            }
          }
        ],
        "method": {
          "type": "supervised"
        },
        "status": "succeeded",
        "model": "curie",
        "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
        "result_files": [
          "file-181a1cbdcdcf4677ada87f63a0928099"
        ],
        "finished_at": 1646127311,
        "trained_tokens": 2342,
        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "fine_tuning.job"
      }
    ],
    "object": "list"
  }
}

Ajuste fino - Crear

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Crea un trabajo que ajusta un modelo especificado a partir de un archivo de entrenamiento dado.

La respuesta incluye detalles del trabajo en cola, incluyendo el estado del trabajo y los parámetros hiper.

El nombre del modelo ajustado finamente se añade a la respuesta una vez completado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 201

Descripción: El fine tune ha sido creado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Respuestas: Código de Estado: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "pending",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Consigue

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Obtiene detalles de un único trabajo de ajuste fino especificado por el fine-tune-id dado.

Los detalles contienen el modelo base, archivos de entrenamiento y validación, hiperparámetros, marcas de tiempo, estado y eventos.

Los eventos se crean cuando cambia el estado del trabajo, por ejemplo, en ejecución o completado, y cuando se suben los resultados.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "succeeded",
    "model": "curie",
    "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "result_files": [
      "file-181a1cbdcdcf4677ada87f63a0928099"
    ],
    "finished_at": 1646127311,
    "trained_tokens": 2342,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Eliminar

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Elimina el trabajo de ajuste fino especificado por el fine-tune-id dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 204

Descripción: El ajuste fino fue eliminado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 204

{
  "headers": {}
}

Ajuste fino - Cancelar

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Cancela el procesamiento del trabajo de ajuste fino especificado por el fine-tune-id dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El ajuste fino ha sido cancelado con éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "cancelled",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Consigue puntos de control

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Obtiene los puntos de control para el trabajo de ajuste fino especificado por el fine-tune-id dado.

Los puntos de control se crean al final de las épocas exitosas durante el entrenamiento.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
        "created_at": 1646126127,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
        "step_number": 10,
        "metrics": {
          "step": 10,
          "train_loss": 0.478,
          "train_mean_token_accuracy": 0.924,
          "valid_loss": 10.112,
          "valid_mean_token_accuracy": 0.145,
          "full_valid_loss": 0.567,
          "full_valid_mean_token_accuracy": 0.944
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
        "created_at": 1646126137,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
        "step_number": 20,
        "metrics": {
          "step": 20,
          "train_loss": 0.355,
          "train_mean_token_accuracy": 0.947,
          "valid_loss": 11.32,
          "valid_mean_token_accuracy": 0.122,
          "full_valid_loss": 0.317,
          "full_valid_mean_token_accuracy": 0.955
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
        "created_at": 1646126147,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
        "step_number": 30,
        "metrics": {
          "step": 30,
          "train_loss": 0.155,
          "train_mean_token_accuracy": 0.975,
          "valid_loss": 9.31,
          "valid_mean_token_accuracy": 0.092,
          "full_valid_loss": 0.114,
          "full_valid_mean_token_accuracy": 0.963
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      }
    ],
    "object": "list"
  }
}

Ajuste - Eventos de obtención

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Obtiene los eventos para el trabajo de ajuste fino especificado por el fine-tune-id dado.

Los eventos se crean cuando cambia el estado del trabajo, por ejemplo, en ejecución o completado, y cuando se suben los resultados.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
        "created_at": 1646126127,
        "level": "info",
        "message": "Job enqueued. Waiting for jobs ahead to complete.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
        "created_at": 1646126169,
        "level": "info",
        "message": "Job started.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
        "created_at": 1646126192,
        "level": "info",
        "message": "Job succeeded.",
        "type": "message",
        "object": "fine_tuning.job.event"
      }
    ],
    "object": "list"
  }
}

Ajuste fino: pausa

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Pausando el procesamiento del trabajo de ajuste fino especificado por el fine-tune-id dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El ajuste fino ha sido pausado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "paused",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Ajuste fino - Currículum

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Reanuda el procesamiento del trabajo de ajuste fino especificado por el fine-tune-id dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: El ajuste fino se ha reanudado con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "resuming",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Empleos de gestión - Lista

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Enumera los trabajos de ingestión.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "body": {
    "value": [
      {
        "jobId": "usercompute-ingestion-job",
        "kind": "UserCompute",
        "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
      },
      {
        "jobId": "syscompute-ingestion-job",
        "kind": "SystemCompute"
      }
    ]
  }
}

Trabajos de ingestión - Create

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Crea un trabajo de ingestión con el id de trabajo especificado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "SystemCompute",
    "jobId": "ingestion-job",
    "searchServiceConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://aykame-dev-search.search.windows.net"
    },
    "datasource": {
      "kind": "Storage",
      "connection": {
        "kind": "EndpointWithManagedIdentity",
        "endpoint": "https://mystorage.blob.core.windows.net/",
        "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
      },
      "containerName": "container",
      "chunking": {
        "maxChunkSizeInTokens": 2048
      },
      "embeddings": [
        {
          "connection": {
            "kind": "RelativeConnection"
          },
          "deploymentName": "Ada"
        }
      ]
    },
    "dataRefreshIntervalInHours": 24,
    "completionAction": "keepAllAssets"
  }
}

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Empleos de ingestión - Consigue

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Obtiene los detalles del ID del puesto especificado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Ingestionjobruns - Lista

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Lista las ejecuciones del id de trabajo especificado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "body": {
    "value": [
      {
        "jobId": "ingestion-job",
        "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
        "status": "succeeded"
      },
      {
        "jobId": "ingestion-job",
        "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
        "status": "failed"
      },
      {
        "jobId": "ingestion-job",
        "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
        "status": "running"
      }
    ]
  }
}

Ingestionjobruns - Obtener

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Obtiene los detalles del id de ejecución especificado como parte del id de trabajo especificado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "body": {
    "jobId": "ingestion-job",
    "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
    "status": "running",
    "progress": {
      "stageProgress": [
        {
          "name": "Preprocessing",
          "totalItems": 14,
          "processedItems": 0,
          "state": "notRunning"
        },
        {
          "name": "Indexing",
          "state": "notRunning"
        }
      ]
    }
  }
}

Modelos - Lista

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Obtiene una lista de todos los modelos accesibles desde el recurso OpenAI de Azure.

Estos incluyen modelos base así como todos los modelos ajustados y finalizados con éxito propiedad del recurso Azure OpenAI.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "succeeded",
        "capabilities": {
          "fine_tune": true,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "fine_tune": 1677662127,
          "inference": 1709284527
        },
        "id": "curie",
        "created_at": 1646126127,
        "object": "model"
      },
      {
        "status": "succeeded",
        "model": "curie",
        "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "capabilities": {
          "fine_tune": false,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "inference": 1709284527
        },
        "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "model"
      }
    ],
    "object": "list"
  }
}

Modelos - Consigue

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Obtiene detalles del modelo especificado por el modelId dado.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "capabilities": {
      "fine_tune": true,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "fine_tune": 1677662127,
      "inference": 1709284527
    },
    "id": "curie",
    "created_at": 1646126127,
    "object": "model"
  }
}

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "model": "curie",
    "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "capabilities": {
      "fine_tune": false,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "inference": 1709284527
    },
    "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "model"
  }
}

Subir archivo - Inicio

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

Se crea un objeto de subida intermedio, que te permite añadir Partes a él. Actualmente, el tamaño de una subida puede ser un máximo de 9 GB en total y caducará dos horas después de haberse creado.

Tras completar la Carga, se generará un objeto Archivo que contiene todas las partes subidas. Este objeto archivo puede usarse en toda nuestra plataforma como cualquier otro archivo.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Cuerpo de la solicitud

Content-Type: text/json

Cuerpo de la solicitud

Content-Type: application/*+json

Responses

Código de estado: 200

Descripción: La subida ha sido creada con éxito.

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

{
 "purpose": "fine-tune",
 "filename": "training_data_v21.jsonl",
 "bytes": 2097152,
 "mime_type": "application/json"
}

Respuestas: Código de estado: 200

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "pending",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Archivo de subida - Cancelar

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Cancela la subida y hará que todas las partes subidas sean eliminadas de forma asíncrona.

No se pueden añadir Partes después de cancelar una subida.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "cancelled",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Archivo de subida - Completo

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

Esto completa la Subida, y el objeto de Subida devuelto contiene un objeto Archivo anidado listo para usarse en toda la plataforma.

Puedes definir el orden de las Partes proporcionando una lista ordenada de IDs de Piezas.

El número total de bytes subidos debe coincidir con el tamaño especificado originalmente al crear el objeto de subida.

Tras esta operación, no se pueden añadir piezas adicionales una vez completada la subida.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Cuerpo de la solicitud

Content-Type: text/json

Cuerpo de la solicitud

Content-Type: application/*+json

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

{
 "part_ids": [
  "LnmictL3p0u4LH/ko343nw==",
  "LmmictL3p0u4LH/ko343nw=="
 ]
}

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "completed",
    "expires_at": 1646133327,
    "file": {
      "status": "processed",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Archivo de subida - Parte

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Añade una Parte a un objeto de Subida, donde cada Parte representa un segmento del archivo que estás subiendo.

Cada Parte puede alcanzar el límite estándar de tamaño para la subida de archivos, según el Propósito del Archivo. Puedes seguir añadiendo Partes hasta alcanzar el límite de tamaño de subida de 9 GB.

Parámetros de URI

Encabezado de solicitud

Utiliza autenticación basada en tokens o clave API. Se recomienda autenticar con autenticación basada en tokens y es más seguro.

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Responses

Código de estado: 200

Descripción: Éxito

Código de estado: por defecto

Descripción: Ha ocurrido un error.

Examples

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Respuestas: Código de estado: 200

{
  "headers": {},
  "body": {
    "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "azure_block_id": "LnmictL3p0u4LH/ko343nw==",
    "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload.part"
  }
}

Componentes

AzureAISearchIndex

Búsqueda de Azure AI Índice.

BaseConnection

Una conexión con un recurso.

Discriminador para BaseConnection

Este componente utiliza la propiedad kind para discriminar entre diferentes tipos:

Batch

Define los valores de un lote.

SolicitudDeCreaciónPorLotes

Define la petición para crear un lote.

BatchErrorData

Información de error por fallo en lote.

BatchErrors

Para lotes que han fallado, esto contendrá más información sobre la causa de los fallos.

BatchRequestCounts

La solicitud cuenta para diferentes estados dentro del lote.

BatchOutputReference

La carpeta Azure Storage para almacenar la salida.

BatchStatus

El estado de un lote.

Lista de lotes

Representa una lista de lotes.

Capabilities

Las capacidades de un modelo base o de ajuste fino.

Elección

ChoiceMessage

ChunkingSettings

Configuración de fragmentación

Acción de Finalización

La acción de completación.

ComputeType

El tipo de cómputo.

ConnectionStringConnection

Conexión de cadenas de conexión.

ConnectionType

El tipo de conexión.

CosmosDBÍndice

Índice de CosmosDB.

Configuraciones de Rastreo

Configuración de rastreo

CreateEvalCompletionsRunDataSource

Un objeto CompletionsRunDataSource que describe una configuración de muestreo de modelos.

Configuración personalizada de fuente de datos para la evaluación (CreateEvalCustomDataSourceConfig)

Un objeto CustomDataSourceConfig que define el esquema para la fuente de datos utilizada para la evaluación se ejecuta. Este esquema se utiliza para definir la forma de los datos que serán: - Utilizados para definir tus criterios de prueba y - Qué datos se requieren al crear una ejecución

CrearElementoDeEvaluación

Un mensaje de chat que compone el prompt o el contexto. Puede incluir referencias a variables al espacio de nombres "elemento", es decir, {{item.name}}.

CreateEvalJsonlRunDataSource

Un objeto JsonlRunDataSource con eso especifica un archivo JSONL que coincide con la evaluación

CreateEvalLabelModelGrader

Un objeto LabelModelGrader que utiliza un modelo para asignar etiquetas a cada elemento de la evaluación.

CreateEvalLogsDataSourceConfig

Una configuración de fuente de datos que especifica la propiedad de metadatos de tu consulta de completaciones almacenadas. Esto suele ser metadatos como usecase=chatbot o prompt-version=v2, etc.

CrearSolicitudDeEvaluación

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Una configuración StoredCompletionsRunDataSource que describe un conjunto de filtros

CustomCompute

Proceso personalizado.

DeploymentConnection

Conexión relativa de despliegue.

Deprecation

Define las fechas de desuecia para los diferentes casos de uso de un modelo.

Normalmente, los modelos base soportan 1 año de ajustes finos tras la creación. La inferencia suele soportarse 2 años después de la creación de modelos base o ajustados finamente. Las fechas exactas se especifican en las propiedades.

DpoHyperparamsRequest

Hiperparámetros para el método DPO de ajuste fino

DpoMethod

Solicitud de ajuste fino del método DPO

DpoMethodConfigRequest

Configuración para dpo el método de ajuste fino. Incluye hiperparámetros específicos de DPO

DpoMethodRequest

Solicitud de ajuste fino del método DPO

EndpointKeyConnection

Conexión de clave de punto final.

EndpointMIConnection

Conexión de identidad gestionada por endpoint.

Error

Contenido de error según la definición de las directrices REST Microsoft.

ErrorCode

Códigos de error definidos en las directrices REST Microsoft.

ErrorResponse

Respuesta al error según la definición de las directrices Microsoft REST.

Eval

Un objeto Eval con una configuración de fuente de datos y criterios de prueba. Una Evaluación representa una tarea a realizar para la integración de tu LLM. Como:

• Mejorar la calidad de mi chatbot
• Mira qué tal gestiona mi chatbot el soporte al cliente
• Comprueba si el o3-mini es mejor para mí que el gpt-4o

Error de EvalApi

Un objeto que representa una respuesta de error de la API de Eval.

EvalCustomDataSourceConfig

Un CustomDataSourceConfig que especifica el esquema de tu item y, opcionalmente sample , de los espacios de nombres. El esquema de respuesta define la forma de los datos que serán: - Utilizados para definir tus criterios de prueba y - Qué datos se requieren al crear una ejecución

EvalFileRunDataSource

Una configuración de FileRunDataSource con un id de archivo

EvalItem

Un mensaje introducido en el modelo con un rol que indica instrucciones siguiendo la jerarquía. Las instrucciones dadas con el developer rol o system tienen prioridad sobre las instrucciones dadas con el user rol. Se presume que los mensajes con el assistant rol fueron generados por el modelo en interacciones anteriores.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Un objeto LabelModelGrader que utiliza un modelo para asignar etiquetas a cada elemento de la evaluación.

EvalList

Un objeto que representa una lista de evaluaciones.