Files - Import

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-10-21

Erstellt eine neue Dateientität, indem Daten aus einer bereitgestellten URL importiert werden. Hochgeladene Dateien können z. B. für Schulungen oder die Auswertung fein abgestimmter Modelle verwendet werden.

POST {endpoint}/openai/files/import?api-version=2024-10-21

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 Ihren Azure OpenAI-Kontonamen.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

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

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 Lines Datei, die hochgeladen werden soll. Wenn die `purpose` auf "Feinabstimmung" festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern "Eingabeaufforderung" und "Abschluss", die Ihre Schulungsbeispiele darstellen.

Antworten

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

Name

Typ

Beschreibung

201 Created

File

Die Datei wurde erfolgreich erstellt.

Header

Location: string

Other Status Codes

ErrorResponse

Fehler.

Sicherheit

api-key

Stellen Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services bereit.

Typ: apiKey
In: header

Beispiele

Importing a file with a blob url as source.

Beispielanforderung

HTTP

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


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

Beispiel für eine Antwort

Statuscode:: 201

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

{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "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 gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Die Meldung dieses Fehlers.
target	string	Der Ort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist mit dem aktuellen Ressourcenstatus in Konflikt.
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	Das Kontingent wurde überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Zu viele Anforderungen. Versuchen Sie es später erneut.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist für den Vorgang nicht autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

Name	Typ	Beschreibung
error	Error	Fehler Fehlerinhalte gemäß 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, 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.
created_at	integer	Ein Zeitstempel, zu 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 beabsichtigte Zweck der hochgeladenen Dokumente. Verwenden Sie "Feinabstimmung" für feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen.
status	FileState	FileState Der Status einer Datei.
status_details	string	Die Fehlermeldung mit Details bei der Verarbeitung dieser Datei ist fehlgeschlagen.

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 Lines Datei, die hochgeladen werden soll. Wenn die `purpose` auf "Feinabstimmung" festgelegt ist, ist jede Zeile ein JSON-Eintrag mit den Feldern "Eingabeaufforderung" und "Abschluss", die Ihre Schulungsbeispiele darstellen.
purpose	Purpose	Zweck Der beabsichtigte Zweck der hochgeladenen Dokumente. Verwenden Sie "Feinabstimmung" für feinabstimmungen. Auf diese Weise können wir das Format der hochgeladenen Datei überprüfen.

FileState

Name	Typ	Beschreibung
deleted	string	Die Entität wurde gelöscht, kann jedoch weiterhin von anderen Entitäten referenziert werden, die das Löschen voranstellen. Sie kann als Terminalzustand kategorisiert werden.
deleting	string	Die Entität ist ni der zu löschende Prozess. Dieser Zustand wird nicht von Azure OpenAI zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Sie kann als aktiver Zustand kategorisiert werden.
error	string	Der Vorgang hat die Verarbeitung mit einem Fehler abgeschlossen und kann nicht weiter verbraucht werden. Sie kann als Terminalzustand kategorisiert werden.
pending	string	Der Vorgang wurde erstellt und wird nicht in die Warteschlange eingereiht, die in Zukunft verarbeitet werden soll. Sie kann als inaktiver Zustand kategorisiert werden.
processed	string	Der Vorgang wurde erfolgreich verarbeitet und ist einsatzbereit. Sie kann als Terminalzustand kategorisiert werden.
running	string	Der Vorgang wurde gestartet, um verarbeitet zu werden. Sie kann als aktiver Zustand kategorisiert werden.
uploaded	string	Die Datei wurde hochgeladen, ist aber noch nicht verarbeitet. Dieser Zustand wird nicht von Azure OpenAI zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Sie kann als inaktiver Zustand kategorisiert werden.

InnerError

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Innere Fehlercodes gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Beschreibung
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.

Purpose

Zweck

Name	Typ	Beschreibung
assistants	string	Diese Datei enthält Daten, die in Assistenten verwendet werden sollen.
assistants_output	string	Diese Datei enthält die Ergebnisse eines Assistenten.
batch	string	Diese Datei enthält die Eingabedaten für einen Batch.
batch_output	string	Diese Datei enthält die Ergebnisse eines Batches.
fine-tune	string	Diese Datei enthält Schulungsdaten für einen Feinabstimmungsauftrag.
fine-tune-results	string	Diese Datei enthält die Ergebnisse eines Feinabstimmungsauftrags.

TypeDiscriminator

Name	Typ	Beschreibung
batch	string	Dieses Objekt stellt einen Batch dar.
file	string	Dieses Objekt stellt eine Datei dar.
fine_tuning.job	string	Dieses Objekt stellt einen Feinabstimmungsauftrag dar.
fine_tuning.job.checkpoint	string	Dieses Objekt stellt einen Prüfpunkt eines Feinabstimmungsauftrags dar.
fine_tuning.job.event	string	Dieses Objekt stellt ein Ereignis eines Feinabstimmungsauftrags 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).
upload	string	Dieses Objekt stellt einen Dateiupload dar.
upload.part	string	Dieses Objekt stellt einen Teil eines Dateiuploads dar.

Freigeben über

Files - Import

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

api-key

Beispiele

Importing a file with a blob url as source.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Zusätzliche Ressourcen