# AmiVoice API

> AmiVoice APIは、株式会社アドバンスト・メディア（Advanced Media, Inc.）が提供するクラウド音声認識APIです。録音済み音声の文字起こし、長時間音声の非同期処理、リアルタイム音声認識に対応します。このファイルは、生成AIやコーディングエージェントが要件に合う方式を選び、実装に必要な公式ドキュメントを参照するための案内です。

リンク先は、原則として生成AIが取得しやすいMarkdown版の公式ドキュメントです。サイト全体のページ一覧ではなく、APIの選定、実装、運用で優先して参照すべきページを掲載しています。

Note: このファイルの内容は、ドキュメントの追加や仕様の変更に合わせて随時見直します。掲載するページや説明は今後変わる可能性があります。

実装前に、入力が音声ファイルかリアルタイムストリームか、音声の言語・用途・形式・長さ、必要な結果情報、ログ保存の可否を確認してください。

インタフェースは次の基準で選択してください。

* 1回のHTTPリクエストで音声を送信し、同じレスポンスで最終結果を取得する場合は同期HTTPを使用します。送信できる音声データは最大16,777,215バイトです。
* 大きな音声ファイル、長時間録音、録音済み通話、会議録音、バッチ処理には非同期HTTPを使用します。ジョブを作成し、状態を確認してから結果を取得します。
* 音声を順次送信し、認識途中結果や発話イベントを取得する場合はWebSocketを使用します。

実装時は次の規則に従ってください。

* 機能の選択と使い分けにはマニュアルを、エンドポイント、パラメータ、コマンド、レスポンスの確定にはリファレンスを使用してください。
* エンドポイント、パラメータ名、接続エンジン名、結果フィールドを推測しないでください。
* インタフェースによって送信形式と結果の受け取り方が異なるため、別のインタフェースのコードをそのまま転用しないでください。
* コードには、使用するインタフェース、接続エンジン名、音声フォーマット、ログ保存設定、追加機能を明示してください。
* HTTPステータスだけで成功を判定せず、レスポンス本文の結果コードとメッセージも確認してください。
* APIキーをソースコード、ログ、エラーメッセージ、設定ファイル、バージョン管理システムへ出力しないでください。
* 制限値や利用可能な機能は変更される可能性があるため、制限事項と更新履歴を確認してください。

## はじめに確認するドキュメント

* [はじめに・クイックスタート](https://docs.amivoice.com/amivoice-api/manual/getting-started.md): APIキーを使用して同期HTTPで音声ファイルを送信し、JSON形式の認識結果を取得する最小手順です。
* [インタフェースの種類と使い方](https://docs.amivoice.com/amivoice-api/manual/interfaces.md): 同期HTTP、非同期HTTP、WebSocketの用途と違いを確認し、実装方式を選択します。
* [音声認識エンジン](https://docs.amivoice.com/amivoice-api/manual/engines.md): 言語、用途、音質、エンジン方式に合う接続エンジン名を選択します。
* [対応している言語](https://docs.amivoice.com/amivoice-api/manual/supported-languages.md): 利用可能な言語と対応する音声認識エンジンを確認します。
* [音声フォーマット](https://docs.amivoice.com/amivoice-api/manual/audio-format.md): 対応する音声形式、サンプリングレート、チャネル、リクエストでの指定方法を確認します。
* [制限事項](https://docs.amivoice.com/amivoice-api/manual/limitations.md): 音声サイズ、セッション時間、タイムアウト、発話区間、結果保存期間などの現在の制限を確認します。

## インタフェースの実装

* [同期HTTPインタフェース](https://docs.amivoice.com/amivoice-api/manual/sync-http-interface.md): 音声データを1回のHTTP POSTで送信し、同じレスポンスで最終結果を取得する実装方法です。
* [同期HTTP APIリファレンス](https://docs.amivoice.com/amivoice-api/reference/sync-http.md): 同期HTTPのエンドポイント、リクエスト形式、パラメータ、レスポンスの正確な仕様です。
* [非同期HTTPインタフェース](https://docs.amivoice.com/amivoice-api/manual/async-http-interface.md): 音声認識ジョブの作成、状態確認、結果取得、失敗時の処理を説明します。
* [非同期HTTP APIリファレンス](https://docs.amivoice.com/amivoice-api/reference/async-http.md): 非同期HTTPのエンドポイント、HTTPメソッド、ジョブ状態、リクエストとレスポンスの正確な仕様です。
* [WebSocketインタフェース](https://docs.amivoice.com/amivoice-api/manual/websocket-interface.md): 接続、認識開始、音声送信、認識終了、セッション維持を含むリアルタイム認識の実装方法です。
* [WebSocketのコマンドと応答](https://docs.amivoice.com/amivoice-api/manual/websocket-interface-command-and-response.md): コマンド、応答、発話検出イベント、認識イベントの意味と処理方法を説明します。
* [HTTPリクエストヘッダで認証情報を送る方法](https://docs.amivoice.com/amivoice-api/manual/websocket-interface-authorization-header.md): WebSocket接続時にAPIキーをHTTPリクエストヘッダへ設定する方法です。
* [WebSocket APIリファレンス](https://docs.amivoice.com/amivoice-api/reference/websocket.md): 接続先、コマンドパケット、イベントパケット、応答、状態遷移の正確な仕様です。

## リクエストとレスポンス

* [リクエスト](https://docs.amivoice.com/amivoice-api/manual/request.md): 音声認識リクエストを構成する認証情報、パラメータ、音声データの関係を説明します。
* [リクエストパラメータ](https://docs.amivoice.com/amivoice-api/manual/request-parameters.md): 接続エンジン名、ログ保存、ユーザー辞書、発話検出、タイムアウトなどの設定項目を説明します。
* [レスポンス](https://docs.amivoice.com/amivoice-api/manual/response.md): 各インタフェースで音声認識結果を受け取る方法を説明します。
* [音声認識の結果フォーマット](https://docs.amivoice.com/amivoice-api/manual/result-format.md): 全体テキスト、発話区間、単語、信頼度、時刻、話者ラベルなどのJSON構造を説明します。
* [レスポンスコードとメッセージ](https://docs.amivoice.com/amivoice-api/manual/response-code-and-message.md): 成功または失敗を判定し、エラー処理を実装するための結果コードとメッセージを説明します。

## 認識精度と追加機能

* [発話検出](https://docs.amivoice.com/amivoice-api/manual/vad.md): 発話開始、発話終了、無音、発話区間、タイムアウトの挙動と調整方法を説明します。
* [ユーザー辞書](https://docs.amivoice.com/amivoice-api/manual/user-dictionary.md): 人名、企業名、商品名、専門用語などを認識させるための単語登録と単語強調の入口です。クイックスタートを含みます。
* [End to Endエンジンの単語強調](https://docs.amivoice.com/amivoice-api/manual/user-dictionary-basics-e2e.md): End to Endエンジン用の単語強調機能です。単語の表記、代替表記、および認識のしやすさを制御する単語強調度（0〜1、省略時は0.5）の指定方法を説明します。
* [ハイブリッドエンジンの単語登録](https://docs.amivoice.com/amivoice-api/manual/user-dictionary-basics.md): ハイブリッドエンジン用の単語登録機能です。単語の表記と読み（必須）に加え、エンジンごとに定義された単語種別（クラス）の指定方法を説明します。
* [ユーザー辞書登録リファレンス](https://docs.amivoice.com/amivoice-api/reference/profilewords.md): ユーザー辞書（プロファイル）の単語を登録・取得するAPIと、登録する単語のフォーマットの正確な仕様です。
* [ルールグラマ](https://docs.amivoice.com/amivoice-api/manual/rule-grammar.md): 認識対象を限定された語彙や発話パターンで表現できる場合に使用する認識方法です。
* [フィラー単語の自動削除](https://docs.amivoice.com/amivoice-api/manual/filler-word-removal.md): 「えー」「あのー」などを認識結果から削除する設定を説明します。
* [話者ダイアライゼーション](https://docs.amivoice.com/amivoice-api/manual/speaker-diarization.md): 複数話者の発話区間を話者ラベルで区別するための設定、対応条件、制限を説明します。
* [感情分析](https://docs.amivoice.com/amivoice-api/manual/sentiment-analysis.md): 音声から感情情報を取得する場合の利用条件、リクエスト設定、結果形式を説明します。

## 認証・データ管理・運用

* [APIキー](https://docs.amivoice.com/amivoice-api/manual/api-key.md): APIキーの役割、認証への使用方法、管理上の注意を説明します。
* [APIキーに付与できる制限・機能](https://docs.amivoice.com/amivoice-api/manual/api-key-additional-features.md): APIキーの発行時に有効期限や接続元IPアドレスの制限などを付与する方法を説明します。
* [APIキー発行リファレンス](https://docs.amivoice.com/amivoice-api/reference/issue-api-key/issue-service-authorization.md): APIキーを発行するAPIのエンドポイント、パラメータ、レスポンスの正確な仕様です。
* [ログ保存](https://docs.amivoice.com/amivoice-api/manual/log-retention.md): 送信した音声データと認識結果を保存するかどうか、およびインタフェースごとの設定方法を説明します。
* [サービス仕様](https://docs.amivoice.com/amivoice-api/manual/specification.md): 通信、セキュリティ、コンプライアンス、サービス提供条件など、導入判断に必要な仕様を説明します。
* [障害・メンテナンス](https://docs.amivoice.com/amivoice-api/manual/maintenance-failure.md): 障害発生時の確認方法、計画メンテナンスの通知、および運用上の注意点を説明します。
* [障害や遅延の情報](https://docs.amivoice.com/amivoice-api/manual/reference-statuspage.md): Statuspageで現在および過去のサービス状態を確認する方法を説明します。
* [トラブルシューティング](https://docs.amivoice.com/amivoice-api/manual/troubleshooting.md): 接続、認証、音声形式、認識結果、性能に関する問題やエラーの対処方法を説明します。
* [更新履歴](https://docs.amivoice.com/amivoice-api/manual/history.md): 新機能、仕様変更、非推奨化、廃止予定を確認します。

## Optional

* [生成AIを利用した開発](https://docs.amivoice.com/amivoice-api/manual/development-with-generative-ai.md): 人間向けに、llms.txtの使用方法、プロンプト例、利用上の注意を説明します。
* [使用量集計タグ](https://docs.amivoice.com/amivoice-api/manual/billing-key.md): 顧客、アプリケーション、機能などの単位で使用量を分類して集計する場合に参照します。
* [クライアントライブラリ](https://docs.amivoice.com/amivoice-api/manual/client-library.md): 公式クライアントライブラリをアプリケーションへ組み込む場合に参照します。
* [サンプルプログラム](https://docs.amivoice.com/amivoice-api/manual/sample-programs.md): 対応言語とインタフェース別の実行可能なサンプルを確認します。
* [費用・価格モデル](https://docs.amivoice.com/amivoice-api/manual/price-model.md): 課金対象時間、課金単位、料金の確認方法を説明します。
* [技術的なお問い合わせ](https://docs.amivoice.com/amivoice-api/manual/contact.md): ドキュメントで解決しない問題について、問い合わせ方法と提示すべき情報を確認します。
* [AmiVoice APIリファレンス](https://docs.amivoice.com/amivoice-api/reference.md): 個別の機能を含むAPIリファレンス全体の入口です。
* [利用規約](https://docs.amivoice.com/amivoice-api/legal/terms): 現行の利用条件、禁止事項、データの取り扱い、責任範囲を確認します。現行版のページへ転送されます。
* [利用規約の更新履歴](https://docs.amivoice.com/amivoice-api/legal/terms-changelog.md): 利用規約の改訂日、変更内容、過去の版を確認します。
* [SLA](https://docs.amivoice.com/amivoice-api/legal/sla): 現行のサービスレベル、適用条件、サービスクレジット等の条件を確認します。現行版のページへ転送されます。
* [SLAの更新履歴](https://docs.amivoice.com/amivoice-api/legal/sla-changelog.md): SLAの改訂内容と過去の版を確認します。