Partilhar via

Descrição geral da API de resumo de dados (pré-visualização)

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

Os criadores usam a API de resumo do Power Pages para adicionar resumo de conteúdo da página com IA generativa. Esta caraterística permite aos utilizadores do site obter uma descrição geral do conteúdo de uma página sem ler a página inteira. A API é construída na API da Web do Power Pages, que fornece resumo de dados para tabelas do Dataverse usadas em páginas.

Importante

  • Esta é uma funcionalidade de pré-visualização.
  • As funcionalidades de pré-visualização não se destinam a utilização em produção e podem ter funcionalidade restrita. Estas caraterísticas estão sujeitas aos termos de utilização suplementares disponíveis antes do lançamento oficial, para que os clientes possam ter acesso antecipadamente e enviar comentários.

Pré-requisitos

  • Ative as definições do site para a API Web.
  • Só as tabelas suportadas pela API Web do Power Pages estão disponíveis para resumo. Mais informações sobre a API Web do Power Pages na Descrição geral da API Web.
  • Esta caraterística não está disponível nas regiões da Nuvem da Comunidade Governamental (GCC), Nuvem da Comunidade Governamental - High (GCC High) ou Departamento de Defesa (DoD).

Definições do site

Ative páginas na sua API Web e defina as seguintes definições do site para a caraterística de API de resumo.

Nome de definição do site Descrição
Resumo/Dados/Ativar Ative ou desative a caraterística de resumo.
Predefinição: false
Valores válidos: true, false
Resumo/comando/{any_identifier}

Use estas definições para fornecer instruções para resumo.
Tipo: cadeia

Exemplo:
Nome: Resumo/comando/resumo_do_caso
Valor: Resumir os principais detalhes e informações críticas
Resumo/Dados/ContentSizeLimit Modifique o limite do tamanho de entrada para o conteúdo de resumo.
Tipo: número inteiro
Padrão: 100000 caracteres

Esquema do API

Método URI Exemplo de JSON
POST [URI do site]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nome da propriedade Descrição
InstructionIdentifier Esta propriedade é opcional. Para transmitir instruções adicionais para resumo, use as definições do site para adicionar o pedido. Forneça sempre o nome da definição do site como foi definido anteriormente.
RecommendationConfig Esta propriedade é opcional. Use esta propriedade para transmitir o pedido recomendado pela API de resumo. O valor tem ser colocado em hash e permanecer inalterado.

Nota

A API segue as especificações padrão do OData (Open Data Protocol) suportadas pela API Web do Power Pages. A API de resumo suporta 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.

Pedir

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 comandos recomendados para ajustar o resumo. Para usar estas recomendações, transmita o valor da configuração no corpo do pedido sem a propriedade InstructionIdentifier.

Segurança

A API de resumo respeita a segurança baseada em funções configurada para permissões de tabela e coluna. Considera apenas registos a que o utilizador pode aceder para resumo.

Autenticar a API de resumo

Não é necessário incluir um código de autenticação porque a sessão da aplicação gere a autenticação e a autorização. Todas as chamadas à API Web têm de incluir um token de falsificação de pedidos entre sites (CSRF).

Códigos de erro e mensagens

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

Código de estado Código de erro Mensagem de erro
400 90041001 As caraterísticas de IA generativa estão desativadas
400 90041003 Resumo de dados desativado para este site. Ative usando a definição do site.
400 90041004 O comprimento do conteúdo excede o limite
400 90041005 Não foram encontrados registos para resumir
400 90041006 Ocorreu um erro ao resumir o conteúdo.

FAQ sobre a API de resumo de dados

  • Last updated on