referência dataApi para páginas gerativas

Quando você gera uma página usando linguagem natural, a IA cria uma página react no TypeScript. A página gerada abrange a experiência do usuário front-end selecionando os componentes corretos e determinando o melhor layout e a lógica de negócios correspondente.

Você pode exibir e editar o código gerado para refinar a saída. As operações de dados usam um dataApi objeto que expõe métodos públicos agrupados nessas categorias:

Category Description
Métodos de tabela do Dataverse Crie, recupere, atualize e exclua linhas de tabela do Dataverse e colunas de escolha de consulta.
Métodos de conector Trabalhe com dados expostos por um conector do Power Platform associado à página.
Métodos de operação do Dataverse Invoque APIs personalizadas do Dataverse associadas à página como ações ou funções.
Métodos de página Controle a própria página generativa, como retornar um valor quando a página é usada como uma caixa de diálogo.

Métodos de conector e métodos de ação e função são membros opcionais do dataApi contrato. Alguns hosts não os implementam, portanto, sempre verifique se existe um método (por exemplo, if (dataApi.executeAction) { ... }) antes de chamá-lo. Um método presente não significa que a página tem um conector ou a API personalizada do Dataverse associada a ele ou que a API personalizada está habilitada ou permitida para o usuário atual. Manipule a funcionalidade indisponível e falhas de API personalizadas explicitamente em vez de assumir o sucesso.

Métodos de tabela do Dataverse

Use os métodos de tabela do Dataverse do dataApi objeto para criar, recuperar, atualizar e excluir linhas de tabela do Dataverse e colunas de escolha de consulta.

Método Description
createRow Cria uma nova linha na tabela especificada.
deleteRow Exclui uma linha da tabela especificada.
getChoices Recupera as opções para o nome da coluna de escolha especificado.
queryTable Consulta uma tabela com as opções especificadas.
retrieveRow Recupera uma linha da tabela especificada com as opções especificadas.
updateRow Atualiza uma linha existente na tabela especificada.

Métodos de conector

Use os métodos de conector do dataApi objeto para trabalhar com dados expostos por um conector do Power Platform associado à página.

Método Description
createConnectorRow Cria uma nova linha na tabela de conectores especificada.
deleteConnectorRow Exclui uma linha da tabela de conectores especificada.
executeConnectorOperation Invoca uma operação nomeada exposta por um conector REST (chave de operação), como Usuários do Office 365.
getConnectorSwagger Recupera a definição de Swagger (OpenAPI) para o conector.
getConnectorTableSchema Recupera o esquema de uma tabela (também chamada de entidade ou lista) exposta pelo conector.
listConnectorDatasets Lista os conjuntos de dados disponíveis para o conector.
listConnectorOperations Lista as operações expostas por um conector REST (chave de operação).
listConnectorTables Lista as tabelas disponíveis no conjunto de dados do conector especificado.
queryConnectorTable Consulta uma tabela exposta pelo conector com as opções especificadas.
retrieveConnectorRow Recupera uma única linha da tabela do conector especificada.
updateConnectorRow Atualiza uma linha existente na tabela do conector especificada.

Métodos de ação e função do Dataverse

Use os métodos de ação e função do dataApi objeto para invocar APIs personalizadas do Dataverse associadas à página.

Método Description
executeAction Invoca uma API personalizada do Dataverse associada à página como uma ação.
executeFunction Invoca uma API personalizada do Dataverse associada à página como uma função.
listBoundActions Lista as APIs personalizadas do Dataverse (ações e funções) associadas à página.

Métodos de página

Use os métodos de página do dataApi objeto para controlar a página generativa em si, como retornar um valor quando a página é usada como uma caixa de diálogo.

Método Description
setPageOutput Define o valor retornado para o script de chamada quando uma caixa de diálogo de página gerativa é fechada.