Skip to main content

生成AIを利用した開発

AmiVoice API の公式ドキュメントを生成 AI やコーディングエージェントに参照させて、インタフェースの選定、仕様の調査、サンプルコードの生成などに役立てる方法を説明します。

llms.txtとは​

llms.txtは、AmiVoice API の主要な仕様とドキュメントへのリンクを 1 つにまとめた、生成 AI 向けの索引ファイルです。次の URL で公開しています。

サイト全体のページを並べたものではありません。方式の選定、実装、運用で先に読むべきページを選んでまとめています。リンク先は、生成 AI が取得しやすい Markdown 版のドキュメントです。

できること​

llms.txtを生成 AI に渡すと、次のような作業に利用できます。

  • 使用するインタフェースやパラメータの調査
  • 要件に合った方式の選定
  • サンプルコードの生成
  • 新しい機能を使った開発の支援

いずれも、公式ドキュメントを根拠として参照させることが目的です。

利用方法​

生成 AI への指示に、llms.txtの URL を追加して使用します。「この URL を起点に、リンク先の公式ドキュメントを参照してください」と伝えると、生成 AI が必要なページを開いて回答します。

正確な回答を得るために、次の 2 点も指示に加えてください。

  • パラメータ名や仕様を推測しないこと
  • 回答に、参照した公式ドキュメントの URL を示すこと

プロンプト例​

そのままコピーして使えるプロンプトの例です。目的に応じて、音声の条件や実装したい内容を書き換えてください。

インタフェースを選定する​

録音済みのファイルを扱う場合の例です。

https://docs.amivoice.com/llms.txt を起点として、
リンク先のAmiVoice API公式ドキュメントを参照してください。

録音済みの30分程度の音声ファイルを文字起こしする場合に、
使用すべきインタフェース、接続エンジン、必要なリクエストパラメータを整理してください。

パラメータ名や仕様を推測せず、
回答には参照した公式ドキュメントのURLを示してください。

リアルタイムに音声を送る場合の例です。

https://docs.amivoice.com/llms.txt を起点として、
リンク先のAmiVoice API公式ドキュメントを参照してください。

ブラウザからマイク音声をリアルタイムで送信し、
認識途中結果を画面に表示したいです。

同期HTTP、非同期HTTP、WebSocketのどれを使用すべきか、
理由、実装手順、参照すべきドキュメントを整理してください。

サンプルコードを生成する​

https://docs.amivoice.com/llms.txt を起点として、
リンク先のAmiVoice API公式ドキュメントを参照してください。

16kHz、モノラル、WAV形式の音声ファイルを同期HTTPインタフェースで
文字起こしするPythonコードを作成してください。

APIキーは環境変数から取得し、
HTTPエラーとレスポンス本文の結果コードを処理してください。
存在しないエンドポイントやパラメータを推測しないでください。

回答には参照した公式ドキュメントのURLも示してください。

認識精度を改善する​

https://docs.amivoice.com/llms.txt を起点として、
リンク先のAmiVoice API公式ドキュメントを参照してください。

専門用語を多く含む音声の認識精度を上げたいです。
ユーザー辞書や接続エンジンの選択など、利用できる方法を整理し、
それぞれの設定手順と参照すべきドキュメントを示してください。

仕様を推測せず、回答には参照した公式ドキュメントのURLを示してください。

エラーを調査する​

https://docs.amivoice.com/llms.txt を起点として、
リンク先のAmiVoice API公式ドキュメントを参照してください。

同期HTTPインタフェースのレスポンスで返る結果コードの意味と、
想定される原因、対処方法を整理してください。

HTTPステータスだけでなくレスポンス本文の結果コードも確認する前提で、
仕様を推測せず、参照した公式ドキュメントのURLを示してください。

Webページを参照できないAIでの利用方法​

llms.txtを URL で参照するには、生成 AI に Web ページを読む機能が必要です。その機能がない場合は、内容を直接プロンプトへ貼り付けて使用します。

ただし、llms.txtはリンクの一覧です。貼り付けただけでは、リンク先の詳しい仕様までは伝わりません。次の手順で使用してください。

  1. llms.txtの内容を貼り付けて、目的に必要なページを特定させる。
  2. 特定したページの Markdown 版ドキュメントも、続けて貼り付ける。

Markdown 版は、ページの URL の末尾に.mdを付けると取得できます。たとえば、はじめにのページはhttps://docs.amivoice.com/amivoice-api/manual/getting-started.mdです。

llms.txtでできないこと​

llms.txtは、公式ドキュメントを見つけて参照しやすくするためのものです。次のことはできません。

  • 生成 AI が AmiVoice API へ自動的に接続する
  • 生成 AI が AmiVoice API をツールとして直接実行する
  • 生成されたコードの正しさを保証する

生成されたコードは、必ず公式リファレンスと照らし合わせてから使用してください。

利用上の注意​

音声認識 API を扱うため、特に次の点に注意してください。

APIキーと音声データの取り扱い
  • APIキー、音声データ、個人情報などを生成AIへ入力する場合は、利用規約や所属組織等のセキュリティルールを確認してください。また、コードやエラーログを入力する際にも、これらの情報が意図せず含まれていないか必ず確認してください。
  • APIキーそのものを提示する必要がない場合は、ダミー値や環境変数名に置き換えてください。
  • 生成されたコードは、公式リファレンスと照合してから使用してください。
  • 料金、制限事項、利用規約、SLA は、必ず現行の公式ページで確認してください。