Çeviri v 3.0

Yenilikler

Çeviri sürüm 3, modern bir JSON tabanlı Web apı 'si sağlar. Mevcut özellikleri daha az işlem halinde birleştirerek kullanılabilirliği ve performansı artırır ve yeni özellikler sağlar.

  • Tek bir dildeki metni bir betikten başka bir betiğe dönüştürmek için alfabe alfabmına dönüştürme.
  • Tek bir istekte birden çok dile çeviri.
  • Tek bir istekte dil algılama, çeviri ve alfabede iyileştirme.
  • Bir terime ait alternatif çevirileri aramak için sözlük, bağlamda kullanılan terimleri gösteren geri çevirileri ve örnekleri bulun.
  • Daha bilgilendirici dil algılama sonuçları.

Temel URL 'Ler

Çeviri istekleri, çoğu durumda, isteğin kaynaklandığı yere en yakın veri merkezi tarafından işlenir. Genel uç nokta kullanılırken bir veri merkezi hatası varsa, istek Coğrafya dışında yönlendirilebilir.

İsteğin belirli bir Coğrafya dahilinde işlenmesine zorlamak için, istenen coğrafi uç noktayı kullanın. Tüm istekler coğrafya içindeki veri merkezleri arasında işlenir.

Coğrafya Temel URL (coğrafi uç noktası) Veri merkezleri
Genel (bölgesel olmayan) api.cognitive.microsofttranslator.com En yakın kullanılabilir veri merkezi
Asya Pasifik api-apc.cognitive.microsofttranslator.com Kore Güney, Japonya Doğu, Güneydoğu Asya ve Avustralya Doğu
Avrupa api-eur.cognitive.microsofttranslator.com Kuzey Avrupa, Batı Avrupa
Birleşik Devletler api-nam.cognitive.microsofttranslator.com Doğu ABD, Orta Güney ABD, Orta Batı ABD ve Batı ABD 2

İsviçre Kuzey veya İsviçre Batı bulunan bir kaynağa sahip 1 müşteri, metin API isteklerinin İsviçre içinde sunulmasını sağlayabilir. isteklerin isviçre 'de işlendiğinden emin olmak için, ' ' İsviçre Kuzey ' veya ' İsviçre Batı ' kaynak bölgesinde Çeviri kaynağını oluşturun, sonra apı isteklerinizin kaynak özel uç noktasını kullanın. örneğin: ' İsviçre Kuzey ' olarak ' kaynak bölgesi ' ile Azure portal bir Çeviri kaynağı oluşturursanız ve kaynak adınız ' my-ch-n ' ise, özel uç noktanız " https://my-ch-n.cognitiveservices.azure.com " olur. Ve çevrilecek örnek bir istek şunlardır:

// Pass secret key and region using headers to a custom endpoint
curl -X POST " my-ch-n.cognitiveservices.azure.com/translator/text/v3.0/translate?to=fr" \
-H "Ocp-Apim-Subscription-Key: xxx" \
-H "Ocp-Apim-Subscription-Region: switzerlandnorth" \
-H "Content-Type: application/json" \
-d "[{'Text':'Hello'}]" -v

2 özel Çeviri, isviçre 'de şu anda kullanılamıyor.

Kimlik Doğrulaması

Azure bilişsel hizmetler 'de Çeviri veya bilişsel hizmetler çoklu hizmet hizmetine abone olun ve kimlik doğrulaması için abonelik anahtarınızı (Azure portal kullanılabilir) kullanın.

Aboneliğinizin kimliğini doğrulamak için kullanabileceğiniz üç üst bilgi vardır. Bu tablo, her birinin nasıl kullanıldığını açıklar:

Üst Bilgiler Description
Ocp-Apim-Subscription-Key Gizli anahtarınızı geçirmektir bilişsel hizmetler aboneliğiyle kullanın.
değer, aboneliğinizin Çeviri Azure gizli anahtarıdır.
Yetkilendirme Kimlik doğrulama belirteci geçirçalışıyorsanız bilişsel hizmetler aboneliğiyle kullanın.
Değer, taşıyıcı belirtecidir: Bearer <token> .
OCP-apim-Subscription-Region Bilişsel hizmetler çoklu hizmet ve bölgesel çevirmen kaynağı ile kullanın.
Değer, çok hizmet veya bölgesel çevirmen kaynağının bölgesidir. Bu değer, genel bir çevirmen kaynağı kullanılırken isteğe bağlıdır.

Gizli anahtar

İlk seçenek üstbilgiyi kullanarak kimlik doğrulaması yapmanız gerekir Ocp-Apim-Subscription-Key . Ocp-Apim-Subscription-Key: <YOUR_SECRET_KEY>Üstbilgiyi isteğinize ekleyin.

