Files - Upload

Služba:

Azure AI Services

Verze rozhraní API:

2024-10-21

Vytvoří novou entitu souboru tak, že nahraje data z místního počítače. Nahrané soubory se dají například použít k trénování nebo vyhodnocování jemně vyladěných modelů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
file	formData	True	file	Získá nebo nastaví soubor pro nahrání do Azure OpenAI.
purpose	formData	True	Purpose	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.
endpoint	path	True	string (url)	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem účtu Azure OpenAI).
api-version	query	True	string	Požadovaná verze rozhraní API.

Hlavička požadavku

Media Types: "multipart/form-data"

Name	Vyžadováno	Typ	Description
api-key	True	string	Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Odpovědi

Name	Typ	Description
201 Created	File	Soubor byl úspěšně vytvořen. Hlavičky Location: string
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

api-key

Tady zadejte svůj klíč účtu Azure OpenAI služeb Cognitive Services.

Typ: apiKey
V: header

Příklady

Upload a file.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Error	Chyba
ErrorCode	Kód chyby
ErrorResponse	ErrorResponse
File	Soubor
FileState	FileState
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
Purpose	Účel
TypeDiscriminator	Type Nábídka

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Podrobnosti o chybě, pokud jsou k dispozici.
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Zpráva o této chybě.
target	string	Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Výčet

Kód chyby

Hodnota	Description
conflict	Požadovaná operace je v konfliktu s aktuálním stavem prostředku.
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.
forbidden	Operace je zakázaná pro aktuální klíč uživatele nebo rozhraní API.
notFound	Prostředek nebyl nalezen.
unexpectedEntityState	Operaci nelze spustit ve stavu aktuálního prostředku.
itemDoesAlreadyExist	Položka již existuje.
serviceUnavailable	Služba není aktuálně dostupná.
internalFailure	Vnitřní chyba. Zkuste to prosím znovu.
quotaExceeded	Kvóta byla překročena.
jsonlValidationFailed	Ověření dat jsonl se nezdařilo.
fileImportFailed	Import souboru se nezdařil.
tooManyRequests	Příliš mnoho požadavků. Zkuste to prosím znovu později.
unauthorized	Aktuální klíč uživatele nebo rozhraní API není pro operaci autorizovaný.
contentFilter	Generování obrázků selhalo v důsledku našeho bezpečnostního systému.

ErrorResponse

Objekt

ErrorResponse

Name	Typ	Description
error	Error	Chyba Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Objekt

Soubor

Name	Typ	Description
bytes	integer (int64)	Velikost tohoto souboru, pokud je k dispozici (může mít hodnotu null). Soubory větší než 2^53-1 nejsou podporovány, aby byla zajištěna kompatibilita s celými čísly Jazyka JavaScript.
created_at	integer (unixtime)	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)
filename	string minLength: 1	Název souboru.
id	string	Identita této položky.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.
purpose	Purpose	Účel Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.
status	FileState	FileState Stav souboru.
status_details	string	Chybová zpráva s podrobnostmi v případě, že zpracování tohoto souboru selhalo.

FileState

Výčet

FileState

Hodnota	Description
uploaded	Soubor se nahrál, ale zatím ho nezpracoval. Azure OpenAI tento stav nevrátá a z důvodu kompatibility je vystavený. Může být kategorizován jako neaktivní stav.
pending	Operace byla vytvořena a není zařazena do fronty ke zpracování v budoucnu. Může být kategorizován jako neaktivní stav.
running	Operace se začala zpracovávat. Může být kategorizován jako aktivní stav.
processed	Operace byla úspěšně zpracována a je připravená k použití. Může být kategorizován jako stav terminálu.
error	Operace dokončila zpracování s chybou a nelze ji dále využívat. Může být kategorizován jako stav terminálu.
deleting	Entita je ni proces, který se má odstranit. Azure OpenAI tento stav nevrátá a z důvodu kompatibility je vystavený. Může být kategorizován jako aktivní stav.
deleted	Entita byla odstraněna, ale ostatní entity před odstraněním mohou být stále odkazovány. Může být kategorizován jako stav terminálu.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Vnitřní kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	Vnitřní chyba Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Výčet

InnerErrorCode

Hodnota	Description
invalidPayload	Data požadavku jsou pro tuto operaci neplatná.

Purpose

Výčet

Účel

Hodnota	Description
fine-tune	Tento soubor obsahuje trénovací data pro doladění úlohy.
fine-tune-results	Tento soubor obsahuje výsledky úlohy vyladění.
assistants	Tento soubor obsahuje data, která se mají používat v asistentech.
assistants_output	Tento soubor obsahuje výsledky asistenta.
batch	Tento soubor obsahuje vstupní data pro dávku.
batch_output	Tento soubor obsahuje výsledky dávky.

TypeDiscriminator

Výčet

Type Nábídka

Hodnota	Description
list	Tento objekt představuje seznam dalších objektů.
fine_tuning.job	Tento objekt představuje doladění úlohy.
file	Tento objekt představuje soubor.
fine_tuning.job.event	Tento objekt představuje událost úlohy jemného ladění.
fine_tuning.job.checkpoint	Tento objekt představuje kontrolní bod úlohy jemného ladění.
model	Tento objekt představuje model (může to být základní model nebo vyladění výsledku úlohy).
batch	Tento objekt představuje dávku.
upload	Tento objekt představuje nahrání souboru.
upload.part	Tento objekt představuje část nahrávání souboru.