Files - Upload

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-05-01-preview

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

POST {endpoint}/openai/files?api-version=2024-05-01-preview

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ů. Pro doladění použijte "fine-tune". 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 vašeho úč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 klíč účtu Cognitive Services Azure OpenAI.

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ě.

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 klíč účtu Cognitive Services Azure OpenAI.

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-05-01-preview

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	ErrorCode
ErrorResponse	ErrorResponse
File	File
FileState	FileState
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
Purpose	Účel
TypeDiscriminator	TypeDiskriminor

Error

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode Kódy chyb definované v pokynech microsoftu 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	Zpráva o této chybě.
target	string	Umístění, ve kterém došlo k chybě, pokud je k dispozici.

ErrorCode

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

ErrorResponse

Name	Typ	Description
error	Error	Chyba Obsah chyby, jak je definováno v pokynech microsoftu REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Name	Typ	Description
bytes	integer	Velikost tohoto souboru, pokud je k dispozici (může být null). Soubory větší než 2^53-1 se kvůli zajištění kompatibility s celými čísly JavaScriptu nepodporují.
created_at	integer	Časové razítko, kdy byla tato úloha nebo položka vytvořena (v unixových epochách).
filename	string	Název souboru.
id	string	Identita této položky
object	TypeDiscriminator	TypeDiskriminor Definuje typ objektu.
purpose	Purpose	Účel Zamýšlený účel nahraných dokumentů. Pro doladění použijte "fine-tune". 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

Name	Typ	Description
deleted	string	Entita byla odstraněna, ale může být stále odkazována jinými entitami, které před odstraněním. Lze ho zařadit do kategorie terminálového stavu.
deleting	string	Entita je proces, který se má odstranit. Azure OpenAI tento stav nevrátá a zobrazuje se pouze kvůli kompatibilitě. Může být kategorizován jako aktivní stav.
error	string	Operace dokončila zpracování s chybou a nelze ji dále využívat. Lze ho zařadit do kategorie terminálového stavu.
pending	string	Operace byla vytvořena a není zařazena do fronty ke zpracování v budoucnu. Může být kategorizován jako neaktivní stav.
processed	string	Operace se úspěšně zpracovala a je připravená ke spotřebě. Lze ho zařadit do kategorie terminálového stavu.
running	string	Operace se začala zpracovávat. Může být kategorizován jako aktivní stav.
uploaded	string	Soubor byl nahrán, ale ještě není zpracován. Azure OpenAI tento stav nevrátá a zobrazuje se pouze kvůli kompatibilitě. Může být kategorizován jako neaktivní stav.

InnerError

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Kódy vnitřních chyb definované v pokynech microsoftu 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

Name	Typ	Description
invalidPayload	string	Data požadavku jsou pro tuto operaci neplatná.

Purpose

Účel

Name	Typ	Description
assistants	string	Tento soubor obsahuje data, která se mají použít v asistentech.
assistants_output	string	Tento soubor obsahuje výsledky asistent.
fine-tune	string	Tento soubor obsahuje trénovací data pro úlohu jemného ladění.
fine-tune-results	string	Tento soubor obsahuje výsledky úlohy jemného ladění.

TypeDiscriminator

TypeDiskriminor

Name	Typ	Description
file	string	Tento objekt představuje soubor.
fine_tuning.job	string	Tento objekt představuje úlohu jemného ladění.
fine_tuning.job.checkpoint	string	Tento objekt představuje kontrolní bod úlohy jemného ladění.
fine_tuning.job.event	string	Tento objekt představuje událost úlohy jemného ladění.
list	string	Tento objekt představuje seznam dalších objektů.
model	string	Tento objekt představuje model (může to být základní model nebo výsledek úlohy jemného ladění).

Sdílet prostřednictvím

Files - Upload

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

api-key

Příklady

Upload a file.

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorCode

ErrorResponse

File

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Další materiály