Documentation Index
Fetch the complete documentation index at: https://docs.jinba.io/llms.txt
Use this file to discover all available pages before exploring further.
Jinba Knowledge Baseツールを使用すると、Jinbaエコシステム内でナレッジベースを更新・管理できます。このツールにより、最新の情報リポジトリを維持し、AI駆動の運用を強化するために他のツールやワークフローからアクセス可能にできます。
主な機能
JINBA_KNOWLEDGE_BASE_UPDATE: 新しい情報でナレッジベースエントリを更新
- ベクトル検索機能との統合
- 複数のコンテンツタイプとフォーマットのサポート
- 自動コンテンツインデックス化と組織化
このツールはJinbaワークスペースの認証情報を使用し、追加のAPIキーは必要ありません。
ツール
JINBA_KNOWLEDGE_BASE_UPDATE
新しいコンテンツでナレッジベースを更新するか、既存のエントリを変更します。
入力:
| パラメータ | 型 | 必須 | 説明 |
|---|
knowledge_base_id | string | はい | 更新するナレッジベースのID |
content | string | はい | 追加または更新するコンテンツ |
title | string | いいえ | コンテンツエントリのタイトル |
metadata | object | いいえ | エントリの追加メタデータ |
tags | array | いいえ | コンテンツ分類用のタグ |
update_mode | string | いいえ | 更新モード: append, replace, merge |
出力:
| フィールド | 型 | 説明 |
|---|
entry_id | string | 更新または作成されたエントリのID |
knowledge_base_id | string | ナレッジベースのID |
status | string | 更新ステータス |
indexed_content | object | インデックス化されたコンテンツの情報 |
metadata | object | 関連付けられたメタデータ |
使用例
例:新しい情報でナレッジベースを更新する
- id: update_knowledge_base
tool: JINBA_KNOWLEDGE_BASE_UPDATE
input:
- name: knowledge_base_id
value: "kb_product_documentation"
- name: content
value: |
# 製品機能アップデート
## 新しい認証システム
以下を提供する新しいOAuth 2.0認証システムを実装しました:
- JWTトークンによるセキュリティ強化
- 多要素認証サポート
- セッション管理の改善
- ユーザーごとのAPIレート制限
## 実装詳細
新しいシステムでは、クライアントアプリケーションが新しいエンドポイントを使用するように更新が必要です:
- ログイン: /auth/oauth/login
- トークン更新: /auth/oauth/refresh
- ログアウト: /auth/oauth/logout
- name: title
value: "認証システムアップデート v2.1"
- name: tags
value: ["認証", "セキュリティ", "oauth", "api"]
- name: metadata
value:
version: "2.1"
category: "feature_update"
priority: "high"
author: "engineering_team"
- name: update_mode
value: "append"
例:ワークフロードキュメントでナレッジベースを更新する
- id: document_workflow
tool: JINBA_KNOWLEDGE_BASE_UPDATE
input:
- name: knowledge_base_id
value: "kb_workflow_documentation"
- name: content
value: |
# 顧客オンボーディングワークフロー
## 概要
このワークフローは、初回サインアップから最初の取引成功まで、顧客オンボーディングプロセスを自動化します。
## ステップ
1. **ウェルカムメール**: 開始ガイド付きパーソナライズされたウェルカムメールを送信
2. **アカウント認証**: メールアドレスと電話番号を認証
3. **プロフィール設定**: ユーザーをプロフィール完成まで誘導
4. **チュートリアル完了**: インタラクティブな製品ツアー
5. **初回取引**: 初回購入または使用をサポート
## 指標
- 平均完了時間: 15分
- 成功率: 87%
- 離脱ポイント: プロフィール設定(23%)、チュートリアル(12%)
## 最適化
- 簡素化されたプロフィール設定により離脱率が15%削減
- インタラクティブチュートリアルにより完了率が28%向上
- name: title
value: "顧客オンボーディングワークフロー v3.0"
- name: tags
value: ["ワークフロー", "オンボーディング", "顧客", "自動化"]
- name: metadata
value:
workflow_id: "wf_customer_onboarding_v3"
success_rate: 0.87
avg_completion_time: 900
last_updated: "2024-01-15"
例:トラブルシューティングガイドでナレッジベースを更新する
- id: add_troubleshooting_guide
tool: JINBA_KNOWLEDGE_BASE_UPDATE
input:
- name: knowledge_base_id
value: "kb_support_documentation"
- name: content
value: |
# API統合トラブルシューティングガイド
## よくある問題
### 1. 認証エラー(401)
**問題**: APIが401 Unauthorizedを返す
**原因**:
- 無効なAPIキー
- 期限切れトークン
- Authorizationヘッダーの欠落
**解決方法**:
- APIキーが正しくアクティブであることを確認
- 認証トークンを更新
- ヘッダー形式を確保: "Authorization: Bearer {token}"
### 2. レート制限(429)
**問題**: Too Many Requestsエラー
**解決方法**:
- 指数バックオフを実装
- リクエスト頻度を下げる
- 利用可能な場合はバッチ操作を使用
### 3. タイムアウト問題
**問題**: リクエストがタイムアウトする
**解決方法**:
- タイムアウト値を増やす
- リトライロジックを実装
- ネットワーク接続を確認
- 大きなリクエストには非同期操作の使用を検討
## ベストプラクティス
- 常にエラーを適切に処理
- 適切なログを実装
- ヘルスチェックを使用
- API使用量メトリクスを監視
- name: title
value: "API統合トラブルシューティングガイド"
- name: tags
value: ["トラブルシューティング", "api", "統合", "サポート"]
- name: metadata
value:
category: "troubleshooting"
difficulty: "intermediate"
estimated_resolution_time: "5-30分"
related_docs: ["api_reference", "authentication_guide"]
例:複数エントリでナレッジベースを一括更新
- id: bulk_update_knowledge_base
tool: PYTHON_SANDBOX_RUN
input:
- name: script
value: |
import json
# 複数のナレッジベース更新を準備
updates = [
{
"title": "新機能: 高度なフィルタリング",
"content": "ユーザーはAND/ORロジックで複数のフィルターを同時に適用できるようになりました。",
"tags": ["機能", "フィルタリング", "ui"],
"category": "feature_announcement"
},
{
"title": "バグ修正: エクスポート機能",
"content": "大きなデータセットでCSVエクスポート中に失敗する問題を修正しました。",
"tags": ["バグ修正", "エクスポート", "csv"],
"category": "bug_fix"
},
{
"title": "パフォーマンス改善: データベースクエリ",
"content": "データベースクエリを最適化し、レスポンス時間を40%削減しました。",
"tags": ["パフォーマンス", "データベース", "最適化"],
"category": "improvement"
}
]
print(json.dumps({"updates": updates}))
- id: update_feature_announcement
tool: JINBA_KNOWLEDGE_BASE_UPDATE
input:
- name: knowledge_base_id
value: "kb_product_updates"
- name: content
value: "{{steps.bulk_update_knowledge_base.result.updates[0].content}}"
- name: title
value: "{{steps.bulk_update_knowledge_base.result.updates[0].title}}"
- name: tags
value: "{{steps.bulk_update_knowledge_base.result.updates[0].tags}}"
- name: metadata
value:
category: "{{steps.bulk_update_knowledge_base.result.updates[0].category}}"
date: "2024-01-15"
- id: update_bug_fix
tool: JINBA_KNOWLEDGE_BASE_UPDATE
input:
- name: knowledge_base_id
value: "kb_product_updates"
- name: content
value: "{{steps.bulk_update_knowledge_base.result.updates[1].content}}"
- name: title
value: "{{steps.bulk_update_knowledge_base.result.updates[1].title}}"
- name: tags
value: "{{steps.bulk_update_knowledge_base.result.updates[1].tags}}"
- name: metadata
value:
category: "{{steps.bulk_update_knowledge_base.result.updates[1].category}}"
date: "2024-01-15"
- 製品ドキュメントと変更履歴の維持
- 包括的なトラブルシューティングガイドの構築
- ワークフロードキュメントリポジトリの作成
- ベストプラクティスとガイドラインの保存
- FAQとサポートナレッジベースの構築
- チームWikiと内部ドキュメントの維持
- トレーニング資料とオンボーディングガイドの作成
- コンプライアンスと規制情報の保存
ベストプラクティス
- 説明的なタイトルと一貫性のあるタグ付けを使用
- 検索性を向上させるために関連メタデータを含める
- 明確な階層でコンテンツを整理
- 情報を最新に保つために定期的に更新
- 読みやすさのために適切な書式を使用
- 関連コンテンツへの相互参照を含める
- 重要なドキュメントのバージョン管理
- コンテンツ品質の監視と維持