Files - Import

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2024-10-21

Új fájlentitást hoz létre egy megadott URL-címről származó adatok importálásával. A feltöltött fájlok például használhatók a finomhangolt modellek betanítására vagy kiértékelésére.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string url	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://aoairesource.openai.azure.com. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-fiók nevére.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
api-key	True	string	Itt adja meg a Cognitive Services Azure OpenAI-fiókkulcsát.

Kérelem törzse

Name	Kötelező	Típus	Description
content_url	True	string	A dokumentum letöltésének URL-címe (lehet egy blob SAS-url-címe vagy bármely más, GET-kéréssel elérhető külső URL-cím).
filename	True	string	A feltöltendő JSON-sorok fájl neve. Ha a `purpose` "finomhangolásra" van állítva, minden sor egy JSON-rekord, amely a betanítási példákat ábrázoló "prompt" és "completion" mezőkkel rendelkezik.

Válaszok

Name	Típus	Description
201 Created	File	A fájl létrehozása sikeresen megtörtént. Fejlécek Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Name

Típus

Description

201 Created

File

A fájl létrehozása sikeresen megtörtént.

Fejlécek

Location: string

Other Status Codes

ErrorResponse

Hiba történt.

Biztonság

api-key

Itt adja meg a Cognitive Services Azure OpenAI-fiókkulcsát.

Típus: apiKey
In: header

Példák

Importing a file with a blob url as source.

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
}

Definíciók

Name	Description
Error	Hiba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Fájl
FileImport	Fájlimport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Cél
TypeDiscriminator	TypeDiscriminator

Error

Hiba

Name	Típus	Description
code	ErrorCode	ErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibakódok.
details	Error[]	A hiba részletei, ha elérhetők.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.
message	string	A hiba üzenete.
target	string	Az a hely, ahol a hiba történt, ha elérhető.

ErrorCode

Name	Típus	Description
conflict	string	A kért művelet ütközik az aktuális erőforrásállapottal.
contentFilter	string	A rendszerkép létrehozása a biztonsági rendszerünk miatt meghiúsult.
fileImportFailed	string	A fájl importálása nem sikerült.
forbidden	string	A művelet az aktuális felhasználói/API-kulcs esetében tilos.
internalFailure	string	Belső hiba. Próbálkozzon újra.
invalidPayload	string	A kérelem adatai érvénytelenek ehhez a művelethez.
itemDoesAlreadyExist	string	Az elem már létezik.
jsonlValidationFailed	string	A jsonl-adatok ellenőrzése nem sikerült.
notFound	string	Az erőforrás nem található.
quotaExceeded	string	A kvóta túllépve.
serviceUnavailable	string	A szolgáltatás jelenleg nem érhető el.
tooManyRequests	string	Túl sok kérés. Próbálkozzon újra később.
unauthorized	string	A művelethez nincs engedélyezve az aktuális felhasználói/API-kulcs.
unexpectedEntityState	string	A művelet nem hajtható végre az aktuális erőforrás állapotában.

ErrorResponse

Name	Típus	Description
error	Error	Hiba A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibatartalom.

File

Fájl

Name	Típus	Description
bytes	integer	A fájl mérete, ha elérhető (null lehet). A 2^53-1-nél nagyobb fájlméretek nem támogatottak a JavaScript-egész számokkal való kompatibilitás biztosítása érdekében.
created_at	integer	Időbélyeg a feladat vagy elem létrehozásakor (unix korszakokban).
filename	string	A fájl neve.
id	string	Az elem identitása.
object	TypeDiscriminator	TypeDiscriminator Meghatározza az objektum típusát.
purpose	Purpose	Cél A feltöltött dokumentumok rendeltetése. A finomhangoláshoz használja a "finomhangolást". Ez lehetővé teszi a feltöltött fájl formátumának ellenőrzését.
status	FileState	FileState A fájl állapota.
status_details	string	A fájl feldolgozásának sikertelensége esetén a részleteket tartalmazó hibaüzenet.

FileImport

Fájlimport

Name	Típus	Description
content_url	string	A dokumentum letöltésének URL-címe (lehet egy blob SAS-url-címe vagy bármely más, GET-kéréssel elérhető külső URL-cím).
filename	string	A feltöltendő JSON-sorok fájl neve. Ha a `purpose` "finomhangolásra" van állítva, minden sor egy JSON-rekord, amely a betanítási példákat ábrázoló "prompt" és "completion" mezőkkel rendelkezik.
purpose	Purpose	Cél A feltöltött dokumentumok rendeltetése. A finomhangoláshoz használja a "finomhangolást". Ez lehetővé teszi a feltöltött fájl formátumának ellenőrzését.

FileState

Name	Típus	Description
deleted	string	Az entitást törölték, de a törlést megelőző más entitások továbbra is hivatkozhatnak rá. Terminálállapotként kategorizálható.
deleting	string	Az entitás a törölni kívánt folyamat. Ezt az állapotot az Azure OpenAI nem adja vissza, és csak kompatibilitás céljából teszi közzé. Aktív állapotként kategorizálható.
error	string	A művelet sikertelen feldolgozással fejeződött be, és nem használható tovább. Terminálállapotként kategorizálható.
pending	string	A művelet létrejött, és a jövőben nem lesz feldolgozva. Inaktív állapotként kategorizálható.
processed	string	A művelet feldolgozása sikeresen megtörtént, és használatra kész. Terminálállapotként kategorizálható.
running	string	A művelet feldolgozása megkezdődött. Aktív állapotként kategorizálható.
uploaded	string	A fájl feltöltése megtörtént, de még nincs feldolgozva. Ezt az állapotot az Azure OpenAI nem adja vissza, és csak kompatibilitás céljából teszi közzé. Inaktív állapotként kategorizálható.

InnerError

Name	Típus	Description
code	InnerErrorCode	InnerErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hibakódok.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.

InnerErrorCode

Name	Típus	Description
invalidPayload	string	A kérelem adatai érvénytelenek ehhez a művelethez.

Purpose

Cél

Name	Típus	Description
assistants	string	Ez a fájl az asszisztensekben használandó adatokat tartalmazza.
assistants_output	string	Ez a fájl egy asszisztens eredményeit tartalmazza.
batch	string	Ez a fájl egy köteg bemeneti adatait tartalmazza.
batch_output	string	Ez a fájl egy köteg eredményeit tartalmazza.
fine-tune	string	Ez a fájl betanítási adatokat tartalmaz egy finomhangoló feladathoz.
fine-tune-results	string	Ez a fájl egy finomhangoló feladat eredményeit tartalmazza.

TypeDiscriminator

Name	Típus	Description
batch	string	Ez az objektum egy köteget jelöl.
file	string	Ez az objektum egy fájlt jelöl.
fine_tuning.job	string	Ez az objektum egy finomhangoló feladatot jelöl.
fine_tuning.job.checkpoint	string	Ez az objektum egy finomhangolási feladat ellenőrzőpontját jelöli.
fine_tuning.job.event	string	Ez az objektum egy finomhangolási feladat eseményét jelöli.
list	string	Ez az objektum más objektumok listáját jelöli.
model	string	Ez az objektum egy modellt jelöl (lehet alapmodell vagy a feladat eredményének finomhangolása).
upload	string	Ez az objektum fájlfeltöltést jelöl.
upload.part	string	Ez az objektum egy fájlfeltöltés egy részét jelöli.

Megosztás a következőn keresztül:

Files - Import

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

api-key

Példák

Importing a file with a blob url as source.

Mintakérelem

Mintaválasz

Definíciók

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

További források