Models - List

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 2023-12-01-preview

Azure OpenAI kaynağı tarafından erişilebilen tüm modellerin listesini alır. Bunlar, temel modellerin yanı sıra Azure OpenAI kaynağının sahip olduğu, başarıyla tamamlanmış tüm ince ayarlı modelleri içerir.

GET {endpoint}/openai/models?api-version=2023-12-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string url	Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI hesap adınızı yazın).
api-version	query	True	string	İstenen API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
api-key	True	string	Bilişsel Hizmetler Azure OpenAI hesap anahtarınızı burada sağlayın.

Yanıtlar

Name	Tür	Description
200 OK	ModelList	Başarılı
Other Status Codes	ErrorResponse	Bir hata oluşmuştur.

Güvenlik

api-key

Bilişsel Hizmetler Azure OpenAI hesap anahtarınızı burada sağlayın.

Tür: apiKey
İçinde: header

Örnekler

Getting all models owned by account.

Örnek isteği

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2023-12-01-preview

Örnek yanıt

Durum kodu:: 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,
      "updated_at": 1646127311,
      "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,
      "updated_at": 1646127311,
      "object": "model"
    }
  ],
  "object": "list"
}

Tanımlar

Name	Description
Capabilities	Özellikler
Deprecation	Kullanımdan kaldırma
Error	Hata
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modelleme
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Özellikler

Name	Tür	Description
chat_completion	boolean	Modelin sohbet tamamlanmasını destekleyip desteklemediğini gösteren değer.
completion	boolean	Modelin tamamlanmasını destekleyip desteklemediğini gösteren değer.
embeddings	boolean	Modelin eklemeleri destekleyip desteklemediğini gösteren değer.
fine_tune	boolean	Modelin ince ayar için kullanılıp kullanılamayacağını gösteren değer.
inference	boolean	Modelin dağıtılıp dağıtılamayacağını gösteren değer.

Deprecation

Kullanımdan kaldırma

Name	Tür	Description
fine_tune	integer	Bu modelin ince ayar desteğinin bitiş tarihi. İnce ayar modelleri için olacaktır `null` .
inference	integer	Bu modelin çıkarım desteğinin bitiş tarihi.

Error

Hata

Name	Tür	Description
code	ErrorCode	ErrorCode Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ) tanımlanan hata kodları.
details	Error[]	Varsa hata ayrıntıları.
innererror	InnerError	InnerError Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ) tanımlandığı gibi iç hata.
message	string	Bu hatanın iletisi.
target	string	Varsa hatanın oluştuğu konum.

ErrorCode

Name	Tür	Description
conflict	string	İstenen işlem geçerli kaynak durumuyla çakişer.
contentFilter	string	Güvenlik sistemimizin bir sonucu olarak görüntü oluşturma başarısız oldu.
fileImportFailed	string	Dosya içeri aktarılamadı.
forbidden	string	geçerli kullanıcı/api anahtarı için işlem yasaktır.
internalFailure	string	İç hata. Lütfen yeniden deneyin.
invalidPayload	string	İstek verileri bu işlem için geçersiz.
itemDoesAlreadyExist	string	Öğe zaten var.
jsonlValidationFailed	string	Jsonl verileri doğrulanamadı.
notFound	string	Kaynak bulunamadı.
quotaExceeded	string	Kota aşıldı.
serviceUnavailable	string	Hizmet şu anda kullanılamıyor.
tooManyRequests	string	Çok fazla istek var. Daha sonra yeniden deneyin.
unauthorized	string	Geçerli kullanıcı/api anahtarı işlem için yetkilendirilmedi.
unexpectedEntityState	string	İşlem geçerli kaynağın durumunda yürütülemez.

ErrorResponse

Name	Tür	Description
error	Error	Hata Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ) tanımlanan hata içeriği.

FineTuningState

Name	Tür	Description
cancelled	string	İşlem iptal edildi ve tamamlanmadı. Terminal durumu olarak kategorilere ayırılabilir.
created	string	İşlem oluşturuldu. Bu durum Azure OpenAI tarafından döndürülmedi ve yalnızca uyumluluk için kullanıma sunuldu. Etkin olmayan bir durum olarak kategorilere ayrılmış olabilir.
failed	string	İşlem bir hatayla işlemeyi tamamladı ve daha fazla kullanılamaz. Terminal durumu olarak kategorilere ayırılabilir.
pending	string	İşlem henüz gelecekte işlenmek üzere kuyruğa alınmadı. Etkin olmayan bir durum olarak kategorilere ayrılmış olabilir.
running	string	İşlem işlenmeye başlandı. Etkin bir durum olarak kategorilere ayrılmış olabilir.
succeeded	string	İşlem başarıyla işlendi ve kullanıma hazır. Terminal durumu olarak kategorilere ayırılabilir.

InnerError

Name	Tür	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ) tanımlanan iç hata kodları.
innererror	InnerError	InnerError Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ) tanımlandığı gibi iç hata.

InnerErrorCode

Name	Tür	Description
invalidPayload	string	İstek verileri bu işlem için geçersiz.

LifeCycleStatus

Name	Tür	Description
generally-available	string	Model genel kullanıma sunulmuştur.
preview	string	Model önizleme aşamasındadır ve hizmet önizleme koşulları kapsamındadır.

Model

Modelleme

Name	Tür	Description
capabilities	Capabilities	Özellikler Temel veya ince ayar modelinin özellikleri.
created_at	integer	Bu işin veya öğenin oluşturulduğu zaman damgası (unix dönemlerinde).
deprecation	Deprecation	Kullanımdan kaldırma Modelin farklı kullanım örnekleri için kullanımdan kaldırma tarihlerini tanımlar. Genellikle temel modeller oluşturulduktan sonra 1 yıllık ince ayarlamayı destekler. Çıkarım genellikle temel veya ince ayarlı modellerin oluşturulmasından 2 yıl sonra desteklenir. Tam tarihler özelliklerde belirtilir.
fine_tune	string	Bu bir ince ayar modeliyse, ince ayar iş kimliği (ince ayar kimliği) ; aksi takdirde `null`.
id	string	Bu öğenin kimliği.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Modelin yaşam döngüsü durumu. Not: Bir model "önizleme"den "genel kullanıma" yükseltilebilir, ancak hiçbir zaman "genel kullanıma açık" olandan "önizlemeye" yükseltilebilir.
model	string	Bu bir ince ayar modeliyse temel model kimliği (model-kimliği); aksi takdirde `null`.
object	TypeDiscriminator	TypeDiscriminator Nesnenin türünü tanımlar.
status	FineTuningState	FineTuningState Finetunes nesnesinin veya ince ayar işinin durumu.
updated_at	integer	Bu işin veya öğenin en son değiştirildiği zaman damgası (unix dönemlerinde).

ModelList

Name	Tür	Description
data	Model[]	Öğe listesi.
object	TypeDiscriminator	TypeDiscriminator Nesnenin türünü tanımlar.

TypeDiscriminator

Name	Tür	Description
file	string	Bu nesne bir dosyayı temsil eder.
fine-tune	string	Bu nesne ince ayar işini temsil eder.
fine-tune-event	string	Bu nesne, ince ayar işinin olayını temsil eder.
fine_tuning.job	string	Bu nesne ince ayar işini temsil eder.
fine_tuning.job.event	string	Bu nesne, ince ayar işinin olayını temsil eder.
list	string	Bu nesne, diğer nesnelerin listesini temsil eder.
model	string	Bu nesne bir modeli temsil eder (temel model veya ince ayar iş sonucu olabilir).

Aracılığıyla paylaş