Azure OpenAI dans Microsoft Foundry Models authoring REST API preview référence

Cet article fournit des détails sur les terminaux d’inférence de l’API REST pour Azure OpenAI.

API specs

La gestion et l’interaction avec les modèles et ressources OpenAI Azure sont réparties sur trois surfaces principales d’API :

• Control plane
• Plan de données - création
• Plan de données - inférence

Chaque surface/spécification API englobe un ensemble différent de capacités Azure OpenAI. Chaque API possède son propre ensemble unique de versions d’aperçu et d’API stable/généralement disponibles (GA). Les sorties de prévisualisation suivent actuellement un rythme mensuel.

Authentication

Azure OpenAI propose deux méthodes d’authentification. Vous pouvez utiliser soit API Keys, soit Microsoft Entra ID.

• Authentification par clé API : Pour ce type d’authentification, toutes les requêtes API doivent inclure la clé API dans l’en-tête api-key HTTP. Le Quickstart fournit des conseils pour passer des appels avec ce type d’authentification.

• Microsoft Entra ID : Vous pouvez authentifier un appel API à l’aide d’un jeton Microsoft Entra. Les jetons d’authentification sont inclus dans une requête en tant qu’en-tête Authorization . Le jeton fourni doit être précédé de Bearer, par exemple Bearer YOUR_AUTH_TOKEN. Vous pouvez lire notre guide pratique sur authentifier avec Microsoft Entra ID.

Versionnement de l’API REST

Les API de service sont versionnées à l’aide du api-version paramètre de requête. Toutes les versions suivent la structure de dates 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

Création de plans de données

Le reste de l’article traite de la version préliminaire de la spécification d’inférence du plan de données OpenAI Azure 2025-04-01-preview.

Si vous cherchez de la documentation sur la dernière version de l’API GA, consultez la dernière API d’inférence des plans de données GA

Série - Liste

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

Obtient une liste de tous les lots détenus par la ressource OpenAI d’Azure.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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 - Créer

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

Crée et exécute un lot à partir d’un fichier de requêtes téléchargé.

La réponse inclut des détails sur le poste en file d’attente, y compris le statut du poste.

L’identifiant du fichier de résultat est ajouté à la réponse une fois terminée.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Responses

Code de statut : 201

Description : Le lot a été créé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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 - Get

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

Obtient les détails d’un seul lot spécifié par l’identifiant de lot donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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 - Annuler

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

Annule le traitement du lot spécifié par l’identifiant de lot donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Le lot a été annulé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
    }
  }
}

Complétion stockée - Liste

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

Obtient la liste des complétions stockées.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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
  }
}

Complétion stockée - Obtenir

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

Obtient la complétion stockée par l’id de complétion stockée donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
      }
    ]
  }
}

Complétion stockée - Mise à jour

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

Mettre à jour la complétion stockée avec l’identifiant de complétion stockée donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
      }
    ]
  }
}

Complétion stockée - Supprimer

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

Supprimez la complétion stockée par l’identifiant de complétion stockée donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : La complétion stockée a été supprimée avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Complétion stockée - Getmessages

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

Reçoit les messages de complétion stockés par l’identifiant de complétion stocké donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Évaluation - Liste d’obtention

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

Listez les évaluations d’un projet.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Liste des évaluations

Examples

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

Réponses : Code de statut : 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
  }
}

Évaluation - Création

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

Créez la structure d’une évaluation qui peut être utilisée pour tester la performance d’un modèle. Une évaluation est un ensemble de critères de test et une source de données. Après avoir créé une évaluation, vous pouvez l’exécuter sur différents modèles et paramètres de modèle. Nous soutenons plusieurs types de correcteurs et sources de données.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 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"
  }
 ]
}

Réponses : Code de statut : 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": {}
  }
}

Évaluation - Supprimer

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

Supprime une évaluation.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Suppression réussie de l’évaluation.

Code de statut : 404

Description : Évaluation non trouvée.

Examples

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

Réponses : Code de statut : 200

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

Code de statut : 404

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

Évaluation - Obtenez

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

Faites une évaluation par pièce d’identité.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : L’évaluation

Examples

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

Réponses : Code de statut : 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": {}
  }
}

Évaluation - Mise à jour

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

Mettez à jour certaines propriétés d’une évaluation.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : L’évaluation mise à jour

Examples

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

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

Réponses : Code de statut : 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"
    }
  }
}

Évaluation - Getrunlist

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

Obtenez une liste de points pour une évaluation.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Liste des points pour l’évaluation

Examples

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

