Files - Import

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
2024-10-21

Vytvoří novou entitu souboru importem dat z zadané adresy URL. Nahrané soubory se dají například použít k trénování nebo vyhodnocování jemně vyladěných modelů.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
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

Name Vyžadováno Typ Description
api-key True

string

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

Text požadavku

Name Vyžadováno Typ Description
content_url True

string

Adresa URL pro stažení dokumentu (může to být adresa URL SAS objektu blob nebo jakékoli jiné externí adresy URL přístupné prostřednictvím požadavku GET).
filename True

string

Název řádků JSON soubor, který se má nahrát. Pokud je purpose nastavená na "doladění", každý řádek je záznam JSON s poli výzvy a dokončení představujícími vaše příklady trénování.

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

Importing a file with a blob url as source.

Ukázkový požadavek

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


{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}

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
FileImport

FileImport
FileState

FileState
InnerError

Vnitřní chyba
InnerErrorCode

InnerErrorCode
Purpose

Účel
TypeDiscriminator

Type Nábídka

Error

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

Zpráva o této chybě.
target

string

Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Kód chyby

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 zakázaná pro aktuální klíč uživatele nebo rozhraní API.
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 není aktuálně dostupná.
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 spustit ve stavu aktuálního prostředku.

ErrorResponse

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

Soubor

Name Typ Description
bytes

integer

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

Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)
filename

string

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.

FileImport

FileImport

Name Typ Description
content_url

string

Adresa URL pro stažení dokumentu (může to být adresa URL SAS objektu blob nebo jakékoli jiné externí adresy URL přístupné prostřednictvím požadavku GET).
filename

string

Název řádků JSON soubor, který se má nahrát. Pokud je purpose nastavená na "doladění", každý řádek je záznam JSON s poli výzvy a dokončení představujícími vaše příklady trénování.
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.

FileState

FileState

Name Typ Description
deleted

string

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

string

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

string

Operace dokončila zpracování s chybou a nelze ji dále využívat. Může být kategorizován jako stav terminálu.
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 byla úspěšně zpracována a je připravená k použití. Může být kategorizován jako stav terminálu.
running

string

Operace se začala zpracovávat. Může být kategorizován jako aktivní stav.
uploaded

string

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.

InnerError

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

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žívat v asistentech.
assistants_output

string

Tento soubor obsahuje výsledky asistenta.
batch

string

Tento soubor obsahuje vstupní data pro dávku.
batch_output

string

Tento soubor obsahuje výsledky dávky.
fine-tune

string

Tento soubor obsahuje trénovací data pro doladění úlohy.
fine-tune-results

string

Tento soubor obsahuje výsledky úlohy vyladění.

TypeDiscriminator

Type Nábídka

Name Typ Description
batch

string

Tento objekt představuje dávku.
file

string

Tento objekt představuje soubor.
fine_tuning.job

string

Tento objekt představuje doladění úlohy.
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 vyladění výsledku úlohy).
upload

string

Tento objekt představuje nahrání souboru.
upload.part

string

Tento objekt představuje část nahrávání souboru.