Azure OpenAI en Microsoft Referencia de la versión preliminar de la API REST de creación de modelos foundry

En este artículo se proporcionan detalles sobre los puntos de conexión de la API REST de inferencia para Azure OpenAI.

API specs

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

• Control plane
• Plano de datos: creación
• Plano de datos: inferencia

Cada superficie o especificación de API encapsula un conjunto diferente de Azure funcionalidades de OpenAI. Cada API tiene su propio conjunto único de versiones preliminares y estables o disponibles con carácter general (GA). Las versiones preliminares tienden actualmente a seguir una cadencia mensual.

Authentication

Azure OpenAI proporciona dos métodos para la autenticación. Puede usar claves de API o Microsoft Entra ID.

• Autenticación de clave de API: para este tipo de autenticación, todas las solicitudes de API deben incluir la clave de API en el api-key encabezado HTTP. En el inicio rápido se proporcionan instrucciones sobre cómo realizar llamadas con este tipo de autenticación.

• Microsoft Entra ID autenticación: puede autenticar una llamada API mediante un token de Microsoft Entra. Los tokens de autenticación se incluyen en una solicitud como Authorization encabezado. El token proporcionado debe ir precedido por Bearer, por ejemplo Bearer YOUR_AUTH_TOKEN. Puede leer nuestra guía paso a paso sobre authenticating con Microsoft Entra ID.

Control de versiones de la API REST

Las API de servicio se versionan mediante el api-version parámetro de consulta. Todas las versiones siguen la estructura de fechas YYYY-MM-DD. For example:

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

Creación del plano de datos

El resto del artículo trata la versión preliminar de la especificación de inferencia del plano de datos openAI de 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.

Batch: lista

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

Obtiene una lista de todos los lotes que pertenecen al recurso Azure OpenAI.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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, incluido el estado del trabajo.

El identificador del archivo de resultados se agrega a la respuesta una vez completado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Responses

Código de estado: 201

Descripción: el lote se ha creado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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: Obtener

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

Obtiene los detalles de un único lote especificado por el identificador de lote especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 identificador de lote especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: el lote se ha cancelado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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"
    }
  }
}

Finalización almacenada: lista

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

Obtiene la lista de finalizaciones almacenadas.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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
  }
}

Finalización almacenada: Obtener

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

Obtiene la finalización almacenada por el identificador de finalización almacenado especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
      }
    ]
  }
}

Finalización almacenada: actualización

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

Actualice la finalización almacenada por el identificador de finalización almacenado especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
      }
    ]
  }
}

Finalización almacenada: eliminar

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

Elimine la finalización almacenada por el identificador de finalización almacenado especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: la finalización almacenada se eliminó correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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
  }
}

Finalización almacenada: Getmessages

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

Obtiene los mensajes de finalización almacenados por el identificador de finalización almacenado especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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: obtener lista

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

Enumera las evaluaciones de un proyecto.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: lista de valores

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

Cree la estructura de una evaluación que se puede usar para probar el rendimiento de un modelo. Una evaluación es un conjunto de criterios de prueba y un origen de datos. Después de crear una evaluación, puede ejecutarla en diferentes modelos y parámetros de modelo. Se admiten varios tipos de calificadores y orígenes de datos.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 201

Description: OK

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

Eliminar una evaluación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: eliminó correctamente la evaluación.

Código de estado: 404

Descripción: no se encuentra la evaluación.

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: Obtener

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

Obtenga una evaluación por identificador.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: 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

Actualice determinadas propiedades de una evaluación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: 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

Obtenga una lista de ejecuciones para una evaluación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: lista de ejecuciones 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: creación de una ejecución

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

Cree una nueva ejecución de evaluación. Este es el punto de conexión que iniciará la calificación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 201

Descripción: ha creado correctamente una ejecución para la evaluación.

Código de estado: 400

Descripción: solicitud incorrecta (por ejemplo, falta un objeto eval)

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

Elimine una ejecución de evaluación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: se eliminó correctamente la ejecución de eval.

Código de estado: 404

Descripción: no se encuentra la ejecución

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: Obtener ejecución

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

Obtenga una ejecución de evaluación por identificador.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

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: Cancelación de la ejecución

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

Cancelar una ejecución de evaluación en curso.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: objeto de ejecución de valor cancelado

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

Obtenga una lista de elementos de salida para una ejecución de evaluación.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

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