Réponses : Code de statut : 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
  }
}

Évaluation - Créer une course

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

Créez une nouvelle exécution d’évaluation. C’est le point final qui va lancer la correction.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 201

Description : Création réussie d’une exécution pour l’évaluation

Code de statut : 400

Description : Mauvaise requête (par exemple, objet d’évaluation manquant)

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

Réponses : Code de statut : 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": {}
  }
}

Évaluation - Suppression de la course

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

Supprime une sortie d’évaluation.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Suppression réussie de la série d’évaluation

Code de statut : 404

Description : Run non trouvé

Examples

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

Réponses : Code de statut : 200

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

Code de statut : 404

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

Évaluation - Partez

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

Faites passer une évaluation par l’ID.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : La course d’évaluation

Examples

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

Réponses : Code de statut : 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": {}
  }
}

Évaluation - Annuler la course

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

Annulez une évaluation en cours.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : L’objet d’évaluation annulée

Examples

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

Réponses : Code de statut : 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": {}
  }
}

Évaluation - Getrunoutputitems

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

Obtenez une liste des éléments de sortie pour une exécution d’évaluation.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Une liste des éléments de sortie pour l’exécution d’évaluation

Examples

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

Réponses : Code de statut : 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
  }
}

Évaluation - Getrunoutputitem

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

Faites exécuter une évaluation et exécuter l’élément de sortie par ID.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : L’élément de sortie de la série d’évaluation

Examples

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

Réponses : Code de statut : 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
    }
  }
}

Fichiers - Liste

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

Obtient une liste de tous les fichiers appartenant à la ressource Azure OpenAI.

Cela inclut le contenu téléchargé par l’utilisateur, comme des fichiers destinés à « fin-tuning » pour entraîner ou valider des modèles de fine-tuning ainsi que des fichiers générés par le service, tels que les « fine-tuning results » qui contiennent diverses métriques pour le travail de fine-tuning correspondant.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Fichiers - Téléverser

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

Crée une nouvelle entité de fichier en téléversant les données depuis une machine locale. Les fichiers téléchargés peuvent, par exemple, être utilisés pour l’entraînement ou l’évaluation de modèles affinés.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: multipart/form-data

Responses

Code de statut : 201

Description : Le fichier a été créé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Fichiers - Importation

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

Crée une nouvelle entité de fichier en important des données d’une URL fournie. Les fichiers téléchargés peuvent, par exemple, être utilisés pour l’entraînement ou l’évaluation de modèles affinés.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Responses

Code de statut : 201

Description : Le fichier a été créé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Fichiers - Obtenez

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

Obtient les détails d’un seul fichier spécifié par l’identifiant donné, y compris le statut, la taille, le but, etc.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Fichiers - Supprimer

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

Supprime le fichier avec l’identifiant de fichier donné.

La suppression est également autorisée si un fichier a été utilisé, par exemple comme fichier d’entraînement lors d’un travail d’ajustement fin.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Le fichier a été supprimé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Fichiers - Obtenir du contenu

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

Obtient le contenu du fichier spécifié par l’identifiant de fichier donné.

Les fichiers peuvent être du contenu téléchargé par l’utilisateur ou générés par le service, comme des métriques de résultats lors d’un travail de fin-tuning.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Ajustement fin - Liste

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

Obtient une liste de tous les travaux d’ajustement finement détenus par la ressource Azure OpenAI. Les détails retournés pour chaque tâche d’ajustement fin incluent, en plus de son identifiant, le modèle de base, les fichiers d’entraînement et de validation, les hyperparamètres, les horodatages, le statut et les événements.

Les événements sont créés lorsque le statut du poste change. Par exemple, en cours ou terminé, et lorsque les résultats sont téléchargés.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Ajustement fin - Création

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

Crée une tâche qui ajuste un modèle spécifié à partir d’un fichier d’entraînement donné.

La réponse inclut des détails sur la tâche en file d’attente, y compris le statut de la tâche et les paramètres hyper.

Le nom du modèle affiné est ajouté à la réponse une fois terminée.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Responses

Code de statut : 201

Description : Le réglage fin a été créé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Ajustement fin - Obtenez

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

Obtient les détails d’un seul travail d’ajustement fin spécifié par l’identifiant de réglage fin donné.

Les détails contiennent le modèle de base, les fichiers d’entraînement et de validation, les hyperparamètres, les horodatages, le statut et les événements.

Les événements sont créés lorsque le statut du poste change, par exemple en cours ou terminé, et lorsque les résultats sont téléchargés.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Ajustement fin - Supprimer

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