Genel kaynakla kimlik doğrulama

küresel bir çevirmen kaynağıkullandığınızda Çeviri çağırmak için bir üst bilgi eklemeniz gerekir.

Üst Bilgiler Description
Ocp-Apim-Subscription-Key değer, aboneliğinizin Çeviri Azure gizli anahtarıdır.

aşağıda, genel çevirmen kaynağını kullanarak Çeviri çağırma isteği verilmiştir

// Pass secret key using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Bölgesel kaynakla kimlik doğrulama

Bölgesel bir çevirmen kaynağıkullandığınızda. Çeviri çağırmanız gereken iki üst bilgi vardır.

Üst Bilgiler Description
Ocp-Apim-Subscription-Key değer, aboneliğinizin Çeviri Azure gizli anahtarıdır.
OCP-apim-Subscription-Region Değer, çevirmen kaynağının bölgesidir.

aşağıda, bölgesel çevirici kaynağını kullanarak Çeviri çağırma isteği verilmiştir

// Pass secret key and region using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Ocp-Apim-Subscription-Region:<your-region>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Çoklu hizmet kaynağıyla kimlik doğrulama

Bilişsel hizmetin çoklu hizmet kaynağını kullandığınızda. Bu, birden çok hizmete yönelik isteklerin kimliğini doğrulamak için tek bir gizli anahtar kullanmanıza olanak sağlar.

Birden çok hizmet gizli anahtarı kullandığınızda, isteğinize iki kimlik doğrulama üst bilgisi eklemeniz gerekir. Çeviri çağırmanız gereken iki üst bilgi vardır.

Üst Bilgiler Description
Ocp-Apim-Subscription-Key Değer, çok hizmet kaynağınız için Azure gizli anahtarı ' dır.
OCP-apim-Subscription-Region Değer, çoklu hizmet kaynağının bölgesidir.

Çoklu hizmet metin API 'SI aboneliği için bölge gereklidir. Seçtiğiniz bölge, çok sunuculu abonelik anahtarını kullanırken metin çevirisi için kullanabileceğiniz tek bölgedir ve Azure portal aracılığıyla çok hizmet aboneliğiniz için kaydolduğunuzda seçtiğiniz bölge olmalıdır.

Sorgu dizesindeki gizli anahtarı parametresiyle geçirirseniz Subscription-Key , bu bölgeyi sorgu parametresiyle birlikte belirtmeniz gerekir Subscription-Region .

Erişim belirteci ile kimlik doğrulama

Alternatif olarak, bir erişim belirteci için gizli anahtarınızı değiş tokuş edebilirsiniz. Bu belirteç her bir isteğe üstbilgi olarak dahildir Authorization . Yetkilendirme belirteci almak için POST AŞAĞıDAKI URL 'ye bir istek yapın:

Kaynak türü Kimlik doğrulama hizmeti URL 'SI
Genel https://api.cognitive.microsoft.com/sts/v1.0/issueToken
Bölgesel veya çok hizmet https://<your-region>.api.cognitive.microsoft.com/sts/v1.0/issueToken

Aşağıda gizli anahtar verilen bir belirteç elde etmek için örnek istekler verilmiştir:

// Pass secret key using header
curl --header 'Ocp-Apim-Subscription-Key: <your-key>' --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken'

// Pass secret key using query string parameter
curl --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken?Subscription-Key=<your-key>'

Başarılı bir istek, kodlanmış erişim belirtecini yanıt gövdesinde düz metin olarak döndürür. geçerli belirteç, Çeviri hizmetine yetkilendirmede bir taşıyıcı belirteci olarak geçirilir.

Authorization: Bearer <Base64-access_token>

Bir kimlik doğrulama belirteci 10 dakika için geçerlidir. Çeviri birden çok çağrı yapıldığında belirtecin yeniden kullanılması gerekir. ancak programınız uzun süre içinde Çeviri istek yapıyorsa, programınızın düzenli aralıklarla yeni bir erişim belirteci istemesi gerekir (örneğin, her 8 dakikada bir).

Azure Active Directory (Azure AD) ile kimlik doğrulaması

Çeviri v 3.0, Microsoft 'un bulut tabanlı kimlik ve erişim yönetimi çözümü olan Azure AD kimlik doğrulamasını destekler. yetkilendirme üstbilgileri, istenen istemcinin kaynağı kullanma yetkisine sahip olduğunu doğrulamak ve isteği gerçekleştirmek için Çeviri hizmetini etkinleştirir.

Önkoşullar

Üst Bilgiler

