Batch - Get

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2024-10-21

A megadott kötegazonosító által megadott egyetlen köteg adatait kéri le.

GET {endpoint}/openai/batches/{batch-id}?api-version=2024-10-21

URI-paraméterek

Name	In	Kötelező	Típus	Description
batch-id	path	True	string	A köteg azonosítója.
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.

Válaszok

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

Getting a batch.

Mintakérelem

HTTP

GET https://aoairesource.openai.azure.com/openai/batches/batch_72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-10-21

Mintaválasz

Állapotkód:: 200

{
  "object": "batch",
  "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
  "endpoint": "/chat/completions",
  "errors": null,
  "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
  "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
  "created_at": 1646126127,
  "in_progress_at": 1646126130,
  "expires_at": 1646126170,
  "finalizing_at": 1646126134,
  "completed_at": 1646126136,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 500,
    "completed": 400,
    "failed": 100
  },
  "metadata": {
    "batch_description": "Evaluation job"
  }
}

Definíciók

Name	Description
Batch	Halom
BatchErrorData	BatchErrorData
BatchErrors	BatchErrors
BatchRequestCounts	BatchRequestCounts
BatchStatus	BatchStatus
Error	Hiba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Batch

Objektum

Halom

Name	Típus	Description
cancelled_at	integer (unixtime)	Időbélyeg a köteg megszakításakor (Unix-korszakokban).
cancelling_at	integer (unixtime)	Időbélyeg, amikor ez a köteg elkezdődött a megszakítással (unix-korszakokban).
completed_at	integer (unixtime)	Időbélyeg a köteg befejezésekor (unix-korszakokban).
completion_window	string	Az az időkeret, amelyen belül a köteget fel kell dolgozni.
created_at	integer (unixtime)	Időbélyeg a köteg létrehozásakor (Unix-korszakokban).
endpoint	string	A köteg által használt API-végpont.
error_file_id	string	A hibákkal rendelkező kérések kimeneteit tartalmazó fájl azonosítója.
errors	BatchErrors	BatchErrors A sikertelen kötegek esetében ez további információkat tartalmaz a hibák okáról.
expired_at	integer (unixtime)	Időbélyeg, amikor ez a köteg lejárt (unix-korszakokban).
expires_at	integer (unixtime)	Időbélyeg, amikor ez a köteg lejár (unix-korszakokban).
failed_at	integer (unixtime)	Időbélyeg, amikor ez a köteg sikertelen volt (unix-korszakokban).
finalizing_at	integer (unixtime)	Időbélyeg, amikor ez a köteg megkezdte a véglegesítést (unix-korszakokban).
id	string	Az elem identitása.
in_progress_at	integer (unixtime)	Időbélyeg, amikor ez a köteg elindult (unix-korszakokban).
input_file_id	string minLength: 1	A köteg bemeneti fájljának azonosítója.
metadata	object	Kulcs-érték párok készlete, amelyek csatolhatók a köteghez. Ez hasznos lehet a köteg további információinak strukturált formátumban történő tárolásához.
object	TypeDiscriminator	TypeDiscriminator Meghatározza az objektum típusát.
output_file_id	string	A sikeresen végrehajtott kérések kimeneteit tartalmazó fájl azonosítója.
request_counts	BatchRequestCounts	BatchRequestCounts A kérelem a köteg különböző állapotainak számát számítja ki.
status	BatchStatus	BatchStatus Egy köteg állapota.

BatchErrorData

Objektum

BatchErrorData

Name	Típus	Description
code	string	A hibatípust azonosító hibakód.
line	string	Annak a bemeneti fájlnak a sorszáma, ahol a hiba történt, ha lehetséges (null lehet).
message	string	Egy emberi olvasásra alkalmas üzenet, amely további részleteket tartalmaz a hibáról.
param	string	A hibát okozó paraméter neve, ha lehetséges (lehet null).

BatchErrors

Objektum

BatchErrors

Name	Típus	Description
data	BatchErrorData	BatchErrorData Hibainformációk a köteg meghibásodásáról.
object	string	A hibaobjektum típusa. Ez mindig "lista".

BatchRequestCounts

Objektum

BatchRequestCounts

Name	Típus	Description
completed	integer	A kötegben sikeresen végrehajtott kérések száma.
failed	integer	A sikertelen kérelmek száma a kötegben.
total	integer	A kötegben lévő kérelmek teljes száma.

BatchStatus

Enumerálás

BatchStatus

Érték	Description
cancelled	A köteg megszakadt.
cancelling	A köteg lemondását kezdeményezték.
completed	A köteg elkészült, és az eredmények készen állnak.
expired	A köteg nem fejeződött be a 24 órás időkereten belül.
failed	A bemeneti fájl nem felelt meg az érvényesítési folyamatnak.
finalizing	A köteg befejeződött, és az eredmények előkészítése folyamatban van.
in_progress	A bemeneti fájl ellenőrzése sikeresen megtörtént, és a köteg végrehajtása folyamatban van.
validating	A bemeneti fájl ellenőrzése a köteg megkezdése előtt történik.

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.

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.

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.

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

Batch - Get

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

api-key

Példák

Getting a batch.

Mintakérelem

Mintaválasz

Definíciók

Batch

BatchErrorData

BatchErrors

BatchRequestCounts

BatchStatus

Error

ErrorCode

ErrorResponse

InnerError

InnerErrorCode

TypeDiscriminator