Jinba Knowledge Base

Update and manage Jinba knowledge bases for enhanced AI workflows

Overview

The Jinba Knowledge Base tool allows you to update and manage knowledge bases within the Jinba ecosystem. This tool enables you to maintain up-to-date information repositories that can be accessed by other tools and workflows for enhanced AI-powered operations.

Key Features

• JINBA_KNOWLEDGE_BASE_UPDATE: Update knowledge base entries with new information
• Integration with vector search capabilities
• Support for multiple content types and formats
• Automatic content indexing and organization

Authentication

This tool uses your Jinba workspace credentials and does not require additional API keys.

Tools

JINBA_KNOWLEDGE_BASE_UPDATE

Update a knowledge base with new content or modify existing entries.

Input:

• knowledge_base_id (string, required): ID of the knowledge base to update
• content (string, required): Content to add or update
• title (string, optional): Title for the content entry
• metadata (object, optional): Additional metadata for the entry
• tags (array, optional): Tags for content categorization
• update_mode (string, optional): Update mode (“append”, “replace”, “merge”)

Output:

• entry_id: ID of the updated or created entry
• knowledge_base_id: ID of the knowledge base
• status: Update status
• indexed_content: Information about indexed content
• metadata: Associated metadata

Examples

Example: Update Knowledge Base with New Information

- id: update_knowledge_base
  tool: JINBA_KNOWLEDGE_BASE_UPDATE
  input:
    - name: knowledge_base_id
      value: "kb_product_documentation"
    - name: content
      value: |
        # Product Feature Update
        
        ## New Authentication System
        We've implemented a new OAuth 2.0 authentication system that provides:
        - Enhanced security with JWT tokens
        - Multi-factor authentication support
        - Session management improvements
        - API rate limiting per user
        
        ## Implementation Details
        The new system requires updating client applications to use the new endpoints:
        - Login: /auth/oauth/login
        - Token refresh: /auth/oauth/refresh
        - Logout: /auth/oauth/logout
    - name: title
      value: "Authentication System Update v2.1"
    - name: tags
      value: ["authentication", "security", "oauth", "api"]
    - name: metadata
      value:
        version: "2.1"
        category: "feature_update"
        priority: "high"
        author: "engineering_team"
    - name: update_mode
      value: "append"

Example: Update Knowledge Base with Workflow Documentation

- id: document_workflow
  tool: JINBA_KNOWLEDGE_BASE_UPDATE
  input:
    - name: knowledge_base_id
      value: "kb_workflow_documentation"
    - name: content
      value: |
        # Customer Onboarding Workflow
        
        ## Overview
        This workflow automates the customer onboarding process from initial signup to first successful transaction.
        
        ## Steps
        1. **Welcome Email**: Send personalized welcome email with getting started guide
        2. **Account Verification**: Verify email and phone number
        3. **Profile Setup**: Guide user through profile completion
        4. **Tutorial Completion**: Interactive product tour
        5. **First Transaction**: Assist with first purchase or usage
        
        ## Metrics
        - Average completion time: 15 minutes
        - Success rate: 87%
        - Drop-off points: Profile setup (23%), Tutorial (12%)
        
        ## Optimizations
        - Simplified profile setup reduced drop-off by 15%
        - Interactive tutorials increased completion by 28%
    - name: title
      value: "Customer Onboarding Workflow v3.0"
    - name: tags
      value: ["workflow", "onboarding", "customer", "automation"]
    - name: metadata
      value:
        workflow_id: "wf_customer_onboarding_v3"
        success_rate: 0.87
        avg_completion_time: 900
        last_updated: "2024-01-15"

Example: Update Knowledge Base with Troubleshooting Guide

- id: add_troubleshooting_guide
  tool: JINBA_KNOWLEDGE_BASE_UPDATE
  input:
    - name: knowledge_base_id
      value: "kb_support_documentation"
    - name: content
      value: |
        # API Integration Troubleshooting Guide
        
        ## Common Issues
        
        ### 1. Authentication Errors (401)
        **Problem**: API returns 401 Unauthorized
        **Causes**:
        - Invalid API key
        - Expired token
        - Missing Authorization header
        
        **Solutions**:
        - Verify API key is correct and active
        - Refresh authentication token
        - Ensure header format: "Authorization: Bearer {token}"
        
        ### 2. Rate Limiting (429)
        **Problem**: Too Many Requests error
        **Solutions**:
        - Implement exponential backoff
        - Reduce request frequency
        - Use batch operations when available
        
        ### 3. Timeout Issues
        **Problem**: Requests timing out
        **Solutions**:
        - Increase timeout values
        - Implement retry logic
        - Check network connectivity
        - Consider using async operations for large requests
        
        ## Best Practices
        - Always handle errors gracefully
        - Implement proper logging
        - Use health checks
        - Monitor API usage metrics
    - name: title
      value: "API Integration Troubleshooting Guide"
    - name: tags
      value: ["troubleshooting", "api", "integration", "support"]
    - name: metadata
      value:
        category: "troubleshooting"
        difficulty: "intermediate"
        estimated_resolution_time: "5-30 minutes"
        related_docs: ["api_reference", "authentication_guide"]

Example: Knowledge Base Update with Multiple Entries

- id: bulk_update_knowledge_base
  tool: PYTHON_SANDBOX_RUN
  input:
    - name: script
      value: |
        import json
        
        # Prepare multiple knowledge base updates
        updates = [
            {
                "title": "New Feature: Advanced Filtering",
                "content": "Users can now apply multiple filters simultaneously with AND/OR logic.",
                "tags": ["feature", "filtering", "ui"],
                "category": "feature_announcement"
            },
            {
                "title": "Bug Fix: Export Function",
                "content": "Fixed issue where large datasets would fail during CSV export.",
                "tags": ["bug_fix", "export", "csv"],
                "category": "bug_fix"
            },
            {
                "title": "Performance Improvement: Database Queries",
                "content": "Optimized database queries reducing response time by 40%.",
                "tags": ["performance", "database", "optimization"],
                "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"

Use Cases

• Maintaining product documentation and changelogs
• Building comprehensive troubleshooting guides
• Creating workflow documentation repositories
• Storing best practices and guidelines
• Building FAQ and support knowledge bases
• Maintaining team wikis and internal documentation
• Creating training materials and onboarding guides
• Storing compliance and regulatory information

Best Practices

• Use descriptive titles and consistent tagging
• Include relevant metadata for better searchability
• Organize content with clear hierarchies
• Regular updates to keep information current
• Use proper formatting for readability
• Include cross-references to related content
• Version control important documentation
• Monitor and maintain content quality