> ## 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エージェントを作成

> AIエージェントを作成します。`ask`、`text_gen`、`extract`の機能のうち1つ以上を指定する必要があります。

<Note>
  このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 [**Box APIのバージョン管理**](/ja/guides/api-calls/api-versioning-strategy/)を参照してください。

  「[Box SDKのバージョニング戦略](/ja/guides/tooling/sdks/sdk-versioning/)について詳しく学ぶ。」
</Note>


## OpenAPI

````yaml box-openapi-jp.json POST /ai_agents
openapi: 3.0.2
info:
  title: Box Platform API
  description: >-
    [Box
    Platform](https://developer.box.com)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://developer.box.com
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2024.0'
  x-box-commit-hash: 92c221bf9d
servers:
  - url: https://api.box.com/2.0
    description: Box Platform APIサーバー。
security:
  - OAuth2Security: []
tags:
  - name: AI
    description: サポート対象のLLMの操作に使用される、一連のエンドポイント。
    x-box-tag: ai
  - name: AI Studio
    description: AI Studioの操作に使用される、一連のエンドポイント。
    x-box-tag: ai_studio
  - name: アプリ項目の関連付け
    x-box-tag: app_item_associations
  - name: 承認
    description: ユーザー承認プロセスを管理するために使用される、一連のエンドポイント。
    x-box-tag: authorization
    x-box-priority: true
  - name: Box Signリクエスト
    description: Box Signリクエストは、署名用ファイルを送信するために使用されます。
    x-box-tag: sign_requests
  - name: Classifications
    description: 分類ラベルは、機密性の高いコンテンツやセキュリティ上の制限が適用されるコンテンツに使用されます。
    x-box-tag: classifications
  - name: ファイルの分類
    description: 分類ラベルは、機密性の高いファイルやセキュリティ上の制限が適用されるファイルに使用されます。
    x-box-tag: file_classifications
  - name: フォルダの分類
    description: 分類ラベルは、機密性の高いフォルダやセキュリティ上の制限が適用されるフォルダに使用されます。
    x-box-tag: folder_classifications
  - name: Collaborations
    description: コラボレーションは、アクセス制限リストと同様に、ユーザーやグループがファイルやフォルダにアクセスする際の権限を定義します。
    x-box-tag: user_collaborations
  - name: コラボレーション (リスト)
    description: ファイル、フォルダ、保留、グループコラボレーションを取得するために使用される、一連のエンドポイント。
    x-box-tag: list_collaborations
  - name: Collections
    description: コレクションを利用して、ファイル、フォルダ、ウェブリンクを1つのフォルダにまとめることなくグループ化できます。
    x-box-tag: collections
  - name: Comments
    description: >-
      コメントは、ユーザーがファイルに対して生成するメッセージです。コメントを使用すると、複数のユーザーがファイル上でコラボレーションし、コンテンツに対するフィードバックについて話し合うことができます。
    x-box-tag: comments
  - name: Device Pinners
    description: Device Pinnerを使用すると、どのデバイスでネイティブBoxアプリケーションの使用を許可するかを企業レベルで制御できます。
    x-box-tag: device_pinners
  - name: ドメインの制限 (ユーザーの除外)
    description: 特定の企業に許可されたコラボレーションドメインのリストによって課せられた制限からユーザーを除外できる、一連のエンドポイント。
    x-box-tag: collaboration_allowlist_exempt_targets
  - name: コラボレーションに対するドメインを制限
    description: ユーザーが企業のファイルやフォルダでコラボレーションできるドメインを管理する、一連のエンドポイント。
    x-box-tag: collaboration_allowlist_entries
  - name: ダウンロード
    description: ダウンロードを利用して、ファイルをアプリケーションのサーバーに保存することも、エンドユーザーがブラウザで直接保存することもできます。
    x-box-tag: downloads
  - name: メールエイリアス
    description: メールエイリアスを使用することで、ユーザーのログイン用プライマリメールアドレスに加えて複数のメールアドレスを指定できます。
    x-box-tag: email_aliases
  - name: Events
    description: イベントを利用して、企業内の任意のユーザー (複数可) またはサービスによって実行される操作をアプリケーションが登録できます。
    x-box-tag: events
  - name: ファイルリクエスト
    description: >-
      ファイルリクエストを利用すると、任意のユーザーに対してファイルとそれに関連付けられたメタデータを迅速かつ安全にリクエストできます。ユーザーは、既存のファイルリクエストを基にして新しいファイルリクエストを作成できるほか、ファイルリクエストの設定を更新したり、プログラムによってファイルリクエストの有効化、無効化、削除を実行したりできます。
    x-box-tag: file_requests
  - name: ファイルバージョンリーガルホールド
    description: >-
      リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。ファイルバージョンリーガルホールドは、特定のファイルバージョンに割り当てられているすべてのポリシーを表します。
    x-box-tag: file_version_legal_holds
  - name: ファイルバージョンリテンション
    description: >-
      リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。
    x-box-tag: file_version_retentions
  - name: ファイルバージョン
    description: ファイルの特定のバージョンを管理するために使用される、一連のエンドポイント。
    x-box-tag: file_versions
  - name: Files
    description: >-
      ファイルは、フォルダとともに、Box
      APIの中核を成します。ファイルはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
    x-box-tag: files
  - name: フォルダロック
    description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
    x-box-tag: folder_locks
  - name: Folders
    description: >-
      フォルダは、ファイルとともに、Box
      APIの中核を成します。フォルダはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
    x-box-tag: folders
  - name: 統合マッピング
    description: 統合マッピングを使用すると、ユーザーはパートナーアプリからのコンテンツがBoxのどこに保存されるかを管理できます。
    x-box-tag: integration_mappings
  - name: グループメンバーシップ
    description: グループメンバーシップは、ユーザーがグループに属していることを示します。
    x-box-tag: memberships
  - name: Groups
    description: 企業内に作成されたグループ。
    x-box-tag: groups
  - name: Invites
    description: 招待は、ユーザーを企業に招待するために使用されます。
    x-box-tag: invites
  - name: リーガルホールドポリシー
    description: >-
      リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。
    x-box-tag: legal_hold_policies
  - name: リーガルホールドポリシー割り当て
    description: >-
      リーガルホールドポリシー割り当ては、ポリシーとカストディアンの関係です。この場合、カストディアンにはユーザー、フォルダ、ファイル、またはファイルバージョンを指定できます。
    x-box-tag: legal_hold_policy_assignments
  - name: メタデータカスケードポリシー
    description: メタデータカスケードポリシーには、フォルダに適用されているメタデータインスタンスを、そのフォルダ内の項目にどのように適用するかが記載されています。
    x-box-tag: metadata_cascade_policies
  - name: メタデータインスタンス (ファイル)
    description: メタデータインスタンスには、テンプレートとファイル間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
    x-box-tag: file_metadata
  - name: メタデータインスタンス (フォルダ)
    description: メタデータインスタンスには、テンプレートとフォルダ間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
    x-box-tag: folder_metadata
  - name: メタデータ階層
    description: メタデータ階層とは、企業内のメタデータを整理して管理するために役立つ、階層型分類システムです。
    x-box-tag: metadata_taxonomies
  - name: メタデータテンプレート
    description: メタデータテンプレートには、ファイルに割り当てることができる、一連の再利用可能なキー/値ペアが記載されています。
    x-box-tag: metadata_templates
  - name: 最近使用した項目
    description: 最近使用した項目は、ユーザーが最近アクセスしたファイルやフォルダなどの項目を表します。
    x-box-tag: recent_items
  - name: リテンションポリシー
    description: >-
      リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや企業全体に割り当てることができます。
    x-box-tag: retention_policies
  - name: リテンションポリシー割り当て
    description: >-
      リテンションポリシー割り当ては、ポリシーとフォルダや企業の関係です。割り当てを作成すると、そのフォルダや企業に属するすべてのファイルバージョンにリテンションが適用されます。
    x-box-tag: retention_policy_assignments
  - name: 検索
    description: Box APIを使用すると、ファイルコンテンツ検索クエリを使用してBox内のコンテンツを探すことができます。
    x-box-tag: search
  - name: セッション終了
    description: セッション終了APIを使用すると、グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成できます。
    x-box-tag: session_termination
  - name: 共有リンク (ファイル)
    description: >-
      ファイル共有リンクは、Boxに保存されているファイルを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
    x-box-tag: shared_links_files
  - name: 共有リンク (フォルダ)
    description: >-
      フォルダ共有リンクは、Boxに保存されているフォルダを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
    x-box-tag: shared_links_folders
  - name: 共有リンク (ウェブリンク)
    description: >-
      ファイル用ウェブリンクは、Box内のウェブリンクを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
    x-box-tag: shared_links_web_links
  - name: 共有リンク (アプリ項目)
    description: Boxに保存されているアプリ項目に対して生成されるURL。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
    x-box-tag: shared_links_app_items
  - name: Shield情報バリア
    description: >-
      BoxのShield情報バリアは、倫理的境界を定義します。倫理的境界とは、利益相反につながり、結果として倫理的または法的に問題のあるビジネス活動につながる可能性があるやり取りまたは通信を防ぐメカニズムです。
    x-box-tag: shield_information_barriers
  - name: Shield情報バリアのセグメント
    description: >-
      Shield情報バリアのセグメントは、ユーザーの定義済みグループを表します。セグメントがグループと異なる点は、ユーザーが所属できるセグメントが1つのみであることです。
    x-box-tag: shield_information_barrier_segments
  - name: Shield情報バリアのセグメントメンバー
    description: Shield情報バリアのセグメントメンバーは、特定のセグメントに割り当てられたユーザーを表します。
    x-box-tag: shield_information_barrier_segment_members
  - name: Shield情報バリアレポート
    description: Shield情報バリアレポートには、情報バリアが有効化されるときに完全に削除される既存のコラボレーションに関する情報が含まれます。
    x-box-tag: shield_information_barrier_reports
  - name: Shield情報バリアのセグメント制限
    description: Shield情報バリアのセグメント制限とは、コンテンツ (ファイルまたはフォルダ) の所有者に基づいて適用されるアクセス制限です。
    x-box-tag: shield_information_barrier_segment_restrictions
  - name: Box Signテンプレート
    description: >-
      署名テンプレートを使用すると、署名リクエストの作成時に、あらかじめ定義されたBox
      Signテンプレートを使用できます。このテンプレートに含まれるプレースホルダには、リクエストの作成時にデータが自動的に入力されます。
    x-box-tag: sign_templates
  - name: Skills
    description: >-
      Box
      Skillsは、ファイルの基盤となるメタデータを強化することを目的として、Boxにアップロードされたファイルにカスタム処理を実行するための機能です。
    x-box-tag: skills
  - name: 標準およびZonesのストレージポリシー
    description: ストレージポリシー割り当ては、特定の企業内の項目に対するストレージゾーンを表します。
    x-box-tag: storage_policies
  - name: 標準およびZonesのストレージポリシー割り当て
    description: ストレージポリシー割り当ては、ストレージゾーンと割り当てられた項目 (特定のゾーンに保存されているファイルなど) の間の関係を表します。
    x-box-tag: storage_policy_assignments
  - name: タスク割り当て
    description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
    x-box-tag: task_assignments
  - name: Tasks
    description: >-
      ユーザーはタスクを使用することで、ファイルのコラボレータに対して、ファイルのレビューや作業の一部の完了をリクエストできます。タスクは、開発者がファイル中心のワークフローを作成するために使用できます。
    x-box-tag: tasks
  - name: サービス利用規約
    description: サービス利用規約を管理するために使用される、一連のエンドポイント。
    x-box-tag: terms_of_services
  - name: サービス利用規約のユーザーステータス
    description: 特定ユーザーのサービス利用規約のステータスを管理するために使用される、一連のエンドポイント。
    x-box-tag: terms_of_service_user_statuses
  - name: フォルダの移動
    description: ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動するためのAPI。
    x-box-tag: transfer
  - name: ごみ箱内のファイル
    description: 削除されて現在ごみ箱にあるファイル。
    x-box-tag: trashed_files
  - name: ごみ箱内のフォルダ
    description: 削除されて現在ごみ箱にあるフォルダ。
    x-box-tag: trashed_folders
  - name: ごみ箱内の項目
    description: 削除されて現在ごみ箱にある項目。
    x-box-tag: trashed_items
  - name: ごみ箱内のウェブリンク
    description: 削除されて現在ごみ箱にあるウェブリンク。
    x-box-tag: trashed_web_links
  - name: アップロード
    description: >-
      直接ファイルアップロードAPIは最大50 MBのファイルをサポートしており、1回のAPIリクエストですべてのバイナリデータをBox
      APIに送信します。
    x-box-tag: uploads
  - name: アップロード (分割)
    description: >-
      分割アップロードエンドポイントは20
      MB以上のファイルをサポートしており、アプリケーションでファイルを複数のパーツに分割してアップロードすることで、エラーのキャッチと個別のパーツの再送信を詳細に制御できます。
    x-box-tag: chunked_uploads
  - name: ユーザーのアバター
    description: >-
      ユーザーのアバターとは、ユーザー画像を表すためにBoxにアップロードされたJPGファイルまたはPNGファイルです。これはユーザーアカウントで表示されます。
    x-box-tag: avatars
  - name: Users
    description: >-
      Box APIは、管理対象ユーザーアカウントでログインする実際の従業員や、App
      Userを使用して強力な自動化ワークフローを推進するアプリケーションなど、さまざまなユーザーをサポートしています。
    x-box-tag: users
  - name: 電子すかし (ファイル)
    description: >-
      電子すかしとは、埋め込みファイルのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、ファイルのアクセス日時が表示されます。
    x-box-tag: file_watermarks
  - name: 電子すかし (フォルダ)
    description: >-
      電子すかしとは、埋め込みフォルダのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、フォルダコンテンツのアクセス日時が表示されます。
    x-box-tag: folder_watermarks
  - name: ウェブリンク
    description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
    x-box-tag: web_links
  - name: Webhooks
    description: >-
      Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ファイルがダウンロードされるのを待ち、ダウンロード後に共有リンクを削除するワークフローを作成できます。
    x-box-tag: webhooks
  - name: ワークフロー (リスト)
    description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
    x-box-tag: workflows
  - name: zipダウンロード
    description: zipダウンロードは、ファイルやフォルダを含むZIPアーカイブを作成するリクエストが成功したことを表します。
    x-box-tag: zip_downloads
externalDocs:
  description: Box Developerドキュメント。
  url: https://developer.box.com
paths:
  /ai_agents:
    post:
      tags:
        - AI Studio
      summary: AIエージェントを作成
      description: AIエージェントを作成します。`ask`、`text_gen`、`extract`の機能のうち1つ以上を指定する必要があります。
      operationId: post_ai_agents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAiAgent'
      responses:
        '200':
          description: 作成されたAIエージェントの定義。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiSingleAgentResponse--Full'
        '400':
          description: 予期しないクライアントエラー。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '500':
          description: 予期しないサーバーエラー。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-codeSamples:
        - lang: curl
          label: AIエージェントを作成
          source: |-
            curl -i -L -X POST "https://api.box.com/2.0/ai_agents" \
                 -H "authorization: Bearer <ACCESS_TOKEN>" \
                 -H "content-type: application/json" \
                 -d '{
                   "type": "ai_agent",
                   "name": "My AI Agent",
                   "access_state": "enabled",
                   "ask": {
                     "type": "ai_agent_ask",
                     "access_state": "enabled",
                     "description": "Answers questions about documents"
                   }
                 }'
        - lang: dotnet
          label: AIエージェントを作成
          source: >-
            await client.AiStudio.CreateAiAgentAsync(requestBody: new
            CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new
            AiStudioAgentAsk(accessState: "enabled", description: "desc1") });
        - lang: swift
          label: AIエージェントを作成
          source: >-
            try await client.aiStudio.createAiAgent(requestBody:
            CreateAiAgent(name: agentName, accessState: "enabled", ask:
            AiStudioAgentAsk(accessState: "enabled", description: "desc1")))
        - lang: java
          label: AIエージェントを作成
          source: >-
            client.getAiStudio().createAiAgent(new
            CreateAiAgent.Builder(agentName, "enabled").ask(new
            AiStudioAgentAsk("enabled", "desc1")).build())
        - lang: node
          label: AIエージェントを作成
          source: |-
            await client.aiStudio.createAiAgent({
              name: agentName,
              accessState: 'enabled',
              ask: new AiStudioAgentAsk({ accessState: 'enabled', description: 'desc1' }),
            } satisfies CreateAiAgentInput);
        - lang: python
          label: AIエージェントを作成
          source: |-
            client.ai_studio.create_ai_agent(
                agent_name,
                "enabled",
                ask=AiStudioAgentAsk(access_state="enabled", description="desc1"),
            )
