Files - Import

Referenz

Service:: Azure AI Services

API Version:: 2024-02-01

Erstellt eine neue Dateientität, indem Daten aus einer angegebenen URL importiert werden. Hochgeladene Dateien können beispielsweise zum Trainieren oder Auswerten von optimierten Modellen verwendet werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Geben Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services an.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
content_url	True	string	Die URL, aus der das Dokument heruntergeladen werden soll (kann die SAS-URL eines Blobs oder eine andere externe URL sein, auf die mit einer GET-Anforderung zugegriffen werden kann).
filename	True	string	Der Name der json-Zeilendatei , die hochgeladen werden soll. Wenn auf `purpose` "Feinabstimmung" festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern "prompt" und "completion", die Ihre Trainingsbeispiele darstellen.
purpose	True	Purpose	Zweck Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie "Feinabstimmung" für die Feinabstimmung. Dadurch können wir das Format der hochgeladenen Datei überprüfen.

Antworten

Name	Typ	Beschreibung
201 Created	File	Die Datei wurde erfolgreich erstellt. Headers Location: string
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

201 Created

File

Die Datei wurde erfolgreich erstellt.

Headers

Location: string

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten.

Sicherheit

api-key

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

Type: apiKey
In: header

Beispiele

Importing a file with a blob url as source.

Sample Request

HTTP

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


{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}

Sample Response

Status code:: 201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

Response Body

{
  "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
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Zweck
TypeDiscriminator	TypeDiscriminator

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Fehlercodes gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
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

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist in Konflikt mit dem aktuellen Ressourcenzustand.
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 unzulässig.
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

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 sicherzustellen.
created_at	integer	Ein Zeitstempel, wenn 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 "Feinabstimmung" 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 zum Fehler bei der Verarbeitung dieser Datei.

FileImport

Name	Typ	Beschreibung
content_url	string	Die URL, aus der das Dokument heruntergeladen werden soll (kann die SAS-URL eines Blobs oder eine andere externe URL sein, auf die mit einer GET-Anforderung zugegriffen werden kann).
filename	string	Der Name der json-Zeilendatei , die hochgeladen werden soll. Wenn auf `purpose` "Feinabstimmung" festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern "prompt" und "completion", die Ihre Trainingsbeispiele darstellen.
purpose	Purpose	Zweck Der Verwendungszweck der hochgeladenen Dokumente. Verwenden Sie "Feinabstimmung" für die Feinabstimmung. Dadurch können wir das Format der hochgeladenen Datei überprüfen.

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 Endzustand 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 Endzustand 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 kann verwendet werden. Es kann als Endzustand kategorisiert werden.
running	string	Die Verarbeitung des Vorgangs wurde gestartet. 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

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Interne Fehlercodes, wie in den Microsoft REST-Richtlinien definiert (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
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

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

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).

Files - Import

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

api-key

Beispiele

Importing a file with a blob url as source.

Sample Request

Sample Response

Definitionen

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Zusätzliche Ressourcen