Azure OpenAI in Microsoft Rest API-preview-verwijzing ontwerpen

In dit artikel vindt u meer informatie over de REST API-eindpunten voor deductie voor Azure OpenAI.

API specs

Het beheren en communiceren met Azure OpenAI-modellen en -resources is verdeeld over drie primaire API-oppervlakken:

• Control plane
• Gegevensvlak - ontwerpen
• Gegevensvlak - deductie

Elke API-surface/-specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft een eigen unieke set preview-versies en stabiele/algemeen beschikbare API-releases. Preview-versies volgen momenteel meestal een maandelijkse frequentie.

Authentication

Azure OpenAI biedt twee methoden voor verificatie. U kunt API-sleutels of Microsoft Entra ID gebruiken.

• API-sleutelverificatie: voor dit type verificatie moeten alle API-aanvragen de API-sleutel in de api-key HTTP-header bevatten. De quickstart bevat richtlijnen voor het maken van aanroepen met dit type verificatie.

• Microsoft Entra ID verificatie: u kunt een API-aanroep verifiëren met behulp van een Microsoft Entra token. Verificatietokens worden als header Authorization opgenomen in een aanvraag. Het opgegeven token moet worden voorafgegaan door Bearerbijvoorbeeld Bearer YOUR_AUTH_TOKEN. Lees onze handleiding over authenticating met Microsoft Entra ID.

REST API-versiebeheer

De service-API's worden geversied met behulp van de api-version queryparameter. Alle versies volgen de JJJJ-MM-DD datumstructuur. For example:

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

Ontwerpen van gegevensvlak

De rest van het artikel bevat informatie over de preview-versie van de specificatie van deductie van de Azure OpenAI-gegevenslaag, 2025-04-01-preview.

Als u op zoek bent naar documentatie over de nieuwste GA API-release, raadpleegt u de nieuwste GA-gegevensvlakdeductie-API

Batch - Lijst

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

Hiermee haalt u een lijst op van alle batches die eigendom zijn van de Azure OpenAI-resource.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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 - Maken

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

Hiermee maakt en voert u een batch uit vanuit een geüpload bestand met aanvragen.

Het antwoord bevat details van de enqueued taak, inclusief de taakstatus.

De id van het resultaatbestand wordt toegevoegd aan het antwoord nadat deze is voltooid.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: De batch is gemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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 - Ophalen

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

Hiermee haalt u details op voor één batch die is opgegeven door de opgegeven batch-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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 - Annuleren

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

Annuleert de verwerking van de batch die is opgegeven door de opgegeven batch-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De batch is geannuleerd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
    }
  }
}

Opgeslagen voltooiing - Lijst

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

Hiermee haalt u een lijst met opgeslagen voltooiingen op.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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
  }
}

Opgeslagen voltooiing - Ophalen

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

Hiermee wordt opgeslagen voltooiing door de opgegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
      }
    ]
  }
}

Opgeslagen voltooiing - Bijwerken

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

Opgeslagen voltooiing bijwerken door de opgegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
      }
    ]
  }
}

Opgeslagen voltooiing - Verwijderen

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

Verwijder opgeslagen voltooiing door de opgegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De opgeslagen voltooiing is verwijderd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Opgeslagen voltooiing - Getmessages

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

Hiermee worden opgeslagen voltooiingsberichten ontvangen door de opgegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Evaluatie - Lijst ophalen

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

Lijst met evaluaties voor een project.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst met evals

Examples

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

Antwoorden: Statuscode: 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
  }
}

Evaluatie - Maken

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

Maak de structuur van een evaluatie die kan worden gebruikt om de prestaties van een model te testen. Een evaluatie is een set testcriteria en een gegevensbron. Nadat u een evaluatie hebt gemaakt, kunt u deze uitvoeren op verschillende modellen en modelparameters. We ondersteunen verschillende typen graders en gegevensbronnen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 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"
  }
 ]
}

Antwoorden: Statuscode: 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": {}
  }
}

Evaluatie - Verwijderen

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

Een evaluatie verwijderen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: de evaluatie is verwijderd.

Statuscode: 404

Beschrijving: Evaluatie is niet gevonden.

Examples

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

Antwoorden: Statuscode: 200

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

Statuscode: 404

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

Evaluatie - Ophalen

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

Haal een evaluatie op id op.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatie

Examples

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

Antwoorden: Statuscode: 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": {}
  }
}

Evaluatie - Bijwerken

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

Bepaalde eigenschappen van een evaluatie bijwerken.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De bijgewerkte evaluatie

Examples

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

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

Antwoorden: Statuscode: 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"
    }
  }
}

Evaluatie - Getrunlist

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

Haal een lijst met uitvoeringen op voor een evaluatie.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst met uitvoeringen voor de evaluatie

