Upload File - Cancel

Szolgáltatás:

Azure AI Services

API-verzió:

2024-10-21

Megszakítja a feltöltést, és az összes feltöltött rész aszinkron törléséhez vezet. A feltöltés megszakítása után nem lehet alkatrészeket hozzáadni.

POST {endpoint}/openai/uploads/{upload-id}/cancel?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.
upload-id	path	True	string	A feltöltés azonosítója.
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.

Válaszok

Name	Típus	Description
200 OK	UploadResource	Siker
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

Cancel a large file upload operation.

Mintakérelem

HTTP

POST https://aoairesource.openai.azure.com/openai/uploads/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f/cancel?api-version=2024-10-21

Mintaválasz

Állapotkód:

200

{
  "bytes": 2097152,
  "filename": "training_data_v21.jsonl",
  "purpose": "fine-tune",
  "status": "cancelled",
  "expires_at": 1646133327,
  "file": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  },
  "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
  "created_at": 1646126127,
  "object": "upload"
}

Definíciók

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

Error

Objektum

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 minLength: 1	A hiba üzenete.
target	string	Az a hely, ahol a hiba történt, ha elérhető.

ErrorCode

Enumerálás

ErrorCode

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

ErrorResponse

Objektum

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

Objektum

Fájl

Name	Típus	Description
bytes	integer (int64)	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 (unixtime)	Időbélyeg a feladat vagy elem létrehozásakor (unix korszakokban).
filename	string minLength: 1	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.

FileState

Enumerálás

FileState

Érték	Description
deleted	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	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	A művelet sikertelen feldolgozással fejeződött be, és nem használható tovább. Terminálállapotként kategorizálható.
pending	A művelet létrejött, és a jövőben nem lesz feldolgozva. Inaktív állapotként kategorizálható.
processed	A művelet feldolgozása sikeresen megtörtént, és használatra kész. Terminálállapotként kategorizálható.
running	A művelet feldolgozása megkezdődött. Aktív állapotként kategorizálható.
uploaded	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

Objektum

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

Enumerálás

InnerErrorCode

Érték	Description
invalidPayload	A kérelem adatai érvénytelenek ehhez a művelethez.

Purpose

Enumerálás

Cél

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

TypeDiscriminator

Enumerálás

TypeDiscriminator

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

UploadResource

Objektum

UploadResource

Name	Típus	Description
bytes	integer (int64)
created_at	integer (unixtime)	Időbélyeg a feladat vagy elem létrehozásakor (unix korszakokban).
expires_at	integer (unixtime)
file	File	Fájl A fájl egy betanításhoz és ellenőrzéshez használható dokumentum. Ez egy szolgáltatás által létrehozott dokumentum is lehet, amely az eredmény részleteit tartalmazza.
filename	string
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	UploadStatus	UploadStatus

UploadStatus

Enumerálás

UploadStatus

Érték	Description
cancelled
completed
expired
pending