Models - List

Layanan:: Azure AI Services

Versi API:: 2024-10-21

Mendapatkan daftar semua model yang dapat diakses oleh sumber daya Azure OpenAI. Ini termasuk model dasar serta semua model yang berhasil diselesaikan yang disempurnakan yang dimiliki oleh sumber daya Azure OpenAI.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (url)	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama akun Azure OpenAI Anda).
api-version	query	True	string	Versi API yang diminta.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
api-key	True	string	Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Respons

Nama	Jenis	Deskripsi
200 OK	ModelList	Keberhasilan
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

api-key

Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Jenis: apiKey
Dalam: header

Contoh

Getting all models owned by account.

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
}

Definisi

Nama	Deskripsi
Capabilities	Kemampuan
Deprecation	Penghentian
Error	Kesalahan
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Pola
ModelList	Daftar Model
TypeDiscriminator	TypeDiscriminator

Capabilities

Objek

Kemampuan

Nama	Jenis	Deskripsi
chat_completion	boolean	Nilai yang menunjukkan apakah model mendukung penyelesaian obrolan.
completion	boolean	Nilai yang menunjukkan apakah model mendukung penyelesaian.
embeddings	boolean	Nilai yang menunjukkan apakah model mendukung penyematan.
fine_tune	boolean	Nilai yang menunjukkan apakah model dapat digunakan untuk penyetelan halus.
inference	boolean	Nilai yang menunjukkan apakah model dapat disebarkan.

Deprecation

Objek

Penghentian

Nama	Jenis	Deskripsi
fine_tune	integer (unixtime)	Tanggal akhir menyempurnakan dukungan model ini. Akan `null` untuk menyempurnakan model.
inference	integer (unixtime)	Tanggal akhir dukungan inferensi dari model ini.

Error

Objek

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	ErrorCode Kode kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Detail kesalahan jika tersedia.
innererror	InnerError	InnerError Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Pesan kesalahan ini.
target	string	Lokasi tempat kesalahan terjadi jika tersedia.

ErrorCode

Enumerasi

ErrorCode

Nilai	Deskripsi
conflict	Operasi yang diminta berkonflik dengan status sumber daya saat ini.
invalidPayload	Data permintaan tidak valid untuk operasi ini.
forbidden	Operasi dilarang untuk kunci pengguna/api saat ini.
notFound	Sumber daya tidak ditemukan.
unexpectedEntityState	Operasi tidak dapat dijalankan dalam status sumber daya saat ini.
itemDoesAlreadyExist	Item sudah ada.
serviceUnavailable	Layanan saat ini tidak tersedia.
internalFailure	Kesalahan internal. Silakan coba lagi.
quotaExceeded	Kuota terlampaui.
jsonlValidationFailed	Validasi data jsonl gagal.
fileImportFailed	Impor file gagal.
tooManyRequests	Terlalu banyak permintaan. Silakan coba lagi nanti.
unauthorized	Kunci pengguna/api saat ini tidak diotorisasi untuk operasi.
contentFilter	Pembuatan gambar gagal sebagai akibat dari sistem keamanan kami.

ErrorResponse

Objek

ErrorResponse

Nama	Jenis	Deskripsi
error	Error	Kesalahan Konten kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Enumerasi

FineTuningState

Nilai	Deskripsi
created	Operasi dibuat. Status ini tidak dikembalikan oleh Azure OpenAI dan hanya diekspos untuk kompatibilitas. Ini dapat dikategorikan sebagai status tidak aktif.
pending	Operasi ini belum diantrekan untuk diproses di masa mendatang. Ini dapat dikategorikan sebagai status tidak aktif.
running	Operasi telah mulai diproses. Ini dapat dikategorikan sebagai status aktif.
succeeded	Operasi telah berhasil diproses dan siap untuk dikonsumsi. Ini dapat dikategorikan sebagai status terminal.
cancelled	Operasi telah dibatalkan dan tidak lengkap. Ini dapat dikategorikan sebagai status terminal.
failed	Operasi telah menyelesaikan pemrosesan dengan kegagalan dan tidak dapat dikonsumsi lebih lanjut. Ini dapat dikategorikan sebagai status terminal.

InnerError

Objek

InnerError

Nama	Jenis	Deskripsi
code	InnerErrorCode	InnerErrorCode Kode kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumerasi

InnerErrorCode

Nilai	Deskripsi
invalidPayload	Data permintaan tidak valid untuk operasi ini.

LifeCycleStatus

Enumerasi

LifeCycleStatus

Nilai	Deskripsi
preview	Model dalam pratinjau dan dicakup oleh persyaratan pratinjau layanan.
generally-available	Model umumnya tersedia.

Model

Objek

Pola

Nama	Jenis	Deskripsi
capabilities	Capabilities	Kemampuan Kemampuan model dasar atau menyempurnakan.
created_at	integer (unixtime)	Tanda waktu ketika pekerjaan atau item ini dibuat (dalam epoch unix).
deprecation	Deprecation	Penghentian Menentukan tanggal penghentian untuk berbagai kasus penggunaan model. Biasanya model dasar mendukung penyetelan halus selama 1 tahun setelah pembuatan. Inferensi biasanya didukung 2 tahun setelah pembuatan model dasar atau yang disempurnakan. Tanggal yang tepat ditentukan dalam properti.
fine_tune	string	Menyempurnakan identitas pekerjaan (fine-tune-id) jika ini adalah model penyetelan halus; jika tidak, `null`.
id	string	Identitas item ini.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Status siklus hidup model. Catatan: Model dapat dipromosikan dari "pratinjau" ke "tersedia secara umum", tetapi tidak pernah dari "tersedia secara umum" ke "pratinjau".
model	string	Identitas model dasar (model-id) jika ini adalah model penyetelan halus; jika tidak, `null`.
object	TypeDiscriminator	TypeDiscriminator Menentukan jenis objek.
status	FineTuningState	FineTuningState Status objek finetunes atau pekerjaan penyetelan halus.

ModelList

Objek

Daftar Model

Nama	Jenis	Deskripsi
data	Model[]	Daftar item.
object	TypeDiscriminator	TypeDiscriminator Menentukan jenis objek.

TypeDiscriminator

Enumerasi

TypeDiscriminator

Nilai	Deskripsi
list	Objek ini mewakili daftar objek lain.
fine_tuning.job	Objek ini mewakili pekerjaan penyetelan halus.
file	Objek ini mewakili file.
fine_tuning.job.event	Objek ini mewakili peristiwa pekerjaan penyetelan halus.
fine_tuning.job.checkpoint	Objek ini mewakili titik pemeriksaan dari pekerjaan penyetelan halus.
model	Objek ini mewakili model (dapat menjadi model dasar atau menyempurnakan hasil pekerjaan).
batch	Objek ini mewakili batch.
upload	Objek ini mewakili unggahan file.
upload.part	Objek ini mewakili bagian dari unggahan file.