Examples

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

Antwoorden: Statuscode: 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
  }
}

Evaluatie - Uitvoering maken

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

Maak een nieuwe evaluatieuitvoering. Dit is het eindpunt dat begint met beoordelen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 201

Beschrijving: Er is een uitvoering gemaakt voor de evaluatie

Statuscode: 400

Beschrijving: Ongeldige aanvraag (bijvoorbeeld ontbrekend eval-object)

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

Antwoorden: Statuscode: 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": {}
  }
}

Evaluatie - Uitvoering verwijderen

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

Een evaluatieuitvoering verwijderen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatieuitvoering is verwijderd

Statuscode: 404

Beschrijving: Uitvoeren is niet gevonden

Examples

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

Antwoorden: Statuscode: 200

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

Statuscode: 404

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

Evaluatie - Uitvoering ophalen

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

Haal een evaluatie op die wordt uitgevoerd op id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatieuitvoering

Examples

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

Antwoorden: Statuscode: 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": {}
  }
}

Evaluatie - Uitvoering annuleren

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

Annuleer een doorlopende evaluatieuitvoering.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Het geannuleerde uitvoerobject voor de evaluatie

Examples

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

Antwoorden: Statuscode: 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": {}
  }
}

Evaluatie - Getrunoutputitems

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

Haal een lijst met uitvoeritems op voor een evaluatieuitvoering.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst met uitvoeritems voor de evaluatieuitvoering

Examples

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

Antwoorden: Statuscode: 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
  }
}

Evaluatie - Getrunoutputitem

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

Haal een uitvoeritem voor de evaluatieuitvoering op op id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Het uitvoeritem van de evaluatieuitvoering

Examples

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

Antwoorden: Statuscode: 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
    }
  }
}

Bestanden - Lijst

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

Hiermee haalt u een lijst op van alle bestanden die eigendom zijn van de Azure OpenAI-resource.

Deze omvatten door de gebruiker geüploade inhoud, zoals bestanden met het doel 'fine-tune' voor training of validatie van modellen met fine-tunes, evenals bestanden die door de service worden gegenereerd, zoals 'fine-tune-results' die verschillende metrische gegevens voor de bijbehorende taak voor het afstemmen bevat.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Bestanden - Uploaden

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

Hiermee maakt u een nieuwe bestandsentiteit door gegevens van een lokale computer te uploaden. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van nauwkeurig afgestemde modellen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 201

Beschrijving: Het bestand is gemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Bestanden - Importeren

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

Hiermee maakt u een nieuwe bestandsentiteit door gegevens uit een opgegeven URL te importeren. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van nauwkeurig afgestemde modellen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: Het bestand is gemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Bestanden - Ophalen

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

Hiermee haalt u details op voor één bestand dat is opgegeven door de opgegeven bestands-id, inclusief status, grootte, doel, enzovoort.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Bestanden - Verwijderen

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

Hiermee verwijdert u het bestand met de opgegeven bestands-id.

Verwijderen is ook toegestaan als een bestand is gebruikt, bijvoorbeeld als trainingsbestand in een taak voor het afstemmen.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: Het bestand is verwijderd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Bestanden - Inhoud ophalen

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

Hiermee haalt u de inhoud van het bestand op dat is opgegeven door de opgegeven bestands-id.

Bestanden kunnen door de gebruiker geüploade inhoud zijn of worden gegenereerd door de service, zoals metrische resultaten van een taak voor het afstemmen van de taak.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Fine-tuning - Lijst

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

Hiermee haalt u een lijst op met alle taken die eigendom zijn van de Azure OpenAI-resource. De details die worden geretourneerd voor elke taak voor het afstemmen, bevatten naast de id het basismodel, trainings- en validatiebestanden, hyperparameters, tijdstempels, status en gebeurtenissen.

Gebeurtenissen worden gemaakt wanneer de taakstatus wordt gewijzigd. Bijvoorbeeld uitvoeren of voltooien en wanneer de resultaten worden geüpload.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Maken

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

Hiermee maakt u een taak waarmee een opgegeven model wordt aangepast op basis van een bepaald trainingsbestand.

Het antwoord bevat details van de enqueued-taak, inclusief taakstatus en hyperparameters.

De naam van het nauwkeurig afgestemde model wordt toegevoegd aan het antwoord zodra het is voltooid.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: De fine tune is gemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemming - Krijgen

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

Hiermee haalt u details op voor één fine-tuning-taak die is opgegeven door de opgegeven fine-tune-id.

De details bevatten het basismodel, trainings- en validatiebestanden, hyperparameters, tijdstempels, status en gebeurtenissen.