Üst bilgi Değer
Yetkilendirme Değer, Azure AD tarafından oluşturulan bir erişim taşıyıcı belirtecidir .
  • Taşıyıcı belirteci, kimlik doğrulaması kanıtı sağlar ve istemcinin kaynağı kullanma yetkilendirmesini doğrular.
  • bir kimlik doğrulama belirteci 10 dakika için geçerlidir ve Çeviri için birden çok çağrı yapıldığında yeniden kullanılması gerekir.
  • Bkz . bir erişim belirteciyle kimlik doğrulama, yukarıdaki.
OCP-apim-Subscription-Region Değer, çevirmen kaynağının bölgesidir.
  • Kaynak geneldir ise bu değer isteğe bağlıdır.
OCP-apim-RESOURCEID değer, Çeviri kaynak örneğinizin kaynak kimliğidir.
  • kaynak kimliğini Çeviri kaynak → özelliklerindeki Azure portal bulacaksınız.
  • Kaynak KIMLIĞI biçimi:
    /Subscriptions/<subscriptionıd>/resourceGroups/<resourcegroupname>/Providers/Microsoft.CognitiveServices/accounts/<resourceName>/
Çeviri özellik sayfası — Azure portal

ekran görüntüsü: Azure portal Çeviri özellikler sayfası.

Örnekler

Genel uç noktasını kullanma

 // Using headers, pass a bearer token generated by Azure AD, resource ID, and the region.

curl -X POST "https://api.cognitive.microsofttranslator.com/translator/text/v3.0/translate?api-version=3.0&to=es" \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Ocp-Apim-ResourceId: <Resource ID>" \
     -H "Ocp-Apim-Subscription-Region: <your-region>" \
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Özel uç noktanızı kullanma

// Using headers, pass a bearer token generated by Azure AD.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Yönetilen kimlikleri kullanan örnekler

Çeviri v 3.0, yönetilen kimliklere erişim yetkisi verme da destekler. Bir çevirmen kaynağı için yönetilen bir kimlik etkinleştirilmişse, istek üstbilgisinde yönetilen kimlik tarafından oluşturulan taşıyıcı belirtecini geçirebilirsiniz.

Genel uç nokta ile

// Using headers, pass a bearer token generated either by Azure AD or Managed Identities, resource ID, and the region.

curl -X POST https://api.cognitive.microsofttranslator.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Ocp-Apim-ResourceId: <Resource ID>" \
     -H "Ocp-Apim-Subscription-Region: <your-region>" \
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Özel uç noktanızla

//Using headers, pass a bearer token generated by Managed Identities.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Sanal Ağ desteği

Çeviri hizmeti artık Azure genel bulutunun tüm bölgelerinde sanal ağ (VNET) özellikleri ile kullanılabilir. Sanal ağı etkinleştirmek için bkz . Azure bilişsel Hizmetler sanal ağlarını yapılandırma.

bu özelliği etkinleştirdikten sonra, Çeviri çağırmak için özel uç noktasını kullanmanız gerekir. Küresel çevirmen uç noktasını ("api.cognitive.microsofttranslator.com") kullanamazsınız ve bir erişim belirteciyle kimlik doğrulaması yapılamaz.

Bir çevirici kaynağı oluşturup seçili ağlardan ve özel uç noktalardan erişime izin verdikten sonra özel uç noktayı bulabilirsiniz.

Üst Bilgiler Description
Ocp-Apim-Subscription-Key değer, aboneliğinizin Çeviri Azure gizli anahtarıdır.
OCP-apim-Subscription-Region Değer, çevirmen kaynağının bölgesidir. Kaynak ise bu değer isteğe bağlıdır global

özel uç nokta kullanarak Çeviri çağırma isteği aşağıda verilmiştir

// Pass secret key and region using headers
curl -X POST "https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Ocp-Apim-Subscription-Region:<your-region>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Hatalar

Standart hata yanıtı, ad/değer çifti adlı bir JSON nesnesidir error . Değer aynı zamanda şu özelliklere sahip bir JSON nesnesidir:

  • code: Sunucu tanımlı bir hata kodu.
  • message: Hata için okunabilir bir gösterimi sağlayan bir dize.

Örneğin, ücretsiz deneme aboneliği olan bir müşteri, ücretsiz kota tükendiğinde aşağıdaki hatayı alır:

{
  "error": {
    "code":403001,
    "message":"The operation is not allowed because the subscription has exceeded its free quota."
    }
}

Hata kodu 3 basamaklı HTTP durum kodunu birleştiren 6 basamaklı bir sayıdır ve ardından hatayı daha fazla kategorilere ayırarak 3 basamaklı bir sayıdır. Ortak hata kodları şunlardır:

