メインコンテンツへスキップ
GET
/
ai_agent_default
cURL
curl -L GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
{
  "type": "ai_agent_ask",
  "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
      }
    }
  },
  "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}`."
  },
  "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
      }
    }
  },
  "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}`."
  },
  "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}`."
  },
  "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}`."
  }
}

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.

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

​
mode
enum<string>
必須

返されるエージェント構成にフィルタをかけるためのモード。

利用可能なオプション:
ask,
text_gen,
extract,
extract_structured
​
language
string

返されるエージェント構成のISO言語コード。その言語がサポートされていない場合は、デフォルトのエージェント構成が返されます。

​
model
string

返されるデフォルトのエージェント構成のモデル。

レスポンス

デフォルトのエージェント構成を含む成功したレスポンス。このレスポンスは、以下の4つのオブジェクトのいずれかになります。

  • 質問用のAIエージェント
  • テキスト生成用のAIエージェント
  • 自由形式のメタデータ抽出用のAIエージェント
  • 構造化メタデータ抽出用のAIエージェント。レスポンスは、このエンドポイントでリクエストされたエージェント構成によって決まります。

クエリの処理に使用されるAIエージェント。

​
type
enum<string>
必須

クエリの処理に使用されるAIエージェントのタイプ。

利用可能なオプション:
ai_agent_ask
例:

"ai_agent_ask"

​
long_text
AIエージェントの長いテキストツール · object

長いテキストの処理に使用されるAIエージェントプロセッサ。

​
basic_text
AIエージェントの基本テキストツール · object

基本テキストの処理に使用されるAIエージェントプロセッサ。

​
spreadsheet
AIエージェントのスプレッドシートツール · object

スプレッドシートや表形式データの処理に使用されるAIエージェントツール。

​
long_text_multi
AIエージェントの長いテキストツール · object

長いテキストの処理に使用されるAIエージェントプロセッサ。

​
basic_text_multi
AIエージェントの基本テキストツール · object

基本テキストの処理に使用されるAIエージェントプロセッサ。

​
basic_image
AIエージェントの基本テキストツール · object

基本テキストの処理に使用されるAIエージェントプロセッサ。

​
basic_image_multi
AIエージェントの基本テキストツール · object

基本テキストの処理に使用されるAIエージェントプロセッサ。