Gebeurtenissen worden gemaakt wanneer de taakstatus wordt gewijzigd, bijvoorbeeld wordt uitgevoerd of voltooid en wanneer de resultaten worden geüpload.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Verwijderen

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

Hiermee verwijdert u de taak voor het afstemmen die is opgegeven door de opgegeven verfijnings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 204

Beschrijving: De fine tune is verwijderd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 204

{
  "headers": {}
}

Afstemmen - Annuleren

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

Hiermee annuleert u de verwerking van de taak voor het afstemmen die is opgegeven door de opgegeven fine-tune-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De fine tune is geannuleerd

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Controlepunten ophalen

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

Hiermee haalt u de controlepunten op voor de taak die is opgegeven met de opgegeven fine-tune-id.

Controlepunten worden gemaakt aan het einde van geslaagde tijdvakken tijdens de training.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Gebeurtenissen ophalen

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

Hiermee haalt u de gebeurtenissen op voor de taak die is opgegeven met de opgegeven verfijnings-id.

Gebeurtenissen worden gemaakt wanneer de taakstatus wordt gewijzigd, bijvoorbeeld wordt uitgevoerd of voltooid en wanneer de resultaten worden geüpload.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Onderbreken

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

De verwerking van de taak voor het afstemmen onderbreken die is opgegeven door de opgegeven fine-tune-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De fine tune is onderbroken.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Afstemmen - Hervatten

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

Hiermee wordt de verwerking van de taak voor het afstemmen hervat die is opgegeven door de opgegeven verfijnings-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Beschrijving: De fine tune is hervat.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Opnametaken - Lijst

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

Hiermee worden de opnametaken weergegeven.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
      }
    ]
  }
}

Opnametaken - Maken

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

Hiermee maakt u een opnametaak met de opgegeven taak-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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

Antwoorden: Statuscode: 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"
    }
  }
}

Opnametaken - Ophalen

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

Hiermee haalt u de details van de opgegeven taak-id op.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
    }
  }
}

Opnamejomappen - Lijst

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

Toont de uitvoeringen van de opgegeven taak-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
      }
    ]
  }
}

Opnamejo intimidaties - Get

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

Hiermee haalt u de details van de opgegeven uitvoerings-id op als onderdeel van de opgegeven taak-id.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
        }
      ]
    }
  }
}

Modellen - Lijst

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

Hiermee haalt u een lijst op van alle modellen die toegankelijk zijn voor de Azure OpenAI-resource.

Dit zijn onder andere basismodellen en alle voltooide, nauwkeurig afgestemde modellen die eigendom zijn van de Azure OpenAI-resource.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Modellen - Ophalen

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

Hiermee haalt u details op voor het model dat is opgegeven door de opgegeven modelId.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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

Antwoorden: Statuscode: 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"
  }
}

Bestand uploaden - Start

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

Er wordt een tussenliggend uploadobject gemaakt, zodat u er onderdelen aan kunt toevoegen. Op dit moment kan een uploadgrootte maximaal 9 GB bedragen en verloopt het twee uur nadat deze is gemaakt.

Nadat het uploaden is voltooid, wordt een bestandsobject gegenereerd met alle geüploade onderdelen. Dit bestandsobject kan vervolgens op ons platform worden gebruikt, net als elk ander bestand.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Statuscode: 200

Beschrijving: Het uploaden is gemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

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

Antwoorden: Statuscode: 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"
  }
}

Bestand uploaden - Annuleren

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

Hiermee wordt het uploaden geannuleerd en worden alle geüploade onderdelen asynchroon verwijderd.

Er kunnen geen onderdelen worden toegevoegd nadat een upload is geannuleerd.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 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"
  }
}

Bestand uploaden - Voltooien

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

Hiermee wordt het uploaden voltooid en bevat het geretourneerde uploadobject een geneste bestandsobject dat klaar is voor gebruik op het platform.

U kunt de volgorde van de onderdelen definiëren door een geordende lijst met deel-id's op te geven.

Het totale aantal geüploade bytes moet overeenkomen met de grootte die oorspronkelijk is opgegeven bij het maken van het uploadobject.

Na deze bewerking kunnen er geen extra onderdelen worden toegevoegd zodra het uploaden is voltooid.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

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

Antwoorden: Statuscode: 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"
  }
}

Bestand uploaden - onderdeel

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

Voegt een onderdeel toe aan een uploadobject, waarbij elk onderdeel een segment vertegenwoordigt van het bestand dat u uploadt.

Elk onderdeel kan voldoen aan de standaardgroottelimiet voor het uploaden van bestanden, op basis van het doel van het bestand. U kunt onderdelen blijven toevoegen totdat u de limiet voor uploadgrootte van 9 GB bereikt.

URI Parameters

Request Header

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 200

Description: Success

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Antwoorden: Statuscode: 200

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

Components

