Compartir vía

Visión general de la API de resumen de datos (versión preliminar)

[Este artículo es documentación preliminar y está sujeto a modificaciones].

Los creadores usan la API de Power Pages de resumen para agregar un resumen del contenido de la página con IA generativa. Esta característica permite a los usuarios del sitio obtener una descripción general del contenido de una página sin leer toda la página. La API se basa en la API web de Power Pages, que proporciona un resumen de datos para las tablas de Dataverse utilizadas en las páginas.

Importante

  • Esta es una característica en versión preliminar.
  • Las características en vista previa no se han diseñado para un uso de producción y pueden tener una funcionalidad restringida. Estas características están sujetas a condiciones de uso adicionales y están disponibles antes del lanzamiento oficial para que los clientes puedan tener un acceso anticipado y proporcionar comentarios.

Requisitos previos

  • Habilitar la configuración del sitio para la API web.
  • Solo las tablas admitidas por la API web de Power Pages están disponibles para el resumen. Obtenga más información sobre la API web de Power Pages en Información general sobre la API web.
  • Esta característica no está disponible en regiones Government Community Cloud (GCC), Government Community Cloud - High (GCC High) o del Departamento de defensa (DoD).

Configuración del sitio

Habilite páginas en la API web y establezca la siguiente configuración del sitio para la función de la API de resumen.

Nombre de configuración del sitio Description
Resumen/Datos/Habilitar Habilitar o deshabilitar la característica de resumen.
Valor predeterminado: false
Valores válidos: true, false
Resumen/solicitud/{any_identifier}

Utilice esta configuración para proporcionar instrucciones para el resumen.
Tipo: cadena

Ejemplo:
Nombre: Resumen/solicitud/resumen de caso
Valor: Resumir los detalles clave y la información crítica
Resumen/Datos/ContentSizeLimit Modifique el límite de tamaño de entrada para el contenido de resumen.
Tipo: entero
Valor predeterminado: 100000 caracteres

Esquema de API

método URI Ejemplo JSON
PUBLICAR [URI del sitio]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nombre de la propiedad Description
InstructionIdentifier Esta propiedad es opcional. Para pasar instrucciones adicionales para el resumen, use la configuración del sitio para agregar la indicación. Proporcione siempre el nombre de la configuración del sitio tal como se definió anteriormente.
RecommendationConfig Esta propiedad es opcional. Use esta propiedad para pasar la solicitud recomendada por la API de resumen. El valor debe estar cifrado con hash y permanecer sin modificar.

Nota

La API sigue las especificaciones estándar del Protocolo de datos abiertos (OData) admitidas por la API web de Power Pages. La API de resumen admite todas las operaciones de lectura disponibles en la API web de Power Pages.

Sample

Resuma el tipo de caso, el asunto, la descripción y el historial del caso centrándose en los detalles clave y la información importante.

Solicitar

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

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 respuesta de resumen proporciona indicaciones recomendadas para ajustar el resumen. Para usar estas recomendaciones, pase el valor de configuración en el cuerpo de la solicitud sin la propiedad InstructionIdentifier.

Seguridad

La API de resumen respeta la seguridad basada en roles configurada para los permisos de tablas y columnas. Solo tiene en cuenta los registros a los que el usuario puede acceder para resumirlos.

Autenticación de la API de resumen

No es necesario que incluya un código de autenticación, ya que la sesión de la aplicación administra la autenticación y la autorización. Todas las llamadas a la API web deben incluir un token de falsificación de solicitud entre sitios (CSRF).

Códigos y mensajes de error

En la tabla siguiente se describen los diferentes códigos de error y mensajes que puede encontrar al usar la API de resumen.

Código de estado Código de error Mensaje de error
400 90041001 Las características de IA generativa están deshabilitadas
400 90041003 Resumen de datos deshabilitado para este sitio. Habilite mediante la configuración del sitio.
400 90041004 La longitud del contenido supera el límite
400 90041005 No se encontraron registros para resumir
400 90041006 Se ha producido un error al resumir el contenido.

Preguntas frecuentes sobre la API de resumen de datos

  • Last updated on