mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-25 23:08:11 -05:00
ee7572185a
* improvement(tools): added visibility for tools that were missing it, added new google tools * fixed the name for google forms * revert schema enrichers change * fixed block ordering
130 lines
6.0 KiB
Plaintext
130 lines
6.0 KiB
Plaintext
---
|
|
title: Knowledge
|
|
description: Use vector search
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="knowledge"
|
|
color="#00B0B0"
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
Sim's Knowledge Base is a powerful native feature that enables you to create, manage, and query custom knowledge bases directly within the platform. Using advanced AI embeddings and vector search technology, the Knowledge Base block allows you to build intelligent search capabilities into your workflows, making it easy to find and utilize relevant information across your organization.
|
|
|
|
The Knowledge Base system provides a comprehensive solution for managing organizational knowledge through its flexible and scalable architecture. With its built-in vector search capabilities, teams can perform semantic searches that understand meaning and context, going beyond traditional keyword matching.
|
|
|
|
Key features of the Knowledge Base include:
|
|
|
|
- Semantic Search: Advanced AI-powered search that understands meaning and context, not just keywords
|
|
- Vector Embeddings: Automatic conversion of text into high-dimensional vectors for intelligent similarity matching
|
|
- Custom Knowledge Bases: Create and manage multiple knowledge bases for different purposes or departments
|
|
- Flexible Content Types: Support for various document formats and content types
|
|
- Real-time Updates: Immediate indexing of new content for instant searchability
|
|
|
|
In Sim, the Knowledge Base block enables your agents to perform intelligent semantic searches across your custom knowledge bases. This creates opportunities for automated information retrieval, content recommendations, and knowledge discovery as part of your AI workflows. The integration allows agents to search and retrieve relevant information programmatically, facilitating automated knowledge management tasks and ensuring that important information is easily accessible. By leveraging the Knowledge Base block, you can build intelligent agents that enhance information discovery while automating routine knowledge management tasks, improving team efficiency and ensuring consistent access to organizational knowledge.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Integrate Knowledge into the workflow. Can search, upload chunks, and create documents.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `knowledge_search`
|
|
|
|
Search for similar content in a knowledge base using vector similarity
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `knowledgeBaseId` | string | Yes | ID of the knowledge base to search in |
|
|
| `query` | string | No | Search query text \(optional when using tag filters\) |
|
|
| `topK` | number | No | Number of most similar results to return \(1-100\) |
|
|
| `tagFilters` | array | No | Array of tag filters with tagName and tagValue properties |
|
|
| `items` | object | No | No description |
|
|
| `properties` | string | No | No description |
|
|
| `tagName` | string | No | No description |
|
|
| `tagValue` | string | No | No description |
|
|
| `tagFilters` | string | No | No description |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `results` | array | Array of search results from the knowledge base |
|
|
| ↳ `documentId` | string | Document ID |
|
|
| ↳ `documentName` | string | Document name |
|
|
| ↳ `content` | string | Content of the result |
|
|
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
|
| ↳ `similarity` | number | Similarity score of the result |
|
|
| ↳ `metadata` | object | Metadata of the result, including tags |
|
|
| `query` | string | The search query that was executed |
|
|
| `totalResults` | number | Total number of results found |
|
|
| `cost` | object | Cost information for the search operation |
|
|
|
|
### `knowledge_upload_chunk`
|
|
|
|
Upload a new chunk to a document in a knowledge base
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `knowledgeBaseId` | string | Yes | ID of the knowledge base containing the document |
|
|
| `documentId` | string | Yes | ID of the document to upload the chunk to |
|
|
| `content` | string | Yes | Content of the chunk to upload |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `data` | object | Information about the uploaded chunk |
|
|
| ↳ `chunkId` | string | Chunk ID |
|
|
| ↳ `chunkIndex` | number | Index of the chunk within the document |
|
|
| ↳ `content` | string | Content of the chunk |
|
|
| ↳ `contentLength` | number | Length of the content in characters |
|
|
| ↳ `tokenCount` | number | Number of tokens in the chunk |
|
|
| ↳ `enabled` | boolean | Whether the chunk is enabled |
|
|
| ↳ `createdAt` | string | Creation timestamp |
|
|
| ↳ `updatedAt` | string | Last update timestamp |
|
|
| `message` | string | Success or error message describing the operation result |
|
|
| `documentId` | string | ID of the document the chunk was added to |
|
|
| `documentName` | string | Name of the document the chunk was added to |
|
|
| `cost` | object | Cost information for the upload operation |
|
|
|
|
### `knowledge_create_document`
|
|
|
|
Create a new document in a knowledge base
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `knowledgeBaseId` | string | Yes | ID of the knowledge base containing the document |
|
|
| `name` | string | Yes | Name of the document |
|
|
| `content` | string | Yes | Content of the document |
|
|
| `documentTags` | object | No | Document tags |
|
|
| `documentTags` | string | No | No description |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `data` | object | Information about the created document |
|
|
| ↳ `documentId` | string | Document ID |
|
|
| ↳ `documentName` | string | Document name |
|
|
| ↳ `type` | string | Document type |
|
|
| ↳ `enabled` | boolean | Whether the document is enabled |
|
|
| ↳ `createdAt` | string | Creation timestamp |
|
|
| ↳ `updatedAt` | string | Last update timestamp |
|
|
| `message` | string | Success or error message describing the operation result |
|
|
| `documentId` | string | ID of the created document |
|
|
|
|
|