Freigeben über


Files - Upload

Erstellt eine neue Dateientität, indem Daten von einem lokalen Computer hochgeladen werden. Hochgeladene Dateien können beispielsweise zum Trainieren oder Auswerten fein abgestimmter Modelle verwendet werden.

POST {endpoint}/openai/files?api-version=2024-02-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
file
formData True

file

Ruft die Datei ab, die in Azure OpenAI hochgeladen werden soll, oder legt sie fest.

purpose
formData True

Purpose

Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie "Fine-Tune" für die Feinabstimmung. Dadurch können wir das Format der hochgeladenen Datei überprüfen.

endpoint
path True

string

url

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch den Namen Ihres Azure OpenAI-Kontos).

api-version
query True

string

Die angeforderte API-Version.

Anforderungsheader

Media Types: "multipart/form-data"

Name Erforderlich Typ Beschreibung
api-key True

string

Geben Sie hier Ihren Cognitive Services Azure OpenAI-Kontoschlüssel an.

Antworten

Name Typ Beschreibung
201 Created

File

Die Datei wurde erfolgreich erstellt.

Header

Location: string

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten.

Sicherheit

api-key

Geben Sie hier Ihren Cognitive Services Azure OpenAI-Kontoschlüssel an.

Typ: apiKey
In: header

Beispiele

Upload a file.

Beispielanforderung

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-02-01

Beispiel für eine Antwort

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "status": "notRunning",
  "created_at": 1646126127,
  "object": "file"
}

Definitionen

Name Beschreibung
Error

Fehler

ErrorCode

ErrorCode

ErrorResponse

ErrorResponse

File

Datei

FileState

FileState

InnerError

InnerError

InnerErrorCode

InnerErrorCode

Purpose

Zweck

TypeDiscriminator

TypeDiscriminator

Error

Fehler

Name Typ Beschreibung
code

ErrorCode

ErrorCode
Fehlercodes, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

details

Error[]

Die Fehlerdetails, falls verfügbar.

innererror

InnerError

InnerError
Innerer Fehler, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

message

string

Die Meldung dieses Fehlers.

target

string

Der Speicherort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

ErrorCode

Name Typ Beschreibung
conflict

string

Der angeforderte Vorgang wird mit dem aktuellen Ressourcenstatus in Konflikt gestellt.

contentFilter

string

Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.

fileImportFailed

string

Fehler beim Importieren der Datei.

forbidden

string

Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel verboten.

internalFailure

string

Interner Fehler. Versuchen Sie es erneut.

invalidPayload

string

Die Anforderungsdaten sind für diesen Vorgang ungültig.

itemDoesAlreadyExist

string

Das Element ist bereits vorhanden.

jsonlValidationFailed

string

Fehler bei der Überprüfung von JSONL-Daten.

notFound

string

Die Ressource wurde nicht gefunden.

quotaExceeded

string

Kontingent überschritten.

serviceUnavailable

string

Der Dienst ist derzeit nicht verfügbar.

tooManyRequests

string

Too many requests. (Zu viele Anforderungen.) Versuchen Sie es später noch mal.

unauthorized

string

Der aktuelle Benutzer-/API-Schlüssel ist nicht für den Vorgang autorisiert.

unexpectedEntityState

string

Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

ErrorResponse

Name Typ Beschreibung
error

Error

Fehler
Fehlerinhalt gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Datei

Name Typ Beschreibung
bytes

integer

Die Größe dieser Datei, sofern 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 zu gewährleisten.

created_at

integer

Ein Zeitstempel, bei dem dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen).

filename

string

Der Name der Datei.

id

string

Die Identität dieses Elements.

object

TypeDiscriminator

TypeDiscriminator
Definiert den Typ eines Objekts.

purpose

Purpose

Zweck
Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie "Fine-Tune" für die Feinabstimmung. Dadurch können wir das Format der hochgeladenen Datei überprüfen.

status

FileState

FileState
Der Status einer Datei.

status_details

string

Die Fehlermeldung mit Details für den Fall, dass die Verarbeitung dieser Datei fehlgeschlagen ist.

FileState

FileState

Name Typ Beschreibung
deleted

string

Die Entität wurde gelöscht, kann aber weiterhin von anderen Entitäten referenziert werden, die vor dem Löschen stehen. Es kann als Terminalzustand kategorisiert werden.

deleting

string

Die Entität ist der zu löschende Prozess. Dieser Zustand wird von Azure OpenAI nicht zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Es kann als aktiver Zustand kategorisiert werden.

error

string

Der Vorgang hat die Verarbeitung mit einem Fehler abgeschlossen und kann nicht weiter genutzt werden. Es kann als Terminalzustand kategorisiert werden.

pending

string

Der Vorgang wurde erstellt und wird nicht in die Warteschlange gestellt, um in Zukunft verarbeitet zu werden. Es kann als inaktiver Zustand kategorisiert werden.

processed

string

Der Vorgang wurde erfolgreich verarbeitet und ist einsatzbereit. Es kann als Terminalzustand kategorisiert werden.

running

string

Der Vorgang wurde mit der Verarbeitung begonnen. Es kann als aktiver Zustand kategorisiert werden.

uploaded

string

Die Datei wurde hochgeladen, aber noch nicht verarbeitet. Dieser Zustand wird von Azure OpenAI nicht zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Es kann als inaktiver Zustand kategorisiert werden.

InnerError

InnerError

Name Typ Beschreibung
code

InnerErrorCode

InnerErrorCode
Interne Fehlercodes, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

innererror

InnerError

InnerError
Innerer Fehler, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

InnerErrorCode

InnerErrorCode

Name Typ Beschreibung
invalidPayload

string

Die Anforderungsdaten sind für diesen Vorgang ungültig.

Purpose

Zweck

Name Typ Beschreibung
fine-tune

string

Diese Datei enthält Trainingsdaten für einen Feinabstimmungsauftrag.

fine-tune-results

string

Diese Datei enthält die Ergebnisse eines Feinabstimmungsauftrags.

TypeDiscriminator

TypeDiscriminator

Name Typ Beschreibung
file

string

Dieses Objekt stellt eine Datei dar.

fine-tune

string

Dieses Objekt stellt einen Feinabstimmungsauftrag dar.

fine-tune-event

string

Dieses Objekt stellt ein Ereignis eines Feinabstimmungsauftrags dar.

fine_tuning.job

string

Dieses Objekt stellt einen Feinabstimmungsauftrag dar.

fine_tuning.job.event

string

Dieses Objekt stellt ein Ereignis eines Feinoptimierungsauftrags dar.

list

string

Dieses Objekt stellt eine Liste anderer Objekte dar.

model

string

Dieses Objekt stellt ein Modell dar (kann ein Basismodell oder ein Feinabstimmungsauftragsergebnis sein).