Başvuru: Eklemeler | Azure Machine Learning

Giriş metnini temsil eden bir ekleme vektöru oluşturur.

POST /embeddings?api-version=2024-04-01-preview

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
api-version	query	Doğru	Dize	API'nin "YYYY-AA-GG" veya "YYYY-AA-GG-önizleme" biçimindeki sürümü.

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
ek parametreler		Dize	Yükte ek parametreler belirtildiğinde API'nin davranışı. kullanarak pass-through api parametresini temel alınan modele geçirir. Temel alınan modelin destekleyebileceğinizi bildiğiniz parametreleri geçirmek istediğinizde bu değeri kullanın. komutunun kullanılması ignore , DESTEKLENMEYEn herhangi bir parametreyi bırakmak için API'yi yapar. Farklı modellerde aynı yükü kullanmanız gerektiğinde bu değeri kullanın, ancak ek parametrelerden biri desteklenmediğinde modelin hata vermesine neden olabilir. kullanmak error , yükteki ek parametreleri reddetmek için API'yi yapar. Yalnızca bu API'de belirtilen parametreler gösterilebilir veya 400 hatası döndürülür.
azureml-model-deployment		Dize	İsteği yönlendirmek istediğiniz dağıtımın adı. Birden çok dağıtımı destekleyen uç noktalar için desteklenir.

İstek Gövdesi

Veri Akışı Adı	Zorunlu	Türü	Açıklama
input	True	string[]	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin.
boyutlar		integer	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
encoding_format		EmbeddingEncodingFormat	Eklemelerin döndürüleceği biçim. Base64, float, int8, uint8, binary veya ubinary. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
input_type		EmbeddingInputType	Girişin türü. , textqueryveya document. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.

Yanıtlar

Adı	Tür	Açıklama
200 Tamam	CreateEmbeddingResponse	Tamam
401 Yetkisiz	UnauthorizedError	Erişim belirteci eksik veya geçersiz Üst Bilgiler x-ms-error-code: dize
404 Bulunamadı	NotFoundError	Model tarafından desteklenmeyen modalite. Hangi yolların kullanılabilir olduğunu görmek için modelin belgelerine bakın. Üst Bilgiler x-ms-error-code: dize
422 İşlenemeyen Varlık	UnprocessableContentError	İstek işlenemez içerik içeriyor Üst Bilgiler x-ms-error-code: dize
429 Çok Fazla İstek Var	TooManyRequestsError	Atanan hız sınırınıza ulaştınız ve isteğinizin ilerlemesi gerekiyor. Üst Bilgiler x-ms-error-code: dize
Diğer Durum Kodları	ContentFilterError	Hatalı istek Üst Bilgiler x-ms-error-code: dize

Güvenlik

Yetkilendirme

belirteci ile birlikte Bearer: prefix, örneğin Bearer abcde12345

Tür: apiKey In: üst bilgi

AADToken

Azure Active Directory OAuth2 kimlik doğrulaması

Tür: oauth2 Flow: uygulama Belirteci URL'si: https://login.microsoftonline.com/common/oauth2/v2.0/token

Örnekler

Giriş metnini temsil eden bir ekleme vektöru oluşturur

Örnek İstek

POST /embeddings?api-version=2024-04-01-preview

{
  "input": [
    "This is a very good text"
  ],
  "input_type": "text",
  "encoding_format": "float",
  "dimensions": 1024
}

Örnek Yanıtı

Durum kodu: 200

