Box Developerドキュメント
ログイン
最新バージョン

AIエージェントのデフォルト構成を取得

get
https://api.box.com/2.0
/ai_agent_default

AIエージェントのデフォルト構成を取得します

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内省略可能
ja

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

stringクエリ内必須
ask

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

次の値のいずれか1つ: ask,text_gen,extract,extract_structured

stringクエリ内省略可能
openai__gpt_3_5_turbo

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

レスポンス

application/jsonテキスト生成リクエスト用のAIエージェント/質問リクエスト用のAIエージェント/抽出リクエスト用のAIエージェント/抽出 (構造化) リクエスト用のAIエージェント

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

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

予期しないサーバーエラー。

application/jsonクライアントエラー

予期しないエラー。

get
AIエージェントのデフォルト構成を取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -L GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
TypeScript Gen
await client.ai.getAiAgentDefaultConfig({
  mode: 'text_gen' as GetAiAgentDefaultConfigQueryParamsModeField,
  language: 'en-US',
} satisfies GetAiAgentDefaultConfigQueryParams);
Python Gen
client.ai.get_ai_agent_default_config(
    GetAiAgentDefaultConfigMode.EXTRACT_STRUCTURED, language="en-US"
)
.NET Gen
await client.Ai.GetAiAgentDefaultConfigAsync(queryParams: new GetAiAgentDefaultConfigQueryParams(mode: GetAiAgentDefaultConfigQueryParamsModeField.TextGen) { Language = "en-US" });
Java
BoxAIAgentConfig config = BoxAI.getAiAgentDefaultConfig(
    api,
    BoxAIAgent.Mode.ASK,
    "en",
    "openai__gpt_3_5_turbo"
);
Python
config = client.get_ai_agent_default_config(
    mode='text_gen',
    language='en',
    model='openai__gpt_3_5_turbo'
)
print(config)
Node
client.ai.getAiAgentDefaultConfig({
    mode: 'ask',
    language: 'en',
    model:'openai__gpt_3_5_turbo'
}).then(response => {
    /* response -> {
        "type": "ai_agent_ask",
        "basic_text": {
            "llm_endpoint_params": {
            "type": "openai_params",
            "frequency_penalty": 1.5,
            "presence_penalty": 1.5,
            "stop": "<|im_end|>",
            "temperature": 0,
            "top_p": 1
            },
            "model": "openai__gpt_3_5_turbo",
            "num_tokens_for_completion": 8400,
            "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. What should I see?",
            "system_message": "You are a helpful travel assistant specialized in budget travel"
        },
        ...
    } */
});

レスポンスの例

{
  "type": "ai_agent_text_gen",
  "basic_gen": {
    "content_template": "---{content}---",
    "embeddings": {
      "model": "openai__text_embedding_ada_002",
      "strategy": {
        "id": "basic",
        "num_tokens_per_chunk": 64
      }
    },
    "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_3_5_turbo_16k",
    "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"
  }
}