Azure OpenAI in Microsoft Foundry Models authoring REST API preview-referentie

Dit artikel geeft details over de inferentie REST API-eindpunten voor Azure OpenAI.

API specs

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

• Control plane
• Datavlak - authoring
• Datavlak - inferentie

Elke API-oppervlakte/specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft zijn eigen unieke set preview- en stabiele/algemeen beschikbare (GA) API-releases. Preview-releases volgen momenteel meestal een maandelijkse cadens.

Authentication

Azure OpenAI biedt twee methoden voor authenticatie. Je kunt API Keys of Microsoft Entra ID gebruiken.

• API-sleutelauthenticatie: Voor dit type authenticatie moeten alle API-verzoeken de API-sleutel in de api-key HTTP-header bevatten. De Quickstart geeft instructies over hoe je met dit type authenticatie oproepen kunt voeren.

• Microsoft Entra ID authenticatie: Je kunt een API-aanroep authenticeren met een Microsoft Entra-token. Authenticatietokens worden opgenomen in een verzoek als header Authorization . Het gegeven token moet voorafgegaan worden door Bearer, bijvoorbeeld Bearer YOUR_AUTH_TOKEN. Je kunt onze handleiding lezen over authenticatie met Microsoft Entra ID.

REST API-versiebeheer

De service-API's zijn versiegevaagd met behulp van de api-version queryparameter. Alle versies volgen de YYYY-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

Datavlak-authoring

De rest van het artikel behandelt de preview-release van de Azure OpenAI dataplane inference specification, 2025-04-01-preview.

Als je op zoek bent naar documentatie over de nieuwste GA API-release, raadpleeg dan de nieuwste GA data plane inference API

Batch - Lijst

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

Krijgt een lijst van alle batches die eigendom zijn van de Azure OpenAI-resource.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 - Aanmaken

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

Maakt een batch aan en voert uit vanuit een geüpload bestand met verzoeken.

Het antwoord bevat details over de genoteerde functie, inclusief de functiestatus.

De ID van het resultaatbestand wordt aan het antwoord toegevoegd zodra het voltooid is.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: De batch is succesvol aangemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Reacties: 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 - Haal

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

Krijgt details voor een enkele batch die door de gegeven batch-id wordt gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 door de gegeven batch-id is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De batch is succesvol geannuleerd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

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

Krijgt een lijst van opgeslagen voltooiingen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 - Haal

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

Krijgt opgeslagen voltooiing door het gegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 - Update

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

Werk stored completion bij met de gegeven stored completion id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 gegeven opgeslagen voltooiings-id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De opgeslagen voltooiing is succesvol verwijderd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

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

Ontvangt opgeslagen completion messages via de gegeven stored completion id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst van evaluaties

Examples

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

Reacties: 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 - Creëren

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

Creëer de structuur van een evaluatie die gebruikt kan worden om de prestaties van een model te testen. Een evaluatie is een set testcriteria en een databron. Na het maken van een evaluatie kun je deze uitvoeren op verschillende modellen en modelparameters. We ondersteunen verschillende soorten beoordelaars en databronnen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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"
  }
 ]
}

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

Verwijder een evaluatie.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatie succesvol verwijderd.

Statuscode: 404

Beschrijving: Evaluatie niet gevonden.

Examples

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

Reacties: 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 - Krijg

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

Laat een evaluatie doen via ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatie

Examples

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

Reacties: 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 - Update

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

Werk bepaalde eigenschappen van een evaluatie bij.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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"
 }
}

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

Maak een lijst met runs voor een evaluatie.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst van runs voor de evaluatie

Examples

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

Reacties: 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 - Een run aanmaken

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

Maak een nieuwe evaluatie-run aan. Dit is het eindpunt dat het beoordelen van start zet.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 201

Beschrijving: Succesvol een run gemaakt voor de evaluatie

Statuscode: 400

Beschrijving: Slecht verzoek (bijvoorbeeld ontbrekend evaluatieobject)

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

