ナレッジベース

フォルダー、ナレッジベース、記事、テンプレート、ドキュメント、コメントを管理し、AI支援による検索を実行するためにナレッジベースAPIと対話します。

トリガー

このノードでフローを開始できるイベントです。トリガーを選択 から追加します。

記事作成

ナレッジベースに新しい記事が作成されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば baseId は $trigger.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

記事更新

ナレッジベースの記事が更新されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば baseId は $trigger.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

記事削除

ナレッジベースから記事が削除されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば id は $trigger.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

ドキュメント作成

ナレッジベースに新しいドキュメントがアップロードされたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば accessLevel は $trigger.output.accessLevel です。

json

{
  "accessLevel": "string",
  "createdAt": "string",
  "folderId": "string",
  "id": "string",
  "metadata": {},
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "type": "string",
  "updatedAt": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	ドキュメントのアクセスレベル（private, public）
`createdAt`	テキスト	作成日時
`folderId`	テキスト	フォルダ ID（非推奨）
`id`	テキスト	ドキュメントの一意識別子
`metadata`	オブジェクト	ドキュメントのメタデータ
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`type`	テキスト	ドキュメントの種類
`updatedAt`	テキスト	最終更新日時

ドキュメント更新

ナレッジベースのドキュメントが更新されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば accessLevel は $trigger.output.accessLevel です。

json

{
  "accessLevel": "string",
  "createdAt": "string",
  "folderId": "string",
  "id": "string",
  "metadata": {},
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "type": "string",
  "updatedAt": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	ドキュメントのアクセスレベル（private, public）
`createdAt`	テキスト	作成日時
`folderId`	テキスト	フォルダ ID（非推奨）
`id`	テキスト	ドキュメントの一意識別子
`metadata`	オブジェクト	ドキュメントのメタデータ
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`type`	テキスト	ドキュメントの種類
`updatedAt`	テキスト	最終更新日時

ドキュメント削除

ナレッジベースからドキュメントが削除されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば id は $trigger.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

フォルダ作成

ナレッジベースに新しいフォルダが作成されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば breadcrumb は $trigger.output.breadcrumb です。

json

{
  "breadcrumb": "string",
  "breadcrumbArray": [
    "string"
  ],
  "childFolderCount": 0,
  "childKbCount": 0,
  "count": 0,
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "parentDirId": "string",
  "path": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`breadcrumb`	テキスト	名前によるパス（非推奨）
`breadcrumbArray[]`	リスト	名前によるパス配列
`childFolderCount`	数値	子フォルダ数
`childKbCount`	数値	子ナレッジベース数
`count`	数値	子項目数（非推奨）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	フォルダを作成したユーザー
`id`	テキスト	フォルダの一意識別子
`name`	テキスト	フォルダ名
`parentDirId`	テキスト	親ディレクトリ ID
`path`	テキスト	ULID によるフォルダの完全パス
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	フォルダを最後に更新したユーザー

フォルダ更新

ナレッジベースのフォルダが更新されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば breadcrumb は $trigger.output.breadcrumb です。

json

{
  "breadcrumb": "string",
  "breadcrumbArray": [
    "string"
  ],
  "childFolderCount": 0,
  "childKbCount": 0,
  "count": 0,
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "parentDirId": "string",
  "path": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`breadcrumb`	テキスト	名前によるパス（非推奨）
`breadcrumbArray[]`	リスト	名前によるパス配列
`childFolderCount`	数値	子フォルダ数
`childKbCount`	数値	子ナレッジベース数
`count`	数値	子項目数（非推奨）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	フォルダを作成したユーザー
`id`	テキスト	フォルダの一意識別子
`name`	テキスト	フォルダ名
`parentDirId`	テキスト	親ディレクトリ ID
`path`	テキスト	ULID によるフォルダの完全パス
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	フォルダを最後に更新したユーザー

フォルダ削除

ナレッジベースからフォルダが削除されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば id は $trigger.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

ナレッジベース作成

新しいナレッジベースが作成されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば accessLevel は $trigger.output.accessLevel です。

json

{
  "accessLevel": "string",
  "baseType": "string",
  "createdAt": "string",
  "createdBy": "string",
  "datasourceId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "processType": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	アクセスレベル（private, public）
`baseType`	テキスト	ナレッジベースの種類（document, article, from_datasource）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	ナレッジベースを作成したユーザー
`datasourceId`	テキスト	データソース ID
`description`	テキスト	ナレッジベースの説明
`id`	テキスト	ナレッジベースの一意識別子
`name`	テキスト	ナレッジベース名
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`processType`	テキスト	ナレッジベース処理タイプ
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	ナレッジベースを最後に更新したユーザー

ナレッジベース更新

ナレッジベースが更新されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば accessLevel は $trigger.output.accessLevel です。

json

{
  "accessLevel": "string",
  "baseType": "string",
  "createdAt": "string",
  "createdBy": "string",
  "datasourceId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "processType": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	アクセスレベル（private, public）
`baseType`	テキスト	ナレッジベースの種類（document, article, from_datasource）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	ナレッジベースを作成したユーザー
`datasourceId`	テキスト	データソース ID
`description`	テキスト	ナレッジベースの説明
`id`	テキスト	ナレッジベースの一意識別子
`name`	テキスト	ナレッジベース名
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`processType`	テキスト	ナレッジベース処理タイプ
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	ナレッジベースを最後に更新したユーザー

ナレッジベース削除

ナレッジベースが削除されたとき

設定項目

設定項目はありません。

出力

後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば id は $trigger.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

アクション

このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。

フォルダー一覧

フォルダーのリストを取得します

設定項目

項目	型	説明
親ディレクトリID	テキスト	親ディレクトリID（デフォルト：/root）
深度	数値	走査する最大深度（最大：5、デフォルト：2）既定値: `2`
取得数	数値	取得するアイテム数（最大：200、デフォルト：100）既定値: `100`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

フォルダー作成

新しいフォルダーを作成します

設定項目

項目	型	必須	説明
名前	テキスト	はい	フォルダー名（最大60文字、最小1文字、OpenAPI仕様で必須）
親ディレクトリID	テキスト		親ディレクトリID（最大27文字、デフォルト：/root）

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば breadcrumb は $.<ステップID>.output.breadcrumb です。

json

{
  "breadcrumb": "string",
  "breadcrumbArray": [
    "string"
  ],
  "childFolderCount": 0,
  "childKbCount": 0,
  "count": 0,
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "parentDirId": "string",
  "path": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`breadcrumb`	テキスト	名前によるパス（非推奨）
`breadcrumbArray[]`	リスト	名前によるパス配列
`childFolderCount`	数値	子フォルダ数
`childKbCount`	数値	子ナレッジベース数
`count`	数値	子項目数（非推奨）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	フォルダを作成したユーザー
`id`	テキスト	フォルダの一意識別子
`name`	テキスト	フォルダ名
`parentDirId`	テキスト	親ディレクトリ ID
`path`	テキスト	ULID によるフォルダの完全パス
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	フォルダを最後に更新したユーザー

ナレッジベース一覧

ナレッジベースのリストを取得します

設定項目

項目	型	説明
親ディレクトリID	テキスト	親ディレクトリID（デフォルト：/root）
カーソル	テキスト	ページネーションカーソル
取得数	数値	取得するアイテム数（最大：100、デフォルト：10）既定値: `100`
方向	選択	ページネーション方向選択肢: `進む`, `戻る`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

ナレッジベース作成

新しいナレッジベースを作成します

設定項目

項目	型	必須	説明
名前	テキスト	はい	ナレッジベース名（最大60文字、最小1文字、OpenAPI仕様で必須）
説明	テキスト		ナレッジベースの説明（最大255文字、オプション - null可）
親ディレクトリID	テキスト		親ディレクトリID（最大27文字、デフォルト：/root）
アクセスレベル	選択	はい	アクセスレベル（privateまたはpublic）選択肢: `プライベート`, `パブリック`
ベースタイプ	選択	はい	ナレッジベースのタイプ（document、article、またはfrom_datasource）選択肢: `記事` 既定値: `article`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "baseType": "string",
  "createdAt": "string",
  "createdBy": "string",
  "datasourceId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "processType": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	アクセスレベル（private, public）
`baseType`	テキスト	ナレッジベースの種類（document, article, from_datasource）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	ナレッジベースを作成したユーザー
`datasourceId`	テキスト	データソース ID
`description`	テキスト	ナレッジベースの説明
`id`	テキスト	ナレッジベースの一意識別子
`name`	テキスト	ナレッジベース名
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`processType`	テキスト	ナレッジベース処理タイプ
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	ナレッジベースを最後に更新したユーザー

記事一覧

ページネーション、フィルタリング、ソート機能で記事のリストを取得します（OpenAPI /v20250606/articles/に基づく）

設定項目

項目	型	説明
ナレッジベースID	テキスト	記事を一覧表示するナレッジベースID（オプション）
ステータス	選択	記事ステータスフィルター選択肢: `下書き`, `公開済み`
ソート項目	選択	ソートフィールド（デフォルト：createdAt）選択肢: `作成日時`, `更新日時`, `タイトル`
ソート順序	選択	ソート順序（デフォルト：desc）選択肢: `昇順`, `降順`
ナレッジベース情報を含める	はい / いいえ	レスポンスにナレッジベース情報を含めるかどうか（デフォルト：false）
ユーザー情報を含める	はい / いいえ	レスポンスに作成者と更新者情報を含めるかどうか（デフォルト：false）
スケジュール情報を含める	はい / いいえ	レスポンスにスケジュール情報を含めるかどうか（デフォルト：false）
検索クエリ	テキスト	記事全体の検索クエリ（タイトル、コンテンツ、キーワード）
カーソル	テキスト	ページネーションカーソル（排他的カーソルキー、最大400文字）
取得数	数値	取得するアイテム数（最小：1、最大：100、デフォルト：10）既定値: `10`
方向	選択	アイテムを取得する方向（デフォルト：forward）選択肢: `進む`, `戻る`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

記事作成

ナレッジベースに新しい記事を作成します（OpenAPI CreateArticleRequestに基づく）

設定項目

項目	型	必須	説明
ナレッジベースID	テキスト	はい	記事が作成されるナレッジベースID
タイトル	テキスト	はい	記事のタイトル（最大255文字、最小1文字、OpenAPI仕様で必須）
コンテンツ	テキスト	はい	記事の内容（最大5000文字、最小1文字、OpenAPI仕様で必須）
ステータス	選択		記事ステータス（デフォルト：published、OpenAPI ArticleStatus列挙型に基づく）選択肢: `Published`, `Draft` 既定値: `published`
キーワード	リスト		検索性向上のための記事のキーワード（文字列の配列、デフォルト：[]）
カスタムデータ	リスト		追加メタデータ用のカスタムデータフィールド（CustomDataInputオブジェクトの配列、デフォルト：[]）
関連記事	リスト		関連記事ID（文字列の配列、最大5項目、デフォルト：[]）

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば baseId は $.<ステップID>.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

一般検索

すべてのエンティティを検索します

設定項目

項目	型	必須	説明
検索クエリ	テキスト	はい	検索クエリ
エンティティ	複数選択		検索するエンティティタイプ（文字列の配列）選択肢: `Folder`, `Base`, `Article`, `Document`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば query は $.<ステップID>.output.query です。

json

{
  "query": "string",
  "results": [
    {
      "data": [
        "string"
      ],
      "type": "string"
    }
  ],
  "took": 0,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`query`	テキスト	検索クエリ
`results[]`	リスト	検索結果
`results[].data[]`	リスト	Entity payload
`results[].type`	テキスト	Entity type
`took`	数値	検索にかかった時間（ミリ秒）
`total`	数値	検索結果の総件数

フォルダー取得

IDで特定のフォルダーを取得します

設定項目

項目	型	必須	説明
フォルダーID	テキスト	はい	取得するフォルダーID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば breadcrumb は $.<ステップID>.output.breadcrumb です。

json

{
  "breadcrumb": "string",
  "breadcrumbArray": [
    "string"
  ],
  "childFolderCount": 0,
  "childKbCount": 0,
  "count": 0,
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "parentDirId": "string",
  "path": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`breadcrumb`	テキスト	名前によるパス（非推奨）
`breadcrumbArray[]`	リスト	名前によるパス配列
`childFolderCount`	数値	子フォルダ数
`childKbCount`	数値	子ナレッジベース数
`count`	数値	子項目数（非推奨）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	フォルダを作成したユーザー
`id`	テキスト	フォルダの一意識別子
`name`	テキスト	フォルダ名
`parentDirId`	テキスト	親ディレクトリ ID
`path`	テキスト	ULID によるフォルダの完全パス
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	フォルダを最後に更新したユーザー

フォルダー更新

既存のフォルダーを更新します

設定項目

項目	型	必須	説明
フォルダーID	テキスト	はい	更新するフォルダーID（最大27文字）
名前	テキスト	はい	新しいフォルダー名（最大60文字、最小1文字、OpenAPI仕様で必須）

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば breadcrumb は $.<ステップID>.output.breadcrumb です。

json

{
  "breadcrumb": "string",
  "breadcrumbArray": [
    "string"
  ],
  "childFolderCount": 0,
  "childKbCount": 0,
  "count": 0,
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "parentDirId": "string",
  "path": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`breadcrumb`	テキスト	名前によるパス（非推奨）
`breadcrumbArray[]`	リスト	名前によるパス配列
`childFolderCount`	数値	子フォルダ数
`childKbCount`	数値	子ナレッジベース数
`count`	数値	子項目数（非推奨）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	フォルダを作成したユーザー
`id`	テキスト	フォルダの一意識別子
`name`	テキスト	フォルダ名
`parentDirId`	テキスト	親ディレクトリ ID
`path`	テキスト	ULID によるフォルダの完全パス
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	フォルダを最後に更新したユーザー

フォルダー削除

IDでフォルダーを削除します

設定項目

項目	型	必須	説明
フォルダーID	テキスト	はい	削除するフォルダーID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

フォルダーエクスプローラー

パンくずリストサポートとカーソルページネーション機能付きの高度なフォルダー探索

設定項目

項目	型	説明
親ディレクトリID	テキスト	親ディレクトリID（デフォルト：/root）
パンくずリスト解決	はい / いいえ	各ドキュメントのパンくずリストを解決するかどうか（デフォルト：false）
カーソル	テキスト	ページネーション用の排他的カーソルキー（最大：400文字）
取得数	数値	取得するアイテム数（最大：100、デフォルト：10）既定値: `10`
方向	選択	取得方向（デフォルト: forward）選択肢: `進む`, `戻る`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

ナレッジベース取得

IDで特定のナレッジベースを取得します

設定項目

項目	型	必須	説明
ナレッジベースID	テキスト	はい	取得するナレッジベースID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "baseType": "string",
  "createdAt": "string",
  "createdBy": "string",
  "datasourceId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "processType": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	アクセスレベル（private, public）
`baseType`	テキスト	ナレッジベースの種類（document, article, from_datasource）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	ナレッジベースを作成したユーザー
`datasourceId`	テキスト	データソース ID
`description`	テキスト	ナレッジベースの説明
`id`	テキスト	ナレッジベースの一意識別子
`name`	テキスト	ナレッジベース名
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`processType`	テキスト	ナレッジベース処理タイプ
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	ナレッジベースを最後に更新したユーザー

ナレッジベース更新

既存のナレッジベースを更新します

設定項目

項目	型	必須	説明
ナレッジベースID	テキスト	はい	更新するナレッジベースID
名前	テキスト	はい	新しいナレッジベース名（最大60文字、最小1文字、OpenAPI仕様で必須）
説明	テキスト		新しいナレッジベースの説明（最大255文字、オプション - null可）
アクセスレベル	選択	はい	アクセスレベル（privateまたはpublic）選択肢: `プライベート`, `パブリック`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "baseType": "string",
  "createdAt": "string",
  "createdBy": "string",
  "datasourceId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "processType": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	アクセスレベル（private, public）
`baseType`	テキスト	ナレッジベースの種類（document, article, from_datasource）
`createdAt`	テキスト	作成日時
`createdBy`	テキスト	ナレッジベースを作成したユーザー
`datasourceId`	テキスト	データソース ID
`description`	テキスト	ナレッジベースの説明
`id`	テキスト	ナレッジベースの一意識別子
`name`	テキスト	ナレッジベース名
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`processType`	テキスト	ナレッジベース処理タイプ
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	ナレッジベースを最後に更新したユーザー

ナレッジベース削除

IDでナレッジベースを削除します

設定項目

項目	型	必須	説明
ナレッジベースID	テキスト	はい	削除するナレッジベースID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

記事取得

IDで特定の記事を取得します

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	取得する記事ID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば baseId は $.<ステップID>.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

記事更新

既存の記事を更新します

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	更新する記事ID
ナレッジベースID	テキスト	はい	記事のナレッジベースID（APIスキーマに存在するが、更新エンドポイントでは必須ではない）
タイトル	テキスト	はい	新しい記事のタイトル（最大255文字）
コンテンツ	テキスト	はい	新しい記事の内容（最大5000文字）
ステータス	選択		記事ステータス（デフォルト：published）選択肢: `Published`, `Draft` 既定値: `published`
キーワード	リスト		検索性向上のための記事のキーワード（文字列の配列）
カスタムデータ	リスト		追加メタデータ用のカスタムデータフィールド（CustomDataInputオブジェクトの配列）
関連記事	リスト		関連記事ID（文字列の配列、最大5項目）

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば baseId は $.<ステップID>.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

記事削除

IDで記事を削除します

設定項目

項目	型	必須	説明
ナレッジベースID	テキスト	はい	記事を含むナレッジベースID
記事ID	テキスト	はい	削除する記事ID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

記事検索

記事を具体的に検索します

設定項目

項目	型	必須	説明
検索クエリ	テキスト	はい	記事の検索クエリ
ナレッジベースID	テキスト		特定のナレッジベースに検索を限定する

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

ドキュメント一覧

親ディレクトリIDでページネーション機能付きドキュメントリストを取得します（OpenAPI /documentsに基づく）

設定項目

項目	型	説明
親ディレクトリID	テキスト	ドキュメントをフィルタリングする親ディレクトリID（最大50文字、デフォルト：/root）
パンくずリスト解決	はい / いいえ	各ドキュメントのパンくずリストを解決するかどうか（デフォルト：false）
カーソル	テキスト	ページネーション用の排他的カーソルキー（最大400文字）
取得数	数値	取得するアイテム数（最小：1、最大：100、デフォルト：10）既定値: `10`
方向	選択	アイテムを取得する方向（デフォルト：forward）選択肢: `進む`, `戻る`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

ドキュメント取得

IDで特定のドキュメントを取得します（OpenAPI /documents/'{documentId}'に基づく）

設定項目

項目	型	必須	説明
ドキュメントID	テキスト	はい	取得するドキュメントID
パンくずリスト解決	はい / いいえ		ドキュメントのパンくずリストを解決するかどうか（デフォルト：false）

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "createdAt": "string",
  "folderId": "string",
  "id": "string",
  "metadata": {},
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "type": "string",
  "updatedAt": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	ドキュメントのアクセスレベル（private, public）
`createdAt`	テキスト	作成日時
`folderId`	テキスト	フォルダ ID（非推奨）
`id`	テキスト	ドキュメントの一意識別子
`metadata`	オブジェクト	ドキュメントのメタデータ
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`type`	テキスト	ドキュメントの種類
`updatedAt`	テキスト	最終更新日時

ドキュメント更新

既存のドキュメントを更新します

設定項目

項目	型	必須	説明
ドキュメントID	テキスト	はい	更新するドキュメントID
名前	テキスト		新しいドキュメント名（最大255文字）
アクセスレベル	選択		ドキュメントアクセスレベル（デフォルト：private）選択肢: `プライベート`, `パブリック`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "createdAt": "string",
  "folderId": "string",
  "id": "string",
  "metadata": {},
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "type": "string",
  "updatedAt": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	ドキュメントのアクセスレベル（private, public）
`createdAt`	テキスト	作成日時
`folderId`	テキスト	フォルダ ID（非推奨）
`id`	テキスト	ドキュメントの一意識別子
`metadata`	オブジェクト	ドキュメントのメタデータ
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`type`	テキスト	ドキュメントの種類
`updatedAt`	テキスト	最終更新日時

ドキュメント削除

IDでドキュメントを削除します

設定項目

項目	型	必須	説明
ドキュメントID	テキスト	はい	削除するドキュメントID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。

json

{
  "id": "string",
  "message": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`id`	テキスト	削除された項目の ID
`message`	テキスト	成功メッセージ

ドキュメントアップロード

ファイルをナレッジベースに直接アップロードします。ノードはファイルの名前、コンテンツタイプ、サイズを自動的に検査します。ターゲットフォルダーのみを指定してください。

設定項目

項目	型	必須	説明
ファイル	ファイル	はい	アップロードするファイル（前のノード出力から）。名前、コンテンツタイプ、サイズは自動的に抽出されます。
フォルダーID	テキスト	はい	ドキュメントをアップロードするフォルダーID（最大27文字、OpenAPI仕様で必須）
アクセスレベル	選択		ドキュメントアクセスレベル（デフォルト：public）選択肢: `プライベート`, `パブリック` 既定値: `public`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば accessLevel は $.<ステップID>.output.accessLevel です。

json

{
  "accessLevel": "string",
  "createdAt": "string",
  "folderId": "string",
  "id": "string",
  "metadata": {},
  "parentDirBreadcrumb": "string",
  "parentDirBreadcrumbArray": [
    "string"
  ],
  "parentDirId": "string",
  "parentDirPath": "string",
  "type": "string",
  "updatedAt": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`accessLevel`	テキスト	ドキュメントのアクセスレベル（private, public）
`createdAt`	テキスト	作成日時
`folderId`	テキスト	フォルダ ID（非推奨）
`id`	テキスト	ドキュメントの一意識別子
`metadata`	オブジェクト	ドキュメントのメタデータ
`parentDirBreadcrumb`	テキスト	名前によるパス（非推奨）
`parentDirBreadcrumbArray[]`	リスト	名前によるパス配列
`parentDirId`	テキスト	親ディレクトリ ID
`parentDirPath`	テキスト	ULID によるパス
`type`	テキスト	ドキュメントの種類
`updatedAt`	テキスト	最終更新日時

ドキュメントダウンロードリンク取得

ドキュメントのダウンロードリンクを取得します

設定項目

項目	型	必須	説明
ドキュメントID	テキスト	はい	ダウンロードリンクを取得するドキュメントID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば downloadUrl は $.<ステップID>.output.downloadUrl です。

json

{
  "downloadUrl": "string",
  "downloadUrlExpires": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`downloadUrl`	テキスト	ドキュメントのダウンロード URL
`downloadUrlExpires`	テキスト	ダウンロード URL の有効期限

記事ショートカット作成

既存の記事へのショートカットを作成します

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	ショートカットを作成する記事ID
ナレッジベースID	テキスト	はい	ショートカットを作成するナレッジベースID

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば baseId は $.<ステップID>.output.baseId です。

json

{
  "baseId": "string",
  "content": "string",
  "contentRaw": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customData": [
    {
      "dataType": "string",
      "description": "string",
      "title": "string",
      "value": "string"
    }
  ],
  "datasourceId": "string",
  "dislikeCount": 0,
  "entityType": "string",
  "id": "string",
  "isShortcut": false,
  "keywords": [
    "string"
  ],
  "likeCount": 0,
  "originArticleId": "string",
  "relatedArticles": [
    {
      "baseId": "string",
      "content": "string",
      "contentRaw": "string",
      "deletedAt": "string",
      "status": "string",
      "title": "string"
    }
  ],
  "shortcutArticleIds": [
    "string"
  ],
  "status": "string",
  "title": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "version": 0,
  "viewCount": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`baseId`	テキスト	ナレッジベースID
`content`	テキスト	記事の内容
`contentRaw`	テキスト	記事の生コンテンツ（HTML、Markdownなど）
`createdAt`	テキスト	作成タイムスタンプ
`createdBy`	テキスト	記事を作成したユーザー
`customData[]`	リスト	カスタムデータフィールド
`customData[].dataType`	テキスト	カスタムフィールドのデータ型
`customData[].description`	テキスト	カスタムフィールドの説明
`customData[].title`	テキスト	カスタムフィールドのタイトル
`customData[].value`	任意	カスタムフィールドの値
`datasourceId`	テキスト	データソースID
`dislikeCount`	数値	非いいね数
`entityType`	テキスト	エンティティタイプ（articleまたはarticle-shortcut）
`id`	テキスト	記事の一意の識別子
`isShortcut`	はい / いいえ	この記事がショートカットかどうか
`keywords[]`	リスト	記事のキーワード
`likeCount`	数値	いいね数
`originArticleId`	テキスト	ショートカットの場合の元記事 ID
`relatedArticles[]`	リスト	関連記事
`relatedArticles[].baseId`	テキスト	関連記事のベースID
`relatedArticles[].content`	テキスト	関連記事の内容
`relatedArticles[].contentRaw`	テキスト	関連記事の生の内容
`relatedArticles[].deletedAt`	テキスト	削除日時。関連記事が削除された場合のみ設定されます
`relatedArticles[].status`	テキスト	関連記事のステータス
`relatedArticles[].title`	テキスト	関連記事のタイトル
`shortcutArticleIds[]`	リスト	ショートカット記事 ID の一覧
`status`	テキスト	記事のステータス（下書き、公開など）
`title`	テキスト	記事タイトル
`updatedAt`	テキスト	最終更新日時
`updatedBy`	テキスト	記事を最後に更新したユーザー
`version`	数値	記事バージョン
`viewCount`	数値	閲覧数

質問

ナレッジベースに質問します

設定項目

項目	型	必須	説明
ベースID	リスト		ベースIDのリスト（文字列の配列）
フォルダーID	リスト		フォルダーIDのリスト（文字列の配列）
ドキュメントID	リスト		ドキュメントIDのリスト（文字列の配列）
質問	テキスト	はい	質問する内容
モード	選択	はい	質問に使用するモード選択肢: `検索`, `RAG` 既定値: `rag`
メタデータ	オブジェクト		リクエストメタデータ（OpenAPI仕様で必須）
ストリーム	はい / いいえ		レスポンスをストリーミングするかどうか既定値: `false`
スコア閾値	数値		RAG モードの精度しきい値（0.1〜1.0、デフォルト: 0.5）既定値: `0.5`
類似度閾値	数値		Search モードの類似度しきい値（0.1〜1.0、デフォルト: 0.5）既定値: `0.5`
デバッグ	はい / いいえ		デバッグモードを有効にする
カスタムプロンプト	テキスト		リクエスト用のカスタムプロンプト
最大参照数	数値		返す最大参照数既定値: `5`
ショートカット記事を除外	はい / いいえ		ショートカット記事を除外して、重複が検索結果スロットを占有しないようにします既定値: `true`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば answer は $.<ステップID>.output.answer です。

json

{
  "answer": "string",
  "debugInfo": [],
  "references": [],
  "type": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`answer`	テキスト	生成された回答
`debugInfo[]`	リスト	デバッグ情報
`references[]`	リスト	参照元
`type`	テキスト	レスポンスタイプ（text または html）

カスタム質問

カスタムパラメータでナレッジベースに質問します

設定項目

項目	型	必須	説明
ベースID	リスト		ベースIDのリスト（文字列の配列）
フォルダーID	リスト		フォルダーIDのリスト（文字列の配列）
ドキュメントID	リスト		ドキュメントIDのリスト（文字列の配列）
質問	テキスト	はい	質問する内容
モード	選択		質問に使用するモード選択肢: `検索`, `RAG` 既定値: `rag`
メタデータ	オブジェクト	はい	リクエストメタデータ
ストリーム	はい / いいえ		レスポンスをストリーミングするかどうか既定値: `false`
スコア閾値	数値		RAG モードの精度しきい値（0.1〜1.0、デフォルト: 0.5）既定値: `0.5`
類似度閾値	数値		Search モードの類似度しきい値（0.1〜1.0、デフォルト: 0.5）既定値: `0.5`
デバッグ	はい / いいえ		デバッグモードを有効にする
カスタムプロンプト	テキスト	はい	リクエスト用のカスタムプロンプト
最大参照数	数値		返す最大参照数既定値: `5`
プライベートベース検索許可	はい / いいえ		プライベートナレッジベースの検索を許可する
ショートカット記事を除外	はい / いいえ		ショートカット記事を除外して、重複が検索結果スロットを占有しないようにします既定値: `true`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば answer は $.<ステップID>.output.answer です。

json

{
  "answer": "string",
  "references": [],
  "type": "string"
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`answer`	テキスト	生成された回答
`references[]`	リスト	参照元
`type`	テキスト	レスポンスタイプ（text または html）

記事品質を分析

KB 品質評価ツールで記事のコンテンツを採点（LLM 呼び出し 1 回）。記事は変更されません。

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	追跡に使用する記事 ID
タイトル	テキスト	はい	分析する記事タイトル
コンテンツ	テキスト	はい	分析する記事の内容
Language	選択		おすすめ用の言語（空の場合は自動検出）選択肢: `英語`, `日本語`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば articleId は $.<ステップID>.output.articleId です。

json

{
  "articleId": "string",
  "recommendations": [],
  "relevanceScore": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`articleId`	テキスト	分析された記事
`recommendations[]`	リスト	実行可能な改善提案
`relevanceScore`	数値	総合品質スコア（0～100）

記事の統計を取得

事前集計済みの合計を含む記事の時間別閲覧数／いいね数／低評価数の統計を取得

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	記事 ID（ショートカットはリンク元に解決されます）
送信元	テキスト		時間範囲の開始（ISO 8601、例：2026-06-01T00:00:00Z）
宛先	テキスト		時間範囲の終了（ISO 8601）
製品	選択		1 つの製品に限定選択肢: `FAQ`, `チャットボット`, `AI ウィジェット`, `Page`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。

json

{
  "data": [],
  "totalDislikes": 0,
  "totalLikes": 0,
  "totalViews": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`data[]`	リスト	時間単位のバケット: id、product、viewCount、likeCount、dislikeCount、hour
`totalDislikes`	数値	バケット全体の dislikeCount の合計
`totalLikes`	数値	バケット全体の likeCount の合計
`totalViews`	数値	バケット全体の viewCount の合計

類似記事を検索

埋め込み類似度が最も高い記事をスコア付きで返す（記事自体とそのショートカットは除外）

設定項目

項目	型	必須	説明
記事ID	テキスト	はい	比較する記事
候補	数値		返す類似記事数既定値: `5`
最小スコア	数値		この値以上の未加工の類似度スコアを持つ候補のみを返す（0～1）。0 または省略した場合はデフォルト値の 0.8 を使用既定値: `0.8`
Base ID に制限	リスト		これらのナレッジベースの候補のみを対象とします（最大 20 件）。ワークスペース全体を検索する場合は省略します

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。

json

{
  "data": []
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`data[]`	リスト	項目: articleId、タイトル、スコア (未加工の KNN スコア、1.0 = 同一)

未使用の記事一覧

合計閲覧数がしきい値以下の公開済み記事を一覧表示（0 = 未閲覧）

設定項目

項目	型	必須	説明
ベースID	リスト	はい	スキャンするナレッジベース。非公開アクセスのベースも含まれます
最大ビュー数	数値		合計閲覧数が最大でこの数の記事を含める既定値: `0`
取得数	数値		ページサイズ既定値: `50`
カーソル	テキスト		前回の呼び出しのページネーションカーソル
製品	リスト		このプロダクト（FAQ、チャットボット、AI ウィジェット、またはページ）からの閲覧のみをカウントします。指定できるプロダクトは 1 つまでです

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "data": [],
  "hasMore": false,
  "total": 0
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	ページネーションカーソル
`data[]`	リスト	項目一覧
`hasMore`	はい / いいえ	さらに項目があるかどうか
`total`	数値	総項目数

KB スイープ

ナレッジベースをスイープし、未使用、低品質、重複している記事を検出。検出のみ - 記事は変更しない。maxArticles、budgetSeconds または maxQualityCalls に達すると停止し、カーソルとともに truncated=true を返す。truncated が false になるまで、そのカーソルと同じ入力を指定して再度呼び出す。続きの呼び出しは未チェックの次の記事から再開するため、スキップや重複は発生しない。未使用記事の検索が最初にページ単位で行われ、複数回の呼び出しを通じて完了した後、記事ごとのチェックが開始される。

設定項目

項目	型	必須	説明
ベースID	リスト	はい	スイープするナレッジベース。非公開アクセスのベースも含まれます
除外するベース ID	リスト		絶対にスイープしてはならないナレッジベース（例: EBIS/DMS）
チェック	複数選択		実行するチェック（デフォルト：すべて）選択肢: `未使用の記事`, `低品質`, `重複`
最小関連度スコア	数値		このスコアを下回る記事は低品質として報告されます。0 または省略した場合はデフォルト値の 30 が使用されます。採点は厳しめ（十分な回答でも 40～50 程度になることが多い）なので、自社のコンテンツで調整してください既定値: `30`
最小類似度	数値		2 つの記事が重複として報告される未加工の類似度スコアのしきい値（0～1）。0 または省略した場合はデフォルト値の 0.85 を使用既定値: `0.85`
類似候補	数値		記事ごとに取得する最近傍数既定値: `5`
最大記事数	数値		truncated=true を返す前に 1 回の呼び出しでスキャンする記事数既定値: `200`
最大 Quality Calls 数	数値		呼び出しごとに許可される LLM 品質呼び出し数（保存済みスコアのない記事のみ必要）。0 または省略時はデフォルト値の 100 を使用。各呼び出しは実際の LLM リクエストになるため、テスト時は少なく設定。上限に達するとカーソルを返し、次の呼び出しで続きを処理既定値: `100`
同時実行数	数値		記事の並列チェック既定値: `4`
時間予算 (秒)	数値		この秒数の経過後は新しい記事のチェックを開始せず、カーソルを返す。チェック中の記事は完了させる既定値: `150`
カーソル	テキスト		前回の呼び出しで返された不透明なカーソル
重複範囲	選択		重複候補の取得元。'bases'（デフォルト）はスイープ対象のベース間の重複のみを報告するため、他のベースにある同じ内容のコピーが、スイープ対象のベース内にある近似重複を押し出すことはありません。'workspace' は他のベースにあるコピーも報告します選択肢: `スイープした塩基のみ`, `ワークスペース全体` 既定値: `bases`
コンテンツの抜粋を含める	はい / いいえ		各記事の最初の 2000 文字をその検出結果に添付既定値: `true`

出力

後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば cursor は $.<ステップID>.output.cursor です。

json

{
  "cursor": "string",
  "findings": [],
  "stats": {},
  "truncated": false
}

例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使うを参照してください。

フィールドの説明

項目	型	説明
`cursor`	テキスト	truncated が true の間、次の呼び出しに渡す不透明なカーソル
`findings[]`	リスト	項目: タイプ (未使用 \| 低品質 \| 重複)、記事 ID、タイトル、ベース ID、根拠、関連記事 ID、重複排除キー。重複の項目はほぼ同一の記事の 1 クラスター
`stats`	オブジェクト	スキャン数、エラー数、エラーサンプル、品質呼び出し、類似呼び出し、経過時間（ms）、stoppedBy（切り詰めの原因となった上限）
`truncated`	はい / いいえ	budgetSeconds、maxArticles または maxQualityCalls によってスイープが早期に停止した場合は True

ナレッジベース ​

トリガー ​

記事作成 ​

記事更新 ​

記事削除 ​

ドキュメント作成 ​

ドキュメント更新 ​

ドキュメント削除 ​

フォルダ作成 ​

フォルダ更新 ​

フォルダ削除 ​

ナレッジベース作成 ​

ナレッジベース更新 ​

ナレッジベース削除 ​

アクション ​

フォルダー一覧 ​

フォルダー作成 ​

ナレッジベース一覧 ​

ナレッジベース作成 ​

記事一覧 ​

記事作成 ​

一般検索 ​

フォルダー取得 ​

フォルダー更新 ​

フォルダー削除 ​

フォルダーエクスプローラー ​

ナレッジベース取得 ​

ナレッジベース更新 ​

ナレッジベース削除 ​

記事取得 ​

記事更新 ​

記事削除 ​

記事検索 ​

ドキュメント一覧 ​

ドキュメント取得 ​

ドキュメント更新 ​

ドキュメント削除 ​

ドキュメントアップロード ​

ドキュメントダウンロードリンク取得 ​

記事ショートカット作成 ​

質問 ​

カスタム質問 ​

記事品質を分析 ​

記事の統計を取得 ​

類似記事を検索 ​

未使用の記事一覧 ​

KB スイープ ​

ナレッジベース

トリガー

記事作成

記事更新

記事削除

ドキュメント作成

ドキュメント更新

ドキュメント削除

フォルダ作成

フォルダ更新

フォルダ削除

ナレッジベース作成

ナレッジベース更新

ナレッジベース削除

アクション

フォルダー一覧

フォルダー作成

ナレッジベース一覧

ナレッジベース作成

記事一覧

記事作成

一般検索

フォルダー取得

フォルダー更新

フォルダー削除

フォルダーエクスプローラー

ナレッジベース取得

ナレッジベース更新

ナレッジベース削除

記事取得

記事更新

記事削除

記事検索

ドキュメント一覧

ドキュメント取得

ドキュメント更新

ドキュメント削除

ドキュメントアップロード

ドキュメントダウンロードリンク取得

記事ショートカット作成

質問

カスタム質問

記事品質を分析

記事の統計を取得

類似記事を検索

未使用の記事一覧

KB スイープ