Nomeação de Campos com IA

INFO

Consulte Introdução às Funcionalidades de IA para conhecer os requisitos de configuração.

Pré-requisitos

Além disso, terá de saber ONDE esta funcionalidade pode ser utilizada:

Documentação da API: Nomear campos em esquemas de pedido/resposta de endpoints

Esquemas: Nomear campos em definições de esquemas reutilizáveis

Componentes: Nomear campos em esquemas de componentes

Visão geral

A IA pode gerar nomes de campos padronizados, profissionais e fáceis de ler com base na sua descrição de um campo específico na documentação atual da API, de acordo com as diretrizes de design de API.

Utilizar a Nomeação de Campos com IA

Passo 1: Localizar o ícone de nomeação por IA

Verá o ícone de nomeação por IA junto a cada campo na sua documentação da API, esquemas ou componentes. Clique no ícone para iniciar o processo de nomeação por IA.

Passo 2: Fornecer a descrição do campo

Depois de clicar no ícone de nomeação por IA, será apresentado um prompt. Introduza uma breve descrição do campo para orientar a IA na geração de um nome de campo adequado. Também pode escolher um modelo de IA diferente. Se já tiver preenchido a descrição do campo, esta será utilizada automaticamente.

Passo 3: Rever os nomes gerados pela IA

Clique em Send e a IA irá gerar vários nomes de campos com base nas diretrizes de design de API, no contexto do documento atual e na descrição do campo. Também fornecerá uma explicação e uma classificação para cada nome.

Passo 4: Aplicar o seu nome preferido

Pode selecionar um dos nomes de campos gerados pela IA e clicar em Adopt para o aplicar diretamente à documentação.

Nomeação de Campos com IA

Pré-requisitos#

Visão geral#

Utilizar a Nomeação de Campos com IA#

Passo 1: Localizar o ícone de nomeação por IA#

Passo 2: Fornecer a descrição do campo#

Passo 3: Rever os nomes gerados pela IA#

Passo 4: Aplicar o seu nome preferido#

Pré-requisitos

Visão geral

Utilizar a Nomeação de Campos com IA

Passo 1: Localizar o ícone de nomeação por IA

Passo 2: Fornecer a descrição do campo

Passo 3: Rever os nomes gerados pela IA

Passo 4: Aplicar o seu nome preferido