Supprime la tâche de réglage fin spécifiée par l’id de réglage fin donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 204

Description : L’ajustement fin a été supprimé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 204

{
  "headers": {}
}

Ajustement fin - Annuler

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

Annule le traitement de la tâche d’ajustement fin spécifiée par l’id de réglage fin donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Le fin réglage a été annulé avec succès

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Ajustement fin - Obtenez des points de contrôle

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

Obtient les points de contrôle pour le travail d’ajustement fin spécifié par l’id de réglage précis.

Les points de contrôle sont créés à la fin des époques réussies pendant l’entraînement.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Ajustement fin - Obtenir des événements

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

Obtient les événements pour le travail de réglage fin spécifié par l’id de réglage précis.

Les événements sont créés lorsque le statut du poste change, par exemple en cours ou terminé, et lorsque les résultats sont téléchargés.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Réglage fin - Pause

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

Mise en pause du traitement de la tâche d’ajustement fin spécifiée par l’id d’ajustement fin donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : Le réglage fin a été mis en pause avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Affinage - CV

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

Reprend le traitement de la tâche d’ajustement fin spécifiée par l’identifiant de réglage fin.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description : L’ajustement fin a été repris avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Emplois en gestion - Liste

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

Liste les emplois d’ingestion.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
      }
    ]
  }
}

Emplois d’ingestion - Créer

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

Crée un travail d’ingestion avec l’identifiant de travail spécifié.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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

Réponses : Code de statut : 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"
    }
  }
}

Emplois en gestion - Obtenez

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

On obtient les détails de l’identifiant du poste spécifié.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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 - Liste

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

Affiche les exécutions de l’identifiant de tâche spécifié.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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 - Obtenez

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

Obtient les détails de l’identifiant de run spécifié dans le cadre de l’id de travail spécifié.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
        }
      ]
    }
  }
}

Modèles - Liste

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

Obtient une liste de tous les modèles accessibles via la ressource Azure OpenAI.

Cela inclut les modèles de base ainsi que tous les modèles finement ajustés réussiment détenus par la ressource Azure OpenAI.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Mannequins - Obtenez

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

Obtient les détails du modèle spécifié par le modelId donné.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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

Réponses : Code de statut : 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"
  }
}

Télécharger le fichier - Démarrer

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

Un objet intermédiaire de téléversement est créé, vous permettant d’y ajouter des parties. Actuellement, une taille d’envoi peut atteindre un maximum de 9 Go au total et expire deux heures après sa création.

Après l’Upload, un objet fichier sera généré, contenant toutes les parties téléchargées. Cet objet fichier peut ensuite être utilisé sur toute notre plateforme, comme n’importe quel autre fichier.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Code de statut : 200

Description : Le téléchargement a été créé avec succès.

Code de statut : par défaut

Description : Une erreur s’est produite.

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

Réponses : Code de statut : 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"
  }
}

Fichier de téléversement - Annuler

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

Annule le téléchargement, et cela entraînera la suppression asynchrone de toutes les parties téléchargées.

Aucune pièce ne peut être ajoutée après l’annulation d’un téléchargement.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 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"
  }
}

Fichier d’envoi - Terminé

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

Cela complète le téléchargement, et l’objet Upload retourné contient un objet fichier imbriqué prêt à être utilisé sur toute la plateforme.

Vous pouvez définir l’ordre des pièces en fournissant une liste ordonnée des identifiants de pièces.

Le nombre total d’octets téléchargés doit correspondre à la taille initialement spécifiée lors de la création de l’objet Upload.

Après cette opération, aucune pièce supplémentaire ne peut être ajoutée une fois le téléchargement terminé.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

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

Réponses : Code de statut : 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"
  }
}

Fichier de téléversement - Partie

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

Ajoute une Partie à un objet Upload, où chaque Partie représente un segment du fichier que vous téléchargez.

Chaque pièce peut atteindre la limite de taille standard pour le téléchargement de fichiers, selon le but du fichier. Vous pouvez continuer à ajouter des pièces jusqu’à atteindre la limite de taille de téléversement de 9 Go.

URI Parameters

Request Header

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Request Body

Content-Type: multipart/form-data

Responses

Code de statut : 200

Description: Success

Code de statut : par défaut

Description : Une erreur s’est produite.

Examples

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

Réponses : Code de statut : 200

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

Components

AzureAISearchIndex

Recherche Azure AI Index.

BaseConnection

Un lien avec une ressource.

Discriminateur pour BaseConnection