Obtener un elemento de salida de ejecución de evaluación por identificador.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: elemento de salida de 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 cargado por el usuario como archivos con el fin de "ajustar" para el entrenamiento o la validación de modelos de ajuste, así como archivos generados por el servicio, como "fine-tune-results", que contiene varias métricas para el trabajo de ajuste adecuado correspondiente.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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: cargar

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

Crea una nueva entidad de archivo mediante la carga de datos desde un equipo local. Los archivos cargados pueden usarse, por ejemplo, para entrenar o evaluar modelos optimizados.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: multipart/form-data

Responses

Código de estado: 201

Descripción: el archivo se ha creado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 entidad de archivo mediante la importación de datos desde una dirección URL proporcionada. Los archivos cargados pueden usarse, por ejemplo, para entrenar o evaluar modelos optimizados.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Responses

Código de estado: 201

Descripción: el archivo se ha creado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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: Obtener

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

Obtiene los detalles de un único archivo especificado por el identificador de archivo especificado, incluido el estado, el tamaño, el propósito, etc.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 identificador de archivo especificado.

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

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: el archivo se eliminó correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 identificador de archivo especificado.

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

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: lista

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

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

Los eventos se crean cuando cambia el estado del trabajo. Por ejemplo, ejecutar o completar y cuándo se cargan los resultados.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: 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 determinado.

La respuesta incluye detalles del trabajo en cola, incluidos el estado del trabajo y los parámetros de hyper.

El nombre del modelo ajustado se agrega a la respuesta una vez completado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Responses

Código de estado: 201

Descripción: la optimización se ha creado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: Obtener

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

Obtiene los detalles de un único trabajo de ajuste especificado por el identificador de ajuste especificado.

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

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

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: eliminar

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

Elimina el trabajo de ajuste especificado por el identificador de ajuste especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 204

Descripción: la optimización se eliminó correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: 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 específico especificado por el identificador de ajuste especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: la optimización se ha cancelado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: obtención de 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 especificado por el identificador de ajuste especificado.

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

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: obtención de eventos

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 especificado por el determinado fine-tune-id.

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

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: Pausar

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

Pausar el procesamiento del trabajo de ajuste preciso especificado por el identificador de ajuste especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: la optimización se ha pausado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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 preciso: reanudar

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

Reanuda el procesamiento del trabajo de ajuste específico especificado por el identificador de ajuste especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Descripción: la optimización se ha reanudado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Trabajos de ingesta: lista

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

Enumera los trabajos de ingesta.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 ingesta: crear

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

Crea un trabajo de ingesta con el identificador de trabajo especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
    }
  }
}

Trabajos de ingesta: Obtener

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

Obtiene los detalles del identificador de trabajo especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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

Enumera las ejecuciones del identificador de trabajo especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 identificador de ejecución especificado como parte del identificador de trabajo especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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 a los que puede acceder el recurso Azure OpenAI.

Estos incluyen modelos base, así como todos los modelos optimizados correctamente completados que pertenecen al recurso Azure OpenAI.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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: Obtener

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

Obtiene los detalles del modelo especificado por el modelId especificado.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Cargar archivo: Inicio

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

Se crea un objeto Upload intermedio, lo que le permite agregar elementos a él. Actualmente, un tamaño de carga puede ser un máximo de 9 GB en total y expirará dos horas después de crearse.

Una vez completada la carga, se generará un objeto File, que contiene todas las partes cargadas. A continuación, este objeto File se puede usar en nuestra plataforma como cualquier otro archivo.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Código de estado: 200

Descripción: la carga se ha creado correctamente.

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Cargar archivo: Cancelar

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

Cancela la carga y dará lugar a que todas las partes cargadas se eliminen de forma asincrónica.

No se puede agregar ninguna parte después de cancelar una carga.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Cargar archivo: completado

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

Esto completa la carga y el objeto Upload devuelto contiene un objeto File anidado que está listo para su uso en toda la plataforma.

Puede definir el orden de los elementos proporcionando una lista ordenada de identificadores de pieza.

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

Después de esta operación, no se pueden agregar elementos adicionales una vez completada la carga.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Cargar archivo: parte

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

Agrega un elemento a un objeto Upload, donde cada elemento representa un segmento del archivo que está cargando.

Cada elemento puede ser hasta el límite de tamaño estándar para la carga de archivos, en función del propósito del archivo. Puede continuar agregando elementos hasta alcanzar el límite de tamaño de carga de 9 GB.