Reacties: 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 - Verwijderen uitvoeren

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

Verwijder een evaluatie-run.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatie-run succesvol verwijderd

Statuscode: 404

Beschrijving: Run niet gevonden

Examples

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

Reacties: 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 - Laat het uitvoeren

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

Laat een evaluatie uitvoeren via ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De evaluatie-run

Examples

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

Reacties: 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 - Annuleren van de run

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

Annuleer een lopende evaluatie.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Het geannuleerde eval-run object

Examples

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

Reacties: 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 outputitems voor een evaluatie-run.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Een lijst van uitvoeritems voor de evaluatie-run

Examples

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

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

Krijg een evaluatie, laat het outputitem op ID uitvoeren.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Het evaluatie-run outputitem

Examples

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

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

Krijgt een lijst van alle bestanden die eigendom zijn van de Azure OpenAI-resource.

Deze omvatten door gebruikers geüploade inhoud zoals bestanden met als doel "fine-tune" te gebruiken voor training of validatie van fine-tunes modellen, evenals bestanden die door de dienst worden gegenereerd, zoals "fine-tune-results" die verschillende metrics voor de bijbehorende fine-tuning taak bevat.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 - Upload

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

Maakt een nieuwe bestandsentiteit aan door data te uploaden van een lokale machine. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van fijn afgestemde modellen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 201

Beschrijving: Het bestand is succesvol aangemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

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

Maakt een nieuwe bestandsentiteit aan door gegevens te importeren uit een opgegeven url. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van fijn afgestemde modellen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: Het bestand is succesvol aangemaakt.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Reacties: 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 - Haal

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

Krijgt details voor een enkel bestand dat door het opgegeven bestands-id wordt gespecificeerd, inclusief status, grootte, doel, enzovoort.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Verwijdert het bestand met het opgegeven bestands-id.

Verwijderen is ook toegestaan als een bestand is gebruikt, bijvoorbeeld als trainingsbestand in een fijntuningtaak.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: Het bestand is succesvol verwijderd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

Reacties: Statuscode: 200

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

Bestanden - Haal inhoud op

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

Krijgt de inhoud van het bestand dat door het opgegeven bestands-id is gespecificeerd.

Bestanden kunnen door gebruikers geüploade content zijn of door de dienst worden gegenereerd, zoals resultaatstatistieken van een fijntuningstaak.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: Statuscode: 200

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

Fijnafstelling - Lijst

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

Krijgt een lijst van alle fine-tuning jobs die eigendom zijn van de Azure OpenAI-resource. De details die voor elke fine-tuning job worden teruggegeven, bevatten naast de identificatie het basismodel, trainings- en validatiebestanden, hyperparameters, tijdstempels, status en gebeurtenissen.

Gebeurtenissen worden aangemaakt wanneer de functiestatus verandert. Bijvoorbeeld, lopend of voltooid, en wanneer resultaten worden geüpload.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Fin-tuning - Create

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

Maakt een taak aan die een gespecificeerd model fine-tunt vanuit een bepaald trainingsbestand.

De reactie bevat details van de genoteerde taak, inclusief taakstatus en hyperparameters.

De naam van het fijn afgestemde model wordt aan de respons toegevoegd zodra deze voltooid is.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 201

Beschrijving: De fijne afstemming is succesvol gecreëerd.

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

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

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

Fijn afstellen - Haal

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

Krijgt details voor een enkele fijntuningtaak die door de gegeven fine-tune-id wordt gespecificeerd.

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

Gebeurtenissen worden aangemaakt wanneer de taakstatus verandert, bijvoorbeeld lopend of voltooid, en wanneer resultaten worden geüpload.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Fijnafstellen - Verwijderen

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

Verwijdert de fine-tuning job die door de gegeven fine-tune-id is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 204

Beschrijving: De fijnafstelling is succesvol 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

Reacties: Statuscode: 204

{
  "headers": {}
}

Fin-tuning - Annuleren

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

