Partage via

Vue d’ensemble de l’API de résumé des données (version préliminaire)

  • Article

[Cet article fait partie de la documentation en version préliminaire et peut faire l’objet de modifications.]

Les créateurs peuvent utiliser l’API de résumé Power Pages pour ajouter un résumé du contenu de la page qui utilise l’IA générative. De cette façon, les utilisateurs du site peuvent avoir un aperçu du contenu d’une page sans avoir à parcourir toute la page. L’API est basée sur l’API web Power Pages qui fournit un résumé des données sur les tables Dataverse utilisées dans les pages.

Important

  • Cette fonctionnalité est en version préliminaire.
  • Les fonctionnalités en version préliminaire ne sont pas destinées à une utilisation en production et peuvent être restreintes. Ces fonctionnalités sont soumises à des conditions d’utilisation supplémentaires, et sont disponibles avant une version officielle de telle sorte que les clients puissent tirer parti d’un accès anticipé et fournir leurs commentaires.

Prérequis

  • Vous devez activer les paramètres du site pour l’API web.
  • Seules les tables prises en charge pour l’API web Power Pages sont disponibles pour le résumé. Pour en savoir plus sur l’API web Power Pages, consultez Vue d’ensemble de l’API web.
  • La fonctionnalité n’est pas disponible dans les régions Government Community Cloud (GCC), Government Community Cloud - High (GCC High) ou Department of Defense (DoD).

Paramètres du site

Activez les pages dans votre API web et définissez les paramètres de site suivants pour la fonctionnalité d’API de résumé.

Nom du paramètre du site Description
Résumé/Données/Activer Activez ou désactivez la fonctionnalité de résumé.
Valeur par défaut : False
Valeurs valides : True, False
Résumé/invite/{any_identifier}

Utilisez ces paramètres pour fournir des instructions pour le résumé.
Type : chaîne

Exemple :
Nom : Résumé/invite/case_summary
Valeur : Résumer les détails clés et les informations critiques
Résumé/Données/ContentSizeLimit Modifiez la limite de taille de l’entrée pour le contenu du résumé.
Type : entier
Valeur par défaut : 100 000

Schéma API

méthode URI Exemple JSON
PUBLICATION [URI du site]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nom de la propriété Description
InstructionIdentifier Cette propriété est facultative. Si vous souhaitez transmettre toute autre instruction pour le résumé, utilisez les paramètres du site pour ajouter l’invite. Vous devez toujours fournir le nom du paramètre du site tel qu’il a été défini précédemment.
RecommendationConfig Cette propriété est facultative. Si vous transmettez l’invite recommandée par l’API de résumé, utilisez cette propriété pour la transmettre. La valeur doit être hachée et non modifiée.

Note

L’API suit les spécifications OData (Open Data Protocol) standard prises en charge par l’API Power Pages Web. L’API de résumé prend en charge toutes les opérations de lecture prises en charge par l’API web Power Pages.

Sample

Résumez le type de cas, le sujet, la description et l’historique du cas en vous concentrant sur les détails clés et les informations essentielles.

Demander

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"
}

Response

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="
    }
  ]
}

La réponse de résumé fournit des invites recommandées pour affiner le résumé. Si vous souhaitez utiliser ces recommandations, transmettez la valeur de configuration dans le corps de la demande sans la propriété InstructionIdentifier.

Sécurité

L’API de résumé respecte la sécurité basée sur les rôles qui est configurée pour les autorisations de table et de colonne. Seuls les enregistrements auxquels l’utilisateur a accès sont pris en compte pour le résumé.

Authentification de l’API de résumé

Il n’est pas nécessaire d’inclure un code d’authentification, car la session de l’application gère l’authentification et l’autorisation. Tous les appels de l’API web doivent inclure un jeton de falsification de requête intersites (CSRF).

Codes et messages d’erreur

Le tableau suivant décrit les différents codes et messages d’erreur que vous pouvez rencontrer lorsque vous utilisez l’API de résumé.

Code statut Code d'erreur Error message
400 90041001 Les fonctionnalités d’IA générative sont désactivées
400 90041003 Résumé des données désactivé pour ce site. Activez-le à l’aide des paramètres du site.
400 90041004 La longueur du contenu dépasse la limite
400 90041005 Aucun enregistrement à résumer n’a été trouvé
400 90041006 Une erreur s’est produite lors du résumé du contenu.

FAQ sur l’API de résumé des données