Modelli OpenAI di Azure

Versione API: v1

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

Variabili del server:

Variabile Predefinito Description
endpoint Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Autenticazione

ApiKeyAuth (API Key)

Passa la chiave API nell'intestare api-key .

ApiKeyAuth_ (Chiave API)

Passa la chiave API nell'intestare authorization .

OAuth2Auth (OAuth 2.0)

Flusso: implicito

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

Ambiti:

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

Requisiti di sicurezza

Gli endpoint accettano uno qualsiasi dei seguenti metodi di autenticazione:

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

Ottenere l'elenco dei modelli

GET {endpoint}/openai/v1/models

Elenca i modelli attualmente disponibili e fornisce informazioni di base su ognuna, ad esempio il proprietario e la disponibilità.

Parametri dell'URI

Name In Obbligatorio Type Description
endpoint server Sì string Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-version query No string
Valori possibili: v1, preview		 Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.ListModelsResponse

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json object
Name Type Description Obbligatorio Predefinito
codice stringa o null Sì
inner_error No
message string Sì
param stringa o null No
type string No

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Recuperare il modello

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

Recupera un'istanza del modello, fornendo informazioni di base sul modello, ad esempio il proprietario e l'autorizzazione.

Parametri dell'URI

Name In Obbligatorio Type Description
endpoint server Sì string Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-version query No string
Valori possibili: v1, preview		 Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
model path Sì string ID del modello da utilizzare per questa richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.Model

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json object
Name Type Description Obbligatorio Predefinito
codice stringa o null Sì
inner_error No
message string Sì
param stringa o null No
type string No

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Eliminare un modello

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

Elimina un'istanza del modello.

Parametri dell'URI

Name In Obbligatorio Type Description
endpoint server Sì string Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host.
Per esempio:
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
api-version query No string
Valori possibili: v1, preview		 Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta.
v1 se non specificato diversamente.
model path Sì string ID del modello da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto Type Descrizione
application/json OpenAI.DeleteModelResponse

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto Type Descrizione
application/json object
Name Type Description Obbligatorio Predefinito
codice stringa o null Sì
inner_error No
message string Sì
param stringa o null No
type string No

Intestazioni di risposta:

Intestazione Type Description
apim-request-id string ID richiesta usato per la risoluzione dei problemi.

Components

AzureAIFoundryModelsApiVersion

Proprietà Value
Type string
Valori v1
preview

OpenAI.DeleteModelResponse

Name Type Description Obbligatorio Predefinito
cancellato boolean Sì
id string Sì
object string Sì

OpenAI.ListModelsResponse

Name Type Description Obbligatorio Predefinito
data matrice di OpenAI.Model Sì
object enum
Valori possibili: list		 Sì

OpenAI.Model

Modello

Descrive un'offerta di modello OpenAI che può essere usata con l'API.

Name Type Description Obbligatorio Predefinito
creato intero (unixtime) Timestamp Unix (in secondi) al momento della creazione del modello. Sì
id string Identificatore del modello, a cui è possibile fare riferimento negli endpoint API. Sì
object enum Tipo di oggetto, che è sempre "model".
Valori possibili: model		 Sì
owned_by string Organizzazione proprietaria del modello. Sì
  • Last updated on