Partager 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.]

L’API de résumé de Power Pages permet aux créateurs d’ajouter un résumé du contenu d’une page à l’aide de l’IA générative qui aide les utilisateurs du site à obtenir un aperçu sans parcourir toute la page. L’API est basée sur l’API web de 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.

Conditions préalables

  • Vous devez activer les paramètres du site pour l’API web.

  • Seules les tables prises en charge pour l’API web de pages sont disponibles pour le résumé. Pour en savoir plus sur l’API web de 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 du site pour la fonctionnalité d’API de résumé.

Nom du paramètre de site Description
Résumé/Données/Activer Active ou désactive 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 de résumé
Type : chaîne
Exemple :
Nom : résumé/invite/résumé_cas
Valeur : résumer les détails clés et les informations critiques
Résumé/Données/ContentSizeLimit Modifier la limite de taille d’entrée pour le contenu du résumé
Type : entier
Valeur par défaut : 100 K

Schéma API

Method URI
PUBLICATION [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Name Description
Identificateur d’instruction Cette propriété est facultative. Si vous souhaitez transmettre toute autre instruction au résumé, utilisez les paramètres du site pour ajouter l’invite.
Vous devez toujours fournir le nom du paramètre du site tel que défini précédemment.
RecommendationConfig Cette propriété est facultative. Si vous transmettez l’invite recommandée fournie par l’API de résumé, utilisez ce paramètre pour la transmettre. La valeur doit être hachée et non modifiée.

Note

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

Échantillon

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 l’InstructionIdentifier.

Sécurité

L’API de résumé respecte la sécurité basée sur les rôles configurée pour les autorisations de table et de colonne. Elle ne prend en compte que les enregistrements auxquels l’utilisateur a accès 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 d’API web doivent inclure un jeton de falsification de requête intersites (CSRF).

Codes et messages d’erreur

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

Code de statut Code d’erreur Message d’erreur
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