メインコンテンツへスキップ
APIバージョン 2024.0 AIエージェントインスタンスのFull版の表示。
このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。
​
id
string
例 1234567890AIエージェントの一意の識別子。
​
type
string
例 ai_agentクエリの処理に使用されるエージェントのタイプ。次の値に固定: ai_agent
​
access_state
string
例 enabledAIエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。
​
allowed_entities
タイプとIDが指定されたエンティティ[グループ (Base)/ユーザー (Base)]array
許可するユーザーまたはグループのリスト。
​
ask
AIエージェントの機能 (質問)object
質問に使用するAIエージェント。
​
created_at
string(date-time)
例 2022-01-01T00:00:00ZこのAIエージェントが作成された時点のISO日時形式のタイムスタンプ。
​
created_by
ユーザー (Base)object
このエージェントを作成したユーザー。
​
extract
AIエージェントの機能 (抽出)object
メタデータ抽出に使用するAIエージェント。
​
icon_reference
string
例 https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svgAIエージェントのアイコン参照。
​
modified_at
string(date-time)
例 2022-01-01T00:00:00ZこのAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。
​
modified_by
ユーザー (Base)object
このエージェントを直近で変更したユーザー。
​
name
string
例 This is my AgentAIエージェントの名前。
​
origin
string
例 CUSTOMAIエージェントのプロバイダ。
​
text_gen
AIエージェントの機能 (テキスト生成)object
テキストの生成に使用するAIエージェント。
{
  "id": "1234567890",
  "type": "ai_agent",
  "access_state": "enabled",
  "allowed_entities": [
    {
      "id": "11446498",
      "type": "user"
    }
  ],
  "ask": {
    "type": "ai_agent_ask",
    "access_state": "enabled",
    "basic_image": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_image_multi": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text_multi": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "long_text_multi": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "spreadsheet": {
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "suggested_questions": [
      "What is in this file?",
      "What are the main highlights of this document?"
    ]
  },
  "created_at": "2022-01-01T00:00:00Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "extract": {
    "type": "ai_agent_extract",
    "access_state": "enabled",
    "basic_image": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    }
  },
  "icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
  "modified_at": "2022-01-01T00:00:00Z",
  "modified_by": {
    "id": "11446498",
    "type": "user"
  },
  "name": "This is my Agent",
  "origin": "CUSTOM",
  "text_gen": {
    "type": "ai_agent_text_gen",
    "access_state": "enabled",
    "basic_gen": {
      "content_template": "---{content}---",
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "suggested_questions": [
      "What is in this file?",
      "What are the main highlights of this document?"
    ]
  }
}