Compartilhar via

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

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

Os criadores usam a API de resumo do Power Pages para adicionar o resumo do conteúdo da página com IA generativa. Esse recurso permite que os usuários do site tenham uma visão geral do conteúdo de uma página sem ler a página inteira. A API é baseada na API Web do Power Pages, que fornece resumo de dados para tabelas do Dataverse usadas em 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

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

Configurações de site

Habilite 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: 100000 caracteres

Esquema do API

método URI Exemplo de JSON
POSTAR [Endereço do site]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nome da propriedade Description
InstructionIdentifier Esta propriedade é opcional. Para passar instruções extras para resumo, use as configurações do site para adicionar o prompt. Sempre forneça o nome da configuração do site como foi definido anteriormente.
RecommendationConfig Esta propriedade é opcional. Use essa propriedade para passar o prompt recomendado pela API de resumo. O valor deve ser hash e permanecer inalterado.

Observação

A API segue as especificações padrão do Protocolo Open Data (OData) com suporte pela API Web do Power Pages. A API de resumo oferece suporte a todas as operações de leitura disponíveis na API Web do Power Pages.

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 importantes.

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

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

Segurança

A API de resumo respeita a segurança baseada em função configurada para permissões de tabela e coluna. Ele considera apenas os registros que o usuário pode acessar 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 Mensagem de erro
400 90041001 Os 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

  • Last updated on