Ce composant utilise la propriété kind pour distinguer différents types :

Batch

Définit les valeurs d’un lot.

BatchCreateRequest

Définit la requête pour créer un lot.

BatchErrorData

Informations d’erreur pour une défaillance dans un lot.

BatchErrors

Pour les lots qui ont échoué, cela contiendra plus d’informations sur la cause des défaillances.

BatchRequestCounts

La demande compte pour différents statuts au sein du lot.

BatchOutputReference

Le dossier stockage Azure pour stocker la sortie.

BatchStatus

Le statut d’un lot.

BatchesList

Représente une liste de lots.

Capabilities

Les capacités d’un modèle de base ou de réglage fin.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

L’action de complétion.

ComputeType

Le type de calcul.

ConnectionStringConnection

Connexion à la chaîne de connexion.

ConnectionType

Le type de connexion.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

Un objet CompletionsRunDataSource décrivant une configuration d’échantillonnage de modèle.

CreateEvalCustomDataSourceConfig

Un objet CustomDataSourceConfig qui définit le schéma de la source de données utilisée pour l’évaluation s’exécute. Ce schéma sert à définir la forme des données qui seront : - Utilisées pour définir vos critères de test et - Quelles données sont nécessaires lors de la création d’une exécution

CreateEvalItem

Un message de chat qui constitue le sujet ou le contexte. Peut inclure des références à variables à l’espace de noms « élément », par exemple {{item.name}}.

CreateEvalJsonlRunDataSource

Un objet JsonlRunDataSource avec cela spécifie un fichier JSONL correspondant à l’évaluation

CreateEvalLabelModelGrader

Un objet LabelModelGrader qui utilise un modèle pour attribuer des étiquettes à chaque élément de l’évaluation.

CreateEvalLogsDataSourceConfig

Une configuration de source de données qui spécifie la propriété de métadonnées de votre requête de complétions stockées. Il s’agit généralement de métadonnées comme usecase=chatbot ou prompt-version=v2, etc.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Une configuration StoredCompletionsRunDataSource décrivant un ensemble de filtres

CustomCompute

Custom compute.

DeploymentConnection

Connexion relative au déploiement.

Deprecation

Définit les dates de dépréciation pour les différents cas d’utilisation d’un modèle.

En général, les modèles de base supportent un an de réglage fin après la création. L’inférence est généralement prise en charge 2 ans après la création des modèles de base ou affinés. Les dates exactes sont spécifiées dans les propriétés.

DpoHyperparamsRequest

Hyperparamètres pour la méthode DPO de réglage fin

DpoMethod

Demande d’ajustement fin de la méthode DPO

DpoMethodConfigRequest

Configuration pour dpo la méthode de réglage fin. Inclut des hyperparamètres spécifiques à la DPO

DpoMethodRequest

Demande d’ajustement fin de la méthode DPO

EndpointKeyConnection

Connexion clé de point de terminaison.

EndpointMIConnection

Connexion Endpoint Managed Identity.

Error

Contenu d’erreur tel que défini dans les directives REST Microsoft.

ErrorCode

Codes d’erreur tels que définis dans les directives REST Microsoft.

ErrorResponse

Réponse à l’erreur telle que définie dans les directives Microsoft REST.

Eval

Un objet Eval avec une configuration de source de données et des critères de test. Une évaluation représente une tâche à accomplir pour votre intégration LLM. Like:

• Améliorer la qualité de mon chatbot
• Voyez comment mon chatbot gère le support client
• Vérifie si O3-mini est meilleur dans mon cas d’usage que GPT-4O

EvalApiError

Un objet représentant une réponse d’erreur provenant de l’API Eval.

EvalCustomDataSourceConfig

Un CustomDataSourceConfig qui spécifie le schéma de votre item et, éventuellement sample , des espaces de noms. Le schéma de réponse définit la forme des données qui seront : - Utilisées pour définir vos critères de test et - Quelles données sont nécessaires lors de la création d’une exécution

EvalFileRunDataSource

Une configuration FileRunDataSource avec un identifiant de fichier

EvalItem

Un message d’entrée dans le modèle avec un rôle indiquant l’instruction suivant la hiérarchie. Les instructions données avec le developer rôle ou system ont la priorité sur les instructions données avec le user rôle. Les messages avec ce assistant rôle sont supposés avoir été générés par le modèle lors d’interactions précédentes.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Un objet LabelModelGrader qui utilise un modèle pour attribuer des étiquettes à chaque élément de l’évaluation.

EvalList

Un objet représentant une liste d’évaluations.