Veri özetleme API'sine genel bakış (önizleme)

[Bu makale yayın öncesi belgedir ve değişebilir.]

Üreticiler, üretken yapay zeka ile sayfa içeriği özetlemesi eklemek için Power Pages özetleme API'sini kullanırlar. Bu özellik, site kullanıcılarının sayfanın tamamını okumadan bir sayfanın içeriğine genel bir bakış elde etmelerini sağlar. API, sayfalarda kullanılan Dataverse tablo için veri özetleme sağlayan Power Pages Web API üzerine kurulmuştur.

Important

  • Bu bir önizleme özelliğidir.
  • Önizleme özellikleri, üretimde kullanıma yönelik değildir ve sınırlı işlevselliğe sahip olabilir. Bu özellikler, ek kullanım koşullarına tabidir ve resmi sürümden önce kullanılabilir, böylece müşteriler erken erişim elde edebilir ve geri bildirim sağlayabilir.

Prerequisites

  • Web API için site ayarlarını etkinleştirin.
  • Özetleme için yalnızca Power Pages Web API tarafından desteklenen tablolar kullanılabilir. Power Pages Web API hakkında daha fazla bilgi edinmek için Web API genel bakışına bakın.

Site ayarları

Web API'nizde sayfaları etkinleştirin ve özetleme API'si özelliği için aşağıdaki site ayarlarını yapın.

Site ayarı adı Description
Özetleme/Veri/Etkinleştir Özetleme özelliğini etkinleştirin veya devre dışı bırakın.
Varsayılan: yanlış
Geçerli değerler: doğru, yanlış
Özetleme/komut istemi/{any_identifier}

Özetleme yönergeleri sağlamak için bu ayarları kullanın.
Tür: dize

Örnek:
Adı: Özetleme/istem/durum_özeti
Değer: Temel ayrıntıları ve kritik bilgileri özetleyin

Özetleme/Veri/İçerikBoyutuSınırı Özetleme içeriği için giriş boyutu sınırını değiştirin.
Tür: tamsayı
Varsayılan: 100000 karakter

API şeması

Yöntem URI JSON Örneği
PAYLAŞ [Site URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Özellik adı Description
TalimatTanımlayıcı Bu özellik isteğe bağlıdır. Özetleme için ek talimatlar iletmek için, komutu eklemek üzere site ayarlarını kullanın. Site ayarı adını her zaman daha önce tanımlandığı şekilde girin.
RecommendationConfig Bu özellik isteğe bağlıdır. Özetleme API'si tarafından önerilen komutu iletmek için bu özelliği kullanın. Değerin hashlenmesi ve değiştirilmemesi gerekir.

Note

API, Power Pages Web API tarafından desteklenen standart Açık Veri Protokolü (OData) özelliklerini takip eder. Özetleme API'si, Power Pages Web API'sinde mevcut olan tüm okuma işlemlerini destekler.

Örnek

Önemli ayrıntılara ve önemli bilgilere odaklanarak vaka türünü, konusunu, açıklamasını ve vaka geçmişini özetleyin.

İstek

POST [Power Pages URL]/_api/summarization/data/v1.0/incidents(aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb)?$select=description,title&$expand=incident_adx_portalcomments($select=description)
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

Body:
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}

Yanıt

HTTP/1.1 200 OK
OData-Version: 4.0
{
  "Summary": "The data results provide information…",
  "Recommendations": [
    {
      "Text": "would you like to know about…?",
      "Config": "HSYmaicakjvIwTFYeCIjKOyC7nQ4RTSiDJ+/LBK56r4="
    }
  ]
}

Özetleme yanıtı, özette ince ayar yapmak için önerilen istemler sağlar. Bu önerileri kullanmak için, istek gövdesinde yapılandırma değerini InstructionIdentifier özelliği olmadan geçirin.

Security

Özetleme API'si, tablo ve sütun izinleri için yapılandırılan rol tabanlı güvenliğe uyar. Yalnızca kullanıcının özetleme için erişebileceği kayıtları dikkate alır.

Özetleme API'sinin kimliğini doğrulama

Uygulama oturumu kimlik doğrulama ve yetkilendirmeyi yönettiğinden, kimlik doğrulaması kodu eklemeniz gerekmez. Tüm Web API çağrıları, siteler arası istek sahteciliği (CSRF) belirtecini içermelidir.

Hata kodları ve iletileri

Aşağıdaki tabloda, özetleme API'sini kullanırken karşılaşabileceğiniz farklı hata kodları ve iletileri açıklanmaktadır.

Durum kodu Hata kodu Hata iletisi
400 90041001 Üretici AI özellikleri devre dışı bırakıldı
400 Kategori 90041003 Bu site için veri özetleme devre dışı bırakıldı. Site ayarını kullanarak etkinleştirin.
400 90041004 İçerik uzunluğu sınırı aşıyor
400 Kategori 90041005 Özetlenecek kayıt bulunamadı
400 90041006 İçerik özetlenirken hata oluştu.

Veri özetleme API'si için SSS