ナレッジベース（新版）

ナレッジベースを作成

POST /api/knowledge-bases/

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
embeddingModel	string (uuid)	必須
rerankerModel	string (uuid)	必須
name	string	必須
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. If not provided, uses system default.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. If not provided, uses system default. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを作成

POST /api/v1/knowledge-bases/

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
embeddingModel	string (uuid)	必須
rerankerModel	string (uuid)	必須
name	string	必須
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. If not provided, uses system default.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. If not provided, uses system default. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

すべてのナレッジベースを一覧表示

GET /api/knowledge-bases/

パラメータ

パラメータ名	必須	タイプ	説明
embeddingModel	❌	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string
rerankerModel	❌	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/?embeddingModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&rerankerModel=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "createdBy"?: string (uuid) // 任意
      "organization"?: string (uuid) // 任意
      "embeddingModel": string (uuid)
      "rerankerModel": string (uuid)
      "name": string
      "description"?: string // 任意
      "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
      "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
      "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
      "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
      "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
      "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
      "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
      {
      }
      "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
      "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
      "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
      "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
      "oracleUser"?: string // Oracle database username. (任意)
      "oraclePassword"?: string // Oracle database password. (任意)
      "labels": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "chatbots"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
      "vectorStorageSize": integer
      "chunksCount": integer
      "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
      "canUpdate": boolean // Return whether the current user can update this resource.
      "canDelete": boolean // Return whether the current user can delete this resource.
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdBy": "550e8400-e29b-41d4-a716-446655440000",
      "organization": "550e8400-e29b-41d4-a716-446655440000",
      "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
      "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列",
      "numberOfRetrievedChunks": 456,
      "sentenceWindowSize": 456,
      "enableHyde": false,
      "similarityCutoff": 456,
      "enableRerank": false,
      "enableRrf": false,
      "vectorDatabaseType": {},
      "vectorDatabaseUrl": "レスポンス文字列",
      "vectorDatabaseApiKey": "レスポンス文字列",
      "opensearchUsername": "レスポンス文字列",
      "opensearchPassword": "レスポンス文字列",
      "oracleUser": "レスポンス文字列",
      "oraclePassword": "レスポンス文字列",
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "chatbots": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "filesCount": 456,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "isMultimodal": false,
      "canUpdate": false,
      "canDelete": false,
      "createdAt": "レスポンス文字列",
      "updatedAt": "レスポンス文字列"
    }
  ]
}

---

すべてのナレッジベースを一覧表示

GET /api/v1/knowledge-bases/

パラメータ

パラメータ名	必須	タイプ	説明
embeddingModel	❌	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string
rerankerModel	❌	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/?embeddingModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&rerankerModel=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "createdBy"?: string (uuid) // 任意
      "organization"?: string (uuid) // 任意
      "embeddingModel": string (uuid)
      "rerankerModel": string (uuid)
      "name": string
      "description"?: string // 任意
      "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
      "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
      "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
      "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
      "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
      "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
      "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
      {
      }
      "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
      "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
      "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
      "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
      "oracleUser"?: string // Oracle database username. (任意)
      "oraclePassword"?: string // Oracle database password. (任意)
      "labels": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "chatbots"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
      "vectorStorageSize": integer
      "chunksCount": integer
      "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
      "canUpdate": boolean // Return whether the current user can update this resource.
      "canDelete": boolean // Return whether the current user can delete this resource.
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdBy": "550e8400-e29b-41d4-a716-446655440000",
      "organization": "550e8400-e29b-41d4-a716-446655440000",
      "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
      "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列",
      "numberOfRetrievedChunks": 456,
      "sentenceWindowSize": 456,
      "enableHyde": false,
      "similarityCutoff": 456,
      "enableRerank": false,
      "enableRrf": false,
      "vectorDatabaseType": {},
      "vectorDatabaseUrl": "レスポンス文字列",
      "vectorDatabaseApiKey": "レスポンス文字列",
      "opensearchUsername": "レスポンス文字列",
      "opensearchPassword": "レスポンス文字列",
      "oracleUser": "レスポンス文字列",
      "oraclePassword": "レスポンス文字列",
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "chatbots": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "filesCount": 456,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "isMultimodal": false,
      "canUpdate": false,
      "canDelete": false,
      "createdAt": "レスポンス文字列",
      "updatedAt": "レスポンス文字列"
    }
  ]
}

---

特定のナレッジベースの詳細を取得

GET /api/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

特定のナレッジベースの詳細を取得

GET /api/v1/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを更新

PUT /api/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
createdBy	string (uuid)	任意
organization	string (uuid)	任意
embeddingModel	string (uuid)	必須
rerankerModel	string (uuid)	必須
name	string	必須
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意	ナレッジベースにアクセスできるグループの一覧
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createdBy": "550e8400-e29b-41d4-a716-446655440000",
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを更新