Kod Description
400000 İstek girişlerinden biri geçerli değil.
400001 "Scope" parametresi geçersiz.
400002 "Category" parametresi geçersiz.
400003 Bir dil tanımlayıcısı eksik veya geçersiz.
400004 Hedef betik Belirleyicisi ("betiğe") eksik veya geçersiz.
400005 Giriş metni eksik veya geçersiz.
400006 Dil ve betiğin birleşimi geçerli değil.
400018 Kaynak betik Belirleyicisi ("betikten") eksik veya geçersiz.
400019 Belirtilen dillerden biri desteklenmez.
400020 Giriş metni dizisindeki öğelerden biri geçerli değil.
400021 API sürümü parametresi eksik veya geçersiz.
400023 Belirtilen dil çiftinin biri geçerli değil.
400035 Kaynak dili ("Kimden" alanı) geçerli değil.
400036 Hedef dil ("to" alanı) eksik veya geçersiz.
400042 Belirtilen seçeneklerden biri ("Seçenekler" alanı) geçerli değil.
400043 İstemci izleme KIMLIĞI (Clienttraceıd alanı veya X-Clienttranceıd üstbilgisi) eksik veya geçersiz.
400050 Giriş metni çok uzun. İstek sınırlarınıgörüntüleyin.
400064 "Translation" parametresi eksik veya geçersiz.
400070 Hedef betiklerin (ToScript parametresi) sayısı, hedef dillerin sayısıyla (parametreye) eşleşmiyor.
400071 Değer TextType için geçerli değil.
400072 Giriş metninin dizisinde çok fazla öğe vardır.
400073 Betik parametresi geçerli değil.
400074 İsteğin gövdesi geçerli bir JSON değil.
400075 Dil çifti ve kategori birleşimi geçerli değil.
400077 İstek boyutu üst sınırı aşıldı. İstek sınırlarınıgörüntüleyin.
400079 Ve dilinden dile arasında çeviri için istenen özel sistem yok.
400080 Söz konusu dil veya betik için alfabede desteklenmez.
401000 Kimlik bilgileri eksik veya geçersiz olduğundan istek yetkilendirilmemiş.
401015 "Belirtilen kimlik bilgileri konuşma API 'SI içindir. Bu istek, metin API 'SI için kimlik bilgileri gerektirir. Çeviri için bir abonelik kullanın. "
403000 İşleme izin verilmiyor.
403001 Abonelik, boş kotasını aştığından işleme izin verilmiyor.
405000 İstek yöntemi istenen kaynak için desteklenmiyor.
408001 İstenen çeviri sistemi hazırlanıyor. Birkaç dakika içinde yeniden deneyin.
408002 Gelen akış beklenirken istek zaman aşımına uğradı. İstemci, sunucunun beklemeye hazırlandığı süre içinde bir istek üretmedi. İstemci daha sonra değişiklik yapmadan isteği yineleyebilir.
415000 Content-Type üst bilgisi eksik veya geçersiz.
429000, 429001, 429002 İstemci istek sınırlarını aştığından, sunucu isteği reddetti.
500000 Beklenmeyen bir hata oluştu. Hata devam ederse, hatayı tarih/saat ile, X-RequestId yanıt başlığından istek tanımlayıcısını ve X-Clienttraceıd istek başlığından istemci tanımlayıcısını bildirin.
503000 Hizmet geçici olarak kullanılamıyor. Retry. Hata devam ederse, hatayı tarih/saat ile, X-RequestId yanıt başlığından istek tanımlayıcısını ve X-Clienttraceıd istek başlığından istemci tanımlayıcısını bildirin.

Ölçümler

Ölçümler, aşağıdaki ekran görüntüsünde gösterildiği gibi ölçümler bölümünde Azure portal, çevirmen kullanım ve kullanılabilirlik bilgilerini görüntülemenize olanak sağlar. Daha fazla bilgi için bkz. veri ve platform ölçümleri.

Çeviri Ölçümler

Bu tablo, kullanılabilir ölçümleri, çeviri API çağrılarını izlemek için nasıl kullanıldıklarından ilgili açıklama ile listeler.

Ölçümler Description
Toplam çağrılar Toplam API çağrısı sayısı.
TotalTokenCalls Kimlik doğrulama belirteci kullanılarak belirteç hizmeti aracılığıyla yapılan toplam API çağrısı sayısı.
Başarılı çağrılar Başarılı çağrı sayısı.
Toplam hata sayısı Hata yanıtı olan çağrı sayısı.
Blockedçağrılarında Oran veya kota sınırını aşan çağrı sayısı.
ServerErrors Sunucu iç hatası olan çağrı sayısı (5XX).
ClientErrors İstemci tarafı hatası (4XX) olan çağrı sayısı.
Gecikme süresi İsteğin tamamlanma süresi (milisaniye).
Karakter Yabanslamuş Gelen metin isteğindeki toplam karakter sayısı.