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

ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。

GET /parameters

Error

A valid request URL is required to generate request examples

200

{
  "opening_statement": "<string>",
  "suggested_questions": [
    "<string>"
  ],
  "suggested_questions_after_answer": {
    "enabled": true
  },
  "speech_to_text": {
    "enabled": true
  },
  "text_to_speech": {
    "enabled": true,
    "voice": "<string>",
    "language": "<string>",
    "autoPlay": "enabled"
  },
  "retriever_resource": {
    "enabled": true
  },
  "annotation_reply": {
    "enabled": true
  },
  "user_input_form": [
    {
      "text-input": {
        "label": "<string>",
        "variable": "<string>",
        "required": true,
        "default": "<string>"
      }
    }
  ],
  "file_upload": {
    "image": {
      "enabled": true,
      "number_limits": 123,
      "transfer_methods": [
        "remote_url"
      ]
    }
  },
  "system_parameters": {
    "file_size_limit": 123,
    "image_file_size_limit": 123,
    "audio_file_size_limit": 123,
    "video_file_size_limit": 123
  }
}

承認

Authorization · string · header · 必須

APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。

レスポンス

200 - application/json

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

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

opening_statement · string

開始文。

suggested_questions · string[]

開始時の推奨質問のリスト。

suggested_questions_after_answer · object

答えを有効にした後の質問を提案します。

表示 子属性

speech_to_text · object

音声からテキストへ。

表示 子属性

text_to_speech · object

テキストから音声へ。

表示 子属性

retriever_resource · object

引用と帰属。

表示 子属性

annotation_reply · object

注釈返信。

表示 子属性

user_input_form · object[]

ユーザー入力フォームの構成。

ユーザー入力フォーム内のコントロール項目。

Option 1

Option 2

Option 3

表示 子属性

file_upload · object

ファイルアップロード構成。

表示 子属性

system_parameters · object

システムパラメータ。

表示 子属性