Annuleert de verwerking van de fijn-afstemmingstaak die door de gegeven fine-tune-id is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De fine tune is met succes 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

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

Fijn afstellen - Haal checkpoints

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

Krijgt de checkpoints voor de fine-tuning job gespecificeerd door de gegeven fine-tune-id.

Aan het einde van succesvolle epochs worden controleposten gecreëerd tijdens de training.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Fijn afstellen - Evenementen ophalen

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

Krijgt de gebeurtenissen voor de fine-tuning job die door de gegeven fine-tune-id is gespecificeerd.

Gebeurtenissen worden aangemaakt wanneer de taakstatus verandert, bijvoorbeeld lopend of voltooid, en wanneer resultaten worden geüpload.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Fijnafstelling - Pauze

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

Het pauzeren van de verwerking van de fijnafstellingstaak die door de gegeven fine-tune-id is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De fijne afstemming is succesvol gepauzeerd.

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

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

Fijnafstelling - CV

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

Hervat de verwerking van de fijnafstellingstaak die door de gegeven fine-tune-id is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Beschrijving: De fijne afstelling is succesvol 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

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

Inneembanen - Lijst

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

Vermeldt de innamebanen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Innamebanen - Create

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

Maakt een ingestiejob aan met de opgegeven job-ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

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

Innamebanen - Word

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

Krijgt de details van het opgegeven functie-ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Ingestionjobruns - Lijst

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

Geeft een lijst van de runs van het opgegeven job-id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Inneemwerkruns - Krijg

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

Krijgt de details van de opgegeven run id als onderdeel van de opgegeven job-id.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 krijg je een lijst van alle modellen die toegankelijk zijn via de Azure OpenAI-bron.

Deze omvatten basismodellen evenals alle succesvol voltooide fine-tuned modellen die eigendom zijn van de Azure OpenAI-resource.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 - Krijg

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

Krijgt details voor het model dat door de gegeven modelId is gespecificeerd.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

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

Uploadbestand - Start

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

Er wordt een tussentijds Upload-object aangemaakt, waarmee je Parts kunt toevoegen. Momenteel kan een uploadgrootte maximaal 9 GB zijn en verloopt deze twee uur na het aanmaken.

Nadat de Upload is voltooid, wordt een Bestandsobject gegenereerd dat alle geüploade onderdelen bevat. Dit Bestandsobject kan vervolgens op ons platform worden gebruikt, net als elk ander bestand.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Statuscode: 200

Beschrijving: De upload is succesvol aangemaakt.

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

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

Annuleert de upload, en zal ertoe leiden dat alle geüploade delen asynchroon worden verwijderd.

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

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

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

Uploadbestand - Voltooid

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

Dit voltooit de Upload, en het teruggegeven Upload-object bevat een genest Bestandsobject dat klaar is voor gebruik op het platform.

Je kunt de volgorde van de onderdelen definiëren door een geordende lijst van onderdeel-ID's te geven.

Het totale aantal bytes dat wordt geüpload moet overeenkomen met de oorspronkelijk gespecificeerde grootte bij het maken van het Upload-object.

Na deze bewerking kunnen er geen extra onderdelen worden toegevoegd zodra de upload is voltooid.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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=="
 ]
}

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

Uploadbestand - Onderdeel

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

Voegt een Part toe aan een Upload-object, waarbij elke Part een segment van het bestand dat je uploadt vertegenwoordigt.

Elke Part kan tot de standaardlimiet voor bestandsupload zijn, afhankelijk van het Bestandsdoel. Je kunt Parts blijven toevoegen totdat je de uploadlimiet van 9 GB bereikt.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is 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

Reacties: 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 hulpbron.

Discriminator voor BaseConnection

Deze component gebruikt de eigenschap kind om verschillende typen te onderscheiden:

Batch

Definieert de waarden van een batch.

BatchCreateRequest

Definieert het verzoek om een batch aan te maken.

BatchErrorData

Foutinformatie voor een storing in batch.

BatchErrors

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

