Modele usługi Azure OpenAI

Wersja interfejsu API: wersja 1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

Zmienne serwera:

Variable	Wartość domyślna	Description
punkt końcowy		Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentication

ApiKeyAuth (klucz API)

Przekaż swój klucz API w nagłówku api-key .

ApiKeyAuth_ (Klucz API)

Przekaż swój klucz API w nagłówku authorization .

OAuth2Auth (OAuth 2.0)

Przepływ: niejawny

Adres URL autoryzacji:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresów:

• https://cognitiveservices.azure.com/.default

Wymagania dotyczące zabezpieczeń

Punkty końcowe akceptują dowolną z następujących metod uwierzytelniania:

1. ApiKeyAuth
2. ApiKeyAuth_
3. OAuth2Auth (zakresy: https://cognitiveservices.azure.com/.default)

Wyświetl listę modeli

GET {endpoint}/openai/v1/models

Wyświetla listę aktualnie dostępnych modeli i zawiera podstawowe informacje o poszczególnych modelach, takich jak właściciel i dostępność.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: v1, preview	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. v1 jeśli nie określono inaczej.

Responses

Kod stanu: 200

Opis: Żądanie zakończyło się pomyślnie.

Typ zawartości	Type	Opis
application/json	OpenAI.ListModelsResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
inner_error			Nie.
komunikat	ciąg		Yes
param	ciąg znaków lub null		Nie.
typ	ciąg		Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Pobieranie modelu

GET {endpoint}/openai/v1/models/{model}

Pobiera wystąpienie modelu, podając podstawowe informacje o modelu, takie jak właściciel i uprawnienie.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: v1, preview	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. v1 jeśli nie określono inaczej.
model	ścieżka	Yes	ciąg	Identyfikator modelu do użycia w tym żądaniu.

Responses

Kod stanu: 200

Opis: Żądanie zakończyło się pomyślnie.

Typ zawartości	Type	Opis
application/json	OpenAI.Model

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
inner_error			Nie.
komunikat	ciąg		Yes
param	ciąg znaków lub null		Nie.
typ	ciąg		Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Usuwanie modelu

DELETE {endpoint}/openai/v1/models/{model}

Usuwa wystąpienie modelu.

Parametry identyfikatora URI

Name	Cala	Obowiązkowy	Typ	Description
punkt końcowy	serwer	Yes	ciąg	Obsługiwany endpoint API Azure AI Foundry Models, w tym protokół i nazwa hosta. Przykład: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
wersja API	kwerenda	Nie.	ciąg Możliwe wartości: v1, preview	Określona wersja interfejsu API modeli Azure AI Foundry do wykorzystania w tym żądaniu. v1 jeśli nie określono inaczej.
model	ścieżka	Yes	ciąg	Identyfikator modelu do usunięcia.

Responses

Kod stanu: 200

Opis: Żądanie zakończyło się pomyślnie.

Typ zawartości	Type	Opis
application/json	OpenAI.DeleteModelResponse

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Kod stanu: wartość domyślna

Opis: Nieoczekiwana odpowiedź na błąd.

Typ zawartości	Type	Opis
application/json	obiekt

Name	Typ	Description	Obowiązkowy	Wartość domyślna
kod	ciąg znaków lub null		Yes
inner_error			Nie.
komunikat	ciąg		Yes
param	ciąg znaków lub null		Nie.
typ	ciąg		Nie.

Nagłówki odpowiedzi:

Nagłówka	Typ	Description
apim-request-id	ciąg	Identyfikator żądania używany do rozwiązywania problemów.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	ciąg
Wartości	v1 preview

OpenAI.DeleteModelResponse

Name	Typ	Description	Obowiązkowy	Wartość domyślna
usunięta	boolean		Yes
id	ciąg		Yes
obiekt	ciąg		Yes

OpenAI.ListModelsResponse

Name	Typ	Description	Obowiązkowy	Wartość domyślna
dane	tablica openAI.Model		Yes
obiekt	wyliczenie	Możliwe wartości: list	Yes

OpenAI.Model

Model

Opisuje ofertę modelu OpenAI, która może być używana z interfejsem API.

Name	Typ	Description	Obowiązkowy	Wartość domyślna
utworzone	Liczba całkowita (unixtime)	Sygnatura czasowa systemu Unix (w sekundach) podczas tworzenia modelu.	Yes
id	ciąg	Identyfikator modelu, do którego można odwoływać się w punktach końcowych interfejsu API.	Yes
obiekt	wyliczenie	Typ obiektu, który jest zawsze "modelem". Możliwe wartości: model	Yes
właścicielem_jest	ciąg	Organizacja, która jest właścicielem modelu.	Yes