Comparteix a través de

Informació general de l'API de resum de dades (versió preliminar)

  • Article

[Aquest article forma part de la documentació preliminar i està subjecte a canvis.]

Els creadors poden utilitzar l'API Power Pages de resum per afegir un resum de contingut de pàgina que utilitza IA generativa. D'aquesta manera, els usuaris del lloc poden obtenir una visió general del contingut d'una pàgina sense haver de passar per tota la pàgina. L'API es basa en l'API Power Pages web que proporciona un resum de dades a les taules que s'utilitzen a les Dataverse pàgines.

Important

  • Aquesta és una característica de visualització prèvia.
  • Les característiques en versió preliminar no estan dissenyades per a un entorn de producció i poden tenir una funcionalitat restringida. Aquestes funcions estan subjectes a condicions d'ús addicionals i estan disponibles abans d'un llançament oficial perquè els clients puguin obtenir accés anticipat i proporcionar comentaris.

Requisits previs

  • Heu d'habilitar la configuració del lloc per a l'API web.
  • Només les taules compatibles amb l'API Power Pages web estan disponibles per al resum. Obteniu més informació sobre l'API web a Informació Power Pages general de l'APIweb.
  • La funció no està disponible a les regions Government Community Cloud (GCC), Government Community Cloud - High (GCC High) o Departament de Defensa (DoD).

Configuració del lloc

Habiliteu les pàgines a l'API web i definiu la configuració del lloc següent per a la característica de l'API de resum.

Nom de la configuració del lloc Descripció
Resum/Dades/Habilita Activeu o inhabiliteu la característica de resum.
Per defecte: Fals
Valors vàlids: Cert,Fals
Resum / prompt/{any_identifier}

Utilitzeu aquesta configuració per proporcionar instruccions per al resum.
Tipus: cadena

Exemple:
Nom: Resum/prompt/case_summary
Valor: Resumeix els detalls clau i la informació crítica
Resum/Dades/ContentSizeLimit Modifiqueu el límit de mida d'entrada per al contingut de resum.
Tipus: enter
Per defecte: 100.000

Esquema API

Mètode URI Exemple de JSON
POST [URI del lloc]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nom de la propietat Descripció
Identificador d'instrucció Aquesta propietat és opcional. Si voleu passar altres instruccions per al resum, utilitzeu la configuració del lloc per afegir la sol·licitud. Sempre heu de proporcionar el nom de la configuració del lloc tal com s'ha definit anteriorment.
RecomanacióConfiguració Aquesta propietat és opcional. Si voleu passar la sol·licitud que recomana l'API de resum, utilitzeu aquesta propietat per passar-la. El valor s'ha de resumir i no modificar.

Nota

L'API segueix les especificacions estàndard del protocol de dades obertes (OData) que admet l'API Power Pages web. L'API de resum admet totes les operacions de lectura que admet l'API Power Pages web.

Exemple

Resumiu el tipus de cas, el tema, la descripció i la història del cas centrant-vos en els detalls clau i la informació crítica.

Sol·licita

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 resposta de resum proporciona indicacions recomanades per ajustar el resum. Si voleu utilitzar aquestes recomanacions, passeu el valor de configuració al cos de la sol·licitud, sense la InstructionIdentifier propietat.

Seguretat

L'API de resum respecta la seguretat basada en funcions que es configura per als permisos de taula i columna. Només es tenen en compte els registres als quals l'usuari té accés per al resum.

Autenticació de l'API de resum

No cal que incloguis un codi d'autenticació, ja que la sessió de l'aplicació gestiona l'autenticació i l'autorització. Totes les trucades a l'API web han d'incloure un testimoni de falsificació de sol·licituds entre llocs (CSRF).

Codis d'error i missatges

A la taula següent es descriuen els diferents codis d'error i missatges que podeu trobar quan utilitzeu l'API de resum.

Codi d'estat Codi d'error Missatge d'error
400 90041001 Les funcions d'IA generativa estan desactivades
400 90041003 Resum de dades desactivat per a aquest lloc. Activeu l'ús de la configuració del lloc.
400 90041004 La longitud del contingut supera el límit
400 90041005 No s'han trobat registres per resumir
400 90041006 S'ha produït un error en resumir el contingut.

Preguntes freqüents sobre l'API de resum de dades