AzureAISearchIndex

Azure AI Zoeken Index.

BaseConnection

Een verbinding met een resource.

Discriminator voor BaseConnection

Dit onderdeel maakt gebruik van de eigenschap kind om onderscheid te maken tussen verschillende typen:

Batch

Definieert de waarden van een batch.

BatchCreateRequest

Definieert de aanvraag voor het maken van een batch.

BatchErrorData

Foutinformatie voor een fout in batch.

BatchErrors

Voor batches die zijn mislukt, bevat dit meer informatie over de oorzaak van de fouten.

BatchRequestCounts

De aanvraag telt voor verschillende statussen in de batch.

BatchOutputReference

De map Azure Storage voor het opslaan van uitvoer.

BatchStatus

De status van een batch.

BatchesList

Vertegenwoordigt een lijst met batches.

Capabilities

De mogelijkheden van een basismodel of het verfijnen van het model.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

De voltooiingsactie.

ComputeType

Het rekentype.

ConnectionStringConnection

Verbindingsreeksverbinding.

ConnectionType

Het verbindingstype.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

Een CompletionsRunDataSource-object met een beschrijving van een modelsamplingconfiguratie.

CreateEvalCustomDataSourceConfig

Een CustomDataSourceConfig-object dat het schema definieert voor de gegevensbron die wordt gebruikt voor de evaluatieuitvoeringen. Dit schema wordt gebruikt om de vorm van de gegevens te definiëren: - Wordt gebruikt om uw testcriteria te definiëren en - welke gegevens nodig zijn bij het maken van een uitvoering

CreateEvalItem

Een chatbericht waaruit de prompt of context bestaat. Kan variabele verwijzingen naar de naamruimte item bevatten, dus {{item.name}}.

CreateEvalJsonlRunDataSource

Een JsonlRunDataSource-object met dat een JSONL-bestand opgeeft dat overeenkomt met de eval

CreateEvalLabelModelGrader

Een LabelModelGrader-object dat gebruikmaakt van een model om labels toe te wijzen aan elk item in de evaluatie.

CreateEvalLogsDataSourceConfig

Een gegevensbronconfiguratie waarmee de metagegevenseigenschap van de opgeslagen voltooiingsquery wordt opgegeven. Dit zijn meestal metagegevens zoals usecase=chatbot of prompt-version=v2, enzovoort.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Een StoredCompletionsRunDataSource-configuratie die een set filters beschrijft

CustomCompute

Custom compute.

DeploymentConnection

Relatieve implementatieverbinding.

Deprecation

Definieert de datums van afschaffing voor de verschillende use cases van een model.

Basismodellen ondersteunen meestal 1 jaar na het maken van de basismodellen. Deductie wordt doorgaans 2 jaar na het maken van basismodellen of nauwkeurig afgestemde modellen ondersteund. De exacte datums worden opgegeven in de eigenschappen.

DpoHyperparamsRequest

Hyperparameters voor DPO-methode voor het afstemmen

DpoMethod

Aanvraag voor het afstemmen van DPO-methoden

DpoMethodConfigRequest

Configuratie voor dpo de verfijningsmethode. Bevat DPO-specifieke hyperparameters

DpoMethodRequest

Aanvraag voor het afstemmen van DPO-methoden

EndpointKeyConnection

Verbinding met eindpuntsleutel.

EndpointMIConnection

Managed Identity-verbinding met eindpunt.

Error

Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen.

ErrorCode

Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen.

ErrorResponse

Foutreactie zoals gedefinieerd in de Microsoft REST-richtlijnen.

Eval

Een Eval-object met een configuratie- en testcriteria voor een gegevensbron. Een Eval vertegenwoordigt een taak die moet worden uitgevoerd voor uw LLM-integratie. Like:

• De kwaliteit van mijn chatbot verbeteren
• Bekijk hoe goed mijn chatbot de klantondersteuning afhandelt
• Controleer of o3-mini beter is in mijn use case dan gpt-4o

EvalApiError

Een object dat een foutbericht weergeeft van de Eval-API.

EvalCustomDataSourceConfig

Een CustomDataSourceConfig waarmee het schema van uw item en eventueel sample naamruimten wordt opgegeven. Het antwoordschema definieert de vorm van de gegevens die worden gebruikt om uw testcriteria te definiëren en welke gegevens nodig zijn bij het maken van een uitvoering

EvalFileRunDataSource

Een FileRunDataSource-configuratie met een bestands-id

EvalItem

Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven. Berichten met de assistant rol worden verondersteld te zijn gegenereerd door het model in eerdere interacties.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Een LabelModelGrader-object dat gebruikmaakt van een model om labels toe te wijzen aan elk item in de evaluatie.

EvalList

Een object dat een lijst met evals vertegenwoordigt.