Models - List

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-10-21

Získá seznam všech modelů, které jsou přístupné prostředkem Azure OpenAI. Patří sem základní modely i všechny úspěšně dokončené jemně vyladěné modely vlastněné prostředkem Azure OpenAI.

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

Odpovědi

Name	Typ	Description
200 OK	ModelList	Úspěch
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

Getting all models owned by account.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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"
}

Definice

Name	Description
Capabilities	Schopnosti
Deprecation	Zavrhování
Error	Chyba
ErrorCode	Kód chyby
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Model
ModelList	Seznam modelů
TypeDiscriminator	Type Nábídka

Capabilities

Schopnosti

Name	Typ	Description
chat_completion	boolean	Hodnota označující, jestli model podporuje dokončování chatu.
completion	boolean	Hodnota označující, jestli model podporuje dokončování.
embeddings	boolean	Hodnota označující, jestli model podporuje vkládání.
fine_tune	boolean	Hodnota označující, jestli lze model použít k jemnému ladění.
inference	boolean	Hodnota označující, jestli lze model nasadit.

Deprecation

Zavrhování

Name	Typ	Description
fine_tune	integer	Koncové datum vyladění podpory tohoto modelu. Bude `null` pro vyladění modelů.
inference	integer	Koncové datum podpory odvozování tohoto modelu.

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

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

FineTuningState

Name	Typ	Description
cancelled	string	Operace byla zrušena a je neúplná. Může být kategorizován jako stav terminálu.
created	string	Operace byla vytvořena. Azure OpenAI tento stav nevrátá a z důvodu kompatibility je vystavený. Může být kategorizován jako neaktivní stav.
failed	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 ještě není zařazena do fronty ke zpracování v budoucnu. Může být kategorizován jako neaktivní stav.
running	string	Operace se začala zpracovávat. Může být kategorizován jako aktivní stav.
succeeded	string	Operace byla úspěšně zpracována a je připravená k použití. Může být kategorizován jako stav terminálu.

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

Name	Typ	Description
invalidPayload	string	Data požadavku jsou pro tuto operaci neplatná.

LifeCycleStatus

Name	Typ	Description
generally-available	string	Model je obecně dostupný.
preview	string	Model je ve verzi Preview a vztahuje se na ně podmínky verze Preview služby.

Model

Name	Typ	Description
capabilities	Capabilities	Schopnosti Možnosti základního modelu nebo doladění modelu.
created_at	integer	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)
deprecation	Deprecation	Zavrhování Definuje data vyřazení pro různé případy použití modelu. Základní modely obvykle podporují 1 rok vyladění po vytvoření. Odvozování se obvykle podporuje 2 roky po vytvoření základních nebo jemně vyladěných modelů. Přesná data jsou zadána ve vlastnostech.
fine_tune	string	Pokud se jedná o model jemného ladění, vylaďte identitu úlohy (fine-tune-id). jinak `null`.
id	string	Identita této položky.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Stav životního cyklu modelu. Poznámka: Model lze zvýšit z verze Preview na obecně dostupný, ale nikdy z "obecně dostupné" na "Preview".
model	string	Základní identita modelu (ID modelu), pokud se jedná o model vyladění; jinak `null`.
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.
status	FineTuningState	FineTuningState Stav jemně vyladěného objektu nebo jemného ladění.

ModelList

Seznam modelů

Name	Typ	Description
data	Model[]	Seznampoložekch
object	TypeDiscriminator	Type Nábídka Definuje typ objektu.

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.

Sdílet prostřednictvím