Models - List

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-10-21

Pobiera listę wszystkich modeli, które są dostępne dla zasobu usługi Azure OpenAI. Należą do nich modele podstawowe, a także wszystkie pomyślnie ukończone dostosowane modele należące do zasobu usługi Azure OpenAI.

GET {endpoint}/openai/models?api-version=2024-10-21

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ModelList	Sukces
Other Status Codes	ErrorResponse	Wystąpił błąd.

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Getting all models owned by account.

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Capabilities	Możliwości
Deprecation	Oczekiwany
Error	Błąd
ErrorCode	Kod błędu
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Model
ModelList	Lista modeli
TypeDiscriminator	TypeDiscriminator

Capabilities

Objekt

Możliwości

Nazwa	Typ	Opis
chat_completion	boolean	Wartość wskazująca, czy model obsługuje uzupełnianie czatu.
completion	boolean	Wartość wskazująca, czy model obsługuje uzupełnianie.
embeddings	boolean	Wartość wskazująca, czy model obsługuje osadzanie.
fine_tune	boolean	Wartość wskazująca, czy można użyć modelu do dostrajania.
inference	boolean	Wartość wskazująca, czy można wdrożyć model.

Deprecation

Objekt

Oczekiwany

Nazwa	Typ	Opis
fine_tune	integer (unixtime)	Data zakończenia dokładnego dostosowania obsługi tego modelu. Będzie `null` w celu dostosowania modeli.
inference	integer (unixtime)	Data zakończenia obsługi wnioskowania tego modelu.

Error

Objekt

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Wyliczanie

Kod błędu

Wartość	Opis
conflict	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
contentFilter	Generowanie obrazu nie powiodło się w wyniku naszego systemu bezpieczeństwa.
fileImportFailed	Importowanie pliku nie powiodło się.
forbidden	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
internalFailure	Błąd wewnętrzny. Ponów próbę.
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	Element już istnieje.
jsonlValidationFailed	Sprawdzanie poprawności danych jsonl nie powiodło się.
notFound	Nie można odnaleźć zasobu.
quotaExceeded	Przekroczono limit przydziału.
serviceUnavailable	Usługa jest obecnie niedostępna.
tooManyRequests	Zbyt wiele żądań. Spróbuj ponownie później.
unauthorized	Bieżący klucz użytkownika/interfejsu API nie jest autoryzowany dla operacji.
unexpectedEntityState	Nie można wykonać operacji w stanie bieżącego zasobu.

ErrorResponse

Objekt

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Wyliczanie

FineTuningState

Wartość	Opis
cancelled	Operacja została anulowana i jest niekompletna. Można go podzielić na stan terminalu.
created	Operacja została utworzona. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidaczniany tylko pod kątem zgodności. Można go sklasyfikować jako stan nieaktywny.
failed	Operacja zakończyła przetwarzanie z powodu błędu i nie może być jeszcze bardziej zużywana. Można go podzielić na stan terminalu.
pending	Operacja nie jest jeszcze w kolejce do przetworzenia w przyszłości. Można go sklasyfikować jako stan nieaktywny.
running	Operacja została rozpoczęta do przetworzenia. Można go sklasyfikować jako aktywny stan.
succeeded	Operacja została pomyślnie przetworzona i jest gotowa do użycia. Można go podzielić na stan terminalu.

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Wyliczanie

InnerErrorCode

Wartość	Opis
invalidPayload	Dane żądania są nieprawidłowe dla tej operacji.

LifeCycleStatus

Wyliczanie

LifeCycleStatus

Wartość	Opis
generally-available	Model jest ogólnie dostępny.
preview	Model jest w wersji zapoznawczej i jest objęty warunkami wersji zapoznawczej usługi.

Model

Objekt

Model

Nazwa	Typ	Opis
capabilities	Capabilities	Możliwości Możliwości modelu podstawowego lub precyzyjnego dostrajania.
created_at	integer (unixtime)	Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix).
deprecation	Deprecation	Oczekiwany Definiuje daty wycofania dla różnych przypadków użycia modelu. Zazwyczaj modele podstawowe obsługują 1 rok dostrajania po utworzeniu. Wnioskowanie jest zwykle obsługiwane 2 lata po utworzeniu podstawowych lub dostrojonych modeli. Dokładne daty są określone we właściwościach.
fine_tune	string	Tożsamość zadania dostrajania (fine-tune-id), jeśli jest to odpowiedni model dostrajania; w przeciwnym razie `null`.
id	string	Tożsamość tego elementu.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Stan cyklu życia modelu. Uwaga: model może być promowany z "wersji zapoznawczej" do "ogólnie dostępne", ale nigdy z "ogólnie dostępnego" do "wersji zapoznawczej".
model	string	Tożsamość modelu podstawowego (model-id), jeśli jest to odpowiedni model dostrajania; w przeciwnym razie `null`.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.
status	FineTuningState	FineTuningState Stan obiektu finetunes lub zadania dostrajania.

ModelList

Objekt

Lista modeli

Nazwa	Typ	Opis
data	Model[]	Lista elementów.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.

TypeDiscriminator

Wyliczanie

TypeDiscriminator

Wartość	Opis
batch	Ten obiekt reprezentuje partię.
file	Ten obiekt reprezentuje plik.
fine_tuning.job	Ten obiekt reprezentuje zadanie dostrajania.
fine_tuning.job.checkpoint	Ten obiekt reprezentuje punkt kontrolny zadania dostrajania.
fine_tuning.job.event	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
list	Ten obiekt reprezentuje listę innych obiektów.
model	Ten obiekt reprezentuje model (może być modelem bazowym lub dostrajać wynik zadania).
upload	Ten obiekt reprezentuje przekazywanie pliku.
upload.part	Ten obiekt reprezentuje część przekazywania plików.

Udostępnij za pośrednictwem

Models - List

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

api-key

Przykłady

Getting all models owned by account.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Capabilities

Deprecation

Error

ErrorCode

ErrorResponse

FineTuningState

InnerError

InnerErrorCode

LifeCycleStatus

Model

ModelList

TypeDiscriminator

Dodatkowe zasoby