Visión xeral da API de resumo de datos (vista previa)

[Este artigo é a documentación de prelanzamento e está suxeito a cambios.]

Os creadores empregan a API de resumo para engadir o resumo do contido da páxina con IA xerativa. Power Pages Esta funcionalidade permite aos usuarios do sitio web obter unha visión xeral do contido dunha páxina sen ter que lela enteira. A API está baseada na API web, que proporciona un resumo de datos para as táboas empregadas nas páxinas. Power Pages Dataverse

Importante

  • Esta é unha funcionalidade de vista previa.
  • As funcionalidades en versión preliminar non están destinadas a usarse en produción e poderían ter restrinxida a funcionalidade. Estas funcións están suxeitas a termos suplementarios de uso, e están dispoñibles antes dun lanzamento oficial para que os clientes poidan access cedo e dar opinións.

Requisitos previos

Configuración do sitio

Activa as páxinas na túa API web e configura a seguinte configuración do sitio para a funcionalidade da API de resumo.

Nome da configuración do sitio Descripción
Resumo/Datos/Activar Activar ou desactivar a función de resumo.
Predeterminado: falso
Valores válidos: verdadeiro, falso
Resumo/indicación/{any_identifier}

Usa esta configuración para proporcionar instrucións para o resumo.
Tipo: cadea

Exemplo:
Nome: Resumo/solicitude/resumo_do_caso
Valor: Resumar os detalles clave e a información crítica
Resumo/Datos/Límite de tamaño do contido Modifica o límite de tamaño de entrada para o contido de resumo.
Escriba: enteiro
Predeterminado: 100000 charecters

Esquema API

Método URI JSON de exemplo
POST [URI do sitio]/_api/resumo/datos/v1.0/nome do conxunto de táboas { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nome da propiedade Descripción
Identificador de instrucións Esta propiedade é opcional. Para pasar instrucións adicionais para o resumo, use a configuración do sitio para engadir a solicitude. Proporcione sempre o nome da configuración do sitio tal e como se definiu previamente.
Configuración de recomendación Esta propiedade é opcional. Usa esta propiedade para pasar a solicitude recomendada pola API de resumo. O valor debe ser codificado mediante hash e permanecer sen modificar.

Nota

A API segue as especificacións estándar do Protocolo de datos abertos (OData) compatibles coa API web. Power Pages A API de resumo admite todas as operacións de lectura dispoñibles na Power Pages API web.

Mostra

Resumir o tipo de caso, o asunto, a descrición e o historial do caso centrándose nos detalles clave e na 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"
}

Resposta

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

A resposta de resumo proporciona indicacións para axustar o resumo. Para usar estas recomendacións, pase o valor de configuración no corpo da solicitude sen a propiedade InstructionIdentifier .

Seguranza

A API de resumo respecta a seguranza baseada en roles configurada para os permisos de táboas e columnas. Só ten en conta os rexistros aos que o usuario pode acceder para o resumo.

Autenticación da API de resumo

Non precisa incluír un código de autenticación porque a sesión da aplicación xestiona a autenticación e a autorización. Todas as chamadas á API web deben incluír un token de falsificación de solicitudes entre sitios (CSRF).

Códigos e mensaxes de erro

A seguinte táboa describe os diferentes códigos de erro e mensaxes que podes atopar ao usar a API de resumo.

Código de estado Código de erro Mensaxe de erro
400 90041001 As funcións de IA xerativa están desactivadas
400 90041003 Resumo de datos desactivado para este sitio. Activar usando a configuración do sitio.
400 90041004 A lonxitude do contido supera o límite
400 90041005 Non se atoparon rexistros para resumir
400 90041006 Produciuse un erro ao resumir o contido.

Preguntas frecuentes sobre a API de resumo de datos

  • Last updated on