アプリケーションのパラメータ情報を取得

アプリケーションの入力フォーム設定（機能スイッチ、入力パラメータ名、タイプ、デフォルト値）を取得します。

GET /parameters

Error

A valid request URL is required to generate request examples

200

{
  "opening_statement": "Hello! How can I help you today?",
  "suggested_questions": [
    "What can you do?",
    "Tell me about your features."
  ],
  "suggested_questions_after_answer": {
    "enabled": true
  },
  "speech_to_text": {
    "enabled": false
  },
  "text_to_speech": {
    "enabled": false,
    "voice": "alloy",
    "language": "en-US",
    "autoPlay": "disabled"
  },
  "retriever_resource": {
    "enabled": true
  },
  "annotation_reply": {
    "enabled": false
  },
  "more_like_this": {
    "enabled": false
  },
  "sensitive_word_avoidance": {
    "enabled": false
  },
  "user_input_form": [
    {
      "text-input": {
        "label": "City",
        "variable": "city",
        "required": true,
        "default": ""
      }
    }
  ],
  "file_upload": {
    "image": {
      "enabled": true,
      "number_limits": 3,
      "detail": "high",
      "transfer_methods": [
        "remote_url",
        "local_file"
      ]
    }
  },
  "system_parameters": {
    "file_size_limit": 15,
    "image_file_size_limit": 10,
    "audio_file_size_limit": 50,
    "video_file_size_limit": 100,
    "workflow_file_upload_limit": 10
  }
}

Authorizations

Authorization · string · header · required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Response

200

application/json

アプリケーションパラメータ情報。

opening_statement · string

開始時に表示されるオープニングステートメント。

suggested_questions · string[]

推奨される初期質問のリスト。

suggested_questions_after_answer · object

回答後の推奨質問の設定。

Show child attributes

speech_to_text · object

音声からテキストへの変換設定。

Show child attributes

text_to_speech · object

テキストから音声への変換設定。

Show child attributes

retriever_resource · object

検索リソースの設定。

Show child attributes

annotation_reply · object

アノテーション返信の設定。

Show child attributes

more_like_this · object

類似コンテンツの設定。

Show child attributes

sensitive_word_avoidance · object

センシティブワードフィルタリングの設定。

Show child attributes

user_input_form · (Text Input · object | Paragraph · object | Select · object)[]

ユーザー入力フォーム要素のリスト。

Text Input

Paragraph

Select

Show child attributes

file_upload · object

ファイルアップロードの設定。

Show child attributes

system_parameters · object

システムレベルのパラメータと制限。

Show child attributes