components:
  schemas:
    CreateAiAgent:
      description: AIエージェント作成リクエストのスキーマ。
      type: object
      properties:
        type:
          description: クエリの処理に使用されるエージェントのタイプ。
          type: string
          example: ai_agent
          enum:
            - ai_agent
        name:
          description: AIエージェントの名前。
          type: string
          example: My AI Agent
        access_state:
          description: >-
            AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。
          type: string
          example: enabled
          title: アクセス状態
          x-box-tag: ai_studio
        icon_reference:
          description: >-
            AIエージェントのアイコン参照。これは、URL
            `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>`の形式で指定する必要があります。この場合、`file_name`に使用可能な値は`logo_boxAi.png`、`logo_stamp.png`、`logo_legal.png`、`logo_finance.png`、`logo_config.png`、`logo_handshake.png`、`logo_analytics.png`、`logo_classification.png`です。
          type: string
          example: >-
            https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg
          minLength: 1
        allowed_entities:
          description: 許可するユーザーまたはグループのリスト。
          type: array
          items:
            $ref: '#/components/schemas/AiAgentAllowedEntity'
        ask:
          $ref: '#/components/schemas/AiStudioAgentAsk'
        text_gen:
          $ref: '#/components/schemas/AiStudioAgentTextGen'
        extract:
          $ref: '#/components/schemas/AiStudioAgentExtract'
      required:
        - type
        - name
        - access_state
      title: AIエージェント作成リクエスト
      x-box-tag: ai_studio
    AiSingleAgentResponse--Full:
      description: AIエージェントインスタンスのFull版の表示。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiSingleAgentResponse'
        - properties:
            ask:
              $ref: '#/components/schemas/AiStudioAgentAskResponse'
            text_gen:
              $ref: '#/components/schemas/AiStudioAgentTextGenResponse'
            extract:
              $ref: '#/components/schemas/AiStudioAgentExtractResponse'
      required:
        - id
        - origin
        - name
        - access_state
      title: AIエージェント (Full)
      x-box-resource-id: ai_single_agent_response--full
      x-box-tag: ai_studio
      x-box-variant: full
      x-box-variants:
        - standard
        - full
    ClientError:
      description: 一般的なエラー。
      type: object
      properties:
        type:
          description: 値は常に`error`になります。
          type: string
          example: error
          enum:
            - error
          nullable: false
        status:
          description: レスポンスのHTTPステータス。
          type: integer
          format: int32
          example: 400
          nullable: false
        code:
          description: Box固有のエラーコード。
          type: string
          example: item_name_invalid
          enum:
            - created
            - accepted
            - no_content
            - redirect
            - not_modified
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - method_not_allowed
            - conflict
            - precondition_failed
            - too_many_requests
            - internal_server_error
            - unavailable
            - item_name_invalid
            - insufficient_scope
        message:
          description: エラーについての短い説明メッセージ。
          type: string
          example: Method Not Allowed
          nullable: false
        context_info:
          description: >-
            このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。`message`は唯一の例です。
          type: object
          example:
            message: Something went wrong
          additionalProperties: {}
          nullable: true
        help_url:
          description: このエラーの原因に関する詳細情報にリンクされたURL。
          type: string
          example: >-
            https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
          nullable: false
        request_id:
          description: Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。
          type: string
          example: abcdef123456
          nullable: false
      title: クライアントエラー
      x-box-resource-id: client_error
    AiAgentAllowedEntity:
      description: タイプとIDが指定されたエンティティ。
      type: object
      oneOf:
        - $ref: '#/components/schemas/User--Base'
        - $ref: '#/components/schemas/Group--Base'
      title: タイプとIDが指定されたエンティティ
      x-box-resource-id: ai_agent_allowed_entity
    AiStudioAgentAsk:
      description: クエリの処理に使用するAIエージェント。
      type: object
      properties:
        type:
          description: クエリの処理に使用されるAIエージェントのタイプ。
          type: string
          example: ai_agent_ask
          enum:
            - ai_agent_ask
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        suggested_questions:
          description: AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。
          type: array
          items:
            type: string
          example:
            - What is in this file?
            - What are the main highlights of this document?
          maxItems: 4
        long_text:
          $ref: '#/components/schemas/AiStudioAgentLongTextTool'
        basic_text:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
        basic_image:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
        spreadsheet:
          $ref: '#/components/schemas/AiStudioAgentSpreadsheetTool'
        long_text_multi:
          $ref: '#/components/schemas/AiStudioAgentLongTextTool'
        basic_text_multi:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
        basic_image_multi:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (質問リクエスト)
      x-box-resource-id: ai_studio_agent_ask
      x-box-tag: ai_studio
    AiStudioAgentTextGen:
      description: テキストの生成に使用するAIエージェント。
      type: object
      properties:
        type:
          description: テキストの生成に使用されるAIエージェントのタイプ。
          type: string
          example: ai_agent_text_gen
          enum:
            - ai_agent_text_gen
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        suggested_questions:
          description: AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。
          type: array
          items:
            type: string
          example:
            - What is in this file?
            - What are the main highlights of this document?
          maxItems: 4
        basic_gen:
          $ref: '#/components/schemas/AiStudioAgentBasicGenTool'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (テキスト生成リクエスト)
      x-box-resource-id: ai_studio_agent_text_gen
      x-box-tag: ai_studio
    AiStudioAgentExtract:
      description: メタデータ抽出に使用するAIエージェント。
      type: object
      properties:
        type:
          description: メタデータ抽出に使用するAIエージェントのタイプ。
          type: string
          example: ai_agent_extract
          enum:
            - ai_agent_extract
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        long_text:
          $ref: '#/components/schemas/AiStudioAgentLongTextTool'
        basic_text:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
        basic_image:
          $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (抽出リクエスト)
      x-box-resource-id: ai_studio_agent_extract
      x-box-tag: ai_studio
    AiSingleAgentResponse:
      description: AIエージェントインスタンスのStandard版の表示。
      type: object
      properties:
        id:
          description: AIエージェントの一意の識別子。
          type: string
          example: '1234567890'
        type:
          description: クエリの処理に使用されるエージェントのタイプ。
          type: string
          example: ai_agent
          enum:
            - ai_agent
        origin:
          description: AIエージェントのプロバイダ。
          type: string
          example: CUSTOM
        name:
          description: AIエージェントの名前。
          type: string
          example: This is my Agent
        access_state:
          description: >-
            AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。
          type: string
          example: enabled
          title: アクセス状態
          x-box-tag: ai_studio
        created_by:
          description: このエージェントを作成したユーザー。
          allOf:
            - $ref: '#/components/schemas/User--Base'
        created_at:
          description: このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。
          type: string
          format: date-time
          example: '2022-01-01T00:00:00Z'
        modified_by:
          description: このエージェントを直近で変更したユーザー。
          allOf:
            - $ref: '#/components/schemas/User--Base'
        modified_at:
          description: このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。
          type: string
          format: date-time
          example: '2022-01-01T00:00:00Z'
        icon_reference:
          description: AIエージェントのアイコン参照。
          type: string
          example: >-
            https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg
          minLength: 1
        allowed_entities:
          description: 許可するユーザーまたはグループのリスト。
          type: array
          items:
            $ref: '#/components/schemas/AiAgentAllowedEntity'
      required:
        - id
        - origin
        - name
        - access_state
      title: AIエージェント
      x-box-resource-id: ai_single_agent_response
      x-box-tag: ai_studio
      x-box-variant: standard
      x-box-variants:
        - standard
        - full
    AiStudioAgentAskResponse:
      description: 質問に使用するAIエージェント。
      type: object
      properties:
        type:
          description: 質問に使用されるAIエージェントのタイプ。
          type: string
          example: ai_agent_ask
          enum:
            - ai_agent_ask
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        suggested_questions:
          description: AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。
          type: array
          items:
            type: string
          example:
            - What is in this file?
            - What are the main highlights of this document?
          maxItems: 4
        long_text:
          $ref: '#/components/schemas/AiStudioAgentLongTextToolResponse'
        basic_text:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
        basic_image:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
        spreadsheet:
          $ref: '#/components/schemas/AiStudioAgentSpreadsheetToolResponse'
        long_text_multi:
          $ref: '#/components/schemas/AiStudioAgentLongTextToolResponse'
        basic_text_multi:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
        basic_image_multi:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (質問)
      x-box-resource-id: ai_studio_agent_ask_response
      x-box-tag: ai_studio
    AiStudioAgentTextGenResponse:
      description: テキストの生成に使用するAIエージェント。
      type: object
      properties:
        type:
          description: テキストの生成に使用されるAIエージェントのタイプ。
          type: string
          example: ai_agent_text_gen
          enum:
            - ai_agent_text_gen
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        suggested_questions:
          description: AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。
          type: array
          items:
            type: string
          example:
            - What is in this file?
            - What are the main highlights of this document?
          maxItems: 4
        basic_gen:
          $ref: '#/components/schemas/AiStudioAgentBasicGenToolResponse'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (テキスト生成)
      x-box-resource-id: ai_studio_agent_text_gen_response
      x-box-tag: ai_studio
    AiStudioAgentExtractResponse:
      description: メタデータ抽出に使用するAIエージェント。
      type: object
      properties:
        type:
          description: メタデータ抽出に使用するAIエージェントのタイプ。
          type: string
          example: ai_agent_extract
          enum:
            - ai_agent_extract
          nullable: false
        access_state:
          description: AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。
          type: string
          example: enabled
          title: 機能のアクセス状態
          x-box-tag: ai_studio
        description:
          description: AIエージェントの説明。
          type: string
          example: This is ASK Agent
        custom_instructions:
          description: AIエージェントに対するカスタム指示。
          type: string
          example: This is a custom instruction
          nullable: true
        long_text:
          $ref: '#/components/schemas/AiStudioAgentLongTextToolResponse'
        basic_text:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
        basic_image:
          $ref: '#/components/schemas/AiStudioAgentBasicTextToolResponse'
      required:
        - type
        - access_state
        - description
      title: AIエージェントの機能 (抽出)
      x-box-resource-id: ai_studio_agent_extract_response
      x-box-tag: ai_studio
    User--Base:
      description: 他のリソース内にネストされたときに使用されるユーザーのMini版の表示。
      type: object
      properties:
        id:
          description: このユーザーの一意の識別子。
          type: string
          example: '11446498'
        type:
          description: 値は常に`user`になります。
          type: string
          example: user
          enum:
            - user
          nullable: false
      required:
        - type
        - id
      title: ユーザー (Base)
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variant: base
      x-box-variants:
        - base
        - mini
        - standard
        - full
    Group--Base:
      description: グループのBase版の表示。
      type: object
      properties:
        id:
          description: このオブジェクトの一意の識別子。
          type: string
          example: '11446498'
        type:
          description: 値は常に`group`になります。
          type: string
          example: group
          enum:
            - group
      required:
        - id
        - type
      title: グループ (Base)
      x-box-resource-id: group--base
      x-box-tag: groups
      x-box-variant: base
      x-box-variants:
        - base
        - mini
        - standard
        - full
    AiStudioAgentLongTextTool:
      description: 長いテキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentLongTextTool'
        - properties:
            is_custom_instructions_included:
              description: システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。
              type: boolean
              example: false
      title: AIエージェントの長いテキストツールのリクエスト
      x-box-tag: ai
    AiStudioAgentBasicTextTool:
      description: 基本テキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicTextTool'
        - properties:
            is_custom_instructions_included:
              description: システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。
              type: boolean
              example: false
      title: AIエージェントの基本テキストツールのリクエスト
      x-box-tag: ai
    AiStudioAgentSpreadsheetTool:
      description: スプレッドシートや表形式データの処理に使用されるAIエージェントツール。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentSpreadsheetTool'
        - properties: {}
      title: AIエージェントのスプレッドシートツール
      x-box-tag: ai
    AiStudioAgentBasicGenTool:
      description: テキストの生成に使用されるAIエージェントの基本ツール。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicGenTool'
        - properties:
            is_custom_instructions_included:
              description: システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。
              type: boolean
              example: false
      title: AIエージェントの基本テキスト生成ツールのリクエスト
      x-box-tag: ai
    AiStudioAgentLongTextToolResponse:
      description: 長いテキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiStudioAgentLongTextTool'
        - properties:
            warnings:
              description: ツールに関する警告。
              type: array
              items:
                type: string
              example:
                - MODEL_INACTIVE
      title: AIエージェントの長いテキストツール
      x-box-tag: ai
    AiStudioAgentBasicTextToolResponse:
      description: 基本テキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiStudioAgentBasicTextTool'
        - properties:
            warnings:
              description: ツールに関する警告。
              type: array
              items:
                type: string
              example:
                - MODEL_INACTIVE
      title: AIエージェントの基本テキストツール
      x-box-tag: ai
    AiStudioAgentSpreadsheetToolResponse:
      description: スプレッドシートや表形式データの処理に使用されるAIエージェントツール。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiStudioAgentSpreadsheetTool'
        - properties:
            warnings:
              description: ツールに関する警告。
              type: array
              items:
                type: string
              example:
                - MODEL_INACTIVE
      title: AIエージェントのスプレッドシートツール
      x-box-tag: ai
    AiStudioAgentBasicGenToolResponse:
      description: テキストの生成に使用されるAIエージェントの基本ツール。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiStudioAgentBasicGenTool'
        - properties:
            warnings:
              description: ツールに関する警告。
              type: array
              items:
                type: string
              example:
                - MODEL_INACTIVE
      title: AIエージェントの基本テキスト生成ツール
      x-box-tag: ai
    AiAgentLongTextTool:
      description: 長いテキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicTextTool'
        - properties:
            embeddings:
              type: object
              properties:
                model:
                  description: 埋め込みを計算するためのAIエージェントに使用されるモデル。
                  type: string
                  example: azure__openai__text_embedding_ada_002
                strategy:
                  type: object
                  properties:
                    id:
                      description: 埋め込みを計算するためのAIエージェントに使用される戦略。
                      type: string
                      example: basic
                    num_tokens_per_chunk:
                      description: チャンクごとのトークンの数。
                      type: integer
                      example: 64
                      maximum: 512
                      minimum: 1
      title: AIエージェントの長いテキストツール
      x-box-tag: ai
    AiAgentBasicTextTool:
      description: 基本テキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicTextToolBase'
        - properties:
            system_message:
              description: LLMが、その役割と実行するべき内容を「理解」するのを支援するためのシステムメッセージ。
              type: string
              example: You are a helpful travel assistant specialized in budget travel
            prompt_template:
              description: >-
                プロンプトテンプレートには、リクエストのコンテキスト情報とユーザープロンプトが含まれます。`prompt_template`パラメータを渡す場合、`{user_question}`および`{content}`の入力を**含める必要があります**。`{current_date}`は、用途に応じて省略できます。
              type: string
              example: >-
                It is `{current_date}`, consider these travel options
                `{content}` and answer the `{user_question}`.
              maxLength: 10000
              pattern: >-
                (\{user_question\}[\s\S]*?\{content\}|\{content\}[\s\S]*?\{user_question\})
      title: AIエージェントの基本テキストツール
      x-box-tag: ai
    AiAgentSpreadsheetTool:
      description: スプレッドシートや表形式データの処理に使用されるAIエージェントツール。
      type: object
      properties:
        model:
          description: >-
            スプレッドシートに対するAIエージェントで使用されるモデル。特定のモデル値については、[利用可能なモデルのリスト](/guides/box-ai/ai-models)を参照してください。
          type: string
          example: azure__openai__gpt_4o_mini
        num_tokens_for_completion:
          description: 完了に必要なトークンの数。
          type: integer
          example: 8400
          minimum: 1
        llm_endpoint_params:
          $ref: '#/components/schemas/AiLlmEndpointParams'
      title: AIエージェントのスプレッドシートツール
      x-box-tag: ai
    AiAgentBasicGenTool:
      description: テキストの生成に使用されるAIエージェントの基本ツール。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentLongTextToolTextGen'
        - properties:
            content_template:
              description: LLMへのリクエストにコンテンツを含める方法。`{content}`の入力は、用途に応じて省略できます。
              type: string
              example: '---{content}---'
      title: AIエージェントの基本テキスト生成ツール
      x-box-tag: ai
    AiAgentBasicTextToolBase:
      description: 基本テキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      properties:
        model:
          description: >-
            基本テキストに対するAIエージェントで使用されるモデル。特定のモデル値については、[利用可能なモデルのリスト](/guides/box-ai/ai-models)を参照してください。
          type: string
          example: azure__openai__gpt_4o_mini
        num_tokens_for_completion:
          description: 完了に必要なトークンの数。
          type: integer
          example: 8400
          minimum: 1
        llm_endpoint_params:
          $ref: '#/components/schemas/AiLlmEndpointParams'
      title: AIエージェントの基本テキストツール
      x-box-tag: ai
    AiLlmEndpointParams:
      description: モデル固有のLLMエンドポイントのパラメータ。
      type: object
      oneOf:
        - $ref: '#/components/schemas/AiLlmEndpointParamsOpenAi'
        - $ref: '#/components/schemas/AiLlmEndpointParamsGoogle'
        - $ref: '#/components/schemas/AiLlmEndpointParamsAWS'
        - $ref: '#/components/schemas/AiLlmEndpointParamsIBM'
      title: AI LLMエンドポイントパラメータ
    AiAgentLongTextToolTextGen:
      description: 長いテキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicTextToolTextGen'
        - properties:
            embeddings:
              type: object
              properties:
                model:
                  description: 埋め込みを計算するためのAIエージェントに使用されるモデル。
                  type: string
                  example: azure__openai__text_embedding_ada_002
                strategy:
                  type: object
                  properties:
                    id:
                      description: 埋め込みを計算するためのAIエージェントに使用される戦略。
                      type: string
                      example: basic
                    num_tokens_per_chunk:
                      description: チャンクごとのトークンの数。
                      type: integer
                      example: 64
                      maximum: 512
                      minimum: 1
      title: AIエージェントの長いテキストツール
      x-box-tag: ai
    AiLlmEndpointParamsOpenAi:
      description: AI LLMエンドポイントパラメータ (OpenAI) オブジェクト。
      type: object
      properties:
        type:
          description: OpenAI用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。
          type: string
          example: openai_params
          enum:
            - openai_params
          nullable: false
        temperature:
          description: >-
            使用するサンプリングtemperature
            (0～2の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 0
          maximum: 2
          minimum: 0
          nullable: true
        top_p:
          description: >-
            temperatureによるサンプリングの代替手段
            (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 1
          maximum: 1
          minimum: 0.1
          nullable: true
        frequency_penalty:
          description: >-
            \-2.0から2.0までの数値。正の値の場合は、新しいトークンがこれまでにテキストに出現した回数に基づいてそのトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を低減させます。
          type: number
          example: 1.5
          maximum: 2
          minimum: -2
          nullable: true
        presence_penalty:
          description: >-
            \-2.0から2.0までの数値。正の値の場合は、新しいトークンがこれまでにテキストに出現したかどうかに基づいてそのトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を引き上げます。
          type: number
          example: 1.5
          maximum: 2
          minimum: -2
          nullable: true
        stop:
          description: APIがトークンをそれ以上生成するのを停止する、最大4つのシーケンス。
          type: string
          example: <|im_end|>
          nullable: true
      required:
        - type
      title: AI LLMエンドポイントパラメータ (OpenAI)
      x-box-resource-id: ai_llm_endpoint_params_openai
    AiLlmEndpointParamsGoogle:
      description: AI LLMエンドポイントパラメータ (Google) オブジェクト。
      type: object
      properties:
        type:
          description: Google用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。
          type: string
          example: google_params
          enum:
            - google_params
          nullable: false
        temperature:
          description: >-
            temperatureはレスポンス生成時のサンプリングに使用されます。レスポンス生成は`top-P`と`top-K`が適用された場合に発生します。temperatureは、トークン選択におけるランダム性の程度を制御します。
          type: number
          example: 0
          maximum: 2
          minimum: 0
          nullable: true
        top_p:
          description: >-
            `Top-P`では、モデルが出力用にトークンを選択する方法を変更します。トークンは、確率の合計が`top-P`値に等しくなるまで、確率の高いもの
            (`top-K`を参照) から低いものへと選択されます。
          type: number
          example: 1
          maximum: 2
          minimum: 0.1
          nullable: true
        top_k:
          description: >-
            `Top-K`では、モデルが出力用にトークンを選択する方法を変更します。`top-K`が小さい場合、次に選択されるトークンは、モデルの語彙に含まれるすべてのトークンの中で最も確率の高いものであることになります
            (グリーディデコードとも呼ばれます)。`top-K`が大きい場合は、temperatureを使用して、最も確率が高い上位3つのトークンから次のトークンが選択されることになります。
          type: number
          example: 1
          maximum: 2
          minimum: 0.1
          nullable: true
      required:
        - type
      title: AI LLMエンドポイントパラメータ (Google)
      x-box-resource-id: ai_llm_endpoint_params_google
    AiLlmEndpointParamsAWS:
      description: AI LLMエンドポイントパラメータ (AWS) オブジェクト。
      type: object
      properties:
        type:
          description: AWS用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。
          type: string
          example: aws_params
          enum:
            - aws_params
          nullable: false
        temperature:
          description: >-
            使用するサンプリングtemperature
            (0～1の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 0.5
          maximum: 1
          minimum: 0
          nullable: true
        top_p:
          description: >-
            temperatureによるサンプリングの代替手段
            (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 0.5
          maximum: 1
          minimum: 0
          nullable: true
      required:
        - type
      title: AI LLMエンドポイントパラメータ (AWS)
      x-box-resource-id: ai_llm_endpoint_params_aws
    AiLlmEndpointParamsIBM:
      description: AI LLMエンドポイントパラメータ (IBM) オブジェクト。
      type: object
      properties:
        type:
          description: IBM用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。
          type: string
          example: ibm_params
          enum:
            - ibm_params
          nullable: false
        temperature:
          description: >-
            使用するサンプリングtemperature
            (0～1の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 0.5
          nullable: true
        top_p:
          description: >-
            temperatureによるサンプリングの代替手段
            (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。
          type: number
          example: 0.5
          maximum: 1
          minimum: 0.1
          nullable: true
        top_k:
          description: >-
            `Top-K`では、モデルが出力用にトークンを選択する方法を変更します。`top-K`が小さい場合、次に選択されるトークンは、モデルの語彙に含まれるすべてのトークンの中で最も確率の高いものであることになります
            (グリーディデコードとも呼ばれます)。`top-K`が大きい場合は、temperatureを使用して、最も確率が高い上位3つのトークンから次のトークンが選択されることになります。
          type: number
          example: 1
          nullable: true
      required:
        - type
      title: AI LLMエンドポイントパラメータ (IBM)
      x-box-resource-id: ai_llm_endpoint_params_ibm
    AiAgentBasicTextToolTextGen:
      description: 基本テキストの処理に使用されるAIエージェントプロセッサ。
      type: object
      allOf:
        - $ref: '#/components/schemas/AiAgentBasicTextToolBase'
        - properties:
            system_message:
              description: >-
                LLMが、その役割と実行するべき内容を理解するのを支援することを目的としたシステムメッセージ。`{current_date}`の入力は、用途に応じて省略できます。
              type: string
              example: You are a helpful travel assistant specialized in budget travel
            prompt_template:
              description: >-
                プロンプトテンプレートには、リクエストのコンテキスト情報とユーザープロンプトが含まれます。


                `prompt_template`パラメータを使用する場合、`{user_question}`の入力を**含める必要があります**。`{current_date}`と`{content}`の入力は、用途に応じて省略できます。
              type: string
              example: >-
                It is `{current_date}`, and I have $8000 and want to spend a
                week in the Azores. `{user_question}`
              maxLength: 10000
              pattern: \{user_question\}
      title: AIエージェントの基本テキストツール
      x-box-tag: ai
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: >-
        The access token received from the authorization server in the OAuth 2.0
        flow.
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Boxに格納されているすべてのファイルとフォルダの読み取り
            root_readwrite: Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み
            manage_app_users: App Userのプロビジョニングと管理
            manage_managed_users: 管理対象ユーザーのプロビジョニングと管理
            manage_groups: 企業のグループの管理
            manage_webhook: APIを使用したプログラムによるWebhookの作成
            manage_enterprise_properties: Enterpriseのプロパティを管理
            manage_data_retention: データリテンションポリシーの管理
            manage_legal_hold: リーガルホールドの管理

````