APIレスポンス仕様
| フィールド | 型 | 説明 | 文字数上限 |
|---|
| id | string | ユニークな識別子（UUID形式） | |
| displayName | string | エージェントの表示名 | 100 |
| description | string | エージェントの簡単な説明 | 129 |
| photoUrl | string | プロフィール画像のURL | |
| serviceUrl | string | 関連サービスのURL | |
| providerName | string | サービス提供者の名前 | 60 |
| ownerUid | string | 所有者の一意識別子 | |
| scope | string | 公開範囲（"private"または"public"） | |
| useAIResponse | boolean | AI応答の使用有無 | |
| フィールド | 型 | 説明 |
|---|
| startUtterance | string | 初回メッセージのテンプレート（@random:[]形式で複数指定可） |
| forbiddenUtterance | string | 禁止された発話の設定 |
| llmErrorUtterance | string | LLMエラー時の応答メッセージ |
| requestLimitExceededUtterance | string | リクエスト制限超過時のメッセージ |
| aiResponseLimitUtterance | string | AI応答の制限到達時のメッセージ |
| フィールド | 型 | 説明 |
|---|
| quickReplyOptions | array (string) | デフォルトで表示するクイックリプライのオプション配列 |
| フィールド | 型 | 説明 |
|---|
| shouldUseHtmlResponse | boolean | HTML応答の使用有無 |
| stream | boolean | ストリーミング応答の有無 |
| フィールド | 型 | 説明 |
|---|
| llm | string | 使用する言語モデルの指定 |
| temperature | number | 応答の多様性を制御するパラメータ (0~1.0) |
| prompt | string | エージェントの振る舞いを定義する詳細な指示 (3000文字以内) |
| フィールド | 型 | 説明 |
|---|
| aiResponseMaxCountPerDay | integer | 1日あたりのAI応答最大数 |
| aiResponseMaxCountPerMonth | integer | 月あたりのAI応答最大数 |
| utteranceMaxLength | integer | 発話の最大長 |
| フィールド | 型 | 説明 |
|---|
| webSearchDataSource | object | ウェブ検索のデータソース設定 |
| knowledgeDataStore | object | 知識データストアの使用設定 |
| insertLinksAutomatically | boolean | リンクの自動挿入有無 |
| useUserInfoSummary | boolean | ユーザー情報要約の使用有無 |
| shouldShowQuery | boolean | クエリの表示有無 |
| searchQueryPrompt | string | 検索クエリ生成のためのプロンプト (1500) |
文字以内## 高度な設定
| フィールド | 型 | 説明 |
|---|
| shouldIncludeDataStoreAddDate | boolean | 追記データストア追加日付の含有有無 |
| webhookTimeoutSec | integer | Webhookのタイムアウト秒数 |
| フィールド | 型 | 説明 |
|---|
| useKnowledgeDataStore | boolean | 知識データストアの使用有無 |
| shouldSendDataStoreResultEmail | boolean | データストア結果をメールで送信するかどうか |
| knowledgeDataStoreNumCandidates | integer | 一回の会話で採用するナレッジデータストアのアイテムの数(0~30) ※0の場合は自動調整 |
| knowledgeDataStoreCandidateScoreThreshold | float | ナレッジデータストアの検索結果で採用するスコアの閾値 (0~1.0) ※0の場合は自動調整 |
| フィールド | 型 | 説明 |
|---|
| dataSourceLabel | string | ウェブ検索のデータソースラベル |
| useDeepWebSearch | boolean | ディープウェブ検索の使用有無 |
最後に、JSONサンプルを以下に示します。値は汎用的なものを使用しています：
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"displayName": "汎用AIエージェント",
"description": "様々なタスクに対応可能な汎用AIエージェント",
"photoUrl": "https://example.com/agent-avatar.png",
"serviceUrl": "https://api.example.com/ai-agent",
"providerName": "AI Solutions Inc.",
"ownerUid": "user123456",
"scope": "public",
"useAIResponse": true,
"utterances": {
"startUtterance": "@random:[\"こんにちは！どのようなお手伝いができますか？\", \"ようこそ！今日は何をお手伝いしましょうか？\"]",
"forbiddenUtterance": "申し訳ありませんが、その内容についてはお答えできません。",
"llmErrorUtterance": "エラーが発生しました。しばらくしてからもう一度お試しください。",
"requestLimitExceededUtterance": "リクエスト制限に達しました。後でもう一度お試しください。",
"aiResponseLimitUtterance": "申し訳ありませんが、応答の制限に達しました。"
},
"quickReply": {
"quickReplyOptions": ["ヘルプ", "設定", "情報"]
},
"autoResponseSettings": {
"ruleBasedThresholdLevel": 3,
"shouldUseHtmlResponse": false,
"stream": true
},
"llmSettings": {
"llm": "gpt-4",
"temperature": 0.7,
"prompt": "あなたは親切で効率的なAIエージェントです。ユーザーの質問に簡潔に答えてください。"
},
"ttsSettings": {
"ttsId": "neural-voice-1",
"ttsPitch": 1.0,
"ttsSpeed": 1.0
},
"limits": {
"aiResponseMaxCountPerDay": 1000,
"aiResponseMaxCountPerMonth": 30000,
"utteranceMaxLength": 500
},
"knowledge": {
"webSearchDataSource": {
"dataSourceLabel": "GeneralWebSearch",
"useDeepWebSearch": false
},
"knowledgeDataStore": {
"useKnowledgeDataStore": true,
"shouldSendDataStoreResultEmail": false
},
"insertLinksAutomatically": true,
"useUserInfoSummary": false,
"searchResultSummaryLength": 150,
"shouldShowQuery": false,
"searchQueryPrompt": "ユーザーの質問から最適な検索クエリを生成してください。"
},
"advancedSettings": {
"additionalPrompt": "",
"shouldIncludeDataStoreAddDate": true,
"webhookTimeoutSec": 30
}
}
