Files - Upload

Hizmet:: Azure AI Services

API Sürümü:: 2024-10-21

Yerel bir makineden veri yükleyerek yeni bir dosya varlığı oluşturur. Karşıya yüklenen dosyalar, örneğin hassas ayarlanmış modelleri eğit veya değerlendirmek için kullanılabilir.

POST {endpoint}/openai/files?api-version=2024-10-21

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
file	formData	True	file	Dosyayı Azure OpenAI'ye yüklenecek şekilde alır veya ayarlar.
purpose	formData	True	Purpose	Karşıya yüklenen belgelerin amaçlanan amacı. İnce ayar yapmak için "ince ayar" kullanın. Bu, karşıya yüklenen dosyanın biçimini doğrulamamıza olanak tanır.
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ığı

Media Types: "multipart/form-data"

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

Yanıtlar

Name	Tür	Description
201 Created	File	Dosya başarıyla oluşturuldu. Üst Bilgiler Location: string
Other Status Codes	ErrorResponse	Bir hata oluştu.

Name

Tür

Description

201 Created

File

Dosya başarıyla oluşturuldu.

Üst Bilgiler

Location: string

Other Status Codes

ErrorResponse

Bir hata oluştu.

Güvenlik

api-key

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

Tür: apiKey
İçinde: header

Örnekler

Upload a file.

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "created_at": 1646126127,
  "object": "file"
}

Tanımlar

Name	Description
Error	Hata
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Dosya
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Amaç
TypeDiscriminator	TypeDiscriminator

Error

Nesne

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ımlanan iç hata.
message	string minLength: 1	Bu hatanın iletisi.
target	string	Varsa hatanın oluştuğu konum.

ErrorCode

Numaralandırma

ErrorCode

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

ErrorResponse

Nesne

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.

File

Nesne

Dosya

Name	Tür	Description
bytes	integer (int64)	Kullanılabilir olduğunda bu dosyanın boyutu (null olabilir). JavaScript tamsayılarıyla uyumluluğu sağlamak için 2^53-1'den büyük dosya boyutları desteklenmez.
created_at	integer (unixtime)	Bu işin veya öğenin oluşturulduğu zaman damgası (unix dönemlerinde).
filename	string minLength: 1	Dosyanın adı.
id	string	Bu öğenin kimliği.
object	TypeDiscriminator	TypeDiscriminator Bir nesnenin türünü tanımlar.
purpose	Purpose	Amaç Karşıya yüklenen belgelerin amaçlanan amacı. İnce ayar yapmak için "ince ayar" kullanın. Bu, karşıya yüklenen dosyanın biçimini doğrulamamıza olanak tanır.
status	FileState	FileState Dosyanın durumu.
status_details	string	Bu dosyanın işlenmesinin başarısız olması durumunda ayrıntıları içeren hata iletisi.

FileState

Numaralandırma

FileState

Değer	Description
uploaded	Dosya karşıya yüklendi ancak henüz işlenmedi. 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 ayırılabilir.
pending	İşlem oluşturuldu ve gelecekte işlenmek üzere kuyruğa alınmadı. Etkin olmayan bir durum olarak kategorilere ayırılabilir.
running	İşlem işlenmeye başlandı. Etkin bir durum olarak kategorilere ayırılabilir.
processed	İşlem başarıyla işlendi ve tüketime hazır. Bu, terminal durumu olarak kategorilere ayırılabilir.
error	İşlem bir hatayla işlemeyi tamamladı ve daha fazla kullanılamaz. Bu, terminal durumu olarak kategorilere ayırılabilir.
deleting	Varlık silinecek işlemdir. Bu durum Azure OpenAI tarafından döndürülmedi ve yalnızca uyumluluk için kullanıma sunuldu. Etkin bir durum olarak kategorilere ayırılabilir.
deleted	Varlık silindi, ancak silme işlemini önceden hazırleyen diğer varlıklar tarafından yine de başvurulabilir. Bu, terminal durumu olarak kategorilere ayırılabilir.

InnerError

Nesne

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ımlanan iç hata.

InnerErrorCode

Numaralandırma

InnerErrorCode

Değer	Description
invalidPayload	İstek verileri bu işlem için geçersiz.

Purpose

Numaralandırma

Amaç

Değer	Description
fine-tune	Bu dosya ince ayar işi için eğitim verileri içerir.
fine-tune-results	Bu dosya ince ayar işinin sonuçlarını içerir.
assistants	Bu dosya yardımcılarda kullanılacak verileri içerir.
assistants_output	Bu dosya bir yardımcının sonuçlarını içerir.
batch	Bu dosya bir toplu iş için giriş verilerini içerir.
batch_output	Bu dosya bir toplu işlemin sonuçlarını içerir.

TypeDiscriminator

Numaralandırma

TypeDiscriminator

Değer	Description
list	Bu nesne, diğer nesnelerin listesini temsil eder.
fine_tuning.job	Bu nesne ince ayar işini temsil eder.
file	Bu nesne bir dosyayı temsil eder.
fine_tuning.job.event	Bu nesne, ince ayar işinin olayını temsil eder.
fine_tuning.job.checkpoint	Bu nesne, ince ayar işinin denetim noktasını temsil eder.
model	Bu nesne bir modeli temsil eder (temel model veya ince ayar iş sonucu olabilir).
batch	Bu nesne bir toplu işlemi temsil eder.
upload	Bu nesne bir dosya karşıya yükleme işlemini temsil eder.
upload.part	Bu nesne, dosya karşıya yükleme işleminin bir bölümünü temsil eder.