Nomeação de Campos com IA

INFO

Consulte Introdução aos Recursos de IA para ver os requisitos de configuração.

Pré-requisitos

Além disso, você precisará saber ONDE este recurso pode ser usado:

Documentação de API: Nomeie campos em esquemas de requisição/resposta de endpoints

Schemas: Nomeie campos em definições de schemas reutilizáveis

Components: Nomeie campos em schemas 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 da API atual, de acordo com as diretrizes de design de API.

Como usar a Nomeação de Campos com IA

Etapa 1: Localize o ícone de nomeação por IA

Você verá o ícone de nomeação por IA ao lado de cada campo na sua documentação de API, schemas ou componentes. Clique no ícone para iniciar o processo de nomeação por IA.

Etapa 2: Forneça a descrição do campo

Após clicar no ícone de nomeação por IA, um prompt será exibido. Insira uma breve descrição do campo para orientar a IA a gerar um nome de campo adequado. Você também pode escolher um modelo de IA diferente. Se você já tiver preenchido a descrição do campo, ela será usada automaticamente.

Etapa 3: Revise os nomes gerados pela IA

Clique em Send e a IA 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. Ela também fornecerá uma explicação e uma classificação para cada nome.

Etapa 4: Aplique o nome de sua preferência

Você pode selecionar um dos nomes de campo gerados pela IA e clicar em Adopt para aplicá-lo diretamente à documentação.

Nomeação de Campos com IA

Pré-requisitos#

Visão geral#

Como usar a Nomeação de Campos com IA#

Etapa 1: Localize o ícone de nomeação por IA#

Etapa 2: Forneça a descrição do campo#

Etapa 3: Revise os nomes gerados pela IA#

Etapa 4: Aplique o nome de sua preferência#

Pré-requisitos

Visão geral

Como usar a Nomeação de Campos com IA

Etapa 1: Localize o ícone de nomeação por IA

Etapa 2: Forneça a descrição do campo

Etapa 3: Revise os nomes gerados pela IA

Etapa 4: Aplique o nome de sua preferência