PUT /api/v1/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
createdBy	string (uuid)	任意
organization	string (uuid)	任意
embeddingModel	string (uuid)	必須
rerankerModel	string (uuid)	必須
name	string	必須
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意	ナレッジベースにアクセスできるグループの一覧
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createdBy": "550e8400-e29b-41d4-a716-446655440000",
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを部分更新

PATCH /api/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
createdBy	string (uuid)	任意
organization	string (uuid)	任意
embeddingModel	string (uuid)	任意
rerankerModel	string (uuid)	任意
name	string	任意
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意	ナレッジベースにアクセスできるグループの一覧
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel"?: string (uuid) // 任意
  "rerankerModel"?: string (uuid) // 任意
  "name"?: string // 任意
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createdBy": "550e8400-e29b-41d4-a716-446655440000",
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを部分更新

PATCH /api/v1/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
createdBy	string (uuid)	任意
organization	string (uuid)	任意
embeddingModel	string (uuid)	任意
rerankerModel	string (uuid)	任意
name	string	任意
description	string	任意
numberOfRetrievedChunks	integer	任意	取得する参照データの件数。デフォルトは 12、最小値は 1
sentenceWindowSize	integer	任意	RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0
enableHyde	boolean	任意	HyDE を有効にする。デフォルトは False
similarityCutoff	number (double)	任意	類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0
enableRerank	boolean	任意	再ランク付けを有効にするかどうか。デフォルトは True
enableRrf	boolean	任意	Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType	object	任意	Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai;
vectorDatabaseUrl	string	任意	Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey	string	任意	API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername	string	任意	Username for OpenSearch Basic Auth.
opensearchPassword	string	任意	Password for OpenSearch Basic Auth.
oracleUser	string	任意	Oracle database username.
oraclePassword	string	任意	Oracle database password.
chatbots	array[IdName]	任意
groups	array[IdName]	任意	ナレッジベースにアクセスできるグループの一覧
isMultimodal	boolean	任意	Whether this knowledge base supports multimodal embeddings (text + images).

リクエスト構造サンプル

{
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel"?: string (uuid) // 任意
  "rerankerModel"?: string (uuid) // 任意
  "name"?: string // 任意
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
    }
  ]
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
}

リクエストのサンプル値