{
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "BERT",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Tanımlar

Veri Akışı Adı	Açıklama
ContentFilterError	İstem yapılandırıldığı gibi bir içerik filtresi tetiklediğinde API çağrısı başarısız olur. İstemi değiştirin ve yeniden deneyin.
CreateEmbeddingRequest	Ekleme oluşturma isteği.
CreateEmbeddingResponse	Ekleme isteğinden gelen yanıt.
Ayrıntı	Hataların ayrıntıları.
Ekleme	Oluşturulan ekleme nesnesini temsil eder.
EmbeddingEncodingFormat	Eklemelerin döndürüleceği biçim. Base64, float, int8, uint8, binary veya ubinary. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
EmbeddingInputType	Girişin türü. , textqueryveya document. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
EmbeddingObject	Her zaman "ekleme" olan nesne türü.
ListObject	Her zaman "list" olan nesne türü.
NotFoundError	Yol, dağıtılan model için geçerli değil.
TooManyRequestsError	Atanan hız sınırınıza ulaştınız ve isteklerinizin hızlanması gerekiyor.
UnauthorizedError	Kimlik doğrulaması eksik veya geçersiz.
UnprocessableContentError	İstek işlenemez içerik içeriyor. Belirtilen yük bu belirtime göre geçerli olduğunda hata döndürülür. Ancak, yükte belirtilen yönergelerden bazıları temel alınan model tarafından desteklenmez. Sorunlu parametreyi details anlamak için bölümünü kullanın.
Kullanım	İsteğin kullanım bilgileri.

ContentFilterError

İstem yapılandırıldığı gibi bir içerik filtresi tetiklediğinde API çağrısı başarısız olur. İstemi değiştirin ve yeniden deneyin.

Adı	Tür	Açıklama
kod	Dize	Hata kodu.
error	Dize	Hata açıklaması.
ileti	Dize	Hata iletisi.
param	Dize	İçerik filtresini tetikleyen parametre.
durum	integer	HTTP durum kodu.

CreateEmbeddingRequest

Ekleme oluşturma isteği.

Veri Akışı Adı	Zorunlu	Türü	Açıklama
input	True	string[]	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin.
boyutlar		integer	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
encoding_format		EmbeddingEncodingFormat	Eklemelerin döndürüleceği biçim. Base64, float, int8, uint8, binary veya ubinary. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.
input_type		EmbeddingInputType	Girişin türü. , textqueryveya document. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.

CreateEmbeddingResponse

Ekleme isteğinden gelen yanıt.

Adı	Tür	Açıklama
veriler	Ekleme[]	Model tarafından oluşturulan eklemelerin listesi.
model	Dize	Eklemeyi oluşturmak için kullanılan modelin adı.
nesne	ListObject	Her zaman "list" olan nesne türü.
kullanım	Kullanım	İsteğin kullanım bilgileri.

Ayrıntı

UnprocessableContentError hatasının ayrıntıları.

Adı	Tür	Açıklama
loc	string[]	Soruna neden olan parametre
değer	Dize	Parametreye geçirilen değer sorunlara neden oluyor.

Ekleme

Oluşturulan ekleme işlemini temsil eder.

Adı	Tür	Açıklama
Katıştırma	[]	Ekleme vektör. Vektör uzunluğu kullanılan modele, türü ise kullanılan modele encoding_format bağlıdır.
dizin	integer	Eklemeler listesindeki ekleme dizini.
nesne	EmbeddingObject	Her zaman "ekleme" olan nesne türü.

EmbeddingEncodingFormat

Eklemelerin döndürüleceği biçim. Base64, float, int8, uint8, binary veya ubinary. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.

Adı	Tür	Açıklama
base64	Dize
ikili	Dize
kayan noktalı sayı	Dize
int8	Dize
ubinary	Dize
uint8	Dize

EmbeddingInputType

Girişin türü. , textqueryveya document. Model değeri veya parametreyi desteklemiyorsa 422 hatası döndürür.

Adı	Tür	Açıklama
belge	Dize	Girişin vektör veritabanında depolanan bir belgeyi temsil ettiğini gösterir.
query	Dize	Girişin, vektör veritabanınızdaki en uygun belgeleri bulmak için bir arama sorgularını temsil eder.
text	Dize	Girişin genel bir metin girişi olduğunu gösterir.

EmbeddingObject

Adı	Tür	Açıklama
Katıştırma	Dize

ListObject

Her zaman "list" olan nesne türü.

Adı	Tür	Tanım
listele	Dize

NotFoundError

Adı	Tür	Açıklama
error	Dize	Hata açıklaması.
ileti	Dize	Hata iletisi.
durum	integer	HTTP durum kodu.

TooManyRequestsError

Adı	Tür	Açıklama
error	Dize	Hata açıklaması.
ileti	Dize	Hata iletisi.
durum	integer	HTTP durum kodu.

UnauthorizedError

Adı	Tür	Açıklama
error	Dize	Hata açıklaması.
ileti	Dize	Hata iletisi.
durum	integer	HTTP durum kodu.

UnprocessableContentError

İstek işlenemez içerik içeriyor. Belirtilen yük bu belirtime göre geçerli olduğunda hata döndürülür. Ancak, yükte belirtilen yönergelerden bazıları temel alınan model tarafından desteklenmez. Sorunlu parametreyi details anlamak için bölümünü kullanın.

Adı	Tür	Açıklama
kod	Dize	Hata kodu.
ayrıntı	Ayrıntı
error	Dize	Hata açıklaması.
ileti	Dize	Hata iletisi.
durum	integer	HTTP durum kodu.

Kullanım

İsteğin kullanım bilgileri.

Adı	Tür	Açıklama
prompt_tokens	integer	İstem tarafından kullanılan belirteç sayısı.
total_tokens	integer	İstek tarafından kullanılan toplam belirteç sayısı.