Models - List

Referentie

Service:: Azure AI Services

API-versie:: 2024-10-21

Hiermee haalt u een lijst op met alle modellen die toegankelijk zijn voor de Azure OpenAI-resource. Dit zijn onder andere basismodellen en alle voltooide, nauwkeurig afgestemde modellen die eigendom zijn van de Azure OpenAI-resource.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
api-key	True	string	Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Antwoorden

Name	Type	Description
200 OK	ModelList	Succes
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

Voorbeelden

Getting all models owned by account.

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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"
}

Definities

Name	Description
Capabilities	Mogelijkheden
Deprecation	Afschaffing
Error	Fout
ErrorCode	Foutcode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Model
ModelList	Modellijst
TypeDiscriminator	TypeDiscriminator

Capabilities

Mogelijkheden

Name	Type	Description
chat_completion	boolean	Een waarde die aangeeft of een model ondersteuning biedt voor het voltooien van chats.
completion	boolean	Een waarde die aangeeft of een model voltooiing ondersteunt.
embeddings	boolean	Een waarde die aangeeft of een model insluitingen ondersteunt.
fine_tune	boolean	Een waarde die aangeeft of een model kan worden gebruikt voor het afstemmen.
inference	boolean	Een waarde die aangeeft of een model kan worden geïmplementeerd.

Deprecation

Afschaffing

Name	Type	Description
fine_tune	integer	De einddatum voor het afstemmen van de ondersteuning van dit model. Wordt `null` voor het verfijnen van modellen.
inference	integer	De einddatum van de deductieondersteuning van dit model.

Error

Fout

Name	Type	Description
code	ErrorCode	Foutcode Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	De foutdetails indien beschikbaar.
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Het bericht van deze fout.
target	string	De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Foutcode

Name	Type	Description
conflict	string	De aangevraagde bewerking conflicteert met de huidige resourcestatus.
contentFilter	string	Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.
fileImportFailed	string	Importeren van bestand is mislukt.
forbidden	string	De bewerking is verboden voor de huidige gebruiker/API-sleutel.
internalFailure	string	Interne fout. Probeer het opnieuw.
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.
itemDoesAlreadyExist	string	Het item bestaat al.
jsonlValidationFailed	string	Validatie van jsonl-gegevens is mislukt.
notFound	string	De resource is niet gevonden.
quotaExceeded	string	Het quotum is overschreden.
serviceUnavailable	string	De service is momenteel niet beschikbaar.
tooManyRequests	string	Te veel aanvragen. Probeer het later opnieuw.
unauthorized	string	De huidige sleutel van de gebruiker/API is niet geautoriseerd voor de bewerking.
unexpectedEntityState	string	De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

Name	Type	Description
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Name	Type	Description
cancelled	string	De bewerking is geannuleerd en is onvolledig. Deze kan worden gecategoriseerd als een terminalstatus.
created	string	De bewerking is gemaakt. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gemaakt voor compatibiliteit. Deze kan worden gecategoriseerd als een inactieve status.
failed	string	De bewerking is voltooid met een fout en kan niet verder worden verbruikt. Deze kan worden gecategoriseerd als een terminalstatus.
pending	string	De bewerking is nog niet in de wachtrij geplaatst om in de toekomst te worden verwerkt. Deze kan worden gecategoriseerd als een inactieve status.
running	string	De bewerking is gestart. Deze kan worden gecategoriseerd als een actieve status.
succeeded	string	De bewerking is verwerkt en is gereed voor gebruik. Deze kan worden gecategoriseerd als een terminalstatus.

InnerError

Name	Type	Description
code	InnerErrorCode	InnerErrorCode Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Type	Description
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.

LifeCycleStatus

Name	Type	Description
generally-available	string	Het model is algemeen beschikbaar.
preview	string	Model is in preview en wordt gedekt door de servicevoorbeeldvoorwaarden.

Model

Name	Type	Description
capabilities	Capabilities	Mogelijkheden De mogelijkheden van een basismodel of het verfijnen van het model.
created_at	integer	Een tijdstempel waarin deze taak of dit item is gemaakt (in unix-epochs).
deprecation	Deprecation	Afschaffing Definieert de datums van afschaffing voor de verschillende use cases van een model. Basismodellen ondersteunen meestal 1 jaar na het maken van de basismodellen. Deductie wordt doorgaans 2 jaar na het maken van basismodellen of nauwkeurig afgestemde modellen ondersteund. De exacte datums worden opgegeven in de eigenschappen.
fine_tune	string	De taakidentiteit (fine-tune-id) als dit een nauwkeurig model is; anders `null`.
id	string	De identiteit van dit item.
lifecycle_status	LifeCycleStatus	LifeCycleStatus De levenscyclusstatus van een model. Opmerking: Een model kan worden gepromoveerd van 'preview' naar 'algemeen beschikbaar', maar nooit van 'algemeen beschikbaar' tot 'preview'.
model	string	De basismodelidentiteit (model-id) als dit een nauwkeurig model is; anders `null`.
object	TypeDiscriminator	TypeDiscriminator Hiermee definieert u het type van een object.
status	FineTuningState	FineTuningState De status van een finetunes object of fine tuning taak.

ModelList

Modellijst

Name	Type	Description
data	Model[]	De lijst met items.
object	TypeDiscriminator	TypeDiscriminator Hiermee definieert u het type van een object.

TypeDiscriminator

Name	Type	Description
batch	string	Dit object vertegenwoordigt een batch.
file	string	Dit object vertegenwoordigt een bestand.
fine_tuning.job	string	Dit object vertegenwoordigt een taak voor het afstemmen.
fine_tuning.job.checkpoint	string	Dit object vertegenwoordigt een controlepunt van een taak voor het afstemmen.
fine_tuning.job.event	string	Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.
list	string	Dit object vertegenwoordigt een lijst met andere objecten.
model	string	Dit object vertegenwoordigt een model (kan een basismodel zijn of taakresultaat verfijnen).
upload	string	Dit object vertegenwoordigt een bestand uploaden.
upload.part	string	Dit object vertegenwoordigt een deel van een bestandsupload.

Delen via