Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Hinweis
Dieses Dokument bezieht sich auf das Microsoft Foundry(klassische) Portal.
🔍 Zeigen Sie die Microsoft Foundry-Dokumentation (neu) an, um mehr über das neue Portal zu erfahren.
Dieser Artikel enthält Details zu den REST API-Rückschlussendpunkten für Azure OpenAI.
API-Spezifikationen
Die Verwaltung von Azure OpenAI-Modellen und -Ressourcen und die Interaktion mit ihnen ist auf drei primäre API-Oberflächen aufgeteilt:
- Steuerebene
- Datenebene: Erstellung
- Datenebene: Rückschluss
Jede API-Oberfläche/-Spezifikation kapselt eine andere Gruppe von Azure OpenAI-Funktionen. Jede API verfügt über individuelle Vorschau-API-Releases und stabile/allgemein verfügbare API-Releases. Vorschaureleases folgen derzeit in der Regel einem monatlichen Rhythmus.
Von Bedeutung
Es gibt jetzt eine neue Vorschau-Ableitungs-API. Erfahren Sie mehr in unserem API-Lebenszyklushandbuch.
| Programmierschnittstelle (API) | Neuestes Vorschaurelease | Neuestes allgemein verfügbares Release | Spezifikationen | BESCHREIBUNG |
|---|---|---|---|---|
| Steuerungsebene | 2025-07-01-preview |
2025-06-01 |
Spezifikationsdateien | Die Steuerungsebenen-API wird für Vorgänge wie das Erstellen von Ressourcen, modellbasierte Bereitstellung und andere Ressourcenverwaltungsaufgaben auf höherer Ebene verwendet. Die Steuerungsebene steuert auch, was mit Komponenten wie Azure Resource Manager, Bicep, Terraform und der Azure CLI möglich ist. |
| Datenebene | v1 preview |
v1 |
Spezifikationsdateien | Die Datenebenen-API steuert Ableitungs- und Erstellungsvorgänge. |
Authentifizierung
Azure OpenAI bietet zwei Authentifizierungsmethoden. Sie können entweder API-Schlüssel oder Microsoft Entra-ID verwenden.
API-Schlüssel-Authentifizierung: Bei dieser Art der Authentifizierung müssen alle API-Anforderungen den API-Schlüssel in den
api-key-HTTP-Header einbeziehen. Die Schnellstartanleitung bietet eine Anleitung, wie Sie mit dieser Art der Authentifizierung Aufrufe tätigen können.Microsoft Entra ID-Authentifizierung: Sie können einen API-Aufruf mit einem Microsoft Entra-Token authentifizieren. Authentifizierungstoken werden als
Authorization-Header in eine Anforderung eingefügt. Dem bereitgestellten Token mussBearervorangestellt werden. Beispiel:Bearer YOUR_AUTH_TOKEN. Sie können unsere Anleitung zur Authentifizierung mit Microsoft Entra ID lesen.
REST-API-Versionsverwaltung
Die Dienst-APIs erhalten mithilfe des Abfrageparameters api-version ihre Versionsangaben. Alle Versionen folgen der Datumsstruktur JJJJ-MM-TT. Beispiel:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Datenebene: Erstellung
Im restlichen Artikel wird die Vorschauversion der Azure OpenAI-Datenebenen-Ableitungsspezifikation behandelt. 2025-04-01-preview
Eine Dokumentation für das neueste allgemein verfügbare API-Release der Datenebenen-API für Rückschlüsse finden Sie hier.
Batch: Liste
GET {endpoint}/openai/batches?api-version=2025-04-01-preview
Ruft eine Liste aller Batches ab, die zur Azure OpenAI-Ressource gehören.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| after | Anfrage | Nein | Schnur | Bezeichner für das letzte Ereignis aus der vorherigen Anforderung zur Paginierung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Batches. Der Standardwert ist 20. |
| $filter | Anfrage | Nein | Schnur | Der OData-Ausdruck zur Beschreibung der Filterbedingungen. |
| $orderby | Anfrage | Nein | Schnur | Der OData-Ausdruck zur Beschreibung der Sortierreihenfolge. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | BatchesList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/batches?api-version=2025-04-01-preview
Antworten: 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: Erstellen
POST {endpoint}/openai/batches?api-version=2025-04-01-preview
Erstellt einen Batch aus einer hochgeladenen Datei mit Anforderungen und führt diesen aus.
Die Antwort enthält Details des Auftrags in der Warteschlange einschließlich des Auftragsstatus.
Die ID der Ergebnisdatei wird der Antwort am Schluss hinzugefügt.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Abschlussfenster | Schnur | Der Zeitrahmen, in dem der Batch verarbeitet werden soll. | Ja | |
| Endpunkt | Schnur | Der vom Batch verwendete API-Endpunkt. | Ja | |
| input_blob (Eingabe-Blob) | Schnur | Die URL eines Azure Storage-BLOB, das als Eingabe für den Batch verwendet werden soll. | Nein | |
| input_file_id | Schnur | Die ID der Eingabedatei für den Batch. | Nein | |
| Metadaten | Objekt | Ein Satz aus Schlüssel-Wert-Paaren, die an den Batch angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Batch in einem strukturierten Format zu speichern. | Nein | |
| output_expires_after | FileExpiresAfter | Definiert ein Ablaufdatum für die Datei. | Nein | |
| output_folder | BatchOutputReference | Der Azure Storage-Ordner zum Speichern der Ausgabe. | Nein |
Antworten
Statuscode: 201
Beschreibung: Der Batch wurde erfolgreich erstellt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Batch |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/batches?api-version=2025-04-01-preview
Antworten: 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: Abrufen
GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview
Ruft Details für einen einzelnen Batch ab, der durch die angegebene Batch-ID angegeben wird.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| batch-id | Pfad | Ja | Schnur | Der Bezeichner des Batches. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Batch |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview
Antworten: 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 – Abbrechen
POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview
Bricht die Verarbeitung des durch die angegebene Batch-ID angegebenen Batches ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| batch-id | Pfad | Ja | Schnur | Der Bezeichner des Batches. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Der Batch wurde erfolgreich abgebrochen.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Batch |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview
Antworten: 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"
}
}
}
Gespeicherte Vervollständigung: Auflisten
GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview
Ruft die Liste der gespeicherten Vervollständigungen ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| Metadaten | Anfrage | Nein | Schnur | Filtern Sie nach dem Paar (Schlüssel, Wert) in der gespeicherten Vervollständigung. |
| Modell | Anfrage | Nein | Schnur | Filtern Sie nach Modellname. |
| after | Anfrage | Nein | Schnur | Bezeichner für die letzte gespeicherte Vervollständigung aus der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Die Anzahl der gespeicherten Vervollständigungen, die abgerufen werden sollen. Der Standardwert ist 20. |
| order | Anfrage | Nein | Schnur | Reihenfolge der Ergebnisse nach Erstellungszeit (aufsteigend oder absteigend). Standardmäßig wird „Desc“ verwendet. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | GespeicherteAbschlussliste |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview
Antworten: 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
}
}
Gespeicherte Vervollständigung: Abrufen
GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Ruft die gespeicherte Vervollständigung durch die angegebene gespeicherte Vervollständigungs-ID ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| stored-completion-id | Pfad | Ja | Schnur | Der Bezeichner der gespeicherten Vervollständigung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | StoredCompletionResponse |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Antworten: 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"
}
]
}
}
Gespeicherter Abschluss – Aktualisieren
POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Aktualisieren Sie die gespeicherte Vervollständigung durch die angegebene gespeicherte Vervollständigungs-ID.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| stored-completion-id | Pfad | Ja | Schnur | Der Bezeichner der gespeicherten Vervollständigung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Metadaten | Objekt | Beliebige Schlüssel-Wert-Paare für zusätzliche Informationen. | Nein |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | StoredCompletion |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Antworten: 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"
}
]
}
}
Gespeicherte Vervollständigung: Löschen
DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Löschen Sie die gespeicherte Vervollständigung durch die angegebene gespeicherte Vervollständigungs-ID.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| stored-completion-id | Pfad | Ja | Schnur | Der Bezeichner der gespeicherten Vervollständigung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die gespeicherte Vervollständigung wurde erfolgreich gelöscht.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | GespeicherteVervollständigungLöschen |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": {
"object": "chat.completion.deleted",
"id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"deleted": true
}
}
Gespeicherte Vervollständigung: Nachrichten abrufen
GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview
Ruft die gespeicherten Vervollständigungsnachrichten durch die angegebene gespeicherte Vervollständigungs-ID ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| stored-completion-id | Pfad | Ja | Schnur | Der Bezeichner der gespeicherten Vervollständigung. |
| after | Anfrage | Nein | Schnur | Bezeichner für die letzte gespeicherte Vervollständigungsnachricht aus der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Die Anzahl der gespeicherten Vervollständigungsnachrichten, die abgerufen werden sollen. Der Standardwert ist 20. |
| order | Anfrage | Nein | Schnur | Reihenfolge der Ergebnisse nach Nachrichtenindex (aufsteigend oder absteigend). Standardmäßig wird asc verwendet. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | GespeicherteAbschlussnachrichten |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": {
"object": "list",
"data": [
{
"role": "user",
"content": "Hello"
}
],
"total": 1,
"first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
"has_more": false
}
}
Auswertung – Liste abrufen
GET {endpoint}/openai/evals?api-version=2025-04-01-preview
Listet Auswertungen für ein Projekt auf.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| after | Anfrage | Nein | Schnur | Bezeichner für die letzte Auswertung der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Auswertungen |
| order | Anfrage | Nein | Schnur Mögliche Werte: asc, desc |
Sortierreihenfolge von Bewertungen nach Zeitstempel. Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. |
| order_by | Anfrage | Nein | Schnur Mögliche Werte: created_at, updated_at |
Evals können nach Erstellungszeit oder zuletzt aktualisierter Zeit sortiert werden. Verwenden Sie created_at für die Erstellungszeit oder updated_at für die Zeit der letzten Aktualisierung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Eine Liste von Bewertungen
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalList |
Beispiele
GET {endpoint}/openai/evals?api-version=2025-04-01-preview
Antworten: 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
}
}
Auswertung – Erstellen
POST {endpoint}/openai/evals?api-version=2025-04-01-preview
Erstellen Sie die Struktur einer Auswertung, die zum Testen der Leistung eines Modells verwendet werden kann. Eine Auswertung ist eine Reihe von Testkriterien und eine Datenquelle. Nachdem Sie eine Auswertung erstellt haben, können Sie sie auf verschiedenen Modellen und Modellparametern ausführen. Wir unterstützen verschiedene Arten von Benotern und Datenquellen.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 201
Beschreibung: OK
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Eval |
Beispiele
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"
}
]
}
Antworten: 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": {}
}
}
Auswertung - Löschen
DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Löschen Sie eine Auswertung.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | Die ID der zu löschenden Auswertung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Auswertung wurde erfolgreich gelöscht.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Objekt |
Statuscode: 404
Beschreibung: Die Auswertung wurde nicht gefunden.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Fehler |
Beispiele
DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Antworten: 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."
}
}
Auswertung: Abrufen
GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Abrufen einer Auswertung nach ID
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | Die ID der abzurufenden Auswertung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Auswertung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Eval |
Beispiele
GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Antworten: 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": {}
}
}
Auswertung – Aktualisieren
POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
Bestimmte Eigenschaften einer Auswertung aktualisieren.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | Die ID der zu aktualisierenden Auswertung. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die aktualisierte Auswertung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Eval |
Beispiele
POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview
{
"name": "Updated Math Quiz",
"metadata": {
"description": "Updated description"
}
}
Antworten: 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"
}
}
}
Auswertung: Ausführungsliste abrufen
GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Erhalte eine Liste von Läufen für eine Auswertung.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | ID der Auswertung, zu der Ausführungen abgerufen werden sollen |
| after | Anfrage | Nein | Schnur | Kennung für den letzten Ausführungslauf aus der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Ausführungen |
| order | Anfrage | Nein | Schnur Mögliche Werte: asc, desc |
Sortierreihenfolge der Ausführungen nach Zeitstempel Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. Wird standardmäßig auf asc festgelegt. |
| status | Anfrage | Nein | Schnur Mögliche Werte: queued, , in_progresscompleted, , canceledfailed |
Filtern der Ausführungen nach Status Mögliche Werte: „queued“, „in_progress“, „failed“, „completed“, „canceled“ |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Eine Liste der Läufe für die Auswertung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRunList |
Beispiele
GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Antworten: 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
}
}
Auswertung: Ausführung erstellen
POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview
Erstellt eine neue Auswertungsausführung Dies ist der Endpunkt, der die Benotung startet.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | ID der Auswertung, für die eine Ausführung erstellt werden soll. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 201
Beschreibung: Erfolgreiche Erstellung einer Ausführung für die Auswertung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRun |
Statuscode: 400
Beschreibung: Ungültige Anforderung (z. B. fehlendes eval-Objekt)
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Fehler |
Beispiele
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
}
}
}
Antworten: 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": {}
}
}
Auswertung – Lauf löschen
DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Löschen Sie einen Evaluierungslauf.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | Die ID der Auswertung, aus der der Lauf gelöscht werden soll. |
| run-id | Pfad | Ja | Schnur | ID der zu löschenden Ausführung |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die eval-Ausführung wurde erfolgreich gelöscht.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Objekt |
Statuscode: 404
Beschreibung: Lauf nicht gefunden
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Fehler |
Beispiele
DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Antworten: 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."
}
}
Auswertung: Ausführung abrufen
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Ruft eine Auswertungsausführung nach ID ab
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | ID der Auswertung, zu der Ausführungen abgerufen werden sollen |
| run-id | Pfad | Ja | Schnur | ID der abzurufenden Ausführung |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Auswertungsausführung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRun |
Beispiele
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Antworten: 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": {}
}
}
Auswertung – Abbrechen der Ausführung
POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Abbrechen einer laufenden Auswertungsausführung
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | Die ID der Auswertung, deren Ausführung Sie abbrechen möchten. |
| run-id | Pfad | Ja | Schnur | ID der Ausführung, die abgebrochen werden soll |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Das abgebrochene eval run-Objekt
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRun |
Beispiele
POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview
Antworten: 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": {}
}
}
Auswertung: Ausgabeelemente der Ausführung abrufen
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview
Ruft eine Liste der Ausgabeelemente für eine Auswertungsausführung ab
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | ID der Auswertung, zu der Ausführungen abgerufen werden sollen |
| run-id | Pfad | Ja | Schnur | ID der Ausführung, für die Ausgabeelemente abgerufen werden sollen |
| after | Anfrage | Nein | Schnur | Bezeichner für das letzte Ausgabeelement aus der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Ausgabeelemente. |
| status | Anfrage | Nein | Schnur Mögliche Werte: fail, pass |
Filtert Ausgabeelemente nach Status. Verwenden Sie failed, um nach fehlgeschlagenen Ausgabeelementen zu filtern, oder pass, um nach übergebenen Ausgabeelementen zu filtern. |
| order | Anfrage | Nein | Schnur Mögliche Werte: asc, desc |
Sortierreihenfolge für Ausgabeelemente nach Zeitstempel. Verwenden Sie asc für aufsteigende Reihenfolge oder desc für absteigende Reihenfolge. Wird standardmäßig auf asc festgelegt. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Eine Liste der Ausgabeelemente für die Auswertungsausführung
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRunOutputItemList |
Beispiele
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview
Antworten: 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
}
}
Auswertung: Ausgabeelement der Ausführung abrufen
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview
Ruft ein Ausgabeelement einer Auswertungsausführung anhand der ID ab
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| eval-id | Pfad | Ja | Schnur | ID der Auswertung, zu der Ausführungen abgerufen werden sollen |
| run-id | Pfad | Ja | Schnur | ID der abzurufenden Ausführung |
| output-item-id | Pfad | Ja | Schnur | Die ID des abzurufenden Ausgabeelements. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Ausgabeelement des Auswertungslaufs
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | EvalRunOutputItem |
Beispiele
GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview
Antworten: 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
}
}
}
Dateien – Liste
GET {endpoint}/openai/files?api-version=2025-04-01-preview
Ruft eine Liste aller Dateien ab, die zur Azure OpenAI-Ressource gehören.
Dazu gehören hochgeladene Inhalte wie Dateien mit Zweck "Feinabstimmung" zur Schulung oder Validierung von Feintunesmodellen sowie Dateien, die vom Dienst generiert werden, z. B. "Feinabstimmungsergebnisse", die verschiedene Metriken für den entsprechenden Feinabstimmungsauftrag enthalten.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| purpose | Anfrage | Nein | Schnur Mögliche Werte: fine-tune, , fine-tune-results, assistantsassistants_output, batch, , batch_output, evalsevals_output |
Geben Sie nur Dateien mit dem angegebenen Zweck zurück. |
| limit | Anfrage | Nein | integer | Ein Grenzwert für die Anzahl von Objekten, die zurückgegeben werden sollen. Der Grenzwert kann zwischen 1 und 10.000 liegen. Der Standardwert ist 10.000. |
after |
Anfrage | Nein | Schnur | Ein Cursor für die Verwendung bei der Paginierung.
after ist eine Objekt-ID, die die Position in der Liste definiert. Wenn Sie z. B. eine Listenanforderung senden und 100 Objekte empfangen, die mit „obj_foo“ enden, kann der nachfolgende Aufruf „after=obj_foo“ enthalten, um die nächste Seite der Liste abzurufen. |
| order | Anfrage | Nein | Schnur | Sortierreihenfolge nach dem Zeitstempel „created_at“ der Objekte.
asc für aufsteigende Reihenfolge und desc absteigende Reihenfolge. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FileList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/files?api-version=2025-04-01-preview
Antworten: 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"
}
}
Dateien – Hochladen
POST {endpoint}/openai/files?api-version=2025-04-01-preview
Erstellt eine neue Dateientität, indem Daten von einem lokalen Computer hochgeladen werden. Hochgeladene Dateien können z. B. für Trainings oder die Auswertung fein abgestimmter Modelle verwendet werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| anchor | Schnur | Definiert den Anker relativ zu dem Zeitpunkt, zu dem die absolute Ablaufzeit generiert werden soll. | Nein | |
| Sekunden | integer | Ruft die relative Ablaufzeit in Sekunden ab. | ||
| Bereich: [1209600 - 2592000]. | Nein | |||
| file | Schnur | Ruft die Datei ab, die in Azure OpenAI hochgeladen werden soll, oder legt diese fest. | Ja | |
| purpose | Schnur | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
Antworten
Statuscode: 201
Beschreibung: Die Datei wurde erfolgreich erstellt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | File |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/files?api-version=2025-04-01-preview
Antworten: 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"
}
}
Dateien – Importieren
POST {endpoint}/openai/files/import?api-version=2025-04-01-preview
Erstellt eine neue Dateientität, indem Daten aus einer bereitgestellten URL importiert werden. Hochgeladene Dateien können z. B. für Trainings oder die Auswertung fein abgestimmter Modelle verwendet werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| content_url | Schnur | Die URL, aus der das Dokument heruntergeladen werden soll (die SAS-URL eines Blobs oder eine andere externe URL, auf die mit einer GET-Anforderung zugegriffen werden kann). | Ja | |
| expires_after | FileExpiresAfter | Definiert ein Ablaufdatum für die Datei. | Nein | |
| Dateiname | Schnur | Der Name der JSON Lines-Datei, die hochgeladen werden soll. | ||
Wenn die purpose Einstellung auf „fine-tune“ festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern „prompt“ und „completion“, die Ihre Trainingsbeispiele darstellen. |
Ja | |||
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
Antworten
Statuscode: 201
Beschreibung: Die Datei wurde erfolgreich erstellt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | File |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/files/import?api-version=2025-04-01-preview
Antworten: 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"
}
}
Dateien: Abrufen
GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Ruft Details für eine einzelne Datei ab, die durch die angegebene Datei-ID angegeben wird, einschließlich Status, Größe, Zweck usw.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| Datei-ID | Pfad | Ja | Schnur | Der Bezeichner der Datei. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | File |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": {
"status": "processed",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
}
Dateien – Löschen
DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Löscht die Datei mit der angegebenen Datei-ID.
Das Löschen ist auch zulässig, wenn eine Datei verwendet wurde, z. B. als Trainingsdatei in einem Optimierungsauftrag.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| Datei-ID | Pfad | Ja | Schnur | Der Bezeichner der Datei. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Datei wurde erfolgreich gelöscht.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FileDelete |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": {
"object": "file",
"deleted": true,
"id": "file-181a1cbdcdcf4677ada87f63a0928099"
}
}
Dateien – Abrufen von Inhalten
GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview
Ruft den Inhalt der Datei ab, die durch die angegebene Datei-ID angegeben wird.
Dateien können von den Benutzenden hochgeladene oder vom Dienst generierte Inhalte sein, z. B. die Ergebnismetriken eines Optimierungsauftrags.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| Datei-ID | Pfad | Ja | Schnur | Der Bezeichner der Datei. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/octet-stream | Schnur | |
| Anwendung/json | Schnur |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| application/octet-stream | ErrorResponse | |
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": "raw file content"
}
Optimierung: Auflisten
GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Ruft eine Liste aller Feinabstimmungsaufträge ab, die der Azure OpenAI-Ressource gehören. Die Details, die für jeden Feinabstimmungsauftrag zurückgegeben werden, enthalten neben dem Bezeichner das Basismodell, Schulungs- und Validierungsdateien, Hyperparameter, Zeitstempel, Status und Ereignisse.
Ereignisse werden erstellt, wenn sich der Auftragsstatus ändert. Beispielsweise bei der Ausführung oder nach dem Abschluss, und wenn Ergebnisse hochgeladen werden
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| after | Anfrage | Nein | Schnur | Bezeichner für das letzte Ereignis aus der vorherigen Anforderung zur Paginierung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Ereignisse. Der Standardwert ist 20. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJobList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Erstellen
POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Erstellt einen Auftrag, der für ein bestimmtes Modell einer bestimmten Trainingsdatei eine Feinabstimmung ausführt.
Die Antwort enthält Details des Auftrags in der Warteschlange, einschließlich Auftragsstatus und Hyperparametern.
Der Name des fein abgestimmten Modells wird der Antwort zum Schluss hinzugefügt.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Hyperparameter | FineTuningHyperParameters | Die Einstellungen für Hyperparameter, die in einem Feinabstimmungsauftrag verwendet werden. | Nein | |
| Integrationen | array | Liste der Konfigurationen für Integrationen zur Unterstützung des Optimierungsauftrags Es sind viele Integrationen geplant. Stellen Sie daher sicher, dass Sie den Integrationstyp überprüfen und entsprechend reagieren. | Nein | |
| Methode | Objekt | Methode zur überwachten Optimierung | Nein | |
| └– Typ | FineTuningMethodType | Nein | ||
| Modell | Schnur | Der Bezeichner (model-id) des Basismodells, das für diese Feinabstimmung verwendet wird. | Ja | |
| Seed | integer | Der für den Optimierungsauftrag verwendete Seed Die Übergabe der gleichen Seed- und Auftragsparameter sollte die gleichen Ergebnisse produzieren, kann sich aber in seltenen Fällen unterscheiden. Wenn kein Seed angegeben wird, wird einer für Sie generiert. | Nein | |
| suffix | Schnur | Der Suffix, der zum Identifizieren des fein abgestimmten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9, - und _) enthalten, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. | Nein | |
| Trainingsdatei | Schnur | Die Dateiidentität (file-id), die für das Training dieses fein abgestimmten Modells verwendet wird. | Ja | |
| Validierungsdatei | Schnur | Die Dateiidentität (file-id), die zum Auswerten des fein abgestimmten Modells während des Trainings verwendet wird. | Nein |
Antworten
Statuscode: 201
Beschreibung: Die Optimierung wurde erfolgreich erstellt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Abrufen
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Ruft Details zu einem einzelnen Optimierungsauftrag ab, der durch die angegebene Optimierungs-ID angegeben wird
Die Details enthalten die Basismodell-, Schulungs- und Validierungsdateien, Hyperparameter, Zeitstempel, Status und Ereignisse.
Ereignisse werden erstellt, wenn sich der Auftragsstatus ändert, z. B. laufend oder abgeschlossen, und wenn Ergebnisse hochgeladen werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Löschen
DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Löscht den durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrag
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 204
Beschreibung: Die Optimierung wurde erfolgreich gelöscht.
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview
Antworten: Statuscode: 204
{
"headers": {}
}
Optimierung: Abbrechen
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview
Bricht die Verarbeitung des durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrags ab
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Optimierung wurde erfolgreich abgebrochen.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Prüfpunkte abrufen
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview
Ruft die Prüfpunkte für den durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrag ab.
Prüfpunkte werden am Ende erfolgreicher Epochen während des Trainings erstellt.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| after | Anfrage | Nein | Schnur | Bezeichner für die letzte Prüfpunkt-ID aus der vorherigen Paginierungsanforderung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Prüfpunkte. Der Standardwert ist 10. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FeineinstellungJobCheckpointListe |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Ereignisse abrufen
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview
Ruft die Ereignisse für den durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrag ab
Ereignisse werden erstellt, wenn sich der Auftragsstatus ändert, z. B. laufend oder abgeschlossen, und wenn Ergebnisse hochgeladen werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| after | Anfrage | Nein | Schnur | Bezeichner für das letzte Ereignis aus der vorherigen Anforderung zur Paginierung. |
| limit | Anfrage | Nein | integer | Anzahl der abzurufenden Ereignisse. Der Standardwert ist 20. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJobEventList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Anhalten
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview
Hält die Verarbeitung des durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrags an
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Optimierung wurde erfolgreich angehalten.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview
Antworten: 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"
}
}
Optimierung: Fortsetzen
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview
Setzt die Verarbeitung des durch die angegebene Optimierungs-ID angegebenen Optimierungsauftrags fort
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| fine-tuning-job-id | Pfad | Ja | Schnur | Bezeichner des Optimierungsauftrags |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Die Optimierung wurde erfolgreich fortgesetzt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | FineTuningJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview
Antworten: 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"
}
}
Erfassungsaufträge: Auflisten
GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview
Listet die Erfassungsaufträge auf.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
| mgmt-user-token | Header | Nein | Schnur | Das Token, das für den Zugriff auf den Arbeitsbereich verwendet wird (nur für Computeaufträge des Benutzers erforderlich). |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | IngestionJobList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview
Antworten: 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"
}
]
}
}
Erfassungsaufträge: Erstellen
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Erstellt einen Erfassungsauftrag mit der angegebenen Auftrags-ID.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
| job-id | Pfad | Ja | Schnur | Die ID des Auftrags, der erstellt wird. |
| mgmt-user-token | Header | Nein | Schnur | Das Token, das für den Zugriff auf den Arbeitsbereich verwendet wird (nur für Computeaufträge des Benutzers erforderlich). |
| aml-user-token | Header | Nein | Schnur | Das Token, das für den Zugriff auf die Ressourcen innerhalb des Auftrags im Arbeitsbereich verwendet wird (nur für Computeaufträge des Benutzers erforderlich). |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| jobId | Schnur | Nein | ||
| freundlich | IngestionJobType | Der Auftragstyp. | Ja |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | IngestionJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Antworten: 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
Antworten: 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"
}
}
}
Erfassungsaufträge: Abrufen
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Ruft die Details der angegebenen Auftrags-ID ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
| job-id | Pfad | Ja | Schnur | Die ID des Auftrags. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | IngestionJob |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview
Antworten: 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"
}
}
}
Erfassungsauftragsausführungen: Auflisten
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview
Listet die Ausführungen der angegebenen Auftrags-ID auf.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
| job-id | Pfad | Ja | Schnur | Die ID des Auftrags. |
| mgmt-user-token | Header | Nein | Schnur | Das Token, das für den Zugriff auf den Arbeitsbereich verwendet wird (nur für Computeaufträge des Benutzers erforderlich). |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | IngestionJobRunList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview
Antworten: 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"
}
]
}
}
Erfassungsauftragsausführungen: Ab
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview
Ruft die Details der angegebenen Ausführungs-ID als Teil der angegebenen Auftrags-ID ab.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
| job-id | Pfad | Ja | Schnur | Die ID des Auftrags. |
| run-id | Pfad | Ja | Schnur | Die ID der Ausführung. |
| mgmt-user-token | Header | Nein | Schnur | Das Token, das für den Zugriff auf den Arbeitsbereich verwendet wird (nur für Computeaufträge des Benutzers erforderlich). |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | IngestionJobRun |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview
Antworten: 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"
}
]
}
}
}
Modelle - Liste
GET {endpoint}/openai/models?api-version=2025-04-01-preview
Ruft eine Liste aller Modelle ab, auf die die Azure OpenAI-Ressource zugreifen kann.
Dazu gehören Basismodelle sowie alle erfolgreich abgeschlossenen fein abgestimmten Modelle, die zur Azure OpenAI-Ressource gehören.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ModelList |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/models?api-version=2025-04-01-preview
Antworten: 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"
}
}
Modelle: Abrufen
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview
Ruft Details für das Modell ab, das durch die angegebene Modell-ID angegeben wird.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| Modell-ID | Pfad | Ja | Schnur | Der Bezeichner des Modells. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | Modell |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview
Antworten: 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
Antworten: 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"
}
}
Datei hochladen – Start
POST {endpoint}/openai/uploads?api-version=2025-04-01-preview
Es wird ein zwischengeschaltetes Upload-Objekt erstellt, mit dem Sie Teile hinzufügen können. Derzeit kann die maximale Uploadgröße 9 GB betragen und läuft zwei Stunden nach der Erstellung ab.
Nach Abschließen des Uploads wird ein File-Objekt generiert, das alle hochgeladenen Teile enthält. Dieses File-Objekt kann dann wie jede andere Datei in unserer Plattform verwendet werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Ja | ||
| Dateiname | Schnur | Ja | ||
| MIME-Typ | Schnur | Ja | ||
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
Anforderungstext
Content-Type: text/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Ja | ||
| Dateiname | Schnur | Ja | ||
| MIME-Typ | Schnur | Ja | ||
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
Anforderungstext
Content-Type: application/*+json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Ja | ||
| Dateiname | Schnur | Ja | ||
| MIME-Typ | Schnur | Ja | ||
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
Antworten
Statuscode: 200
Beschreibung: Der Upload wurde erfolgreich erstellt.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | UploadResource |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/uploads?api-version=2025-04-01-preview
{
"purpose": "fine-tune",
"filename": "training_data_v21.jsonl",
"bytes": 2097152,
"mime_type": "application/json"
}
Antworten: 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"
}
}
Datei hochladen – Abbrechen
POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview
Bricht den Upload ab und löscht alle hochgeladenen Teile asynchron.
Nach dem Abbrechen eines Uploads können keine Teile hinzugefügt werden.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| upload-id | Pfad | Ja | Schnur | Der Bezeichner des Uploads. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | UploadResource |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview
Antworten: 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"
}
}
Datei hochladen - Vollständig
POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview
Dadurch wird das Upload-Objekt abgeschlossen. Das zurückgegebene Upload-Objekt enthält ein geschachteltes File-Objekt, das in der gesamten Plattform verwendet werden kann.
Sie können die Reihenfolge der Teile definieren, indem Sie eine sortierte Liste mit Teil-IDs angeben.
Die Gesamtanzahl der hochgeladenen Bytes muss mit der ursprünglich beim Erstellen des Upload-Objekts angegebenen Größe übereinstimmen.
Nach diesem Vorgang können keine zusätzlichen Teile hinzugefügt werden, nachdem der Upload abgeschlossen wurde.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| upload-id | Pfad | Ja | Schnur | Der Bezeichner des Uploads. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Type: application/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| md5 | Schnur | Nein | ||
| Teil-IDs | array | Ja |
Anforderungstext
Content-Type: text/json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| md5 | Schnur | Nein | ||
| Teil-IDs | array | Ja |
Anforderungstext
Content-Type: application/*+json
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| md5 | Schnur | Nein | ||
| Teil-IDs | array | Ja |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | UploadResource |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview
{
"part_ids": [
"LnmictL3p0u4LH/ko343nw==",
"LmmictL3p0u4LH/ko343nw=="
]
}
Antworten: 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"
}
}
Datei hochladen – Teil
POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview
Fügt einem Upload-Objekt einen Teil hinzu, wobei jeder Teil ein Segment der Datei darstellt, die Sie hochladen.
Jeder Teil kann bis zu der für den Datei-Upload zulässigen Standardgröße reichen, je nach Verwendungszweck der Datei. Sie können so lange Teile hinzufügen, bis Sie die Größenbeschränkung von 9 GB erreicht haben.
URI-Parameter
| Name | Geben Sie in | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|---|
| Endpunkt | Pfad | Ja | Schnur url |
Unterstützte Azure OpenAI-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie „aoairesource“ durch den Namen Ihrer Azure OpenAI-Ressource). https://{Name Ihrer Ressource}.openai.azure.com |
| upload-id | Pfad | Ja | Schnur | Der Bezeichner des Uploads. |
| API-Version | Anfrage | Ja | Schnur | Die angeforderte API-Version. |
Anfrage-Kopf
Verwenden Sie entweder tokenbasierte Authentifizierung oder API-Schlüssel. Es wird empfohlen, die Authentifizierung mit tokenbasierter Methode zu verwenden, da diese sicherer ist.
| Name | Erforderlich | Typ | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Richtig | Schnur |
Beispiel:Authorization: Bearer {Azure_OpenAI_Auth_Token}So generieren Sie ein Authentifizierungstoken mit Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.comTyp: oauth2 Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeBereich: https://cognitiveservices.azure.com/.default |
| API-Schlüssel | Richtig | Schnur | Geben Sie hier den Azure OpenAI-API-Schlüssel an. |
Anforderungstext
Content-Typ: mehrteilige Formulardaten (multipart/form-data)
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | Schnur | Ja |
Antworten
Statuscode: 200
Beschreibung: Erfolg
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | UploadPartResource |
Statuscode: Standard
Beschreibung: Fehler.
| Inhaltstyp | Typ | Beschreibung |
|---|---|---|
| Anwendung/json | ErrorResponse |
Beispiele
POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview
Antworten: Statuscode: 200
{
"headers": {},
"body": {
"upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
"azure_block_id": "LnmictL3p0u4LH/ko343nw==",
"id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
"created_at": 1646126127,
"object": "upload.part"
}
}
Komponenten
Azure-AI-Suchindex
Azure AI Search Index.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connectionId | Schnur | Die ID der Verbindung, die auf den Index von Azure KI-Suche verweist. | Nein | |
| freundlich | Zieltyp | Der Zieltyp. | Ja |
BaseConnection
Eine Verbindung mit einer Ressource.
Diskriminator für BaseConnection
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja |
Batch
Definiert die Werte eines Batches.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| cancelled_at | integer | Zeitstempel, wann dieser Batch abgebrochen wurde (in Unix-Epochen). | Nein | |
| cancelling_at | integer | Zeitstempel, wann der Abbruch dieses Batches gestartet wurde (in Unix-Epochen). | Nein | |
| abgeschlossen_am | integer | Zeitstempel, wann dieser Batch abgeschlossen wurde (in Unix-Epochen). | Nein | |
| Abschlussfenster | Schnur | Der Zeitrahmen, in dem der Batch verarbeitet werden soll. | Nein | |
| erstellt_am | integer | Ein Zeitstempel, wann dieser Batch erstellt wurde (in Unix-Epochen). | Nein | |
| Endpunkt | Schnur | Der vom Batch verwendete API-Endpunkt. | Nein | |
| error_blob | Schnur | Blob-URL mit den Ausgaben von Anforderungen mit Fehlern | Nein | |
| error_file_id | Schnur | Die ID der Datei, die Ausgaben von Anforderungen mit Fehlern enthält. | Nein | |
| Irrtümer | BatchErrors | Bei fehlgeschlagenen Batches sind weitere Informationen zur Ursache der Fehler enthalten. | Nein | |
| abgelaufen_am | integer | Ein Zeitstempel, wann dieser Batch abgelaufen ist (in Unix-Epochen). | Nein | |
| läuft_ab_am | integer | Ein Zeitstempel, wann dieser Batch ablaufen wird (in Unix-Epochen). | Nein | |
| failed_at | integer | Zeitstempel, wann dieser Batch fehlgeschlagen ist (in Unix-Epochen). | Nein | |
| finalizing_at | integer | Ein Zeitstempel, wann der Abschluss dieses Batches begonnen hat (in Unix-Epochen). | Nein | |
| id | Schnur | Die Identität dieses Elements. | Ja | |
| in_progress_at | integer | Ein Zeitstempel, der den Start der Verarbeitung dieses Batches angibt (in Unix-Epochen). | Nein | |
| input_blob (Eingabe-Blob) | Schnur | Die Blob-URL, die die Eingabedatei für den Batch enthält. | Nein | |
| input_file_id | Schnur | Die ID der Eingabedatei für den Batch. | Ja | |
| Metadaten | Objekt | Ein Satz aus Schlüssel-Wert-Paaren, die an den Batch angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Batch in einem strukturierten Format zu speichern. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| output_blob | Schnur | Blob-URL mit den Ausgaben von erfolgreich ausgeführten Anforderungen | Nein | |
| Ausgabedatei-ID | Schnur | Die ID der Datei, die Ausgaben von erfolgreich ausgeführten Anforderungen enthält. | Nein | |
| Anfrageanzahl | BatchRequestCounts | Die Anforderung gilt für unterschiedliche Status innerhalb des Batches. | Nein | |
| status | BatchStatus | Der Status eines Batches. | Nein |
StapelErstellungsAnfrage
Definiert die Anforderung zum Erstellen eines Batches.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Abschlussfenster | Schnur | Der Zeitrahmen, in dem der Batch verarbeitet werden soll. | Ja | |
| Endpunkt | Schnur | Der vom Batch verwendete API-Endpunkt. | Ja | |
| input_blob (Eingabe-Blob) | Schnur | Die URL eines Azure Storage-BLOB, das als Eingabe für den Batch verwendet werden soll. | Nein | |
| input_file_id | Schnur | Die ID der Eingabedatei für den Batch. | Nein | |
| Metadaten | Objekt | Ein Satz aus Schlüssel-Wert-Paaren, die an den Batch angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Batch in einem strukturierten Format zu speichern. | Nein | |
| output_expires_after | FileExpiresAfter | Definiert ein Ablaufdatum für die Datei. | Nein | |
| output_folder | BatchOutputReference | Der Azure Storage-Ordner zum Speichern der Ausgabe. | Nein |
Batch-Fehlerdaten
Informationen zu einem Fehler im Batch.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| code | Schnur | Ein Fehlercode, der den Fehlertyp angibt. | Nein | |
| line | Schnur | Die Zeilennummer der Eingabedatei, bei der der Fehler aufgetreten ist (kann null sein). | Nein | |
| Nachricht | Schnur | Eine lesbare Nachricht, die weitere Details zum Fehler bereitstellt. | Nein | |
| param | Schnur | Der Name des Parameters, der den Fehler verursacht hat, falls zutreffend (kann null sein). | Nein |
BatchErrors
Bei fehlgeschlagenen Batches sind weitere Informationen zur Ursache der Fehler enthalten.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | BatchErrorData | Informationen zu einem Fehler im Batch. | Nein | |
| Objekt | Schnur | Der Typ des Fehlerobjekts. Dies ist immer „Liste“. | Nein |
BatchRequestCounts
Die Anforderung gilt für unterschiedliche Status innerhalb des Batches.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| completed | integer | Die Anzahl der Anforderungen im Batch, die erfolgreich abgeschlossen wurden. | Nein | |
| misslungen | integer | Die Anzahl der Anforderungen im Batch, die fehlgeschlagen sind. | Nein | |
| total | integer | Die Gesamtanzahl der Anforderungen im Batch. | Nein |
BatchOutputReference
Der Azure Storage-Ordner zum Speichern der Ausgabe.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Trennzeichen | Schnur | Wahlfrei. Das Trennzeichen, das im Ordnerpfad verwendet wird, standardmäßig "/". | Nein | |
| url | Schnur | Die URL des Azure Storage-Ordners, in dem die Batchausgabe gespeichert wurde. | Nein |
BatchStatus
Der Status eines Batches.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Status eines Batches. |
| Typ | Schnur |
| Werte | validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled |
BatchesList
Stellt eine Liste von Batches dar.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| first_id | Schnur | Die ID des ersten Batches in der Liste der zurückgegebenen Batches. | Nein | |
| has_more | boolean | Ein Wert, der angibt, ob die Liste mehr Elemente enthält als zurückgegeben. | Nein | |
| last_id | Schnur | Die ID des letzten Batches in der Liste der zurückgegebenen Batches. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
Fähigkeiten
Die Funktionen eines Basis- oder Feinabstimmungsmodells.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| chat_completion | boolean | Ein Wert, der angibt, ob ein Modell die Chatvervollständigung unterstützt. | Ja | |
| Fertigstellung | boolean | Ein Wert, der angibt, ob ein Modell Vervollständigungen unterstützt. | Ja | |
| embeddings | boolean | Ein Wert, der angibt, ob ein Modell Einbettungen unterstützt. | Ja | |
| fine_tune | boolean | Ein Wert, der angibt, ob ein Modell zur Feinabstimmung verwendet werden kann. | Ja | |
| inference | boolean | Ein Wert, der angibt, ob ein Modell bereitgestellt werden kann. | Ja |
Auswahl
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Beendigungsgrund | Schnur | Der Grund, warum das Modell das Generieren von Token beendet hat. | Nein | |
| Index | integer | Der Index der Auswahl in der Liste der Auswahlmöglichkeiten | Nein | |
| logprobs | Objekt | Logarithmierte Wahrscheinlichkeit für die Auswahl | Nein | |
| Nachricht | ChoiceMessage | Nein |
ChoiceMessage
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Inhalt | Schnur | Der Inhalt der Nachricht. | Nein | |
| Rolle (role) | Schnur | Die Rolle der Entität, die die Nachricht erstellt. | Nein | |
| tool_calls | array | Eine Liste mit den relevanten Toolaufrufen. | Nein |
Chunking-Einstellungen
Segmentierungseinstellungen
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| maximale Abschnittsgröße in Token | integer | Nein |
CompletionAction
Die Vervollständigungsaktion.
| Eigentum | Wert |
|---|---|
| Beschreibung | Die Vervollständigungsaktion. |
| Typ | Schnur |
| Werte | cleanUpTempAssetskeepAllAssets |
Berechnungstyp
Der Computetyp.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Computetyp. |
| Typ | Schnur |
| Werte | ServerlessComputeCustomCompute |
ConnectionStringConnection
Verbindung zur Verbindungszeichenfolge.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connectionString | Schnur | Verbindungszeichenfolge | Nein | |
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja |
Verbindungstyp
Der Verbindungstyp.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Verbindungstyp. |
| Typ | Schnur |
| Werte | EndpointWithKeyConnectionStringEndpointWithManagedIdentityWorkspaceConnectionRelativeConnection |
CosmosDBIndex
CosmosDB Index.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Sammlungsname | Schnur | Der Name der Cosmos DB-Sammlung. | Nein | |
| connectionId | Schnur | Die ID der Verbindung, die auf die Cosmos DB zeigt. | Nein | |
| Datenbankname | Schnur | Der Name der Cosmos DB-Datenbank. | Nein | |
| freundlich | Zieltyp | Der Zieltyp. | Ja |
Crawler-Einstellungen
Durchsuchungseinstellungen
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| maximale Crawltiefe | integer | Nein | ||
| Maximale CrawldauerInMinuten | integer | Nein | ||
| maximaleDownloadZeitInMinuten | integer | Nein | ||
| maxDateigröße | integer | Nein | ||
| maxFiles | integer | Nein | ||
| maximale Umleitungen | integer | Nein |
CreateEvalCompletionsRunDataSource
Ein CompletionsRunDataSource-Objekt, das eine Modellsamplingkonfiguration beschreibt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Eingabenachrichten | Objekt | Nein | ||
| └– item_reference | Schnur | Ein Verweis auf eine Variable im Namespace "item", z. B. "item.name". | Nein | |
| └- Vorlage | array | Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den Namespace "item" enthalten, z. B. {{item.name}}. | Nein | |
| └– Typ | enum | Der Typ der Eingabemeldungen. Entweder template oder item_reference.Mögliche Werte: template, item_reference |
Nein | |
| Modell | Schnur | Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini"). | Nein | |
| Parameter für Stichprobennahme | Objekt | Nein | ||
| └– max_completion_tokens | integer | Die maximale Anzahl von Tokens in der generierten Ausgabe. | Nein | |
| └- Samen | integer | Ein Startwert zur Initialisierung der Zufälligkeit während des Samplings. | Nein | 42 |
| └– Temperatur | number | Eine höhere Temperatur erhöht die Zufälligkeit in den Ergebnissen. | Nein | 1 |
| └– top_p | number | Eine Alternative zur Temperatur bei der Kern-Probenahme; 1.0 enthält alle Token. | Nein | 1 |
| Quelle | Objekt | Ja | ||
| └– Typ | enum | Der Quelltyp. Kann EvalJsonlFileContentSource, EvalJsonlFileIdSource oder EvalStoredCompletionsSource sein.Mögliche Werte: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nein | |
| Typ | enum | Der Typ der Ausführungsdatenquelle. Immer completions.Möglicher Wert: completions |
Ja |
ErstellenEvalBenutzerdefinierteDatenquellenKonfiguration
Ein CustomDataSourceConfig-Objekt, das das Schema für die Datenquelle definiert, die für die Bewertungsläufe verwendet wird. Dieses Schema wird verwendet, um die Form der Daten zu definieren, die verwendet werden, um Ihre Testkriterien zu definieren und die Daten, die beim Erstellen einer Ausführung erforderlich sind
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Beispielschema einfügen | boolean | Ob die Auswertung erwarten sollte, dass Sie den Beispiel-Namespace auffüllen (d. h. durch Generieren von Antworten aus der Datenquelle) | Nein | Falsch |
| Artikel-Schema | Objekt | Das JSON-Schema für jede Zeile in der Datenquelle. | Ja | |
| Typ | enum | Der Typ der Datenquelle. Immer custom.Möglicher Wert: custom |
Ja |
ErstelleBewertungsElement
Eine Chatnachricht, aus der der "Prompt" oder der Kontext besteht. Kann Variablenverweise auf den Namespace "item" enthalten, also {{item.name}}.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Inhalt | ['string'; 'InputTextContent'; 'object'] | Texteingaben für das Modell – können Vorlagenzeichenfolgen enthalten. | Ja | |
| Rolle (role) | enum | Die Rolle der Nachrichteneingabe. Einer der folgenden Werte: user, assistant, system oder developer.Mögliche Werte: user, , assistant, systemdeveloper |
Ja | |
| Typ | enum | Der Typ der Nachrichteneingabe. Immer message.Möglicher Wert: message |
Nein |
CreateEvalJsonlRunDataSource
Ein JsonlRunDataSource-Objekt, mit dem eine JSONL-Datei angegeben wird, die dem Bewertungsprozess entspricht.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Quelle | Objekt | Ja | ||
| └– Inhalt | array | Der Inhalt der JSONL-Datei. | Nein | |
| └– ID | Schnur | Der Bezeichner der Datei. | Nein | |
| └– Typ | enum | Der Typ der JSONL-Quelle. Immer file_id.Möglicher Wert: file_id |
Nein | |
| Typ | enum | Der Typ der Datenquelle. Immer jsonl.Möglicher Wert: jsonl |
Ja |
CreateEvalLabelModelGrader
Ein LabelModelGrader -Objekt, das ein Modell verwendet, um jedem Element in der Auswertung Bezeichnungen zuzuweisen.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Eingabe | array | Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann Variablenverweise auf den Namespace "item" enthalten, also {{item.name}}. | Ja | |
| Bezeichnungen | array | Die Bezeichnungen, die verwendet werden, um jedes Element in der Auswertung zu klassifizieren. | Ja | |
| Modell | Schnur | Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen | Ja | |
| name | Schnur | Name des Bewerters (Graders) | Ja | |
| passing_labels | array | Bezeichnungen für ein bestandenes Ergebnis. Muss eine Teilmenge von „labels“ (Bezeichnungen) sein | Ja | |
| Typ | enum | Der Objekttyp, der immer label_model ist.Möglicher Wert: label_model |
Ja |
ErstelleAuswertungsprotokollDatenquellenKonfiguration
Eine Datenquellenkonfiguration, die die Metadateneigenschaft Ihrer gespeicherten Abschlussabfrage angibt. Dies ist in der Regel Metadaten wie usecase=chatbot oder prompt-version=v2usw.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Metadaten | Objekt | Metadatenfilter für die Protokolldatenquelle. | Nein | |
| Typ | enum | Der Typ der Datenquelle. Immer logs.Möglicher Wert: logs |
Ja |
ErstelleBewertungsAnfrage
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Datenquellenkonfiguration | Objekt | Ein CustomDataSourceConfig-Objekt, das das Schema für die Datenquelle definiert, die für die Bewertungsläufe verwendet wird. Dieses Schema wird verwendet, um die Form der Daten zu definieren, die verwendet werden, um Ihre Testkriterien zu definieren und die Daten, die beim Erstellen einer Ausführung erforderlich sind | Ja | |
| └– include_sample_schema | boolean | Ob die Auswertung erwarten sollte, dass Sie den Beispiel-Namespace auffüllen (d. h. durch Generieren von Antworten aus der Datenquelle) | Nein | Falsch |
| └– item_schema | Objekt | Das JSON-Schema für jede Zeile in der Datenquelle. | Nein | |
| └- Metadaten | Objekt | Metadatenfilter für die Protokolldatenquelle. | Nein | |
| └– Typ | enum | Der Typ der Datenquelle. Immer logs.Möglicher Wert: logs |
Nein | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| name | Schnur | Der Name der Auswertung. | Nein | |
| Testkriterien | array | Liste der Bewerter (Grader) für alle Auswertungsausführungen in dieser Gruppe | Ja |
CreateEvalRunRequest
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Datenquelle | Objekt | Ein JsonlRunDataSource-Objekt, mit dem eine JSONL-Datei angegeben wird, die dem Bewertungsprozess entspricht. | Ja | |
| └– input_messages | Objekt | Nein | ||
| └– item_reference | Schnur | Ein Verweis auf eine Variable im Namespace "item", z. B. "item.name". | Nein | |
| └- Vorlage | array | Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den Namespace "item" enthalten, z. B. {{item.name}}. | Nein | |
| └– Typ | enum | Der Typ der Eingabemeldungen. Entweder template oder item_reference.Mögliche Werte: template, item_reference |
Nein | |
| └─ Modell | Schnur | Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini"). | Nein | |
| └– Stichprobenparameter | Objekt | Nein | ||
| └– max_completion_tokens | integer | Die maximale Anzahl von Tokens in der generierten Ausgabe. | Nein | |
| └- Samen | integer | Ein Startwert zur Initialisierung der Zufälligkeit während des Samplings. | Nein | 42 |
| └– Temperatur | number | Eine höhere Temperatur erhöht die Zufälligkeit in den Ergebnissen. | Nein | 1 |
| └– top_p | number | Eine Alternative zur Temperatur bei der Kern-Probenahme; 1.0 enthält alle Token. | Nein | 1 |
| └- Quelle | Objekt | Nein | ||
| └– Typ | enum | Der Quelltyp. Kann EvalJsonlFileContentSource, EvalJsonlFileIdSource oder EvalStoredCompletionsSource sein.Mögliche Werte: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nein | |
| └– Typ | enum | Der Typ der Ausführungsdatenquelle. Immer completions.Möglicher Wert: completions |
Nein | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| name | Schnur | Name der Ausführung | Nein |
CreateEvalStoredCompletionsRunDataSource
Eine StoredCompletionsRunDataSource-Konfiguration, die eine Gruppe von Filtern beschreibt
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| created_after | integer | Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die nach dieser Zeit erstellt wurden. | Nein | |
| erstellt_vor | integer | Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die vor dieser Zeit erstellt wurden. | Nein | |
| limit | integer | Eine optionale maximale Anzahl von Elementen, die zurückgegeben werden sollen. | Nein | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| Modell | Schnur | Ein optionales Modell, nach dem gefiltert wird (z. B. "gpt-4o"). | Nein | |
| Typ | enum | Der Typ der Datenquelle. Immer stored_completions.Möglicher Wert: stored_completions |
Ja |
CustomCompute
Benutzerdefinierter Compute.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| computeId | Schnur | ID des benutzerdefinierten Computes | Nein | |
| freundlich | ComputeType | Der Computetyp. | Ja |
DeploymentConnection
Relative Bereitstellungsverbindung.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja |
Missbilligung
Legt die Daten fest, ab denen die verschiedenen Anwendungsfälle eines Modells als veraltet gelten.
In der Regel unterstützen Basismodelle nach der Erstellung 1 Jahr eine Feinabstimmung. Rückschlüsse werden in der Regel 2 Jahre nach der Erstellung von Basis- oder Feinabstimmungsmodellen unterstützt. Die genauen Datumsangaben werden in den Eigenschaften angegeben.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| fine_tune | integer | Das Enddatum der Unterstützung der Feinabstimmung für dieses Modell. Ist für Feinabstimmungsmodelle null. |
Nein | |
| inference | integer | Das Enddatum der Unterstützung von Rückschlüssen für dieses Modell. | Ja |
DpoHyperparamsRequest
Hyperparameter für die DPO-Methode zur Optimierung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Batch-Größe | integer | Die für das Training zu verwendende Batchgröße. Die Batchgröße ist die Anzahl der Trainingsbeispiele, die zum Trainieren einer einzelnen Vorwärts- und Rückwärtsberechnung verwendet werden. Im Allgemeinen haben wir festgestellt, dass größere Batchgrößen tendenziell besser für größere Datasets funktionieren. Der Standardwert sowie der Maximalwert für diese Eigenschaft sind spezifisch für ein Basismodell. | Nein | |
| Beta | number | DPO-Betawert | Nein | |
| l2_multiplier | number | L2-Normalisierungsmultiplikator | Nein | |
| Lernratenmultiplikator | number | Der Lernratenmultiplikator, der für das Training verwendet werden soll. Die Optimierungslernrate ist die ursprüngliche Lernrate, die für das Vorabtraining verwendet wird, mit diesem Wert multipliziert. Größere Lernraten weisen für größere Batches tendenziell eine bessere Leistung auf. Es empfiehlt sich, mit Werten im Bereich 0,02 bis 0,2 zu experimentieren, um zu sehen, was die besten Ergebnisse erzeugt. | Nein | |
| n_epochs | integer | Die Anzahl der Epochen zum Trainieren des Modells. Eine Epoche bezieht sich auf einen vollständigen Zyklus durch das Trainingsdataset. | Nein |
DpoMethod
Anforderung für die DPO-Methode zur Optimierung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
dpo |
DpoMethodConfigRequest | Konfiguration für dpo-Methode zur Optimierung Enthält DPO-spezifische Hyperparameter |
Ja | |
| Typ | FineTuningMethodType | Ja |
DpoMethodConfigRequest
Konfiguration für dpo-Methode zur Optimierung Enthält DPO-spezifische Hyperparameter
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Hyperparameter | DpoHyperparamsRequest | Hyperparameter für die DPO-Methode zur Optimierung | Nein |
DpoMethodRequest
Anforderung für die DPO-Methode zur Optimierung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
dpo |
DpoMethodConfigRequest | Konfiguration für dpo-Methode zur Optimierung Enthält DPO-spezifische Hyperparameter |
Ja | |
| Typ | FineTuningMethodType | Ja |
Endpunkt-Schlüsselverbindung
Verbindung zum Endpunktschlüssel.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Endpunkt | Schnur | Endpunkt | Nein | |
| Schlüssel | Schnur | Schlüssel | Nein | |
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja |
EndpointMIConnection
Verbindung zur verwalteten Identität des Endpunkts.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Endpunkt | Schnur | Endpunkt | Nein | |
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja | |
| Ressourcen-ID | Schnur | Ressourcen-ID | Nein |
Fehler
Fehlerinhalte, wie in den Microsoft REST-Richtlinien definiert.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| code | ErrorCode | Fehlercodes, wie in den Microsoft REST-Richtlinien definiert. | Ja | |
| Details | array | Details zum Fehler, falls verfügbar. | Nein | |
innererror |
InnerError | Interner Fehler gemäß den Microsoft REST-Richtlinien. | Nein | |
| Nachricht | Schnur | Die Meldung dieses Fehlers. | Ja | |
| Ziel | Schnur | Der Ort, an dem der Fehler aufgetreten ist, falls verfügbar. | Nein |
Fehlercode
Fehlercodes, wie in den Microsoft REST-Richtlinien definiert.
| Eigentum | Wert |
|---|---|
| Beschreibung | Fehlercodes, wie in den Microsoft REST-Richtlinien definiert. |
| Typ | Schnur |
| Werte | conflictinvalidPayloadforbiddennotFoundunexpectedEntityStateitemDoesAlreadyExistserviceUnavailableinternalFailurequotaExceededjsonlValidationFailedfileImportFailedtooManyRequestsunauthorizedcontentFilter |
Fehlerantwort
Fehlerantwort gemäß der Definition in den Microsoft REST-Richtlinien.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Fehler | Fehler | Fehlerinhalte, wie in den Microsoft REST-Richtlinien definiert. | Ja |
Eval
Ein Eval-Objekt mit einer Datenquellenkonfiguration und Testkriterien. Eine Eval stellt eine Aufgabe dar, die für Ihre LLM-Integration durchgeführt werden soll. Beispiel:
- Verbessern der Qualität meines Chatbots
- Sehen Sie, wie gut mein Chatbot den Kundensupport verarbeitet
- Überprüfen Sie, ob o3-mini bei meinem Anwendungsfall besser ist als gpt-4o
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Der Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Evals. | Ja | |
| Datenquellenkonfiguration | Objekt | Eine CustomDataSourceConfig, die das Schema Ihrer item und optional sample Namespaces angibt. Das Antwortschema legt die Form der Daten fest, die verwendet werden, um Ihre Testkriterien zu definieren, sowie die Daten, die beim Erstellen eines Testlaufs erforderlich sind. |
Ja | |
| └- Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| └- Schema | Objekt | Das JSON-Schema für die Laufdatenquellenelemente. Hier erfahren Sie, wie Sie JSON-Schemas erstellen. | Nein | |
| └– Typ | enum | Der Typ der Datenquelle. Immer stored_completions.Möglicher Wert: stored_completions |
Nein | |
| id | Schnur | Eindeutiger Bezeichner für die Auswertung. | Ja | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Ja | |
| name | Schnur | Der Name der Auswertung. | Ja | |
| Objekt | enum | Der Objekttyp. Möglicher Wert: eval |
Ja | |
| Testkriterien | array | Eine Liste der Testkriterien. | Ja |
EvalApiError
Ein Objekt, das eine Fehlerantwort der Eval-API darstellt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| code | Schnur | Der Fehlercode. | Ja | |
| Nachricht | Schnur | Die Fehlermeldung. | Ja |
EvalCustomDataSourceConfig
Eine CustomDataSourceConfig, die das Schema Ihrer item und optional sample Namespaces angibt. Das Antwortschema legt die Form der Daten fest, die verwendet werden, um Ihre Testkriterien zu definieren, sowie die Daten, die beim Erstellen eines Testlaufs erforderlich sind.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| schema | Objekt | Das JSON-Schema für die Laufdatenquellenelemente. Hier erfahren Sie, wie Sie JSON-Schemas erstellen. | Ja | |
| Typ | enum | Der Typ der Datenquelle. Immer custom.Möglicher Wert: custom |
Ja |
EvalFileRunDataSource
Eine FileRunDataSource-Konfiguration mit einer Datei-ID
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Datei-ID | Schnur | Der Bezeichner der Datei. | Ja | |
| Typ | enum | Der Typ der Datenquelle. Immer file.Möglicher Wert: file |
Ja |
EvalItem
Meldungseingabe für das Modell mit einer Rolle für die Anweisung, gefolgt von der Hierarchie Anweisungen, die mit der developer Rolle angegeben werden, system haben Vorrang vor Anweisungen, die mit der user Rolle angegeben werden. Nachrichten mit der assistant Rolle werden davon ausgegangen, dass sie vom Modell in früheren Interaktionen generiert wurden.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Inhalt | Objekt | Eine Texteingabe für das Modell. | Ja | |
| └– Text | Schnur | Die Textausgabe aus dem Modell. | Nein | |
| └– Typ | enum | Der Typ des Ausgabetexts. Immer output_text.Möglicher Wert: output_text |
Nein | |
| Rolle (role) | enum | Die Rolle der Nachrichteneingabe. Einer der folgenden Werte: user, assistant, system oder developer.Mögliche Werte: user, , assistant, systemdeveloper |
Ja | |
| Typ | enum | Der Typ der Nachrichteneingabe. Immer message.Möglicher Wert: message |
Nein |
EvalJsonlDateiInhaltsquelle
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Inhalt | array | Der Inhalt der JSONL-Datei. | Ja | |
| Typ | enum | Der Typ der JSONL-Quelle. Immer file_content.Möglicher Wert: file_content |
Ja |
EvalJsonlDatei-ID-Quelle
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| id | Schnur | Der Bezeichner der Datei. | Ja | |
| Typ | enum | Der Typ der JSONL-Quelle. Immer file_id.Möglicher Wert: file_id |
Ja |
EvalLabelModelGrader
Ein LabelModelGrader -Objekt, das ein Modell verwendet, um jedem Element in der Auswertung Bezeichnungen zuzuweisen.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Eingabe | array | Ja | ||
| Bezeichnungen | array | Die Bezeichnungen, die jedem Element in der Auswertung zugewiesen werden sollen. | Ja | |
| Modell | Schnur | Das Modell, das für die Auswertung verwendet werden soll. Muss strukturierte Ausgaben unterstützen | Ja | |
| name | Schnur | Name des Bewerters (Graders) | Ja | |
| passing_labels | array | Bezeichnungen für ein bestandenes Ergebnis. Muss eine Teilmenge von „labels“ (Bezeichnungen) sein | Ja | |
| Typ | enum | Der Objekttyp, der immer label_model ist.Möglicher Wert: label_model |
Ja |
EvalList
Ein Objekt, das eine Liste von Evals darstellt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Ein Array von Eval-Objekten. | Ja | |
| first_id | Schnur | Der Bezeichner der ersten Auswertung im Datenarray. | Ja | |
| has_more | boolean | Gibt an, ob weitere Evals verfügbar sind. | Ja | |
| last_id | Schnur | Der Bezeichner der letzten Auswertung im Datenarray. | Ja | |
| Objekt | enum | Der Typ dieses Objekts. Immer auf „list“ festgelegt Möglicher Wert: list |
Ja |
EvalRun
Ein Schema, das eine Auswertungsausführung darstellt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs. | Ja | |
| Datenquelle | Objekt | Ein JsonlRunDataSource-Objekt, mit dem eine JSONL-Datei angegeben wird, die dem Bewertungsprozess entspricht. | Ja | |
| └– input_messages | Objekt | Nein | ||
| └– item_reference | Schnur | Ein Verweis auf eine Variable im Namespace "item", z. B. "item.name". | Nein | |
| └- Vorlage | array | Eine Liste der Chatnachrichten, die die Eingabeaufforderung oder den Kontext bilden. Kann variable Verweise auf den Namespace "item" enthalten, z. B. {{item.name}}. | Nein | |
| └– Typ | enum | Der Typ der Eingabemeldungen. Entweder template oder item_reference.Mögliche Werte: template, item_reference |
Nein | |
| └─ Modell | Schnur | Der Name des Modells, das zum Generieren von Fertigstellungen verwendet werden soll (z. B. "o3-mini"). | Nein | |
| └– Stichprobenparameter | Objekt | Nein | ||
| └– max_completion_tokens | integer | Die maximale Anzahl von Tokens in der generierten Ausgabe. | Nein | |
| └- Samen | integer | Ein Startwert zur Initialisierung der Zufälligkeit während des Samplings. | Nein | 42 |
| └– Temperatur | number | Eine höhere Temperatur erhöht die Zufälligkeit in den Ergebnissen. | Nein | 1 |
| └– top_p | number | Eine Alternative zur Temperatur bei der Kern-Probenahme; 1.0 enthält alle Token. | Nein | 1 |
| └- Quelle | Objekt | Nein | ||
| └– Typ | enum | Der Quelltyp. Kann EvalJsonlFileContentSource, EvalJsonlFileIdSource oder EvalStoredCompletionsSource sein.Mögliche Werte: EvalJsonlFileContentSource, , EvalJsonlFileIdSourceEvalStoredCompletionsSource |
Nein | |
| └– Typ | enum | Der Typ der Ausführungsdatenquelle. Immer completions.Möglicher Wert: completions |
Nein | |
| Fehler | EvalApiError | Ein Objekt, das eine Fehlerantwort der Eval-API darstellt. | Ja | |
| eval_id | Schnur | Bezeichner der zugeordneten Auswertung | Ja | |
| id | Schnur | Eindeutiger Bezeichner für die Auswertungsausführung | Ja | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Ja | |
| Modell | Schnur | Das Modell, das ausgewertet wird, falls zutreffend. | Ja | |
| name | Schnur | Name der Auswertungsausführung | Ja | |
| Objekt | enum | Der Typ des Objekts. Immer „eval.run“ Möglicher Wert: eval.run |
Ja | |
| pro_Modell_Nutzung | array | Nutzungsstatistiken für jedes Modell während der Auswertungsausführung. | Ja | |
| Ergebnisse_pro_Testkriterien | array | Ergebnisse pro Testkriterien, die während der Auswertungsausführung angewendet werden. | Ja | |
| report_url | Schnur | URL zum gerenderten Bericht der Auswertungsausführung im Dashboard auf der Benutzeroberfläche | Ja | |
| Ergebnisanzahl | Objekt | Indikatoren, die die Ergebnisse der Auswertungsausführung zusammenfassen. | Ja | |
| └– fehler | integer | Anzahl der Ausgabeelemente, die zu einem Fehler geführt haben. | Nein | |
| └– fehlgeschlagen | integer | Anzahl der Ausgabeelemente, die die Auswertung nicht bestanden haben. | Nein | |
| └– bestanden | integer | Anzahl der Ausgabeelemente, die die Auswertung bestanden haben. | Nein | |
| └– Gesamtsumme | integer | Gesamtanzahl der ausgeführten Ausgabeelemente. | Nein | |
| status | Schnur | Status der Auswertungsausführung | Ja |
EvalRunList
Objekt, das eine Liste der Ausführungen einer Auswertung darstellt
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Array von Objekten der Auswertungsausführung | Ja | |
| first_id | Schnur | Der Bezeichner des ersten Eval-Vorgangs im Datenarray. | Ja | |
| has_more | boolean | Gibt an, ob weitere Evals verfügbar sind. | Ja | |
| last_id | Schnur | Bezeichner der letzten Auswertungsausführung im Datenarray | Ja | |
| Objekt | enum | Der Typ dieses Objekts. Immer auf „list“ festgelegt Möglicher Wert: list |
Ja |
EvalRunOutputItem
Ein Schema, das ein Ausgabeelement einer Auswertungsausführung darstellt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Unix-Zeitstempel (in Sekunden) beim Erstellen des Auswertungslaufs. | Ja | |
| Datenquellenobjekt | Objekt | Details zum Datenquellelement der Eingabe | Ja | |
| datasource_item_id | integer | Der Bezeichner für das Datenquellenelement. | Ja | |
| eval_id | Schnur | Der Bezeichner der Auswertungsgruppe. | Ja | |
| id | Schnur | Eindeutiger Bezeichner für das Ausgabeelement der Auswertungsausführung | Ja | |
| Objekt | enum | Der Typ des Objekts. Immer „eval.run.output_item“ Möglicher Wert: eval.run.output_item |
Ja | |
| Ergebnisse | array | Eine Liste der Ergebnisse aus der Auswertungsausführung. | Ja | |
| run_id | Schnur | Der Bezeichner der Auswertungsausführung, die diesem Ausgabeelement zugeordnet ist. | Ja | |
| Beispiel | Objekt | Ein Beispiel, das die Eingabe und Ausgabe des Auswertungslaufs enthält. | Ja | |
| └– Fehler | EvalApiError | Ein Objekt, das eine Fehlerantwort der Eval-API darstellt. | Nein | |
| └- finish_reason | Schnur | Der Grund, warum die Beispielgenerierung abgeschlossen wurde. | Nein | |
| └– Eingabe | array | Ein Array von Eingabemeldungen. | Nein | |
| └– max_completion_tokens | integer | Die maximale Anzahl von Token, die für die Fertigstellung verwendet werden dürfen. | Nein | |
| └─ Modell | Schnur | Das Modell, das zum Generieren des Beispiels verwendet wird. | Nein | |
| └─ Ausgabe | array | Ein Array von Ausgabemeldungen. | Nein | |
| └- Samen | integer | Der zum Generieren der Stichprobe verwendete Seed | Nein | |
| └– Temperatur | number | Die verwendete Probenahmetemperatur. | Nein | |
| └– top_p | number | Der top_p Wert, der für das Sampling verwendet wird. | Nein | |
| └– Nutzung | Objekt | Details zur Nutzung von Tokens für das Beispiel. | Nein | |
| └– zwischengespeicherte_Token | integer | Die Anzahl der Token, die aus dem Cache abgerufen wurden. | Nein | |
| └– completion_tokens | integer | Die Anzahl der generierten Abschlusstoken. | Nein | |
| └– prompt_tokens | integer | Die Anzahl der verwendeten Prompt-Token. | Nein | |
| └– total_tokens | integer | Die Gesamtzahl der verwendeten Token. | Nein | |
| status | Schnur | Status der Auswertungsausführung | Ja |
EvalRunOutputItemList
Ein Objekt, das eine Liste der Ausgabeelemente für eine Auswertungsausführung darstellt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Array von Ausgabeelementobjekten einer Auswertungsausführung | Ja | |
| first_id | Schnur | Bezeichner des ersten Ausgabeelements einer Auswertungsausführung im Datenarray | Ja | |
| has_more | boolean | Gibt an, ob weitere Ausgabeelemente für die Auswertungsausführung verfügbar sind | Ja | |
| last_id | Schnur | Der Bezeichner des letzten Ausgabeelements des Eval-Durchlaufs im Datenarray. | Ja | |
| Objekt | enum | Der Typ dieses Objekts. Immer auf „list“ festgelegt Möglicher Wert: list |
Ja |
EvalScoreModelGrader
Ein ScoreModelGrader-Objekt, das ein Modell verwendet, um der Eingabe eine Bewertung zuzuweisen.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Eingabe | array | Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten. | Ja | |
| Modell | Schnur | Das Modell, das für die Auswertung verwendet werden soll. | Ja | |
| name | Schnur | Name des Bewerters (Graders) | Ja | |
| Schwellenwert erreichen | number | Der Schwellenwert für die Bewertung. | Nein | |
| range | array | Der Bereich für den Score Wird standardmäßig auf [0, 1] festgelegt. |
Nein | |
| Parameter für Stichprobennahme | Objekt | Die Samplingparameter für das Modell. | Nein | |
| Typ | enum | Der Objekttyp, der immer score_model ist.Möglicher Wert: score_model |
Ja |
Konfigurationsquelle für gespeicherte Eval-Vervollständigungen
Eine StoredCompletionsDataSourceConfig, die die Metadateneigenschaft Ihrer gespeicherten Abschlussabfrage angibt. Dies ist in der Regel Metadaten wie usecase=chatbot oder prompt-version=v2usw. Das von dieser Datenquellenkonfiguration zurückgegebene Schema wird verwendet, um zu definieren, welche Variablen in Ihren Evals verfügbar sind.
item und sample sind bei dieser Datenquellenkonfiguration beide definiert.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| schema | Objekt | Das JSON-Schema für die Laufdatenquellenelemente. Hier erfahren Sie, wie Sie JSON-Schemas erstellen. | Ja | |
| Typ | enum | Der Typ der Datenquelle. Immer stored_completions.Möglicher Wert: stored_completions |
Ja |
EvalStoredCompletionsSource
Eine StoredCompletionsRunDataSource-Konfiguration, die eine Gruppe von Filtern beschreibt
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| created_after | integer | Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die nach dieser Zeit erstellt wurden. | Nein | |
| erstellt_vor | integer | Ein optionaler Unix-Zeitstempel zum Filtern von Elementen, die vor dieser Zeit erstellt wurden. | Nein | |
| limit | integer | Eine optionale maximale Anzahl von Elementen, die zurückgegeben werden sollen. | Nein | |
| Metadaten | Metadaten | 16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen. | Nein | |
| Modell | Schnur | Ein optionales Modell, nach dem gefiltert wird (z. B. "gpt-4o"). | Nein | |
| Typ | enum | Der Quelltyp. Immer stored_completions.Möglicher Wert: stored_completions |
Ja |
EvalStringCheckGrader
Ein StringCheckGrader-Objekt, das einen Zeichenfolgenvergleich zwischen Eingabe und Verweis mithilfe eines angegebenen Vorgangs durchführt.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Eingabe | Schnur | Der Eingabetext. Dies kann Vorlagenzeichenfolgen enthalten. | Ja | |
| name | Schnur | Name des Bewerters (Graders) | Ja | |
| operation | enum | Der auszuführende Zeichenfolgenüberprüfungsvorgang Einer der folgenden Werte: eq, ne, like oder ilike.Mögliche Werte: eq, , ne, likeilike |
Ja | |
| Referenz | Schnur | Der Referenztext. Dies kann Vorlagenzeichenfolgen enthalten. | Ja | |
| Typ | enum | Der Objekttyp, der immer string_check ist.Möglicher Wert: string_check |
Ja |
EvalTextSimilarityGrader
Ein TextSimilarityGrader -Objekt, das Text basierend auf Ähnlichkeitsmetriken benotet.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Bewertungsmetrik | enum | Die zu verwendende Auswertungsmetrik. Einer von fuzzy_match, bleu, , gleumeteor, rouge_1, , rouge_2, rouge_3, rouge_4, , oder rouge_5rouge_l.Mögliche Werte: fuzzy_match, , bleu, gleu, meteorrouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l |
Ja | |
| Eingabe | Schnur | Der Text, der benotet wird. | Ja | |
| name | Schnur | Name des Bewerters (Graders) | Nein | |
| Schwellenwert erreichen | number | Ein Score (als Gleitkommazahl), der größer oder gleich diesem Wert ist, gilt als bestanden. | Ja | |
| Referenz | Schnur | Der Text, für die Bewertung. | Ja | |
| Typ | enum | Typ des Bewerters (Graders) Möglicher Wert: text_similarity |
Ja |
Eventtyp
Definiert den Schweregrad eines Ergebnisses des Inhaltsfilters.
| Eigentum | Wert |
|---|---|
| Beschreibung | Definiert den Schweregrad eines Ergebnisses des Inhaltsfilters. |
| Typ | Schnur |
| Werte | messagemetrics |
Datei
Eine Datei ist ein Dokument, das für Trainings und Validierungen verwendet werden kann. Es kann auch ein vom Dienst generiertes Dokument mit Ergebnisdetails sein.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Die Größe dieser Datei, wenn verfügbar (kann null sein). Dateigrößen, die größer als 2^53-1 sind, werden nicht unterstützt, um die Kompatibilität mit JavaScript-Ganzzahlen sicherzustellen. | Nein | |
| erstellt_am | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen). | Nein | |
| läuft_ab_am | integer | Unix-Zeitstempel (Anzahl der Sekunden, die seit dem 1. Januar 1970 verstrichen sind), wenn die Datei abgelaufen ist. | Nein | |
| Dateiname | Schnur | Der Name der Datei. | Ja | |
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja | |
| status | FileState | Der Status einer Datei. | Nein | |
| status_details | Schnur | Die Fehlermeldung mit Details falls die Verarbeitung dieser Datei fehlgeschlagen ist. Veraltet (nicht mehr empfohlen) | Nein |
DateiErstellen
Definiert ein Dokument, das aus einer externen Inhalts-URL importiert werden soll, die mit Azure OpenAI verwendet werden kann.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| content_url | Schnur | Die URL, aus der das Dokument heruntergeladen werden soll (die SAS-URL eines Blobs oder eine andere externe URL, auf die mit einer GET-Anforderung zugegriffen werden kann). | Ja | |
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
DateiLöschen
Definiert die Antwort für die Dateilöschung.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| gelöscht | boolean | Ein Wert, der angibt, ob die Datei gelöscht wurde. | Ja | |
| id | Schnur | Die Datei-ID, die gelöscht wurde. | Ja | |
| Objekt | Schnur | Gibt an, ob die Datei gelöscht wurde. | Ja |
FileDetails
Ein Dateidetail ist ein Dokument, das vom Batchdienst zum Abrufen von Datei-BLOB-Details verwendet wird.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Dateiname | Schnur | Der Name der Datei. | Ja | |
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Pfad | Schnur | Relativer Pfad zur Datei innerhalb des Containers | Nein | |
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja | |
| Speicherkonto-URI | Schnur | Die URL des Speicherkontos dieser Datei. | Nein | |
| Speichercontainername | Schnur | Der Name des Speichercontainers dieses Datei-BLOBs. | Nein |
FileExpiresAfter
Definiert ein Ablaufdatum für die Datei.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| anchor | FileExpiryAnchor | Definiert den Anker relativ zu dem Zeitpunkt, zu dem die absolute Ablaufzeit generiert werden soll. | Nein | |
| Sekunden | integer | Die relative Ablaufzeit in Sekunden. Bereich: [1209600 - 2592000]. | Nein |
FileExpiryAnchor
Definiert den Anker relativ zu dem Zeitpunkt, zu dem die absolute Ablaufzeit generiert werden soll.
| Eigentum | Wert |
|---|---|
| Beschreibung | Definiert den Anker relativ zu dem Zeitpunkt, zu dem die absolute Ablaufzeit generiert werden soll. |
| Typ | Schnur |
| Werte | created_at |
Dateiimport
Definiert ein Dokument, das aus einer externen Inhalts-URL importiert werden soll, die mit Azure OpenAI verwendet werden kann.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| content_url | Schnur | Die URL, aus der das Dokument heruntergeladen werden soll (die SAS-URL eines Blobs oder eine andere externe URL, auf die mit einer GET-Anforderung zugegriffen werden kann). | Ja | |
| expires_after | FileExpiresAfter | Definiert ein Ablaufdatum für die Datei. | Nein | |
| Dateiname | Schnur | Der Name der JSON Lines-Datei, die hochgeladen werden soll. Wenn die purpose Einstellung auf „fine-tune“ festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern „prompt“ und „completion“, die Ihre Trainingsbeispiele darstellen. |
Ja | |
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
FileList
Stellt eine Liste von Dateien dar.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
Dateistatus
Der Status einer Datei.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Status einer Datei. |
| Typ | Schnur |
| Werte | uploadedpendingrunningprocessederrordeletingdeleted |
FineTuneMethod
Diskriminator für FineTuneMethod
Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Typ | FineTuningMethodType | Ja |
FineTuneMethodRequest
Diskriminator für FineTuneMethodRequest
Diese Komponente verwendet die Eigenschaft type , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Typ | FineTuningMethodType | Ja |
Feinabstimmung von Hyperparametern
Die Einstellungen für Hyperparameter, die in einem Feinabstimmungsauftrag verwendet werden.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Batch-Größe | integer | Die für das Training zu verwendende Batchgröße. Die Batchgröße ist die Anzahl der Trainingsbeispiele, die zum Trainieren einer einzelnen Vorwärts- und Rückwärtsberechnung verwendet werden. Im Allgemeinen haben wir festgestellt, dass größere Batchgrößen für größere Datasets besser funktionieren. Der Standardwert sowie der Maximalwert für diese Eigenschaft sind spezifisch für ein Basismodell. | Nein | |
| Lernratenmultiplikator | number | Der Lernratenmultiplikator, der für das Training verwendet werden soll. Die Optimierungslernrate ist die ursprüngliche Lernrate, die für das Vorabtraining verwendet wird, mit diesem Wert multipliziert. Größere Lernraten weisen für größere Batches tendenziell eine bessere Leistung auf. Es empfiehlt sich, mit Werten im Bereich 0,02 bis 0,2 zu experimentieren, um zu sehen, was die besten Ergebnisse erzeugt. | Nein | |
| n_epochs | integer | Die Anzahl der Epochen zum Trainieren des Modells. Eine Epoche bezieht sich auf einen vollständigen Zyklus durch das Trainingsdataset. | Nein |
FineTuningJob
Definiert die Werte eines Optimierungsauftrags
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen). | Nein | |
| Fehler | FineTuningJobError | Bei fehlgeschlagenen Feinabstimmungsaufträgen sind weitere Informationen zur Ursache des Fehlers enthalten. | Nein | |
| geschätzte Fertigstellung | integer | Unix-Zeitstempel (in Sekunden) für die Vervollständigung des Feinabstimmungsauftrags. Der Wert ist NULL, wenn der Optimierungsauftrag nicht ausgeführt wird. | Nein | |
| fine_tuned_model | Schnur | Der Bezeichner (model-id) des resultierenden fein abgestimmten Modells. Diese Eigenschaft wird nur für erfolgreich abgeschlossene Optimierungsausführungen aufgefüllt. Verwenden Sie diesen Bezeichner, um eine Bereitstellung für den Rückschluss zu erstellen. | Nein | |
| finished_at | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erfolgreich abgeschlossen wurde (in Unix-Epochen). | Nein | |
| Hyperparameter | FineTuningHyperParameters | Die Einstellungen für Hyperparameter, die in einem Feinabstimmungsauftrag verwendet werden. | Nein | |
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Integrationen | array | Liste der Konfigurationen für Integrationen zur Unterstützung des Optimierungsauftrags Es sind viele Integrationen geplant. Stellen Sie daher sicher, dass Sie den Integrationstyp überprüfen und entsprechend reagieren. | Nein | |
| Methode | Objekt | Methode zur überwachten Optimierung | Nein | |
| └– Typ | FineTuningMethodType | Nein | ||
| Modell | Schnur | Der Bezeichner (model-id) des Basismodells, das für die Feinabstimmung verwendet wird. | Ja | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| Organisations-ID | Schnur | Organisations-ID dieses Optimierungsauftrags Nicht verwendet in Azure OpenAI; nur mit OpenAI kompatibel. | Nein | |
| Ergebnisdateien | array | Die Identitäten der Ergebnisdatei (file-id), die Trainings- und Auswertungsmetriken im CSV-Format enthalten. Die Datei ist nur bei erfolgreich abgeschlossenen Optimierungen verfügbar. | Nein | |
| Seed | integer | Der für den Optimierungsauftrag verwendete Seed | Nein | |
| status | FineTuningState | Zustand eines Optimierungsobjekts oder eines Optimierungsauftrags | Nein | |
| suffix | Schnur | Der Suffix, der zum Identifizieren des fein abgestimmten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9, - und _) enthalten, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. | Nein | |
| trainierte Token | integer | Die Gesamtzahl der abrechnungsfähigen Tokens, die durch diesen Feinabstimmungsauftrag verarbeitet wurden. | Nein | |
| Trainingsdatei | Schnur | Die Datei, die für Trainings verwendet wird. | Ja | |
| Validierungsdatei | Schnur | Die Datei, die zum Auswerten des fein abgestimmten Modells während des Trainings verwendet wird. | Nein |
FineTuningJobCheckpoint
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Unix-Zeitstempel (in Sekunden) für den Zeitpunkt der Erstellung des Prüfpunkts. | Ja | |
| fine_tuned_model_checkpoint | Schnur | Der Name des erstellten fein abgestimmten Prüfpunktmodells. | Ja | |
| fine_tuning_job_id | Schnur | Name des Optimierungsauftrags, aus dem dieser Prüfpunkt erstellt wurde | Ja | |
| id | Schnur | Die Identität dieses Prüfpunkts. | Nein | |
| Metriken | Objekt | Die Metriken bei der Schrittnummer während des Feinabstimmungsauftrags. | Ja | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| Schrittnummer | integer | Die Schrittnummer, bei der der Prüfpunkt erstellt wurde. | Ja |
FineTuningJobCheckpointList
Stellt eine Liste der Prüfpunkte dar.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| has_more | boolean | Ein Wert, der angibt, ob die Liste mehr Elemente enthält als zurückgegeben. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
FineTuningJobCreation
Definiert die Werte eines Optimierungsauftrags
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Hyperparameter | FineTuningHyperParameters | Die Einstellungen für Hyperparameter, die in einem Feinabstimmungsauftrag verwendet werden. | Nein | |
| Integrationen | array | Liste der Konfigurationen für Integrationen zur Unterstützung des Optimierungsauftrags Es sind viele Integrationen geplant. Stellen Sie daher sicher, dass Sie den Integrationstyp überprüfen und entsprechend reagieren. | Nein | |
| Methode | Objekt | Methode zur überwachten Optimierung | Nein | |
| └– Typ | FineTuningMethodType | Nein | ||
| Modell | Schnur | Der Bezeichner (model-id) des Basismodells, das für diese Feinabstimmung verwendet wird. | Ja | |
| Seed | integer | Der für den Optimierungsauftrag verwendete Seed Die Übergabe der gleichen Seed- und Auftragsparameter sollte die gleichen Ergebnisse produzieren, kann sich aber in seltenen Fällen unterscheiden. Wenn kein Seed angegeben wird, wird einer für Sie generiert. | Nein | |
| suffix | Schnur | Der Suffix, der zum Identifizieren des fein abgestimmten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9, - und _) enthalten, die ihrem fein abgestimmten Modellnamen hinzugefügt werden. | Nein | |
| Trainingsdatei | Schnur | Die Dateiidentität (file-id), die für das Training dieses fein abgestimmten Modells verwendet wird. | Ja | |
| Validierungsdatei | Schnur | Die Dateiidentität (file-id), die zum Auswerten des fein abgestimmten Modells während des Trainings verwendet wird. | Nein |
FineTuningJobError
Bei fehlgeschlagenen Feinabstimmungsaufträgen sind weitere Informationen zur Ursache des Fehlers enthalten.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| code | Schnur | Der computerlesbare Fehlercode. | Nein | |
| Nachricht | Schnur | Die menschenlesbare Fehlermeldungen. | Nein | |
| param | Schnur | Der ungültige Parameter, meist training_file oder validation_file. Dieses Feld ist null, wenn der Fehler nicht parameterspezifisch war. | Nein |
FineTuningJobEvent
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| erstellt_am | integer | Zeitstempel, wann dieses Ereignis erstellt wurde (in Unix-Epochen). | Ja | |
| Daten | Maschinenlesbare Daten dieses Ereignisses. | Nein | ||
| id | Schnur | Die Identität dieses Ereignisses. | Nein | |
| level | LogLevel | Die Ausführlichkeitsebene eines Ereignisses. | Ja | |
| Nachricht | Schnur | Die Meldung, die das Ereignis beschreibt. Dies kann eine Änderung des Zustands sein, z. B. enqueued, started, failed oder completed, oder andere Ereignisse, wie hochgeladene Ergebnisse. | Ja | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| Typ | EventType | Definiert den Schweregrad eines Ergebnisses des Inhaltsfilters. | Ja |
FineTuningJobEventList
Stellt eine Liste von Ereignissen dar.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| has_more | boolean | Ein Wert, der angibt, ob die Liste mehr Elemente enthält als zurückgegeben. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
FineTuningJobList
Stellt eine Liste von Optimierungen dar
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| has_more | boolean | Ein Wert, der angibt, ob die Liste mehr Elemente enthält als zurückgegeben. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
FineTuningMethodType
| Eigentum | Wert |
|---|---|
| Typ | Schnur |
| Werte | dposupervised |
FineTuningState
Zustand eines Optimierungsobjekts oder eines Optimierungsauftrags
| Eigentum | Wert |
|---|---|
| Beschreibung | Zustand eines Optimierungsobjekts oder eines Optimierungsauftrags |
| Typ | Schnur |
| Werte | createdpendingrunningpausingpausedresumingsucceededcancelledfailed |
FunctionCallFunction
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Argumente | Schnur | Die Argumente, von denen das Modell erwartet, dass Sie sie an die Funktion übergeben. | Nein | |
| name | Schnur | Der Name der Funktion. | Nein |
Funktionsdefinition
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Beschreibung | Schnur | Eine Beschreibung des Zwecks der Funktion, die vom Modell verwendet wird, um auszuwählen, wann und wie die Funktion aufgerufen wird. | Nein | |
| name | Schnur | Der Name der funktion, die aufgerufen werden soll. | Nein | |
| Parameter | Die Parameter, die die Funktionen akzeptieren, die als JSON-Schemaobjekt beschrieben werden. | Nein |
Allgemeine Einbettungseinstellungen
Einstellungen für das Einbetten von Verbindungen
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connection | BaseConnection | Eine Verbindung mit einer Ressource. | Nein | |
| deploymentName | Schnur | Nein | ||
| Modellname | Schnur | Nein |
Eingabefehler
Details zum Erfassungsfehler
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| innerErrors | array | Nein | ||
| Nachricht | Schnur | Nein |
IngestionJob
Stellt die Details eines Auftrags dar.
Diskriminator für IngestionJob
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| jobId | Schnur | Nein | ||
| freundlich | IngestionJobType | Der Auftragstyp. | Ja |
IngestionJobList
Stellt eine Liste von Erfassungsaufträgen dar
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| nextLink | Schnur | Der Link zur nächsten Seite. | Nein | |
| value | array | Die Liste der Elemente. | Nein |
IngestionJobProgress
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Phasenfortschritt | array | Ja |
IngestionJobRun
Die Details einer Auftragsausführung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Fehler | IngestionError | Details zum Erfassungsfehler | Nein | |
| jobId | Schnur | Nein | ||
| Fortschritt | IngestionJobProgress | Nein | ||
| runId | Schnur | Nein | ||
| status | OperationState | Der Status eines Auftrags oder Elements. | Nein | |
| Warnungen | array | Nein |
IngestionJobRunList
Stellt eine Liste von Ausführungen von Erfassungsaufträgen dar
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| nextLink | Schnur | Der Link zur nächsten Seite. | Nein | |
| value | array | Die Liste der Elemente. | Nein |
IngestionJobStageProgress
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| name | Schnur | Nein | ||
| verarbeiteteElemente | integer | Nein | ||
| Staat | OperationState | Der Status eines Auftrags oder Elements. | Nein | |
| Teilabschnittfortschritt | array | Nein | ||
| totalItems | integer | Nein |
IngestionJobSystemRechnen
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| completionAction | CompletionAction | Die Vervollständigungsaktion. | Nein | |
| DatenaktualisierungsintervallInStunden | integer | Nein | ||
| datasource | SystemComputeDatasource | Nein | ||
| jobId | Schnur | Nein | ||
| freundlich | IngestionJobType | Der Auftragstyp. | Ja | |
| searchServiceConnection | BaseConnection | Eine Verbindung mit einer Ressource. | Nein |
IngestionJobType
Der Auftragstyp.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Auftragstyp. |
| Typ | Schnur |
| Werte | SystemComputeUserCompute |
IngestionJobUserCompute
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| compute | JobCompute | Die Computeeinstellungen des Auftrags. | Nein | |
| DatenaktualisierungsintervallInStunden | integer | Nein | ||
| datasource | UserComputeDatasource | Nein | ||
| jobId | Schnur | Nein | ||
| freundlich | IngestionJobType | Der Auftragstyp. | Ja | |
| Ziel | TargetIndex | Informationen zum zu erstellenden Index. | Nein | |
| Arbeitsbereichs-ID | Schnur | Nein |
InnerError
Interner Fehler gemäß den Microsoft REST-Richtlinien.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| code | InnerErrorCode | Interne Fehlercodes, wie in den Microsoft REST-Richtlinien definiert. | Nein | |
innererror |
InnerError | Interner Fehler gemäß den Microsoft REST-Richtlinien. | Nein |
InnerErrorCode (innerer Fehlercode)
Interne Fehlercodes, wie in den Microsoft REST-Richtlinien definiert.
| Eigentum | Wert |
|---|---|
| Beschreibung | Interne Fehlercodes, wie in den Microsoft REST-Richtlinien definiert. |
| Typ | Schnur |
| Werte | invalidPayload |
Eingabenachricht
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Inhalt | Schnur | Der Inhalt der Nachricht. | Nein | |
| id | Schnur | Die Identität der Nachricht. | Nein | |
| name | Schnur | Ein optionaler Name für den Teilnehmer. Stellt die Modellinformationen bereit, um zwischen den Teilnehmern derselben Rolle zu unterscheiden. | Nein | |
| Rolle (role) | Schnur | Die Rolle der Entität, die die Nachricht erstellt. | Nein |
Eingabetextinhalt
Eine Texteingabe für das Modell.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Text | Schnur | Die Texteingabe für das Modell. | Ja | |
| Typ | enum | Der Typ des Eingabeelements. Immer input_text.Möglicher Wert: input_text |
Ja |
Integrationstypen
Liste der verfügbaren Optimierungsintegrationen
| Eigentum | Wert |
|---|---|
| Beschreibung | Liste der verfügbaren Optimierungsintegrationen |
| Typ | Schnur |
| Werte | wandb |
JobCompute
Die Computeeinstellungen des Auftrags.
Diskriminator für JobCompute
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | ComputeType | Der Computetyp. | Ja |
LifeCycleStatus
Der Lebenszyklusstatus eines Modells.
Hinweis: Ein Modell kann von preview zu generally-available befördert werden, aber nie von generally-available zu preview.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Lebenszyklusstatus eines Modells. Hinweis: Ein Modell kann von preview zu generally-available befördert werden, aber nie von generally-available zu preview. |
| Typ | Schnur |
| Werte | previewgenerally-availabledeprecatingdeprecated |
LogLevel
Die Ausführlichkeitsebene eines Ereignisses.
| Eigentum | Wert |
|---|---|
| Beschreibung | Die Ausführlichkeitsebene eines Ereignisses. |
| Typ | Schnur |
| Werte | infowarningerror |
Logprob
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| logprob | number | Die Protokollwahrscheinlichkeit dieses Tokens, wenn es zu den 20 wahrscheinlichsten Tokens gehört. Andernfalls wird der Wert -9999.0 verwendet, um zu kennzeichnen, dass das Token sehr unwahrscheinlich ist. |
Nein | |
| token | Schnur | Das Token. | Nein |
Metadaten
16 Schlüssel-Wert-Paare, die an ein Objekt angefügt werden können. Dies kann hilfreich sein, um zusätzliche Informationen zum Objekt in einem strukturierten Format zu speichern und Objekte über DIE API oder das Dashboard abzufragen. Schlüssel sind Zeichenfolgen mit maximal 64 Zeichen. Werte sind Zeichenfolgen mit maximal 512 Zeichen.
Für diese Komponente sind keine Eigenschaften definiert.
Modell
Ein Modell ist entweder ein Basismodell oder das Ergebnis eines erfolgreichen Optimierungsauftrags.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Fähigkeiten | Funktionen | Die Funktionen eines Basis- oder Feinabstimmungsmodells. | Ja | |
| erstellt_am | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen). | Nein | |
| deprecation | Missbilligung | Legt die Daten fest, ab denen die verschiedenen Anwendungsfälle eines Modells als veraltet gelten. In der Regel unterstützen Basismodelle 1 Jahr nach der Erstellung Optimierungen. Rückschlüsse werden in der Regel 2 Jahre nach der Erstellung von Basis- oder Optimierungsmodellen unterstützt. Die genauen Datumsangaben werden in den Eigenschaften angegeben. | Ja | |
| fine_tune | Schnur | Die Feinabstimmung der Auftragsidentität (fine-tune-id), wenn dies ein Feinabstimmungsmodell ist; andernfalls null. |
Nein | |
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Lebenszyklusstatus | LifeCycleStatus | Der Lebenszyklusstatus eines Modells. Hinweis: Ein Modell kann von "Vorschau" zu generally-available heraufgestuft werden, aber niemals von generally-available zu "Vorschau". |
Ja | |
| Modell | Schnur | Die Basismodellidentität (model-id), wenn dies ein Feinabstimmungsmodell ist; andernfalls null. |
Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| status | FineTuningState | Zustand eines Optimierungsobjekts oder eines Optimierungsauftrags | Nein |
ModelListe
Stellt eine Liste von Modellen dar.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der Elemente. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein |
OperationState
Der Status eines Auftrags oder Elements.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Status eines Auftrags oder Elements. |
| Typ | Schnur |
| Werte | notRunningrunningsucceededfailed |
Bestellung
Definiert den Zweck einer Datei.
| Eigentum | Wert |
|---|---|
| Beschreibung | Definiert den Zweck einer Datei. |
| Typ | Schnur |
| Werte | descasc |
OrderByOrder
| Eigentum | Wert |
|---|---|
| Typ | Schnur |
| Werte | ascdesc |
PineconeIndex
Pinecone-Index
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connectionId | Schnur | Die ID der Verbindung, die auf den Pinecone zeigt. | Nein | |
| freundlich | Zieltyp | Der Zieltyp. | Ja |
Zweck
Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. |
| Typ | Schnur |
| Werte | fine-tunefine-tune-resultsassistantsassistants_outputbatchbatch_outputevalsevals_output |
Serverlose Datenverarbeitung
Serverloses Computing.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| instanceCount (InstanzAnzahl) | integer | Die Anzahl der Instanzen, auf denen der Auftrag ausgeführt werden soll. | Nein | |
| freundlich | ComputeType | Der Computetyp. | Ja | |
| sku | Schnur | SKU-Ebene | Nein |
Gespeicherte Fertigstellung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Optionen | array | Eine Liste der Auswahlmöglichkeiten für den Chatabschluss. Es können mehrere sein, wenn n größer als 1 ist. |
Nein | |
| created | integer | Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Chatvervollständigung erstellt wurde | Nein | |
| Häufigkeitsstrafe | number | Eine Zahl zwischen -2,0 und 2,0. Positive Werte benachteiligen neue Token auf der Grundlage ihrer bisherigen Häufigkeit im Text, wodurch die Wahrscheinlichkeit, dass das Modell dieselbe Zeile wortwörtlich wiederholt, sinkt. | Nein | |
| id | Schnur | Die Identität der gespeicherten Vervollständigung. | Nein | |
| Benutzereingabe | Schnur | Der Eingabebenutzer für diese Anforderung. | Nein | |
| Metadaten | Objekt | Beliebige Schlüssel-Wert-Paare für zusätzliche Informationen. | Nein | |
| Modell | Schnur | Die ID des zu verwendenden Modells. | Nein | |
| Präsenzstrafe | number | Eine Zahl zwischen -2,0 und 2,0. Positive Werte benachteiligen neue Token, je nachdem, ob sie bereits im Text vorkommen, und erhöhen so die Wahrscheinlichkeit, dass das Modell über neue Themen spricht. | Nein | |
| Anfrage_ID | Schnur | Ein eindeutiger Bezeichner für die OpenAI-API-Anforderung. Geben Sie diese Anforderungs-ID an, wenn Sie sich an den Support wenden. | Nein | |
| Seed | integer | Wenn Sie dies angeben, bemüht sich unser System nach besten Kräften, eine deterministische Auswahl zu treffen, sodass wiederholte Anforderungen mit demselben seed und denselben Parametern dasselbe Ergebnis liefern sollten. Determinismus ist nicht garantiert, und Sie sollten auf den |
||
system_fingerprint Antwortparameter zum Überwachen von Änderungen im Back-End. |
Nein | |||
| Dienststufe | Schnur | Gibt die Latenzebene an, die für die Verarbeitung der Anforderung verwendet werden soll. | Nein | |
| Systemfingerabdruck | Schnur | Dieser Fingerabdruck stellt die Back-End-Konfiguration dar, mit der das Modell ausgeführt wird. Kann zusammen mit dem Anforderungsparameter seed verwendet werden, um zu verstehen, wann Back-End-Änderungen vorgenommen wurden, die sich auf den Determinismus auswirken können. |
Nein | |
| Temperatur | number | Die zu verwendende Temperatur für die Stichprobenentnahme zwischen 0 und 2. Durch höhere Werte wie 0,8 wird die Ausgabe zufälliger, während sie durch niedrigere Werte wie 0,2 fokussierter und deterministischer wird. Wir empfehlen im Allgemeinen, dies oder top_p zu ändern, aber nicht beides. |
Nein | |
| Toolauswahl | Schnur | Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. | Nein | |
| Werkzeuge | array | Eine Liste der Tools, die das Modell aufrufen kann. Derzeit werden nur Funktionen als Tool unterstützt. Verwenden Sie diesen Parameter, um eine Liste der Funktionen anzugeben, für die das Modell JSON-Eingaben generieren kann. Es werden maximal 128 Funktionen unterstützt. | Nein | |
| top_p | number | Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen. Wir empfehlen im Allgemeinen, dies oder temperature zu ändern, aber nicht beides. |
Nein | |
| Verwendung | Verwendung | Nein |
StoredCompletionDelete
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| gelöscht | boolean | Ein Wert, der angibt, ob die gespeicherte Vervollständigung gelöscht wurde. | Nein | |
| id | Schnur | Die gespeicherte Vervollständigungs-ID, die gelöscht wurde. | Nein | |
| Objekt | Schnur | Gibt an, ob die gespeicherte Vervollständigung gelöscht wurde. | Ja |
StoredCompletionList
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der abgerufenen Objekte. | Nein | |
| first_id | Schnur | Die erste ID in der abgerufenen list |
Nein | |
| has_more | boolean | Die has_more Eigenschaft wird für die Paginierung verwendet, um anzugeben, dass zusätzliche Ergebnisse vorhanden sind. |
Nein | |
| last_id | Schnur | Die letzte ID in der abgerufenen list |
Nein | |
| Objekt | Schnur | Der Objekttyp, der immer list ist. |
Nein | |
| total | integer | Gesamtanzahl der Elemente. | Nein |
GespeicherteAbschlussnachrichten
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Daten | array | Die Liste der abgerufenen Objekte. | Nein | |
| first_id | Schnur | Die erste ID in der abgerufenen list |
Nein | |
| has_more | boolean | Die has_more Eigenschaft wird für die Paginierung verwendet, um anzugeben, dass zusätzliche Ergebnisse vorhanden sind. |
Nein | |
| last_id | Schnur | Die letzte ID in der abgerufenen list |
Nein | |
| Objekt | Schnur | Der Objekttyp, der immer list ist. |
Nein | |
| total | integer | Gesamtanzahl der Elemente. | Nein |
GespeicherteAbschlussAntwort
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Optionen | array | Eine Liste der Auswahlmöglichkeiten für den Chatabschluss. Es können mehrere sein, wenn n größer als 1 ist. |
Nein | |
| created | integer | Der Unix-Zeitstempel (in Sekunden) des Zeitpunkts, zu dem die Chatvervollständigung erstellt wurde | Nein | |
| Häufigkeitsstrafe | number | Eine Zahl zwischen -2,0 und 2,0. Positive Werte benachteiligen neue Token auf der Grundlage ihrer bisherigen Häufigkeit im Text, wodurch die Wahrscheinlichkeit, dass das Modell dieselbe Zeile wortwörtlich wiederholt, sinkt. | Nein | |
| id | Schnur | Die Identität der gespeicherten Vervollständigung. | Nein | |
| Benutzereingabe | Schnur | Der Eingabebenutzer für diese Anforderung. | Nein | |
| Metadaten | Objekt | Beliebige Schlüssel-Wert-Paare für zusätzliche Informationen. | Nein | |
| Modell | Schnur | Die ID des zu verwendenden Modells. | Nein | |
| Objekt | Schnur | Der Typ dieses Objekts. | Nein | |
| Präsenzstrafe | number | Eine Zahl zwischen -2,0 und 2,0. Positive Werte benachteiligen neue Token, je nachdem, ob sie bereits im Text vorkommen, und erhöhen so die Wahrscheinlichkeit, dass das Modell über neue Themen spricht. | Nein | |
| Anfrage_ID | Schnur | Ein eindeutiger Bezeichner für die OpenAI-API-Anforderung. Geben Sie diese Anforderungs-ID an, wenn Sie sich an den Support wenden. | Nein | |
| Seed | integer | Wenn angegeben, wird unser System eine bestmögliche Bemühung unternehmen, um deterministisch zu probieren, sodass wiederholte Anforderungen mit demselben seedund den gleichen Parametern das gleiche Ergebnis liefern sollten. Der Determinismus ist nicht garantiert, und Sie sollten auf den system_fingerprint Antwortparameter verweisen, um Änderungen im Back-End zu überwachen. |
Nein | |
| Dienststufe | Schnur | Gibt die Latenzebene an, die für die Verarbeitung der Anforderung verwendet werden soll. | Nein | |
| Systemfingerabdruck | Schnur | Dieser Fingerabdruck stellt die Back-End-Konfiguration dar, mit der das Modell ausgeführt wird. Kann zusammen mit dem Anforderungsparameter seed verwendet werden, um zu verstehen, wann Back-End-Änderungen vorgenommen wurden, die sich auf den Determinismus auswirken können. |
Nein | |
| Temperatur | number | Die zu verwendende Temperatur für die Stichprobenentnahme zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministisch machen. Wir empfehlen im Allgemeinen, dies oder top_p zu ändern, aber nicht beides. |
Nein | |
| Toolauswahl | Schnur | Steuert, welches Tool (falls vorhanden) vom Modell aufgerufen wird. | Nein | |
| Werkzeuge | array | Eine Liste der Tools, die das Modell aufrufen kann. Derzeit werden nur Funktionen als Tool unterstützt. Verwenden Sie diesen Parameter, um eine Liste der Funktionen anzugeben, für die das Modell JSON-Eingaben generieren kann. Es werden maximal 128 Funktionen unterstützt. | Nein | |
| top_p | number | Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen. Wir empfehlen im Allgemeinen, dies oder temperature zu ändern, aber nicht beides. |
Nein | |
| Verwendung | Verwendung | Nein |
Überwachtes Verfahren
Methode zur überwachten Optimierung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Typ | FineTuningMethodType | Ja |
AnfrageFürÜberwachteMethode
Methode zur überwachten Optimierung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Typ | FineTuningMethodType | Ja |
SystemComputeDatasource
Diskriminator für SystemComputeDatasource
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | SystemComputeDatasourceType | Der Typ der Datenquelle. | Ja |
SystemComputeDatasourceType
Der Typ der Datenquelle.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Typ der Datenquelle. |
| Typ | Schnur |
| Werte | StorageUrls |
SystemRechenSpeicher
Speicherkonto
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Segmentierung | Chunking-Einstellungen | Segmentierungseinstellungen | Nein | |
| connection | BaseConnection | Eine Verbindung mit einer Ressource. | Nein | |
| BehälterName | Schnur | Containername | Nein | |
| embeddings | array | Nein | ||
| freundlich | SystemComputeDatasourceType | Der Typ der Datenquelle. | Ja |
SystemComputeUrl
URLs
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Segmentierung | Chunking-Einstellungen | Segmentierungseinstellungen | Nein | |
| connection | BaseConnection | Eine Verbindung mit einer Ressource. | Nein | |
| BehälterName | Schnur | Containername | Nein | |
| Durchforstung | CrawlingSettings | Durchsuchungseinstellungen | Nein | |
| embeddings | array | Nein | ||
| freundlich | SystemComputeDatasourceType | Der Typ der Datenquelle. | Ja | |
| urls | array | Nein |
Zielindex
Informationen zum zu erstellenden Index.
Diskriminator für TargetIndex
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | Zieltyp | Der Zieltyp. | Ja |
Zieltyp
Der Zieltyp.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Zieltyp. |
| Typ | Schnur |
| Werte | AzureAISearchCosmosDBPinecone |
Werkzeug
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Funktion | FunctionDefinition | Nein | ||
| Typ | Schnur | Die Art des Toolaufrufs. Ist für diese Art von Toolaufruf immer function. |
Nein |
ToolCall
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Funktion | FunctionCallFunction | Nein | ||
| id | Schnur | Die ID des Toolaufrufs | Nein | |
| Typ | Schnur | Der Typ des Toolaufrufs, für den die Ausgabe erforderlich ist. Dieser Wert ist vorerst immer function. |
Nein |
Typdiskriminator
Definiert den Typ eines Objekts.
| Eigentum | Wert |
|---|---|
| Beschreibung | Definiert den Typ eines Objekts. |
| Typ | Schnur |
| Werte | listfine_tuning.jobfilefine_tuning.job.eventfine_tuning.job.checkpointmodeluploadupload.partbatchwandb |
AktualisiereGespeicherteAbschlussAnfrage
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Metadaten | Objekt | Beliebige Schlüssel-Wert-Paare für zusätzliche Informationen. | Nein |
UploadFileCompleteBody
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| md5 | Schnur | Nein | ||
| Teil-IDs | array | Ja |
UploadFileStartBody
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Ja | ||
| Dateiname | Schnur | Ja | ||
| MIME-Typ | Schnur | Ja | ||
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Ja |
UploadPartResource
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| azure_block_id | Schnur | Nein | ||
| erstellt_am | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen). | Nein | |
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| Hochlade-ID | Schnur | Nein |
UploadResource
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Byte | integer | Nein | ||
| erstellt_am | integer | Zeitstempel, wann dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen). | Nein | |
| läuft_ab_am | integer | Nein | ||
| file | File | Eine Datei ist ein Dokument, das für Trainings und Validierungen verwendet werden kann. Es kann auch ein vom Dienst generiertes Dokument mit Ergebnisdetails sein. | Nein | |
| Dateiname | Schnur | Nein | ||
| id | Schnur | Die Identität dieses Elements. | Nein | |
| Objekt | TypeDiscriminator | Definiert den Typ eines Objekts. | Nein | |
| purpose | Zweck | Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie „fine-tune“ für Feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen. | Nein | |
| status | UploadStatus | Nein |
UploadStatus
| Eigentum | Wert |
|---|---|
| Typ | Schnur |
| Werte | pendingexpiredcompletedcancelled |
Verwendung
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| completion_tokens | integer | Anzahl der Token in der generierten Vervollständigung | Nein | |
| prompt_tokens | integer | Anzahl der Token im Prompt. | Nein | |
| Gesamtanzahl Tokens | integer | Die Gesamtzahl der in der Anforderung verwendeten Token (Prompt + Vervollständigung). | Nein |
BenutzerRechenDatensatz
Speicherkonto
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Segmentierung | Chunking-Einstellungen | Segmentierungseinstellungen | Nein | |
| datasetId | Schnur | Nein | ||
| Datensatztyp | Schnur | Nein | ||
| embeddings | array | Nein | ||
| freundlich | BenutzerBerechnungsDatenquellenTyp | Der Typ der Datenquelle. | Ja |
UserComputeDatasource
Diskriminator für UserComputeDatasource
Diese Komponente verwendet die Eigenschaft kind , um zwischen verschiedenen Typen zu unterscheiden:
| Typwert | Schema |
|---|
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| freundlich | BenutzerBerechnungsDatenquellenTyp | Der Typ der Datenquelle. | Ja |
Benutzerberechnungsdatenquellentyp
Der Typ der Datenquelle.
| Eigentum | Wert |
|---|---|
| Beschreibung | Der Typ der Datenquelle. |
| Typ | Schnur |
| Werte | DatasetUrls |
UserComputeUrl
URLs
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Segmentierung | Chunking-Einstellungen | Segmentierungseinstellungen | Nein | |
| Durchforstung | CrawlingSettings | Durchsuchungseinstellungen | Nein | |
| embeddings | array | Nein | ||
| freundlich | BenutzerBerechnungsDatenquellenTyp | Der Typ der Datenquelle. | Ja | |
| urls | array | Nein |
WandBIntegrationRequest
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Entität | Schnur | Nein | ||
| name | Schnur | Nein | ||
| Projekt | Schnur | Ja | ||
| Schlagwörter | array | Nein |
WandBIntegrationRequestWrapper
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| Typ | IntegrationTypes | Liste der verfügbaren Optimierungsintegrationen | Ja | |
| wandb | WandBIntegrationRequest | Ja |
WorkspaceConnection
Verbindung zum AML-Arbeitsbereich.
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connectionId | Schnur | ConnectionId | Nein | |
| freundlich | Verbindungstyp | Der Verbindungstyp. | Ja |
Einstellungen für das Einbetten von Arbeitsbereichsverbindungen
Verbindungs-ID des Einbettungsmodells
| Name | Typ | BESCHREIBUNG | Erforderlich | Standard |
|---|---|---|---|---|
| connectionId | Schnur | Nein | ||
| deploymentName | Schnur | Nein | ||
| Modellname | Schnur | Nein |
Nächste Schritte
Erfahren Sie mehr über Modelle und die Feinabstimmung mit der REST-API. Erfahren Sie mehr über die zugrunde liegenden Modelle, auf denen Azure OpenAI basiert.