Dela via


Files - Upload

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-02-15-preview

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 för 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 inträffade.

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-02-15-preview

Exempelsvar

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

Definitioner

Name Description
Error

Fel

ErrorCode

Felkod

ErrorResponse

ErrorResponse

File

Fil

FileState

FileState

InnerError

InnerError

InnerErrorCode

InnerErrorCode

Purpose

Syfte

TypeDiscriminator

TypeDiscriminator

Error

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder som definieras 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

Meddelandet om det här felet.

target

string

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

ErrorCode

Felkod

Name Typ Description
conflict

string

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

contentFilter

string

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

fileImportFailed

string

Det gick inte att importera filen.

forbidden

string

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

internalFailure

string

Internt fel. Försök igen.

invalidPayload

string

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

itemDoesAlreadyExist

string

Objektet finns redan.

jsonlValidationFailed

string

Verifieringen av jsonl-data misslyckades.

notFound

string

Det går inte att hitta resursen.

quotaExceeded

string

Kvoten har överskridits.

serviceUnavailable

string

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

tooManyRequests

string

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

unauthorized

string

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

unexpectedEntityState

string

Det går inte att utföra åtgärden i den aktuella resursens tillstånd.

ErrorResponse

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

Fil

Name Typ Description
bytes

integer

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

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

filename

string

Namnet på filen.

id

string

Identiteten för det här objektet.

object

TypeDiscriminator

TypeDiscriminator
Definierar typen av ett objekt.

purpose

Purpose

Syfte
Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet för 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

FileState

Name Typ Description
deleted

string

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

deleting

string

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.

error

string

Åtgärden har slutfört bearbetningen med ett fel och kan inte användas ytterligare. Det kan kategoriseras som ett terminaltillstånd.

pending

string

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

processed

string

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

running

string

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

uploaded

string

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

InnerError

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

InnerErrorCode

Name Typ Description
invalidPayload

string

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

Purpose

Syfte

Name Typ Description
assistants

string

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

assistants_output

string

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

fine-tune

string

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

fine-tune-results

string

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

TypeDiscriminator

TypeDiscriminator

Name Typ Description
file

string

Det här objektet representerar en fil.

fine_tuning.job

string

Det här objektet representerar ett finjusterat jobb.

fine_tuning.job.event

string

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

list

string

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

model

string

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