Compartilhar via

Visão geral da API de resumo de dados (versão preliminar)

  • Artigo

[Este artigo faz parte da documentação de pré-lançamento e está sujeito a alterações.]

Os criadores podem usar a API de resumo do Power Pages para adicionar resumo de conteúdo da página que usa IA generativa. Dessa forma, os usuários do site podem obter uma visão geral do conteúdo de uma página sem ter que percorrer toda a página. A API é criada sobre a Power Pages API da Web que fornece resumo de dados nas Dataverse tabelas usadas nas páginas.

Importante

  • Este é um recurso em versão preliminar.
  • Os recursos de versão preliminar não foram criados para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos estão sujeitos a termos de uso suplementares e são disponibilizados antes de um lançamento oficial, de maneira que os clientes possam ter acesso antecipado e fazer comentários.

Pré-requisitos

  • Você deve habilitar as configurações do site para a API Web.
  • Somente as tabelas com suporte para a Power Pages API Web estão disponíveis para resumo. Saiba mais sobre a API Web do Power Pages na Visão geral da API Web.
  • Este recurso não está disponível nas regiões da Nuvem da Comunidade Governamental (GCC), da Nuvem da Comunidade Governamental – Alta (GCC High) ou do Departamento de Defesa.

Configurações de site

Habilite as páginas em sua API da Web e defina as seguintes configurações de site para o recurso de API de resumo.

Nome da configuração do site Description
Resumo/Dados/Habilitar Habilitar ou desabilitar o recurso de resumo.
Padrão: Falso
Valores válidos: Verdadeiro, Falso
Resumo/prompt/{any_identifier}

Use essas configurações para fornecer instruções de resumo.
Tipo: cadeia de caracteres

Exemplo:
Nome: Summarization/prompt/case_summary
Valor: Resumir os principais detalhes e informações críticas
Resumo/Dados/ContentSizeLimit Modifique o limite de tamanho de entrada para o conteúdo de resumo.
Tipo: inteiro
Padrão: 100.000

Esquema do API

método URI Exemplo de JSON
POSTAR [URI do site]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nome da propriedade Description
InstructionIdentifier Esta propriedade é opcional. Se você quiser passar qualquer outra instrução para resumo, use as configurações do site para adicionar o prompt. Você deve sempre fornecer o nome da configuração do site como foi definido anteriormente.
RecommendationConfig Esta propriedade é opcional. Se você quiser passar o prompt que a API de resumo recomenda, use esta propriedade para passá-lo. O valor deve ser com hash e não modificado.

Observação

A API segue as especificações padrão do protocolo OData (Open Data Protocol) que a Power Pages API da Web suporta. A API de Resumo oferece suporte a todas as operações de leitura que a API Web do Power Pages oferece suporte.

Sample

Resuma o tipo de caso, o assunto, a descrição e o histórico do caso, concentrando-se nos principais detalhes e informações críticas.

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

A resposta de resumo fornece prompts recomendados para ajustar o resumo. Se você quiser usar essas recomendações, passe o valor de configuração no corpo da solicitação, sem a InstructionIdentifier propriedade.

Segurança

A API de resumo respeita a segurança baseada em função configurada para permissões de tabela e coluna. Somente os registros aos quais o usuário tem acesso são considerados para resumo.

Autenticando a API de resumo

Não é necessário incluir um código de autenticação porque a sessão do aplicativo gerencia a autenticação e a autorização. Todas as chamadas da API Web devem incluir um Token de solicitação intersite forjada (CSRF).

Códigos de erro e mensagens

A tabela a seguir descreve os diferentes códigos de erro e mensagens que você pode encontrar ao usar a API de resumo.

Código de status Código de erro Error message
400 90041001 Recursos de IA Generativa estão desativados
400 90041003 Resumo de dados desabilitado para este site. Habilite o uso da configuração de site.
400 90041004 O comprimento do conteúdo excede o limite
400 90041005 Nenhum registro encontrado para resumo
400 90041006 Erro ao resumir o conteúdo.

Perguntas frequentes da API de resumo de dados