URI Parameters

Request Header

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Request Body

Content-Type: multipart/form-data

Responses

Código de estado: 200

Description: Success

Código de estado: valor predeterminado

Descripción: se produjo 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"
  }
}

Components

AzureAISearchIndex

Búsqueda de Azure AI Índice.

BaseConnection

Una conexión a un recurso.

Discriminador para BaseConnection

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

Batch

Define los valores de un lote.

BatchCreateRequest

Define la solicitud para crear un lote.

BatchErrorData

Información de error de un error por lotes.

BatchErrors

En el caso de los lotes con errores, esto contendrá más información sobre la causa de los errores.

BatchRequestCounts

La solicitud cuenta los distintos estados del lote.

BatchOutputReference

Carpeta Azure Storage para almacenar la salida.

BatchStatus

Estado de un lote.

BatchesList

Representa una lista de lotes.

Capabilities

Las funcionalidades de un modelo base o de ajuste preciso.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

Acción de finalización.

ComputeType

Tipo de proceso.

ConnectionStringConnection

Conexión de cadena de conexión.

ConnectionType

Tipo de conexión.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

Objeto CompletionsRunDataSource que describe una configuración de muestreo del modelo.

CreateEvalCustomDataSourceConfig

Objeto CustomDataSourceConfig que define el esquema del origen de datos usado para las ejecuciones de evaluación. Este esquema se usa para definir la forma de los datos que serán: - Se usa para definir los criterios de prueba y - Qué datos se requieren al crear una ejecución

CreateEvalItem

Mensaje de chat que constituye el mensaje o el contexto. Puede incluir referencias de variable al espacio de nombres "item", es decir, {{item.name}}.

CreateEvalJsonlRunDataSource

Objeto JsonlRunDataSource con que especifica un archivo JSONL que coincide con la eval

CreateEvalLabelModelGrader

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

CreateEvalLogsDataSourceConfig

Configuración del origen de datos que especifica la propiedad de metadatos de la consulta de finalizaciones almacenadas. Esto suele ser metadatos como usecase=chatbot o prompt-version=v2, etc.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Una configuración StoredCompletionsRunDataSource que describe un conjunto de filtros

CustomCompute

Custom compute.

DeploymentConnection

Conexión de implementación relativa.

Deprecation

Define las fechas de desuso para los distintos casos de uso de un modelo.

Normalmente, los modelos base admiten 1 año de ajuste fino después de la creación. Normalmente, la inferencia se admite 2 años después de la creación de modelos base o optimizados. Las fechas exactas se especifican en las propiedades.

DpoHyperparamsRequest

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

DpoMethod

Solicitud de ajuste preciso del método DPO

DpoMethodConfigRequest

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

DpoMethodRequest

Solicitud de ajuste preciso del método DPO

EndpointKeyConnection

Conexión de clave de punto de conexión.

EndpointMIConnection

Conexión de identidad administrada del punto de conexión.

Error

Contenido de error tal como se define en las instrucciones rest de Microsoft.

ErrorCode

Códigos de error tal como se definen en las directrices rest de Microsoft.

ErrorResponse

Respuesta de error tal como se define en las directrices de REST de Microsoft.

Eval

Objeto Eval con una configuración de origen de datos y criterios de prueba. Una instancia de Eval representa una tarea que se va a realizar para la integración de LLM. Like:

• Mejora de la calidad de mi bot de chat
• Ver cómo mi bot de chat controla el soporte técnico al cliente
• Compruebe si o3-mini es mejor en mi caso de uso que gpt-4o

EvalApiError

Objeto que representa una respuesta de error de la API de Eval.

EvalCustomDataSourceConfig

CustomDataSourceConfig que especifica el esquema de los item espacios de nombres y opcionalmente sample . El esquema de respuesta define la forma de los datos que serán: - Se usa para definir los criterios de prueba y - Qué datos son necesarios al crear una ejecución

EvalFileRunDataSource

Configuración de FileRunDataSource con un identificador de archivo

EvalItem

Entrada de mensaje al modelo con un rol que indica la instrucción siguiente a la jerarquía. Las instrucciones dadas con el developer rol o system tienen prioridad sobre las instrucciones dadas con el user rol. Se supone que el modelo ha generado mensajes con el assistant rol en interacciones anteriores.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

EvalList

Objeto que representa una lista de valores.