Models - List

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2023-12-01-preview

Získá seznam všech modelů, které jsou přístupné z prostředku Azure OpenAI. Patří mezi ně 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=2023-12-01-preview

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. "aoairesource" nahraďte názvem vašeho úč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 klíč účtu Cognitive Services Azure OpenAI.

Odpovědi

Name	Typ	Description
200 OK	ModelList	Success
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

api-key

Tady zadejte klíč účtu Cognitive Services Azure OpenAI.

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=2023-12-01-preview

Ukázková odpověď

Stavový kód:: 200

{
  "data": [
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    },
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    }
  ],
  "object": "list"
}

Definice

Name	Description
Capabilities	Možnosti
Deprecation	Vyřazení
Error	Chyba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modelování
ModelList	Seznam modelů
TypeDiscriminator	TypeDiskriminor

Capabilities

Možnosti

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čení.
embeddings	boolean	Hodnota označující, jestli model podporuje vkládání.
fine_tune	boolean	Hodnota označující, zda lze model použít k jemnému ladění.
inference	boolean	Hodnota označující, jestli je možné model nasadit.

Deprecation

Vyřazení

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

Error

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode Kódy chyb definované v pokynech microsoftu 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í, ve kterém došlo k chybě, pokud je k dispozici.

ErrorCode

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 pro aktuálního uživatele nebo klíče rozhraní API zakázaná.
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 v současné době není k dispozici.
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 provést v aktuálním stavu prostředku.

ErrorResponse

Name	Typ	Description
error	Error	Chyba Obsah chyby, jak je definováno v pokynech microsoftu 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á. Lze ho zařadit do kategorie terminálového stavu.
created	string	Operace byla vytvořena. Azure OpenAI tento stav nevrátá a zobrazuje se pouze kvůli kompatibilitě. 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. Lze ho zařadit do kategorie terminálového stavu.
pending	string	Operace ještě není zařazena do fronty, aby se v budoucnu zpracovala. 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 se úspěšně zpracovala a je připravená ke spotřebě. Lze ho zařadit do kategorie terminálového stavu.

InnerError

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Kódy vnitřních chyb definované v pokynech microsoftu 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

Modelování

Name	Typ	Description
capabilities	Capabilities	Možnosti Možnosti základního nebo jemně vyladěného modelu.
created_at	integer	Časové razítko, kdy byla tato úloha nebo položka vytvořena (v unixových epochách).
deprecation	Deprecation	Vyřazení Definuje data vyřazení pro různé případy použití modelu. Základní modely obvykle podporují 1 rok jemného ladění po vytvoření. Odvozování se obvykle podporuje po 2 letech od vytvoření základních nebo jemně vyladěných modelů. Přesná data jsou zadána ve vlastnostech.
fine_tune	string	Identita úlohy jemného ladění (fine-tune-id), pokud se jedná o model jemného ladění; jinak `null`.
id	string	Identita této položky
lifecycle_status	LifeCycleStatus	LifeCycleStatus Stav životního cyklu modelu. Poznámka: Model může být povýšen z "preview" na "obecně dostupný", ale nikdy z "obecně dostupné" na "preview".
model	string	Základní identita modelu (id modelu), pokud se jedná o model jemného ladění; jinak `null`.
object	TypeDiscriminator	TypeDiskriminor Definuje typ objektu.
status	FineTuningState	FineTuningState Stav objektu jemného ladění nebo úlohy jemného ladění.
updated_at	integer	Časové razítko poslední změny této úlohy nebo položky (v unixových epochách).

ModelList

Seznam modelů

Name	Typ	Description
data	Model[]	Seznam položek.
object	TypeDiscriminator	TypeDiskriminor Definuje typ objektu.

TypeDiscriminator

TypeDiskriminor

Name	Typ	Description
file	string	Tento objekt představuje soubor.
fine-tune	string	Tento objekt představuje úlohu jemného ladění.
fine-tune-event	string	Tento objekt představuje událost úlohy jemného ladění.
fine_tuning.job	string	Tento objekt představuje úlohu 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 výsledek úlohy jemného ladění).

Sdílet prostřednictvím