Models - List

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2024-10-21

Lekéri az Azure OpenAI-erőforrás által elérhető összes modell listáját. Ezek közé tartoznak az alapmodellek, valamint az Azure OpenAI-erőforrás tulajdonában lévő összes sikeresen befejezett, finomhangolt modell.

GET {endpoint}/openai/models?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.

Válaszok

Name	Típus	Description
200 OK	ModelList	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 all models owned by account.

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

Definíciók

Name	Description
Capabilities	Képességek
Deprecation	Helytelenítés
Error	Hiba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	ÉletciklusStatus
Model	Modell
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Képességek

Name	Típus	Description
chat_completion	boolean	Érték, amely jelzi, hogy egy modell támogatja-e a csevegés befejezését.
completion	boolean	Érték, amely jelzi, hogy egy modell támogatja-e a befejezést.
embeddings	boolean	Érték, amely jelzi, hogy egy modell támogatja-e a beágyazást.
fine_tune	boolean	Érték, amely azt jelzi, hogy egy modell használható-e a finomhangoláshoz.
inference	boolean	Egy érték, amely jelzi, hogy egy modell üzembe helyezhető-e.

Deprecation

Helytelenítés

Name	Típus	Description
fine_tune	integer	A modell finomhangolásának végső dátuma. A modellek finomhangolásához `null`.
inference	integer	A modell következtetési támogatásának záró dátuma.

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.

FineTuningState

Name	Típus	Description
cancelled	string	A művelet megszakadt, és nem fejeződött be. Terminálállapotként kategorizálható.
created	string	A művelet létrejött. 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ó.
failed	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 a jövőben még nem lesz feldolgozva. Inaktív állapotként kategorizálható.
running	string	A művelet feldolgozása megkezdődött. Aktív állapotként kategorizálható.
succeeded	string	A művelet feldolgozása sikeresen megtörtént, és használatra kész. Terminálá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.

LifeCycleStatus

ÉletciklusStatus

Name	Típus	Description
generally-available	string	A modell általánosan elérhető.
preview	string	A modell előzetes verzióban érhető el, és a szolgáltatás előzetes verziójának feltételei vonatkoznak.

Model

Modell

Name	Típus	Description
capabilities	Capabilities	Képességek Egy alap- vagy finomhangoló modell képességei.
created_at	integer	Időbélyeg a feladat vagy elem létrehozásakor (unix korszakokban).
deprecation	Deprecation	Helytelenítés Meghatározza a modell különböző használati eseteinek elavulásának dátumát. Az alapmodellek általában 1 év finomhangolást támogatnak a létrehozás után. A következtetés általában 2 évvel az alap- vagy finomhangolt modellek létrehozása után támogatott. A pontos dátumok a tulajdonságokban vannak megadva.
fine_tune	string	A feladat identitásának finomhangolása (finomhangolási azonosító), ha ez egy finomhangoló modell; egyéb esetben `null`.
id	string	Az elem identitása.
lifecycle_status	LifeCycleStatus	ÉletciklusStatus A modell életciklusának állapota. Megjegyzés: A modell előléptethető az "előzetes verzióból" az "általánosan elérhető" értékre, de az "általánosan elérhető" és az "előzetes verzió" között soha nem.
model	string	Az alapmodell identitása (modellazonosító), ha ez egy finomhangoló modell; egyéb esetben `null`.
object	TypeDiscriminator	TypeDiscriminator Meghatározza az objektum típusát.
status	FineTuningState	FineTuningState Egy finomhangolási objektum vagy finomhangolási feladat állapota.

ModelList

Name	Típus	Description
data	Model[]	Az elemek listája.
object	TypeDiscriminator	TypeDiscriminator Meghatározza az objektum típusát.

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: