テキストジェネレーターアプリ API

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。

​

テキストの生成

• 完了メッセージを送信：inputs の値をアプリのプロンプトテンプレートに反映し、応答を生成します。ブロッキングモードでは生成の完了後に応答をまとめて返します。ストリーミングモードでは message イベントを message_end まで連続で受信できます。アプリでテキスト読み上げの自動再生が有効な場合は、tts_message イベントも届きます。
• 生成を停止：ストリーミング中の応答を完了前に中断します。

​

ファイルの操作

• ファイルをアップロード：画像、ドキュメント、音声、動画ファイルをアップロードし、完了メッセージを送信 から参照できるようにします。ファイルはアップロードしたエンドユーザーのみが利用できます。
• ファイルをダウンロード：アップロード済みファイルをプレビューまたはダウンロードします。対象はアプリ内のメッセージに紐づくファイルに限られます。
• エンドユーザー取得：エンドユーザー ID（ファイルアップロードのレスポンスにある created_by など）から、そのユーザーの詳細を取得します。

​

音声とテキストの相互変換

• 音声をテキストに変換：アップロードされた音声ファイル（MP3、M4A、WAV、AMR、MPGA のいずれか、最大 30 MB）を文字起こしします。エンドユーザーはタイピングの代わりに音声で入力できます。
• テキストを音声に変換：生成された応答を音声として合成します。

​

アプリ情報と設定の取得

• アプリケーションの基本情報を取得：アプリの名前、説明、タグ、モードを返します。
• アプリケーションのパラメータ情報を取得：呼び出し時に inputs で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。
• アプリケーションのメタ情報を取得：ツールアイコンなどの設定メタデータを返します。
• アプリの WebApp 設定を取得：WebApp のサイト設定、テーマ、カスタマイズ項目を返します。

​

フィードバックの収集

• メッセージフィードバックを送信：エンドユーザーが応答を like または dislike で評価します。任意でコメントも付けられます。
• アプリのフィードバック一覧を取得：エンドユーザーと管理者の両方から寄せられた、アプリ全体のフィードバックをすべて返します。