mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-13 07:55:09 -05:00
fix(docs): fixed naming semantics for memory tools, updated doc generator, & included docs for memory block (#389)
* added docs for memories * updated doc generator script to better find outputs * include google drive new tools in docs
This commit is contained in:
@@ -70,6 +70,7 @@ Fetch PR details including diff and files changed
|
||||
| `blob_url` | string |
|
||||
| `raw_url` | string |
|
||||
| `status` | string |
|
||||
| `content` | string |
|
||||
|
||||
### `github_comment`
|
||||
|
||||
@@ -103,6 +104,7 @@ Create comments on GitHub PRs
|
||||
| `line` | string |
|
||||
| `side` | string |
|
||||
| `commit_id` | string |
|
||||
| `content` | string |
|
||||
|
||||
### `github_repo_info`
|
||||
|
||||
@@ -126,6 +128,7 @@ Retrieve comprehensive GitHub repository metadata including stars, forks, issues
|
||||
| `forks` | string |
|
||||
| `openIssues` | string |
|
||||
| `language` | string |
|
||||
| `content` | string |
|
||||
|
||||
### `github_latest_commit`
|
||||
|
||||
@@ -150,6 +153,7 @@ Retrieve the latest commit from a GitHub repository
|
||||
| `author` | string |
|
||||
| `login` | string |
|
||||
| `avatar_url` | string |
|
||||
| `content` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
@@ -97,9 +97,10 @@ Read content from a Google Docs document
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `content` | string |
|
||||
| Parameter | Type |
|
||||
| ---------- | ------ |
|
||||
| `content` | string |
|
||||
| `metadata` | string |
|
||||
|
||||
### `google_docs_write`
|
||||
|
||||
@@ -118,6 +119,7 @@ Write or update content in a Google Docs document
|
||||
| Parameter | Type |
|
||||
| ---------------- | ------ |
|
||||
| `updatedContent` | string |
|
||||
| `metadata` | string |
|
||||
|
||||
### `google_docs_create`
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Google Drive
|
||||
description: Create and list files
|
||||
description: Create, upload, and list files
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from '@/components/ui/block-info-card'
|
||||
|
||||
@@ -78,7 +78,9 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
|
||||
|
||||
#### Output
|
||||
|
||||
This tool does not produce any outputs.
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `content` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
@@ -102,9 +102,10 @@ Retrieve memories from Mem0 by ID or filter criteria
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `data` | string |
|
||||
| Parameter | Type |
|
||||
| ---------- | ------ |
|
||||
| `memories` | string |
|
||||
| `ids` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
130
apps/docs/content/docs/tools/memory.mdx
Normal file
130
apps/docs/content/docs/tools/memory.mdx
Normal file
@@ -0,0 +1,130 @@
|
||||
---
|
||||
title: Memory
|
||||
description: Add memory store
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from '@/components/ui/block-info-card'
|
||||
|
||||
<BlockInfoCard
|
||||
type="memory"
|
||||
color="#F64F9E"
|
||||
icon={true}
|
||||
iconSvg={`<svg className="block-icon"
|
||||
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
|
||||
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M12 5a3 3 0 1 0-5.997.125 4 4 0 0 0-2.526 5.77 4 4 0 0 0 .556 6.588A4 4 0 1 0 12 18Z" />
|
||||
<path d="M12 5a3 3 0 1 1 5.997.125 4 4 0 0 1 2.526 5.77 4 4 0 0 1-.556 6.588A4 4 0 1 1 12 18Z" />
|
||||
<path d="M15 13a4.5 4.5 0 0 1-3-4 4.5 4.5 0 0 1-3 4" />
|
||||
<path d="M17.599 6.5a3 3 0 0 0 .399-1.375" />
|
||||
<path d="M6.003 5.125A3 3 0 0 0 6.401 6.5" />
|
||||
<path d="M3.477 10.896a4 4 0 0 1 .585-.396" />
|
||||
<path d="M19.938 10.5a4 4 0 0 1 .585.396" />
|
||||
<path d="M6 18a4 4 0 0 1-1.967-.516" />
|
||||
<path d="M19.967 17.484A4 4 0 0 1 18 18" />
|
||||
</svg>`}
|
||||
/>
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Create persistent storage for data that needs to be accessed across multiple workflow steps. Store and retrieve information throughout your workflow execution to maintain context and state.
|
||||
|
||||
## Tools
|
||||
|
||||
### `memory_add`
|
||||
|
||||
Add a new memory to the database or append to existing memory with the same ID. When appending to existing memory, the memory types must match.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ------ | -------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | Yes | Identifier for the memory. If a memory with this ID already exists, the new data will be appended to it. |
|
||||
| `type` | string | Yes | Type of memory \(agent or raw\) |
|
||||
| `role` | string | No | Role for agent memory \(user, assistant, or system\) |
|
||||
| `content` | string | No | Content for agent memory |
|
||||
| `rawData` | json | No | Raw data to store \(JSON format\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| ---------- | ------ |
|
||||
| `memories` | string |
|
||||
|
||||
### `memory_get`
|
||||
|
||||
Retrieve a specific memory by its ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ------ | -------- | ------------------------------------- |
|
||||
| `id` | string | Yes | Identifier for the memory to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| ---------- | ------ |
|
||||
| `memories` | string |
|
||||
| `message` | string |
|
||||
|
||||
### `memory_get_all`
|
||||
|
||||
Retrieve all memories from the database
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| ---------- | ------ |
|
||||
| `message` | string |
|
||||
| `memories` | string |
|
||||
|
||||
### `memory_delete`
|
||||
|
||||
Delete a specific memory by its ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ------ | -------- | ----------------------------------- |
|
||||
| `id` | string | Yes | Identifier for the memory to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `message` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------- | ------ | -------- | ----------- |
|
||||
| `operation` | string | Yes | Operation |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Type | Description |
|
||||
| ------------ | ------ | ------------------------ |
|
||||
| `response` | object | Output from response |
|
||||
| ↳ `memories` | any | memories of the response |
|
||||
| ↳ `id` | string | id of the response |
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `blocks`
|
||||
- Type: `memory`
|
||||
@@ -23,6 +23,7 @@
|
||||
"jira",
|
||||
"linkup",
|
||||
"mem0",
|
||||
"memory",
|
||||
"notion",
|
||||
"openai",
|
||||
"perplexity",
|
||||
|
||||
@@ -160,6 +160,7 @@ Fetch vectors by ID from a Pinecone index
|
||||
| `values` | string |
|
||||
| `metadata` | string |
|
||||
| `score` | string |
|
||||
| `id` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
@@ -63,6 +63,7 @@ Fetch the most popular (hot) posts from a specified subreddit.
|
||||
| Parameter | Type |
|
||||
| ----------- | ------ |
|
||||
| `subreddit` | string |
|
||||
| `posts` | string |
|
||||
|
||||
### `reddit_get_posts`
|
||||
|
||||
@@ -82,6 +83,7 @@ Fetch posts from a subreddit with different sorting options
|
||||
| Parameter | Type |
|
||||
| ----------- | ------ |
|
||||
| `subreddit` | string |
|
||||
| `posts` | string |
|
||||
|
||||
### `reddit_get_comments`
|
||||
|
||||
|
||||
@@ -69,6 +69,7 @@ Retrieve an object from an AWS S3 bucket
|
||||
| `size` | string |
|
||||
| `name` | string |
|
||||
| `lastModified` | string |
|
||||
| `url` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
@@ -98,9 +98,9 @@ A powerful web search tool that provides access to Google search results through
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ----- |
|
||||
| `results` | array |
|
||||
| Parameter | Type |
|
||||
| --------------- | ------ |
|
||||
| `searchResults` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
@@ -86,9 +86,11 @@ Download files uploaded in Typeform responses
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `fileUrl` | string |
|
||||
| Parameter | Type |
|
||||
| ------------- | ------ |
|
||||
| `fileUrl` | string |
|
||||
| `contentType` | string |
|
||||
| `filename` | string |
|
||||
|
||||
### `typeform_insights`
|
||||
|
||||
|
||||
@@ -83,6 +83,7 @@ Read tweet details, including replies and conversation context
|
||||
| Parameter | Type |
|
||||
| --------- | ------ |
|
||||
| `tweet` | string |
|
||||
| `context` | string |
|
||||
|
||||
### `x_search`
|
||||
|
||||
|
||||
@@ -61,6 +61,7 @@ Search for videos on YouTube using the YouTube Data API.
|
||||
| --------------- | ------ |
|
||||
| `totalResults` | string |
|
||||
| `nextPageToken` | string |
|
||||
| `items` | string |
|
||||
|
||||
## Block Configuration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user