Delen via


Files - Upload

Hiermee maakt u een nieuwe bestandsentiteit door gegevens van een lokale computer te uploaden. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van nauwkeurig afgestemde modellen.

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

URI-parameters

Name In Vereist Type Description
file
formData True

file

Hiermee haalt u het bestand op of stelt u het in om te uploaden naar Azure OpenAI.

purpose
formData True

Purpose

Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hierdoor kunnen we de indeling van het geüploade bestand valideren.

endpoint
path True

string (url)

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).

api-version
query True

string

De aangevraagde API-versie.

Aanvraagkoptekst

Media Types: "multipart/form-data"

Name Vereist Type Description
api-key True

string

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Antwoorden

Name Type Description
201 Created

File

Het bestand is gemaakt.

Kopteksten

Location: string

Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

Voorbeelden

Upload a file.

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Error

Fout

ErrorCode

Foutcode

ErrorResponse

ErrorResponse

File

Bestand

FileState

FileState

InnerError

InnerError

InnerErrorCode

InnerErrorCode

Purpose

Doel

TypeDiscriminator

TypeDiscriminator

Error

Fout

Name Type Description
code

ErrorCode

Foutcode
Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

details

Error[]

De foutdetails indien beschikbaar.

innererror

InnerError

InnerError
Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

message

string

minLength: 1

Het bericht van deze fout.

target

string

De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Foutcode

Waarde Description
conflict

De aangevraagde bewerking conflicteert met de huidige resourcestatus.

contentFilter

Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.

fileImportFailed

Importeren van bestand is mislukt.

forbidden

De bewerking is verboden voor de huidige gebruiker/API-sleutel.

internalFailure

Interne fout. Probeer het opnieuw.

invalidPayload

De aanvraaggegevens zijn ongeldig voor deze bewerking.

itemDoesAlreadyExist

Het item bestaat al.

jsonlValidationFailed

Validatie van jsonl-gegevens is mislukt.

notFound

De resource is niet gevonden.

quotaExceeded

Het quotum is overschreden.

serviceUnavailable

De service is momenteel niet beschikbaar.

tooManyRequests

Te veel aanvragen. Probeer het later opnieuw.

unauthorized

De huidige sleutel van de gebruiker/API is niet geautoriseerd voor de bewerking.

unexpectedEntityState

De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

ErrorResponse

Name Type Description
error

Error

Fout
Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Bestand

Name Type Description
bytes

integer (int64)

De grootte van dit bestand indien beschikbaar (kan null zijn). Bestandsgrootten groter dan 2^53-1 worden niet ondersteund om compatibiliteit met JavaScript-gehele getallen te garanderen.

created_at

integer (unixtime)

Een tijdstempel waarin deze taak of dit item is gemaakt (in unix-epochs).

filename

string

minLength: 1

De naam van het bestand.

id

string

De identiteit van dit item.

object

TypeDiscriminator

TypeDiscriminator
Hiermee definieert u het type van een object.

purpose

Purpose

Doel
Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hierdoor kunnen we de indeling van het geüploade bestand valideren.

status

FileState

FileState
De status van een bestand.

status_details

string

Het foutbericht met details voor het geval de verwerking van dit bestand is mislukt.

FileState

FileState

Waarde Description
deleted

De entiteit is verwijderd, maar kan nog steeds worden verwezen door andere entiteiten die de verwijdering voorafgaan. Deze kan worden gecategoriseerd als een terminalstatus.

deleting

De entiteit is ni het proces dat moet worden verwijderd. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gemaakt voor compatibiliteit. Deze kan worden gecategoriseerd als een actieve status.

error

De bewerking is voltooid met een fout en kan niet verder worden verbruikt. Deze kan worden gecategoriseerd als een terminalstatus.

pending

De bewerking is gemaakt en wordt niet in de wachtrij geplaatst om in de toekomst te worden verwerkt. Deze kan worden gecategoriseerd als een inactieve status.

processed

De bewerking is verwerkt en is gereed voor gebruik. Deze kan worden gecategoriseerd als een terminalstatus.

running

De bewerking is gestart. Deze kan worden gecategoriseerd als een actieve status.

uploaded

Het bestand is geüpload, maar is nog niet verwerkt. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gemaakt voor compatibiliteit. Deze kan worden gecategoriseerd als een inactieve status.

InnerError

InnerError

Name Type Description
code

InnerErrorCode

InnerErrorCode
Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

innererror

InnerError

InnerError
Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Waarde Description
invalidPayload

De aanvraaggegevens zijn ongeldig voor deze bewerking.

Purpose

Doel

Waarde Description
assistants

Dit bestand bevat gegevens die moeten worden gebruikt in assistenten.

assistants_output

Dit bestand bevat de resultaten van een assistent.

batch

Dit bestand bevat de invoergegevens voor een batch.

batch_output

Dit bestand bevat de resultaten van een batch.

fine-tune

Dit bestand bevat trainingsgegevens voor een taak voor het verfijnen van de taak.

fine-tune-results

Dit bestand bevat de resultaten van een taak voor het afstemmen.

TypeDiscriminator

TypeDiscriminator

Waarde Description
batch

Dit object vertegenwoordigt een batch.

file

Dit object vertegenwoordigt een bestand.

fine_tuning.job

Dit object vertegenwoordigt een taak voor het afstemmen.

fine_tuning.job.checkpoint

Dit object vertegenwoordigt een controlepunt van een taak voor het afstemmen.

fine_tuning.job.event

Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.

list

Dit object vertegenwoordigt een lijst met andere objecten.

model

Dit object vertegenwoordigt een model (kan een basismodel zijn of taakresultaat verfijnen).

upload

Dit object vertegenwoordigt een bestand uploaden.

upload.part

Dit object vertegenwoordigt een deel van een bestandsupload.