BatchRequestCounts

Het verzoek telt voor verschillende statussen binnen de batch.

BatchOutputReference

De Azure Storage-map om output op te slaan.

BatchStatus

De status van een batch.

BatchesList

Geeft een lijst van batches voor.

Capabilities

De mogelijkheden van een basis- of fijnafstellingsmodel.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

De voltooiingsactie.

ComputeType

Het rekentype.

ConnectionStringConnection

Verbindingsstringverbinding.

ConnectionType

Het type verbinding.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

Een CompletionsRunDataSource-object dat een modelbemonsteringsconfiguratie beschrijft.

CreateEvalCustomDataSourceConfig

Een CustomDataSourceConfig-object dat het schema definieert voor de databron die voor de evaluatie wordt gebruikt, wordt uitgevoerd. Dit schema wordt gebruikt om de vorm van de data te definiëren die zal zijn: - Gebruikt om je testcriteria te definiëren en - Welke data nodig is bij het maken van een run

CreateEvalItem

Een chatbericht dat de prompt of context vormt. Kan variabelenreferenties bevatten naar de naamruimte "item", bijvoorbeeld {{item.name}}.

CreateEvalJsonlRunDataSource

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

CreateEvalLabelModelGrader

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

CreateEvalLogsDataSourceConfig

Een databronconfiguratie die de metadata-eigenschap van je opgeslagen completions-query specificeert. Dit is meestal metadata zoals usecase=chatbot of prompt-version=v2, enzovoort.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

Een StoredCompletionsRunDataSource-configuratie die een set filters beschrijft

CustomCompute

Custom compute.

DeploymentConnection

Relatieve deployment-verbinding.

Deprecation

Definieert de datums van uitval voor de verschillende gebruikssituaties van een model.

Meestal ondersteunen basismodellen 1 jaar fijnafstelling na de creatie. Inferentie wordt doorgaans 2 jaar na het maken van basis- of fijn afgestelde modellen ondersteund. De exacte data worden in de eigendommen vermeld.

DpoHyperparamsRequest

Hyperparameters voor de DPO-methode van fijnafstemming

DpoMethod

Verzoek om DPO-methode fijn afstemming

DpoMethodConfigRequest

Configuratie voor dpo fijnafstemmingsmethode. Bevat DPO-specifieke hyperparameters

DpoMethodRequest

Verzoek om DPO-methode fijn afstemming

EndpointKeyConnection

Eindpuntsleutelverbinding.

EndpointMIConnection

Endpoint Managed Identity-verbinding.

Error

Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen.

ErrorCode

Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen.

ErrorResponse

Foutrespons zoals gedefinieerd in de Microsoft REST-richtlijnen.

Eval

Een evaluatieobject met een databronconfiguratie en testcriteria. Een evaluatie vertegenwoordigt een taak die je moet uitvoeren voor je LLM-integratie. Like:

• Verbeter de kwaliteit van mijn chatbot
• Kijk hoe goed mijn chatbot klantenservice aanpakt
• Controleer of O3-mini beter is voor mijn gebruik dan GPT-4o

EvalApiError

Een object dat een foutrespons van de Eval API vertegenwoordigt.

EvalCustomDataSourceConfig

Een CustomDataSourceConfig die het schema van je item en eventueel sample namespaces specificeert. Het responsschema definieert de vorm van de data die zal zijn: - Gebruikt om je testcriteria te definiëren en - Welke data nodig is bij het maken van een run

EvalFileRunDataSource

Een FileRunDataSource-configuratie met een bestands-id

EvalItem

Een bericht dat wordt ingevoerd in het model met een rol die de instructie aangeeft die de hiërarchie volgt. Instructies die met de developer of system rol worden gegeven, hebben voorrang boven instructies die bij de user rol worden gegeven. Berichten met de assistant rol worden verondersteld door het model in eerdere interacties te zijn gegenereerd.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

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

EvalList

Een object dat een lijst van evaluaties vertegenwoordigt.