Compartir a través de

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

  • Artículo

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

La API de resumen de Power Pages permite a los creadores agregar un resumen del contenido de la página mediante IA generativa que ayuda a los usuarios del sitio a obtener una visión general sin necesidad de repasar toda la página. La API se basa en la Power Pages API web que proporciona un resumen de datos en Dataverse las tablas 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

  • Debe habilitar la configuración del sitio para la API web.

  • Solo las tablas compatibles con la API web de páginas están disponibles para el resumen. Obtenga más información sobre la API web de páginas en Información general sobre la API web.

  • La característica no está disponible en las regiones Government Community Cloud (GCC), Government Community Cloud (GCC High) i el Departamento de Defensa (DoD).

Configuración del sitio

Habilite las páginas en su API web y establezca la configuración del sitio para la característica API de resumen.

Nombre de configuración del sitio Description
Resumen/Datos/Habilitar Habilita o deshabilita la característica Resumen.
Predeterminado: Falso
Valores válidos: Verdadero, Falso
Resumen/prompt/{any_identifier} Utilice esta configuración para proporcionar cualquier instrucción para el tipo de resumen
Tipo: cadena
Ejemplo:
Nombre: Resumen/símbolo/resumen_caso
Valor: Detalles clave del resumen e información crítica
Resumen/Datos/ContentSizeLimit Modificar el límite de tamaño de entrada para el tipo de contenido de resumen
Tipo: entero
Predeterminado: 100 K

Esquema de API

Method URI
PUBLICAR [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Name Description
InstructionIdentifier Esta propiedad es opcional. Si desea pasar cualquier otra instrucción al resumen, use la configuración del sitio para agregar la indicación.
Siempre debe proporcionar el nombre de la configuración del sitio como se definió anteriormente.
RecommendationConfig Esta propiedad es opcional. Si pasa la solicitud recomendada proporcionada por la API de resumen, use este parámetro para pasar. El valor debe ser tener hash y no debe estar modificado.

Nota

La API sigue las especificaciones estándar de OData admitidas por la API Web de Power Pages. La API de resumen admite todas las operaciones de lectura que admite la API web de Power Pages.

Ejemplo

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 crítica.

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
{
"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. Si desea utilizar estas recomendaciones, pase el valor de configuración en el cuerpo de la solicitud sin 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 tiene acceso para resumir.

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 incluyen 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