डेटा सारांश API अवलोकन (पूर्वावलोकन)
[यह आलेख रिलीज़-पूर्व दस्तावेज़ है और परिवर्तन के अधीन है.]
निर्माता पृष्ठ सामग्री सारांश जोड़ने के लिए सारांश API का उपयोग कर सकते हैं जो जनरेटिव AI का उपयोग करता है। Power Pages इस तरह, साइट उपयोगकर्ता पूरे पृष्ठ को देखे बिना ही पृष्ठ की सामग्री का अवलोकन कर सकते हैं। यह API वेब API के शीर्ष पर बनाया गया है जो पृष्ठों पर उपयोग की जाने वाली तालिकाओं पर डेटा सारांश प्रदान करता है। Power Pages Dataverse
महत्त्वपूर्ण
- यह एक पूर्वावलोकन सुविधा है.
- पूर्वावलोकन सुविधाएं उत्पादन उपयोग के लिए नहीं हैं और उनकी कार्यक्षमता सीमित हो सकती है. ये सुविधाएँ उपयोग की अनुपूरक शर्तों के अधीन हैं और आधिकारिक रिलीज़ से पहले उपलब्ध हैं ताकि ग्राहक शीघ्र पहुँच प्राप्त कर सकें और प्रतिक्रिया दे सकें।
पूर्वावश्यकताएँ
- आपको वेब API के लिए साइट सेटिंग सक्षम करनी होगी.
- केवल वे तालिकाएँ जो Power Pages वेब API के लिए समर्थित हैं, सारांशीकरण के लिए उपलब्ध हैं। Power Pages वेब API के बारे में अधिक जानें वेब API अवलोकन में।
- यह सुविधा सरकारी सामुदायिक क्लाउड (GCC), सरकारी सामुदायिक क्लाउड - उच्च (GCC High), या रक्षा विभाग (DoD) क्षेत्रों में उपलब्ध नहीं है।
साइट सेटिंग
अपने वेब API में पृष्ठों को सक्षम करें, और सारांश API सुविधा के लिए निम्नलिखित साइट सेटिंग्स सेट करें।
साइट सेटिंग नाम | विवरण |
---|---|
सारांश/डेटा/सक्षम करें | संक्षेपण सुविधा को सक्षम या अक्षम करें. डिफ़ॉल्ट: गलत मान्य मान: सत्य, असत्य |
सारांश/प्रॉम्प्ट/{any_identifier} | सारांशीकरण के लिए कोई भी निर्देश प्रदान करने के लिए इन सेटिंग्स का उपयोग करें। उदाहरण: |
सारांशीकरण/डेटा/सामग्री आकार सीमा | सारांश सामग्री के लिए इनपुट आकार सीमा संशोधित करें. : पूर्णांक टाइप करें डिफ़ॉल्ट: 100,000 |
API स्कीमा
विधि | URI | JSON नमूना |
---|---|---|
POST | [साइट URI]/_api/summarization/data/v1.0/tablesetname | { "InstructionIdentifier":"", "RecommendationConfig":"" } |
गुण का नाम | विवरण |
---|---|
निर्देश पहचानकर्ता | यह गुण वैकल्पिक है. यदि आप सारांशीकरण के लिए कोई अन्य निर्देश देना चाहते हैं, तो संकेत जोड़ने के लिए साइट सेटिंग्स का उपयोग करें। आपको हमेशा साइट सेटिंग का नाम उसी रूप में प्रदान करना चाहिए जैसा कि पहले परिभाषित किया गया था। |
अनुशंसाकॉन्फ़िगरेशन | यह गुण वैकल्पिक है. यदि आप वह प्रॉम्प्ट पास करना चाहते हैं जिसकी सारांशीकरण API अनुशंसा करता है, तो उसे पास करने के लिए इस गुण का उपयोग करें। मान को हैश किया जाना चाहिए तथा संशोधित नहीं किया जाना चाहिए। |
नोट
एपीआई मानक ओपन डेटा प्रोटोकॉल (OData) विनिर्देशों का पालन करता है जिसका वेब एपीआई समर्थन करता है। Power Pages सारांश API उन सभी पठन कार्यों का समर्थन करता है जिनका वेब API समर्थन करता है। Power Pages
नमूना
मुख्य विवरण और महत्वपूर्ण जानकारी पर ध्यान केंद्रित करके मामले के प्रकार, विषय, विवरण और मामले के इतिहास को संक्षेप में बताएं।
अनुरोध करें
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
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}
प्रत्युत्तर
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="
}
]
}
सारांशीकरण प्रत्युत्तर सारांश को बेहतर बनाने के लिए अनुशंसित संकेत प्रदान करता है। यदि आप इन अनुशंसाओं का उपयोग करना चाहते हैं, तो अनुरोध बॉडी में कॉन्फ़िगरेशन मान को InstructionIdentifier
प्रॉपर्टी के बिना पास करें.
सुरक्षा
सारांश API भूमिका-आधारित सुरक्षा का सम्मान करता है जिसे तालिका और स्तंभ अनुमतियों के लिए कॉन्फ़िगर किया गया है। केवल उन रिकार्डों पर ही सारांशीकरण के लिए विचार किया जाता है जिन तक उपयोगकर्ता की पहुंच होती है।
सारांश API को प्रमाणित करना
आपको प्रमाणीकरण कोड शामिल करना आवश्यक नहीं है, क्योंकि अनुप्रयोग सत्र प्रमाणीकरण और प्राधिकरण का प्रबंधन करता है। सभी वेब API कॉल में क्रॉस-साइट अनुरोध जालसाजी (CSRF) टोकन शामिल होना चाहिए।
त्रुटि कोड और संदेश
निम्न तालिका उन विभिन्न त्रुटि कोडों और संदेशों का वर्णन करती है, जिनका सामना आपको सारांशीकरण API का उपयोग करते समय करना पड़ सकता है।
स्थिति कोड | त्रुटि कोड | त्रुटि संदेश: |
---|---|---|
400 | 90041001 | जनरेटिव AI सुविधाएँ अक्षम हैं |
400 | 90041003 | इस साइट के लिए डेटा सारांशीकरण अक्षम किया गया है। साइट सेटिंग का उपयोग करके सक्षम करें. |
400 | 90041004 | सामग्री की लंबाई सीमा से अधिक है |
400 | 90041005 | सारांशित करने के लिए कोई रिकॉर्ड नहीं मिला |
400 | 90041006 | सामग्री सारांशित करते समय त्रुटि हुई. |