{
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "サンプル名称",
  "description": "サンプル文字列",
  "numberOfRetrievedChunks": 123,
  "sentenceWindowSize": 123,
  "enableHyde": true,
  "similarityCutoff": 123,
  "enableRerank": true,
  "enableRrf": true,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "サンプル文字列",
  "vectorDatabaseApiKey": "サンプル文字列",
  "opensearchUsername": "サンプル文字列",
  "opensearchPassword": "サンプル文字列",
  "oracleUser": "サンプル文字列",
  "oraclePassword": "サンプル文字列",
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "isMultimodal": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "createdBy": "550e8400-e29b-41d4-a716-446655440000",
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "name": "サンプル名称",
    "description": "サンプル文字列",
    "numberOfRetrievedChunks": 123,
    "sentenceWindowSize": 123,
    "enableHyde": true,
    "similarityCutoff": 123,
    "enableRerank": true,
    "enableRrf": true,
    "vectorDatabaseType": {},
    "vectorDatabaseUrl": "サンプル文字列",
    "vectorDatabaseApiKey": "サンプル文字列",
    "opensearchUsername": "サンプル文字列",
    "opensearchPassword": "サンプル文字列",
    "oracleUser": "サンプル文字列",
    "oraclePassword": "サンプル文字列",
    "chatbots": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "isMultimodal": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースを削除

DELETE /api/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ナレッジベースを削除

DELETE /api/v1/knowledge-bases/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

RRF の利用可否を確認

GET /api/knowledge-bases/{id}/check-rrf-availability/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/check-rrf-availability/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

RRF の利用可否を確認

GET /api/v1/knowledge-bases/{id}/check-rrf-availability/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/check-rrf-availability/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "createdBy"?: string (uuid) // 任意
  "organization"?: string (uuid) // 任意
  "embeddingModel": string (uuid)
  "rerankerModel": string (uuid)
  "name": string
  "description"?: string // 任意
  "numberOfRetrievedChunks"?: integer // 取得する参照データの件数。デフォルトは 12、最小値は 1 (任意)
  "sentenceWindowSize"?: integer // RAG の拡張センテンスウィンドウサイズ。デフォルトは 2、最小値は 0 (任意)
  "enableHyde"?: boolean // HyDE を有効にする。デフォルトは False (任意)
  "similarityCutoff"?: number (double) // 類似度のしきい値。デフォルトは 0.0、範囲は 0.0〜1.0 (任意)
  "enableRerank"?: boolean // 再ランク付けを有効にするかどうか。デフォルトは True (任意)
  "enableRrf"?: boolean // Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. (任意)
  "vectorDatabaseType"?:  // Type of vector database: elasticsearch or opensearch.

* `elasticsearch` - Elasticsearch
* `opensearch` - OpenSearch
* `oracle` - Oracle AI Database 26ai (任意)
  {
  }
  "vectorDatabaseUrl"?: string // Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name"). (任意)
  "vectorDatabaseApiKey"?: string // API Key for Elasticsearch. Not used for OpenSearch. (任意)
  "opensearchUsername"?: string // Username for OpenSearch Basic Auth. (任意)
  "opensearchPassword"?: string // Password for OpenSearch Basic Auth. (任意)
  "oracleUser"?: string // Oracle database username. (任意)
  "oraclePassword"?: string // Oracle database password. (任意)
  "labels": [
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "chatbots"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "groups"?: [ // ナレッジベースにアクセスできるグループの一覧 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "filesCount": integer // Return count of KnowledgeBaseFile excluding processed files, conversation attachments, and soft-deleted.
  "vectorStorageSize": integer
  "chunksCount": integer
  "isMultimodal"?: boolean // Whether this knowledge base supports multimodal embeddings (text + images). (任意)
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdBy": "550e8400-e29b-41d4-a716-446655440000",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "description": "レスポンス文字列",
  "numberOfRetrievedChunks": 456,
  "sentenceWindowSize": 456,
  "enableHyde": false,
  "similarityCutoff": 456,
  "enableRerank": false,
  "enableRrf": false,
  "vectorDatabaseType": {},
  "vectorDatabaseUrl": "レスポンス文字列",
  "vectorDatabaseApiKey": "レスポンス文字列",
  "opensearchUsername": "レスポンス文字列",
  "opensearchPassword": "レスポンス文字列",
  "oracleUser": "レスポンス文字列",
  "oraclePassword": "レスポンス文字列",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "chatbots": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "filesCount": 456,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "isMultimodal": false,
  "canUpdate": false,
  "canDelete": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ラベルの Excel をエクスポート

GET /api/knowledge-bases/{id}/export-labels-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/export-labels-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
200	Excel file download

---

ラベルの Excel をエクスポート

GET /api/v1/knowledge-bases/{id}/export-labels-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/export-labels-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
200	Excel file download

---

ラベルの Excel をインポート

POST /api/knowledge-bases/{id}/import-labels-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/import-labels-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -F "excelFile=@example_file.txt"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "success"?: boolean // 任意
  "updated_count"?: integer // 任意
  "total_rows"?: integer // 任意
  "errors"?: [ // 任意
    {
      "row"?: integer // 任意
      "file_id"?: string // 任意
      "error"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "success": false,
  "updated_count": 456,
  "total_rows": 456,
  "errors": [
    {
      "row": 456,
      "file_id": "レスポンス文字列",
      "error": "レスポンス文字列"
    }
  ]
}

---

ラベルの Excel をインポート

POST /api/v1/knowledge-bases/{id}/import-labels-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/import-labels-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -F "excelFile=@example_file.txt"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "success"?: boolean // 任意
  "updated_count"?: integer // 任意
  "total_rows"?: integer // 任意
  "errors"?: [ // 任意
    {
      "row"?: integer // 任意
      "file_id"?: string // 任意
      "error"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "success": false,
  "updated_count": 456,
  "total_rows": 456,
  "errors": [
    {
      "row": 456,
      "file_id": "レスポンス文字列",
      "error": "レスポンス文字列"
    }
  ]
}

---

メタデータの Excel をエクスポート

GET /api/knowledge-bases/{id}/export-metadata-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/export-metadata-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
200	Excel ファイルのダウンロード

---

メタデータの Excel をエクスポート

GET /api/v1/knowledge-bases/{id}/export-metadata-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/export-metadata-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
200	Excel ファイルのダウンロード

---

メタデータの Excel をインポート

POST /api/knowledge-bases/{id}/import-metadata-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/import-metadata-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -F "excelFile=@example_file.txt"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "success"?: boolean // 任意
  "updated_count"?: integer // 任意
  "total_rows"?: integer // 任意
  "errors"?: [ // 任意
    {
      "row"?: integer // 任意
      "file_id"?: string // 任意
      "error"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "success": false,
  "updated_count": 456,
  "total_rows": 456,
  "errors": [
    {
      "row": 456,
      "file_id": "レスポンス文字列",
      "error": "レスポンス文字列"
    }
  ]
}

---

メタデータの Excel をインポート

POST /api/v1/knowledge-bases/{id}/import-metadata-excel/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/import-metadata-excel/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -F "excelFile=@example_file.txt"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "success"?: boolean // 任意
  "updated_count"?: integer // 任意
  "total_rows"?: integer // 任意
  "errors"?: [ // 任意
    {
      "row"?: integer // 任意
      "file_id"?: string // 任意
      "error"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "success": false,
  "updated_count": 456,
  "total_rows": 456,
  "errors": [
    {
      "row": 456,
      "file_id": "レスポンス文字列",
      "error": "レスポンス文字列"
    }
  ]
}

---

新しいラベルを作成

POST /api/knowledge-bases/{knowledgeBasePk}/labels/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	必須

リクエスト構造サンプル

{
  "name": string
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

新しいラベルを作成

POST /api/v1/knowledge-bases/{knowledgeBasePk}/labels/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	必須

リクエスト構造サンプル

{
  "name": string
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ナレッジベース内のラベルを一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/labels/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/?page=1&pageSize=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "name"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ]
}

---

ナレッジベース内のラベルを一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/labels/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/?page=1&pageSize=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "name"?: string // 任意
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ]
}

---

特定のラベルの詳細を取得

GET /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

特定のラベルの詳細を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ラベルを更新

PUT /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	必須

リクエスト構造サンプル

{
  "name": string
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ラベルを更新

PUT /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	必須

リクエスト構造サンプル

{
  "name": string
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ラベルを部分更新

PATCH /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	任意

リクエスト構造サンプル

{
  "name"?: string // 任意
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ラベルを部分更新

PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
name	string	任意

リクエスト構造サンプル

{
  "name"?: string // 任意
}

リクエストのサンプル値

{
  "name": "サンプル名称"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名称"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "name"?: string // 任意
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列"
}

---

ラベルを削除

DELETE /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ラベルを削除

DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this knowledge base label.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

メタデータ項目を作成

POST /api/knowledge-bases/{knowledgeBasePk}/metadata-keys/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
keyName	string	必須	Metadata の key 名
description	string	任意	この項目の用途の説明
isRequired	boolean	任意	必須項目かどうか
defaultValue	string	任意	新規ファイルのデフォルト値
enabledForSearch	boolean	任意	検索時にこの項目を使用するかどうか

リクエスト構造サンプル

{
  "keyName": string // Metadata の key 名
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
}

リクエストのサンプル値

{
  "keyName": "サンプル文字列",
  "description": "サンプル文字列",
  "isRequired": true,
  "defaultValue": "サンプル文字列",
  "enabledForSearch": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyName": "サンプル文字列",
    "description": "サンプル文字列",
    "isRequired": true,
    "defaultValue": "サンプル文字列",
    "enabledForSearch": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

メタデータ項目を作成

POST /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
keyName	string	必須	Metadata の key 名
description	string	任意	この項目の用途の説明
isRequired	boolean	任意	必須項目かどうか
defaultValue	string	任意	新規ファイルのデフォルト値
enabledForSearch	boolean	任意	検索時にこの項目を使用するかどうか

リクエスト構造サンプル

{
  "keyName": string // Metadata の key 名
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
}

リクエストのサンプル値

{
  "keyName": "サンプル文字列",
  "description": "サンプル文字列",
  "isRequired": true,
  "defaultValue": "サンプル文字列",
  "enabledForSearch": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyName": "サンプル文字列",
    "description": "サンプル文字列",
    "isRequired": true,
    "defaultValue": "サンプル文字列",
    "enabledForSearch": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

メタデータ項目を一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/metadata-keys/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/?page=1&pageSize=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "knowledgeBase": 
      {
        "id": string (uuid)
        "name": string
      }
      "keyName": string // Metadata の key 名
      "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
      "description"?: string // この項目の用途の説明 (任意)
      "isRequired"?: boolean // 必須項目かどうか (任意)
      "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
      "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "keyName": "レスポンス文字列",
      "keyType": "レスポンス文字列",
      "description": "レスポンス文字列",
      "isRequired": false,
      "defaultValue": "レスポンス文字列",
      "enabledForSearch": false,
      "createdAt": "レスポンス文字列",
      "updatedAt": "レスポンス文字列"
    }
  ]
}

---

メタデータ項目を一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/?page=1&pageSize=1" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "knowledgeBase": 
      {
        "id": string (uuid)
        "name": string
      }
      "keyName": string // Metadata の key 名
      "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
      "description"?: string // この項目の用途の説明 (任意)
      "isRequired"?: boolean // 必須項目かどうか (任意)
      "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
      "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
      "createdAt": string (timestamp)
      "updatedAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "keyName": "レスポンス文字列",
      "keyType": "レスポンス文字列",
      "description": "レスポンス文字列",
      "isRequired": false,
      "defaultValue": "レスポンス文字列",
      "enabledForSearch": false,
      "createdAt": "レスポンス文字列",
      "updatedAt": "レスポンス文字列"
    }
  ]
}

---

特定のメタデータ項目を取得

GET /api/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Metadata Key.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

特定のメタデータ項目を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Metadata Key.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

メタデータ項目を更新

PUT /api/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Metadata Key.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
keyName	string	必須	Metadata の key 名
description	string	任意	この項目の用途の説明
isRequired	boolean	任意	必須項目かどうか
defaultValue	string	任意	新規ファイルのデフォルト値
enabledForSearch	boolean	任意	検索時にこの項目を使用するかどうか

リクエスト構造サンプル

{
  "keyName": string // Metadata の key 名
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
}

リクエストのサンプル値

{
  "keyName": "サンプル文字列",
  "description": "サンプル文字列",
  "isRequired": true,
  "defaultValue": "サンプル文字列",
  "enabledForSearch": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyName": "サンプル文字列",
    "description": "サンプル文字列",
    "isRequired": true,
    "defaultValue": "サンプル文字列",
    "enabledForSearch": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

メタデータ項目を更新

PUT /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Metadata Key.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
keyName	string	必須	Metadata の key 名
description	string	任意	この項目の用途の説明
isRequired	boolean	任意	必須項目かどうか
defaultValue	string	任意	新規ファイルのデフォルト値
enabledForSearch	boolean	任意	検索時にこの項目を使用するかどうか

リクエスト構造サンプル

{
  "keyName": string // Metadata の key 名
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
}

リクエストのサンプル値

{
  "keyName": "サンプル文字列",
  "description": "サンプル文字列",
  "isRequired": true,
  "defaultValue": "サンプル文字列",
  "enabledForSearch": true
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/metadata-keys/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyName": "サンプル文字列",
    "description": "サンプル文字列",
    "isRequired": true,
    "defaultValue": "サンプル文字列",
    "enabledForSearch": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "knowledgeBase": 
  {
    "id": string (uuid)
    "name": string
  }
  "keyName": string // Metadata の key 名
  "keyType": string // 項目名に基づいて自動判定（デフォルト項目またはカスタム項目）
  "description"?: string // この項目の用途の説明 (任意)
  "isRequired"?: boolean // 必須項目かどうか (任意)
  "defaultValue"?: string // 新規ファイルのデフォルト値 (任意)
  "enabledForSearch"?: boolean // 検索時にこの項目を使用するかどうか (任意)
  "createdAt": string (timestamp)
  "updatedAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "keyName": "レスポンス文字列",
  "keyType": "レスポンス文字列",
  "description": "レスポンス文字列",
  "isRequired": false,
  "defaultValue": "レスポンス文字列",
  "enabledForSearch": false,
  "createdAt": "レスポンス文字列",
  "updatedAt": "レスポンス文字列"
}

---

ナレッジベースにファイルをアップロード

POST /api/knowledge-bases/{knowledgeBasePk}/files/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
files	array[KnowledgeBaseFileCreate]	必須	複数ファイルの一括アップロードに対応しています。1 回あたり最大 50 ファイルまでです

リクエスト構造サンプル

{
  "files": [ // 複数ファイルの一括アップロードに対応しています。1 回あたり最大 50 ファイルまでです
    {
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "parser"?: string (uuid) // 任意
      "labels"?: [ // 任意
        {
          "id": string (uuid)
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
    }
  ]
}

リクエストのサンプル値

{
  "files": [
    {
      "filename": "my-file.pdf",
      "file": "string",
      "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "labels": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "my-label"
        }
      ],
      "rawUserDefineMetadata": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    {
      "filename": "you-can-upload-multiple-files.pdf",
      "file": "string",
      "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "filename": "my-file.pdf",
        "file": "string",
        "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "labels": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "my-label"
          }
        ],
        "rawUserDefineMetadata": {
          "key1": "value1",
          "key2": "value2"
        }
      },
      {
        "filename": "you-can-upload-multiple-files.pdf",
        "file": "string",
        "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

ナレッジベースにファイルをアップロード

POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
files	array[KnowledgeBaseFileCreate]	必須	複数ファイルの一括アップロードに対応しています。1 回あたり最大 50 ファイルまでです

リクエスト構造サンプル

{
  "files": [ // 複数ファイルの一括アップロードに対応しています。1 回あたり最大 50 ファイルまでです
    {
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "parser"?: string (uuid) // 任意
      "labels"?: [ // 任意
        {
          "id": string (uuid)
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
    }
  ]
}

リクエストのサンプル値

{
  "files": [
    {
      "filename": "my-file.pdf",
      "file": "string",
      "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "labels": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "my-label"
        }
      ],
      "rawUserDefineMetadata": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    {
      "filename": "you-can-upload-multiple-files.pdf",
      "file": "string",
      "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "filename": "my-file.pdf",
        "file": "string",
        "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "labels": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "my-label"
          }
        ],
        "rawUserDefineMetadata": {
          "key1": "value1",
          "key2": "value2"
        }
      },
      {
        "filename": "you-can-upload-multiple-files.pdf",
        "file": "string",
        "parser": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

ファイルを一括削除

POST /api/knowledge-bases/{knowledgeBasePk}/files/batch-delete/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
ids	array[string]	必須

リクエスト構造サンプル

{
  "ids": [
    string (uuid)
  ]
}

リクエストのサンプル値

{
  "ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-delete/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ファイルを一括削除

POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-delete/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
ids	array[string]	必須

リクエスト構造サンプル

{
  "ids": [
    string (uuid)
  ]
}

リクエストのサンプル値

{
  "ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-delete/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ファイルを一括で再解析

PATCH /api/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
filename	string	任意	ファイル名
file	string (uri)	任意	アップロードするファイル
parser	string (uuid)	任意
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意

リクエスト構造サンプル

{
  "filename"?: string // ファイル名 (任意)
  "file"?: string (uri) // アップロードするファイル (任意)
  "parser"?: string (uuid) // 任意
  "labels"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
}

リクエストのサンプル値

{
  "filename": "document.pdf",
  "file": "https://example.com/file.jpg",
  "parser": "550e8400-e29b-41d4-a716-446655440000",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "rawUserDefineMetadata": null
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "document.pdf",
    "file": "https://example.com/file.jpg",
    "parser": "550e8400-e29b-41d4-a716-446655440000",
    "labels": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "rawUserDefineMetadata": null
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイルを一括で再解析

PATCH /api/knowledge-bases/{knowledgeBasePk}/files/batch-reparse/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

コードサンプル

{% tabs %} {% tab title="Shell/Bash" %}

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[]'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = [];

axios.patch("https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", data, config)
  .then(response => {
    console.log('レスポンスの取得に成功しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

import requests

url = "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = []

response = requests.patch(url, json=data, headers=headers)
try:
    print("レスポンスの取得に成功しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->patch("https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => []
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスの取得に成功しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

ファイルを一括で再解析

PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
filename	string	任意	ファイル名
file	string (uri)	任意	アップロードするファイル
parser	string (uuid)	任意
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意

リクエスト構造サンプル

{
  "filename"?: string // ファイル名 (任意)
  "file"?: string (uri) // アップロードするファイル (任意)
  "parser"?: string (uuid) // 任意
  "labels"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
}

リクエストのサンプル値

{
  "filename": "document.pdf",
  "file": "https://example.com/file.jpg",
  "parser": "550e8400-e29b-41d4-a716-446655440000",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "rawUserDefineMetadata": null
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "document.pdf",
    "file": "https://example.com/file.jpg",
    "parser": "550e8400-e29b-41d4-a716-446655440000",
    "labels": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "rawUserDefineMetadata": null
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイルを一括で再解析

PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-reparse/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

コードサンプル

{% tabs %} {% tab title="Shell/Bash" %}

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[]'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = [];

axios.patch("https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", data, config)
  .then(response => {
    console.log('レスポンスの取得に成功しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

import requests

url = "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = []

response = requests.patch(url, json=data, headers=headers)
try:
    print("レスポンスの取得に成功しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->patch("https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-reparse/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => []
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスの取得に成功しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

ナレッジベース内のファイルを一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/files/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

コードサンプル

{% tabs %} {% tab title="Shell/Bash" %}

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", config)
  .then(response => {
    console.log('レスポンスの取得に成功しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

import requests

url = "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスの取得に成功しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスの取得に成功しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

ナレッジベース内のファイルを一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
fileType	❌	string	ファイルタイプのフィルター。例：pdf、docx、txt、xlsx など
knowledgeBase	❌	string	ナレッジベース ID
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：ファイル ID、ファイル名、ラベル名、Metadata value
status	❌	string	ファイルステータスのフィルター。指定可能な値：initial（初期化）、processing（処理中）、done（完了）、deleting（削除中）、deleted（削除済み）、failed（失敗） `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...

コードサンプル

{% tabs %} {% tab title="Shell/Bash" %}

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", config)
  .then(response => {
    console.log('レスポンスの取得に成功しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

import requests

url = "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスの取得に成功しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=delete_failed", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスの取得に成功しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "filename": string // ファイル名
      "file": string (uri) // アップロードするファイル
      "fileType": string
      "knowledgeBase"?:  // 任意
      {
        "id": string (uuid)
        "name": string
      }
      "size": integer
      "status": 
      {
      }
      "parser": {
      {
        "id": string (uuid)
        "name": string
        "provider": 
        {
        }
        "order"?: integer // 任意
      }
      }
      "labels"?: [ // 任意
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "rawUserDefineMetadata"?: object // 任意
      "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
      "chunksCount": integer // Number of chunks/nodes generated from this file
      "waitingTime": number (double)
      "processingTime": number (double)
      "processingTimeDetails": object
      "createdAt": string (timestamp)
    }
  ]
}

レスポンスのサンプル値

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "レスポンス文字列",
      "file": "https://example.com/file.jpg",
      "fileType": "レスポンス文字列",
      "knowledgeBase": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "size": 456,
      "status": {},
      "parser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "provider": {},
        "order": 456
      },
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "rawUserDefineMetadata": null,
      "vectorStorageSize": 456,
      "chunksCount": 456,
      "waitingTime": 456,
      "processingTime": 456,
      "processingTimeDetails": null,
      "createdAt": "レスポンス文字列"
    }
  ]
}

---

特定のファイルの詳細を取得

GET /api/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

特定のファイルの詳細を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイルの最新の失敗原因を取得

GET /api/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/latest-failed-reason/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "errorMessage": string
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "errorMessage": "レスポンス文字列",
  "createdAt": "レスポンス文字列"
}

---

ファイルの最新の失敗原因を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/latest-failed-reason/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "errorMessage": string
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "errorMessage": "レスポンス文字列",
  "createdAt": "レスポンス文字列"
}

---

ファイルの文字起こし内容を取得

GET /api/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/transcription/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイルの文字起こし内容を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/transcription/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイル情報を更新

PUT /api/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
filename	string	必須	ファイル名
file	string (uri)	必須	アップロードするファイル
parser	string (uuid)	任意
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意

リクエスト構造サンプル

{
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "parser"?: string (uuid) // 任意
  "labels"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
}

リクエストのサンプル値

{
  "filename": "document.pdf",
  "file": "https://example.com/file.jpg",
  "parser": "550e8400-e29b-41d4-a716-446655440000",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "rawUserDefineMetadata": null
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "document.pdf",
    "file": "https://example.com/file.jpg",
    "parser": "550e8400-e29b-41d4-a716-446655440000",
    "labels": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "rawUserDefineMetadata": null
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイル情報を更新

PUT /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
filename	string	必須	ファイル名
file	string (uri)	必須	アップロードするファイル
parser	string (uuid)	任意
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意

リクエスト構造サンプル

{
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "parser"?: string (uuid) // 任意
  "labels"?: [ // 任意
    {
      "id": string (uuid)
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
}

リクエストのサンプル値

{
  "filename": "document.pdf",
  "file": "https://example.com/file.jpg",
  "parser": "550e8400-e29b-41d4-a716-446655440000",
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "rawUserDefineMetadata": null
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filename": "document.pdf",
    "file": "https://example.com/file.jpg",
    "parser": "550e8400-e29b-41d4-a716-446655440000",
    "labels": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "rawUserDefineMetadata": null
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

{
  "id": string (uuid)
  "filename": string // ファイル名
  "file": string (uri) // アップロードするファイル
  "fileType": string
  "knowledgeBase"?:  // 任意
  {
    "id": string (uuid)
    "name": string
  }
  "size": integer
  "status": 
  {
  }
  "parser": {
  {
    "id": string (uuid)
    "name": string
    "provider": 
    {
    }
    "order"?: integer // 任意
  }
  }
  "labels"?: [ // 任意
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "rawUserDefineMetadata"?: object // 任意
  "vectorStorageSize": integer // Size of vectors for this file in Elasticsearch (bytes)
  "chunksCount": integer // Number of chunks/nodes generated from this file
  "waitingTime": number (double)
  "processingTime": number (double)
  "processingTimeDetails": object
  "createdAt": string (timestamp)
}

レスポンスのサンプル値

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "レスポンス文字列",
  "file": "https://example.com/file.jpg",
  "fileType": "レスポンス文字列",
  "knowledgeBase": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列"
  },
  "size": 456,
  "status": {},
  "parser": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "provider": {},
    "order": 456
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "rawUserDefineMetadata": null,
  "vectorStorageSize": 456,
  "chunksCount": 456,
  "waitingTime": 456,
  "processingTime": 456,
  "processingTimeDetails": null,
  "createdAt": "レスポンス文字列"
}

---

ファイルを削除

DELETE /api/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ファイルを削除

DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Knowledge Base File.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ファイル翻訳を作成

POST /api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
sourceLanguage	string	任意
targetLanguage	string	必須
customPrompt	string	任意
largeLanguageModelId	string (uuid)	必須

リクエスト構造サンプル

{
  "sourceLanguage"?: string // 任意
  "targetLanguage": string
  "customPrompt"?: string // 任意
  "largeLanguageModelId": string (uuid)
}

リクエストのサンプル値

{
  "sourceLanguage": "サンプル文字列",
  "targetLanguage": "サンプル文字列",
  "customPrompt": "サンプル文字列",
  "largeLanguageModelId": "550e8400-e29b-41d4-a716-446655440000"
}

コードサンプル

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceLanguage": "サンプル文字列",
    "targetLanguage": "サンプル文字列",
    "customPrompt": "サンプル文字列",
    "largeLanguageModelId": "550e8400-e29b-41d4-a716-446655440000"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

{
  "sourceLanguage"?: string // 任意
  "targetLanguage": string
  "customPrompt"?: string // 任意
  "largeLanguageModelId": string (uuid)
}

レスポンスのサンプル値

{
  "sourceLanguage": "レスポンス文字列",
  "targetLanguage": "レスポンス文字列",
  "customPrompt": "レスポンス文字列",
  "largeLanguageModelId": "550e8400-e29b-41d4-a716-446655440000"
}

---

ファイル翻訳を作成

POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
sourceLanguage	string	任意
targetLanguage	string	必須
customPrompt	string	任意
largeLanguageModelId	string (uuid)	必須

リクエスト構造サンプル

{
  "sourceLanguage"?: string // 任意
  "targetLanguage": string
  "customPrompt"?: string // 任意
  "largeLanguageModelId": string (uuid)
}

リクエストのサンプル値

{
  "sourceLanguage": "サンプル文字列",
  "targetLanguage": "サンプル文字列",
  "customPrompt": "サンプル文字列",
  "largeLanguageModelId": "550e8400-e29b-41d4-a716-446655440000"
}

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

レスポンスのサンプル値

---

ファイル翻訳を一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ファイル翻訳を一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

特定の翻訳を取得

GET /api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

特定の翻訳を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

翻訳を削除

DELETE /api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

翻訳を削除

DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

翻訳ファイルをダウンロード

GET /api/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/download/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

翻訳ファイルをダウンロード

GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/download/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this File Translation.
knowledgeBaseFilePk	✅	string
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ナレッジベースのドキュメントを一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/documents/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
chatbotFileId	❌	string	【非推奨予定】ファイル ID（knowledge_base_file_id を使用してください）
knowledgeBaseFileId	❌	string	ナレッジベースファイル ID

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ナレッジベースのドキュメントを一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/documents/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
chatbotFileId	❌	string	【非推奨予定】ファイル ID（knowledge_base_file_id を使用してください）
knowledgeBaseFileId	❌	string	ナレッジベースファイル ID

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ドキュメントを更新

PUT /api/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
fileName	string	必須
pageNumber	integer	任意
chatbotFile	string (uuid)	必須
excludedEmbedMetadataKeys	object	任意	List[str]: embedding に含めない metadata キーの一覧
excludedLlmMetadataKeys	object	任意	List[str]: LLM のコンテキストに含めない metadata キーの一覧
llamaIndexObjectJson	object	任意
metadata	object	任意
text	string	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ドキュメントを更新

PUT /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
fileName	string	必須
pageNumber	integer	任意
chatbotFile	string (uuid)	必須
excludedEmbedMetadataKeys	object	任意	List[str]: embedding に含めない metadata キーの一覧
excludedLlmMetadataKeys	object	任意	List[str]: LLM のコンテキストに含めない metadata キーの一覧
llamaIndexObjectJson	object	任意
metadata	object	任意
text	string	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ドキュメントを部分更新

PATCH /api/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
fileName	string	任意
pageNumber	integer	任意
chatbotFile	string (uuid)	任意
excludedEmbedMetadataKeys	object	任意	List[str]: embedding に含めない metadata キーの一覧
excludedLlmMetadataKeys	object	任意	List[str]: LLM のコンテキストに含めない metadata キーの一覧
llamaIndexObjectJson	object	任意
metadata	object	任意
text	string	任意

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ドキュメントを部分更新

PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
fileName	string	任意
pageNumber	integer	任意
chatbotFile	string (uuid)	任意
excludedEmbedMetadataKeys	object	任意	List[str]: embedding に含めない metadata キーの一覧
excludedLlmMetadataKeys	object	任意	List[str]: LLM のコンテキストに含めない metadata キーの一覧
llamaIndexObjectJson	object	任意
metadata	object	任意
text	string	任意

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

ドキュメントを削除

DELETE /api/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

ドキュメントを削除

DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this Chatbot ドキュメント.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

新しい FAQ を作成

POST /api/knowledge-bases/{knowledgeBasePk}/faqs/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	必須
answer	string	必須
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

レスポンスのサンプル値

---

新しい FAQ を作成

POST /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	必須
answer	string	必須
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 201

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を一括削除

POST /api/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
ids	array[string]	任意

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

FAQ を一括削除

POST /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
ids	array[string]	任意

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

特定のナレッジベースのすべての FAQ を一覧表示

GET /api/knowledge-bases/{knowledgeBasePk}/faqs/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：FAQ ID、質問、回答、ラベル名、Metadata value

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

特定のナレッジベースのすべての FAQ を一覧表示

GET /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/

パラメータ

パラメータ名	必須	タイプ	説明
knowledgeBasePk	✅	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
query	❌	string	検索キーワード。スペース区切りの複数条件検索に対応しています。検索対象：FAQ ID、質問、回答、ラベル名、Metadata value

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

特定の FAQ の詳細を取得

GET /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

特定の FAQ の詳細を取得

GET /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を更新

PUT /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	必須
answer	string	必須
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を更新

PUT /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	必須
answer	string	必須
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を部分更新

PATCH /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	任意
answer	string	任意
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を部分更新

PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

リクエスト内容

リクエストパラメータ

項目	タイプ	必須	説明
question	string	任意
answer	string	任意
answerMediaUrls	object	任意	回答内の画像や動画などのメディアファイルの URLs を格納します
labels	array[IdName]	任意
rawUserDefineMetadata	object	任意
knowledgeBase	object (2 個のプロパティを含む: id, name)	任意
knowledgeBase.id	string (uuid)	必須

リクエスト構造サンプル

リクエストのサンプル値

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード: 200

レスポンス構造サンプル

レスポンスのサンプル値

---

FAQ を削除

DELETE /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---

FAQ を削除

DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/

パラメータ

パラメータ名	必須	タイプ	説明
id	✅	string	A UUID string identifying this FAQ.
knowledgeBasePk	✅	string

コードサンプル

Shell/Bash

JavaScript

Python

PHP

レスポンス内容

ステータスコード	説明
204	No response body

---