​
Introduction

The Knowledge Bases Module provides comprehensive functionality for managing knowledge repositories and performing semantic searches within the xpander.ai platform.

​
Overview

In this module, you can:
  • Create and manage knowledge bases for document storage
  • Add documents from URLs to knowledge repositories
  • Perform semantic searches across document collections
  • Delete and manage knowledge base lifecycle
  • Handle both synchronous and asynchronous operations

​
Examples

​
Creating Knowledge Bases

This example demonstrates how to create new knowledge bases with both asynchronous and synchronous approaches.

​
Asynchronous Example

Using acreate() to create knowledge bases asynchronously: 
from xpander_sdk import KnowledgeBases

kbs = KnowledgeBases()
kb = await kbs.acreate(
    name="Product Documentation",
    description="Knowledge base for product documentation and guides"
)
print(f"Created knowledge base: {kb.name} (ID: {kb.id})")

​
Synchronous Example

Using create() to create knowledge bases synchronously: 
from xpander_sdk import KnowledgeBases

kbs = KnowledgeBases()
kb = kbs.create(
    name="Product Documentation",
    description="Knowledge base for product documentation and guides"
)
print(f"Created knowledge base: {kb.name} (ID: {kb.id})")

​
Listing Knowledge Bases

Retrieve all available knowledge bases in your organization.

​
Asynchronous Example

kbs_list = await kbs.alist()
for kb in kbs_list:
    print(f"Knowledge Base: {kb.name} (ID: {kb.id})")
    print(f"Type: {kb.type}")

​
Synchronous Example

kbs_list = kbs.list()
for kb in kbs_list:
    print(f"Knowledge Base: {kb.name} (ID: {kb.id})")
    print(f"Type: {kb.type}")

​
Adding Documents

Add documents to knowledge bases from URLs.

​
Asynchronous Example

documents = await kb.aadd_documents(
    document_urls=[
        "https://example.com/docs/user-guide.pdf",
        "https://example.com/docs/api-reference.md"
    ],
    sync=True
)
print(f"Added {len(documents)} documents to knowledge base")

​
Synchronous Example

documents = kb.add_documents(
    document_urls=[
        "https://example.com/docs/user-guide.pdf",
        "https://example.com/docs/api-reference.md"
    ],
    sync=True
)
print(f"Added {len(documents)} documents to knowledge base")

​
Searching Knowledge Bases

Perform semantic searches across document collections.

​
Asynchronous Example

search_results = await kb.asearch("authentication methods")
for result in search_results:
    print(f"Score: {result.score:.3f}")
    print(f"Content: {result.content[:200]}...")
    print("---")

​
Synchronous Example

search_results = kb.search("authentication methods")
for result in search_results:
    print(f"Score: {result.score:.3f}")
    print(f"Content: {result.content[:200]}...")
    print("---")

​
Deleting Knowledge Bases

Remove knowledge bases when they’re no longer needed.

​
Asynchronous Example

await kb.adelete()
print(f"Knowledge base {kb.name} has been deleted")

​
Synchronous Example

kb.delete()
print(f"Knowledge base {kb.name} has been deleted")
Continue to the Knowledge Bases API Reference for detailed documentation on classes and methods.

Agents Module

Agent interaction with knowledge bases

Tools Repository

Tool integration and management

Configuration

SDK configuration and authentication

Tasks Module

Task execution and management

​
Support

For additional help: