> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# AI Studio リソース
AI Studioの操作に使用される、一連のエンドポイント。
## AIエージェント
AIエージェントインスタンスのStandard版の表示。
| プロパティ | 型 | 必須 | 説明 |
| ------------------ | -------------------------------------------------- | --- | ----------------------------------------------------------------------- |
| `id` | `string` | はい | AIエージェントの一意の識別子。 |
| `type` | `enum` | いいえ | クエリの処理に使用されるエージェントのタイプ。 使用可能なオプション: `ai_agent`. |
| `origin` | `string` | はい | AIエージェントのプロバイダ。 |
| `name` | `string` | はい | AIエージェントの名前。 |
| `access_state` | `string` | はい | AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。 |
| `created_by` | [ユーザー (Base)](/ja/reference/users-resources#-base) | いいえ | このエージェントを作成したユーザー。 |
| `created_at` | `string` | いいえ | このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。 |
| `modified_by` | [ユーザー (Base)](/ja/reference/users-resources#-base) | いいえ | このエージェントを直近で変更したユーザー。 |
| `modified_at` | `string` | いいえ | このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。 |
| `icon_reference` | `string` | いいえ | AIエージェントのアイコン参照。 |
| `allowed_entities` | array of `タイプとIDが指定されたエンティティ` | いいえ | 許可するユーザーまたはグループのリスト。 |
```json 例 theme={null}
{
"id": "1234567890",
"type": "ai_agent",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
]
}
```
## AIエージェント (Full)
AIエージェントインスタンスのFull版の表示。
| プロパティ | 型 | 必須 | 説明 |
| ------------------ | -------------------------------------------------- | --- | ----------------------------------------------------------------------- |
| `id` | `string` | はい | AIエージェントの一意の識別子。 |
| `type` | `enum` | いいえ | クエリの処理に使用されるエージェントのタイプ。 使用可能なオプション: `ai_agent`. |
| `origin` | `string` | はい | AIエージェントのプロバイダ。 |
| `name` | `string` | はい | AIエージェントの名前。 |
| `access_state` | `string` | はい | AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。 |
| `created_by` | [ユーザー (Base)](/ja/reference/users-resources#-base) | いいえ | このエージェントを作成したユーザー。 |
| `created_at` | `string` | いいえ | このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。 |
| `modified_by` | [ユーザー (Base)](/ja/reference/users-resources#-base) | いいえ | このエージェントを直近で変更したユーザー。 |
| `modified_at` | `string` | いいえ | このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。 |
| `icon_reference` | `string` | いいえ | AIエージェントのアイコン参照。 |
| `allowed_entities` | array of `タイプとIDが指定されたエンティティ` | いいえ | 許可するユーザーまたはグループのリスト。 |
| `ask` | [AIエージェントの機能 (質問)](#ai-) | いいえ | |
| `text_gen` | [AIエージェントの機能 (テキスト生成)](#ai-) | いいえ | |
| `extract` | [AIエージェントの機能 (抽出)](#ai-) | いいえ | |
```json 例 theme={null}
{
"id": "1234567890",
"type": "ai_agent",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
}
```
## AIエージェントのリスト
ページネーションを使用したAIエージェントのリスト。
| プロパティ | 型 | 必須 | 説明 |
| ------------- | ------------------------------------ | --- | ------------------------------------------------------------------------------ |
| `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 |
| `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 |
| `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 |
| `entries` | array of [AIエージェント (Full)](#ai-full) | はい | AIエージェントのリスト。 |
```json 例 theme={null}
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "1234567890",
"type": "ai_agent",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
}
]
}
```
## AIエージェントの機能 (テキスト生成)
テキストの生成に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | ---------------------- | --- | ----------------------------------------------------------- |
| `type` | `enum` | はい | テキストの生成に使用されるAIエージェントのタイプ。 使用可能なオプション: `ai_agent_text_gen`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `suggested_questions` | array of `string` | いいえ | AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。 |
| `basic_gen` | `AIエージェントの基本テキスト生成ツール` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
```
## AIエージェントの機能 (テキスト生成リクエスト)
テキストの生成に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | ---------------------------- | --- | ----------------------------------------------------------- |
| `type` | `enum` | はい | テキストの生成に使用されるAIエージェントのタイプ。 使用可能なオプション: `ai_agent_text_gen`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `suggested_questions` | array of `string` | いいえ | AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。 |
| `basic_gen` | `AIエージェントの基本テキスト生成ツールのリクエスト` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false
}
}
```
## AIエージェントの機能 (質問)
質問に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | ---------------------- | --- | ----------------------------------------------------------- |
| `type` | `enum` | はい | 質問に使用されるAIエージェントのタイプ。 使用可能なオプション: `ai_agent_ask`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `suggested_questions` | array of `string` | いいえ | AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。 |
| `long_text` | `AIエージェントの長いテキストツール` | いいえ | |
| `basic_text` | `AIエージェントの基本テキストツール` | いいえ | |
| `basic_image` | `AIエージェントの基本テキストツール` | いいえ | |
| `spreadsheet` | `AIエージェントのスプレッドシートツール` | いいえ | |
| `long_text_multi` | `AIエージェントの長いテキストツール` | いいえ | |
| `basic_text_multi` | `AIエージェントの基本テキストツール` | いいえ | |
| `basic_image_multi` | `AIエージェントの基本テキストツール` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
```
## AIエージェントの機能 (質問リクエスト)
クエリの処理に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | -------------------------- | --- | ----------------------------------------------------------- |
| `type` | `enum` | はい | クエリの処理に使用されるAIエージェントのタイプ。 使用可能なオプション: `ai_agent_ask`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `suggested_questions` | array of `string` | いいえ | AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。 |
| `long_text` | `AIエージェントの長いテキストツールのリクエスト` | いいえ | |
| `basic_text` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
| `basic_image` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
| `spreadsheet` | `AIエージェントのスプレッドシートツール` | いいえ | |
| `long_text_multi` | `AIエージェントの長いテキストツールのリクエスト` | いいえ | |
| `basic_text_multi` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
| `basic_image_multi` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
}
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
}
}
```
## AIエージェントの機能 (抽出)
メタデータ抽出に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | -------------------- | --- | --------------------------------------------------------- |
| `type` | `enum` | はい | メタデータ抽出に使用するAIエージェントのタイプ。 使用可能なオプション: `ai_agent_extract`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `long_text` | `AIエージェントの長いテキストツール` | いいえ | |
| `basic_text` | `AIエージェントの基本テキストツール` | いいえ | |
| `basic_image` | `AIエージェントの基本テキストツール` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
```
## AIエージェントの機能 (抽出リクエスト)
メタデータ抽出に使用するAIエージェント。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | -------------------------- | --- | --------------------------------------------------------- |
| `type` | `enum` | はい | メタデータ抽出に使用するAIエージェントのタイプ。 使用可能なオプション: `ai_agent_extract`. |
| `access_state` | `string` | はい | AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。 |
| `description` | `string` | はい | AIエージェントの説明。 |
| `custom_instructions` | `string` | いいえ | AIエージェントに対するカスタム指示。 `null` を指定できます。 |
| `long_text` | `AIエージェントの長いテキストツールのリクエスト` | いいえ | |
| `basic_text` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
| `basic_image` | `AIエージェントの基本テキストツールのリクエスト` | いいえ | |
```json 例 theme={null}
{
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false
}
}
```