Dela via

Files - Upload

Tjänst:
Azure AI Services
API-version:
2024-10-21

Skapar en ny filentitet genom att ladda upp data från en lokal dator. Uppladdade filer kan till exempel användas för träning eller utvärdering av finjusterade modeller.

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

URI-parametrar

Name I Obligatorisk Typ Description
file
 formData True

file

Hämtar eller ställer in filen som ska laddas upp till Azure OpenAI.
purpose
 formData True

Purpose

Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.
endpoint
 path True

string (url)

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
api-version
 query True

string

Den begärda API-versionen.

Begärandehuvud

Media Types: "multipart/form-data"

Name Obligatorisk Typ Description
api-key True

string

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Svar

Name Typ Description
201 Created

File

Filen har skapats.

Sidhuvuden

Location: string
Other Status Codes

ErrorResponse

Ett fel uppstod.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Typ: apiKey
I: header

Exempel

Upload a file.

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Error

Fel
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
File

Fil
FileState

FileState
InnerError

InnerError
InnerErrorCode

InnerErrorCode
Purpose

Avsikt
TypeDiscriminator

TypeDiscriminator

Error

Objekt

Fel

Name Typ Description
code

ErrorCode

ErrorCode
Felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Felinformationen om den är tillgänglig.
innererror

InnerError

InnerError
Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Meddelandet om det här felet.
target

string

Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Uppräkning

ErrorCode

Värde Description
conflict

Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.
forbidden

Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
notFound

Det går inte att hitta resursen.
unexpectedEntityState

Åtgärden kan inte köras i den aktuella resursens tillstånd.
itemDoesAlreadyExist

Objektet finns redan.
serviceUnavailable

Tjänsten är inte tillgänglig för närvarande.
internalFailure

Internt fel. Försök igen.
quotaExceeded

Kvoten har överskridits.
jsonlValidationFailed

Verifieringen av jsonl-data misslyckades.
fileImportFailed

Det gick inte att importera filen.
tooManyRequests

För många begäranden. Försök igen senare.
unauthorized

Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
contentFilter

Bildgenereringen misslyckades till följd av vårt säkerhetssystem.

ErrorResponse

Objekt

ErrorResponse

Name Typ Description
error

Error

Fel
Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Objekt

Fil

Name Typ Description
bytes

integer (int64)

Storleken på den här filen när den är tillgänglig (kan vara null). Filstorlekar som är större än 2^53-1 stöds inte för att säkerställa kompatibilitet med JavaScript-heltal.
created_at

integer (unixtime)

En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).
filename

string

minLength: 1

Namnet på filen.
id

string

Identiteten för det här objektet.
object

TypeDiscriminator

TypeDiscriminator
Definierar typen av ett objekt.
purpose

Purpose

Avsikt
Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.
status

FileState

FileState
Tillståndet för en fil.
status_details

string

Felmeddelandet med information om bearbetningen av den här filen misslyckades.

FileState

Uppräkning

FileState

Värde Description
uploaded

Filen har laddats upp men den har ännu inte bearbetats. Det här tillståndet returneras inte av Azure OpenAI och exponeras endast för kompatibilitet. Den kan kategoriseras som ett inaktivt tillstånd.
pending

Åtgärden skapades och är inte i kö för att bearbetas i framtiden. Den kan kategoriseras som ett inaktivt tillstånd.
running

Åtgärden har börjat bearbetas. Det kan kategoriseras som ett aktivt tillstånd.
processed

Åtgärden har bearbetats och är klar för förbrukning. Den kan kategoriseras som ett terminaltillstånd.
error

Åtgärden har slutfört bearbetningen med ett fel och kan inte förbrukas ytterligare. Den kan kategoriseras som ett terminaltillstånd.
deleting

Entiteten är den process som ska tas bort. Det här tillståndet returneras inte av Azure OpenAI och exponeras endast för kompatibilitet. Det kan kategoriseras som ett aktivt tillstånd.
deleted

Entiteten har tagits bort men kan fortfarande refereras av andra entiteter som föregått borttagningen. Den kan kategoriseras som ett terminaltillstånd.

InnerError

Objekt

InnerError

Name Typ Description
code

InnerErrorCode

InnerErrorCode
Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Uppräkning

InnerErrorCode

Värde Description
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.

Purpose

Uppräkning

Avsikt

Värde Description
fine-tune

Den här filen innehåller träningsdata för ett finjusterat jobb.
fine-tune-results

Den här filen innehåller resultatet av ett finjusterat jobb.
assistants

Den här filen innehåller data som ska användas i assistenter.
assistants_output

Den här filen innehåller resultatet av en assistent.
batch

Den här filen innehåller indata för en batch.
batch_output

Den här filen innehåller resultatet av en batch.

TypeDiscriminator

Uppräkning

TypeDiscriminator

Värde Description
list

Det här objektet representerar en lista över andra objekt.
fine_tuning.job

Det här objektet representerar ett finjusterat jobb.
file

Det här objektet representerar en fil.
fine_tuning.job.event

Det här objektet representerar en händelse av ett finjusteringsjobb.
fine_tuning.job.checkpoint

Det här objektet representerar en kontrollpunkt för ett finjusteringsjobb.
model

Det här objektet representerar en modell (kan vara en basmodell eller finjustera jobbresultatet).
batch

Det här objektet representerar en batch.
upload

Det här objektet representerar en filuppladdning.
upload.part

Det här objektet representerar en del av en filuppladdning.