AIを活用したフィールド命名

INFO

セットアップ要件については、AI機能の開始方法を参照してください。

さらに、この機能を使用できる場所を把握しておく必要があります。

APIドキュメント: エンドポイントのリクエスト/レスポンススキーマ内のフィールドに名前を付けます

スキーマ: 再利用可能なスキーマ定義内のフィールドに名前を付けます

コンポーネント: コンポーネントスキーマ内のフィールドに名前を付けます

概要

AIは、現在のAPIドキュメント内の特定フィールドに関する説明に基づき、API設計ガイドラインに従って、標準化された、専門的で読みやすいフィールド名を生成できます。

APIドキュメント、スキーマ、またはコンポーネント内の各フィールドの横に、AI命名アイコンが表示されます。アイコンをクリックして、AI命名プロセスを開始します。

AI命名アイコンをクリックすると、プロンプトが表示されます。AIが適切なフィールド名を生成できるように、フィールドの短い説明を入力します。別のAIモデルを選択することもできます。すでにフィールドの説明を入力している場合は、自動的に使用されます。

Sendをクリックすると、AIはAPI設計ガイドライン、現在のドキュメントコンテキスト、およびフィールドの説明に基づいて、複数のフィールド名を生成します。また、各名前について説明と評価も提示します。

AIが生成したフィールド名のいずれかを選択し、Adoptをクリックすると、ドキュメントに直接適用できます。