Models - List

Riferimento

Service:: Azure AI Services

API Version:: 2024-02-01

Ottiene un elenco di tutti i modelli accessibili dalla risorsa Azure OpenAI. Questi includono i modelli di base e tutti i modelli ottimizzati completati correttamente di proprietà della risorsa Azure OpenAI.

GET {endpoint}/openai/models?api-version=2024-02-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il nome dell'account Azure OpenAI.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
api-key	True	string	Specificare qui la chiave dell'account Azure OpenAI di Servizi cognitivi.

Risposte

Nome	Tipo	Descrizione
200 OK	ModelList	Operazione riuscita
Other Status Codes	ErrorResponse	Si è verificato un errore.

Sicurezza

api-key

Specificare qui la chiave dell'account Azure OpenAI di Servizi cognitivi.

Type: apiKey
In: header

Esempio

Getting all models owned by account.

Sample Request

HTTP

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

Sample Response

Status code:: 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,
      "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,
      "object": "model"
    }
  ],
  "object": "list"
}

Definizioni

Nome	Descrizione
Capabilities	Funzionalità
Deprecation	Deprecazione
Error	Errore
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modello
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Funzionalità

Nome	Tipo	Descrizione
chat_completion	boolean	Valore che indica se un modello supporta il completamento della chat.
completion	boolean	Valore che indica se un modello supporta il completamento.
embeddings	boolean	Valore che indica se un modello supporta incorporamenti.
fine_tune	boolean	Valore che indica se un modello può essere usato per l'ottimizzazione fine.
inference	boolean	Valore che indica se è possibile distribuire un modello.

Deprecation

Deprecazione

Nome	Tipo	Descrizione
fine_tune	integer	Data di fine ottimizzazione del supporto di questo modello. Sarà `null` necessario ottimizzare i modelli.
inference	integer	Data di fine del supporto dell'inferenza di questo modello.

Error

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore definiti nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Dettagli dell'errore se disponibile.
innererror	InnerError	InnerError Errore interno definito nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Messaggio di questo errore.
target	string	Posizione in cui si è verificato l'errore se disponibile.

ErrorCode

Nome	Tipo	Descrizione
conflict	string	L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
contentFilter	string	La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.
fileImportFailed	string	Importazione di file non riuscita.
forbidden	string	L'operazione non è consentita per la chiave utente/API corrente.
internalFailure	string	Errore interno. Riprovare.
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.
itemDoesAlreadyExist	string	L'elemento esiste già.
jsonlValidationFailed	string	La convalida dei dati jsonl non è riuscita.
notFound	string	La risorsa non viene trovata.
quotaExceeded	string	Quota superata.
serviceUnavailable	string	Il servizio non è attualmente disponibile.
tooManyRequests	string	Numero eccessivo di richieste. Riprovare più tardi.
unauthorized	string	La chiave utente/API corrente non è autorizzata per l'operazione.
unexpectedEntityState	string	Impossibile eseguire l'operazione nello stato della risorsa corrente.

ErrorResponse

Nome	Tipo	Descrizione
error	Error	Errore Contenuto degli errori definito nelle linee guida REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Nome	Tipo	Descrizione
cancelled	string	L'operazione è stata annullata ed è incompleta. Può essere classificato come stato terminale.
created	string	L'operazione è stata creata. Questo stato non viene restituito da Azure OpenAI ed esposto solo per la compatibilità. Può essere classificato come stato inattivo.
failed	string	L'operazione ha completato l'elaborazione con un errore e non può essere ulteriormente utilizzata. Può essere classificato come stato terminale.
pending	string	L'operazione non è ancora in coda da elaborare in futuro. Può essere classificato come stato inattivo.
running	string	L'operazione è stata avviata per l'elaborazione. Può essere classificato come stato attivo.
succeeded	string	L'operazione è stata elaborata correttamente ed è pronta per l'utilizzo. Può essere classificato come stato terminale.

InnerError

Nome	Tipo	Descrizione
code	InnerErrorCode	InnerErrorCode Codici di errore interni definiti nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Errore interno definito nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Descrizione
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.

LifeCycleStatus

Nome	Tipo	Descrizione
generally-available	string	Il modello è disponibile a livello generale.
preview	string	Il modello è in anteprima e coperto dalle condizioni di anteprima del servizio.

Model

Modello

Nome	Tipo	Descrizione
capabilities	Capabilities	Funzionalità Le funzionalità di un modello di base o di ottimizzazione.
created_at	integer	Timestamp quando questo processo o elemento è stato creato (in epoche unix).
deprecation	Deprecation	Deprecazione Definisce le date di deprecazione per i diversi casi d'uso di un modello. In genere i modelli di base supportano 1 anno di ottimizzazione fine dopo la creazione. L'inferenza è in genere supportata 2 anni dopo la creazione di modelli di base o ottimizzati. Le date esatte vengono specificate nelle proprietà.
fine_tune	string	L'identità del processo di ottimizzazione (fine-tune-id) se si tratta di un modello di ottimizzazione; altrimenti `null`.
id	string	Identità di questo elemento.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Stato del ciclo di vita di un modello. Nota: un modello può essere promosso da "anteprima" a "disponibile a livello generale", ma mai da "disponibile a livello generale" a "anteprima".
model	string	Identità del modello di base (model-id) se si tratta di un modello di ottimizzazione corretto; altrimenti `null`.
object	TypeDiscriminator	TypeDiscriminator Definisce il tipo di un oggetto.
status	FineTuningState	FineTuningState Stato di un oggetto di finetunes o di un processo di ottimizzazione fine.

ModelList

Nome	Tipo	Descrizione
data	Model[]	Elenco di elementi.
object	TypeDiscriminator	TypeDiscriminator Definisce il tipo di un oggetto.

TypeDiscriminator

Nome	Tipo	Descrizione
file	string	Questo oggetto rappresenta un file.
fine-tune	string	Questo oggetto rappresenta un processo di ottimizzazione.
fine-tune-event	string	Questo oggetto rappresenta un evento di un processo di ottimizzazione fine.
fine_tuning.job	string	Questo oggetto rappresenta un processo di ottimizzazione.
fine_tuning.job.event	string	Questo oggetto rappresenta un evento di un processo di ottimizzazione fine.
list	string	Questo oggetto rappresenta un elenco di altri oggetti.
model	string	Questo oggetto rappresenta un modello (può essere un modello di base o ottimizzare il risultato del processo).

Share via