Skip to content

DOC-7121 Consolidate agent-memory Python/TypeScript SDK quickstarts into one TCE page #4149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andy-stark-redis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC-7121 Consolidate agent-memory Python/TypeScript SDK quickstarts into one TCE page #4149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build/components/example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
PREFIXES = {
'python': '#',
'node.js': '//',
'typescript': '//',
'ioredis': '//',
'java': '//',
'java-sync': '//',
Expand Down
10 changes: 10 additions & 0 deletions build/local_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
EXTENSION_TO_LANGUAGE = {
'.py': 'python',
'.js': 'node.js',
'.ts': 'typescript',
'.go': 'go',
'.c': 'c',
'.h': 'c',
Expand Down Expand Up @@ -101,13 +102,20 @@ def get_client_name_from_language_and_path(language: str, path: str,

For Python (.py) files, override based on path substrings:
- If 'redisvl' in path -> RedisVL
- If 'agent-memory' in path -> Agent Memory (Python)
- Otherwise -> Python

For TypeScript (.ts) files, override based on path substrings:
- If 'agent-memory' in path -> Agent Memory (TypeScript)

Substring checks are case-sensitive and can appear anywhere in the path.
"""
if language == 'node.js':
if 'ioredis' in path:
return 'ioredis'
if language == 'typescript':
if 'agent-memory' in path:
return 'Agent Memory (TypeScript)'
if language == 'java':
if 'lettuce-sync' in path:
return 'Lettuce-Sync'
Expand All @@ -123,6 +131,8 @@ def get_client_name_from_language_and_path(language: str, path: str,
if language == 'python':
if 'redisvl' in path:
return 'RedisVL'
if 'agent-memory' in path:
return 'Agent Memory (Python)'
if language == 'c#':
variant = 'Async' if 'async' in path else 'Sync'
client = 'NRedisStack' if is_nredisstack_example(content) else 'SE.Redis'
Expand Down
4 changes: 3 additions & 1 deletion config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ gitHubRepo = "https://github.com/redis/docs"
aiSchemaVersion = 2

# Display and sort order for client examples
clientsExamples = ["Python", "Node.js", "ioredis", "Java-Sync", "Lettuce-Sync", "Java-Async", "Java-Reactive", "Go", "C", "C#-Sync (NRedisStack)", "C#-Async (NRedisStack)", "C#-Sync (SE.Redis)", "C#-Async (SE.Redis)", "RedisVL", "PHP", "Ruby", "Rust-Sync", "Rust-Async"]
clientsExamples = ["Python", "Node.js", "ioredis", "Java-Sync", "Lettuce-Sync", "Java-Async", "Java-Reactive", "Go", "C", "C#-Sync (NRedisStack)", "C#-Async (NRedisStack)", "C#-Sync (SE.Redis)", "C#-Async (SE.Redis)", "RedisVL", "PHP", "Ruby", "Rust-Sync", "Rust-Async", "Agent Memory (Python)", "Agent Memory (TypeScript)"]
searchService = "/convai/api/search-service"
ratingsService = "/docusight/api/rate/docs"

Expand Down Expand Up @@ -120,6 +120,8 @@ rdi_current_version = "2.0.0"
"Ruby"={quickstartSlug="redis-rb", langId="ruby", clientId="redis-rb", clientName="redis-rb", mappingClientId="redis_rb"}
"Rust-Sync"={quickstartSlug="rust", langId="rust", clientId="redis-rs", clientName="redis-rs", mappingClientId="redis_rs_sync"}
"Rust-Async"={quickstartSlug="rust", langId="rust", clientId="redis-rs", clientName="redis-rs", mappingClientId="redis_rs_async"}
"Agent Memory (Python)"={quickstartSlug="", langId="python", clientId="agent-memory-python", clientName="Agent Memory (Python)", mappingClientId=""}
"Agent Memory (TypeScript)"={quickstartSlug="", langId="typescript", clientId="agent-memory-typescript", clientName="Agent Memory (TypeScript)", mappingClientId=""}

# Mount directories for duplicate content
[module]
Expand Down
18 changes: 6 additions & 12 deletions content/develop/ai/context-engine/agent-memory/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ When enabled, automatic summarization compacts session memory by summarizing old

Access Redis Agent Memory through the Python and TypeScript SDKs or its REST API. It works with any agent framework or LLM provider.

<div class="grid grid-cols-1 md:grid-cols-4 gap-6 my-8">
<div class="grid grid-cols-1 md:grid-cols-3 gap-6 my-8">
{{< tile-card color="bg-blue-300" title="Overview" description="What's the same and what's different if you already know Redis" url="/develop/ai/context-engine/agent-memory/overview" >}}
{{< tile-card color="bg-redis-yellow-500" title="Python SDK" description="Explore Redis Agent Memory with Python" url="/develop/ai/context-engine/agent-memory/python-sdk-quickstart" >}}
{{< tile-card color="bg-redis-yellow-500" title="TypeScript SDK" description="Explore Redis Agent Memory with TypeScript" url="/develop/ai/context-engine/agent-memory/typescript-sdk-quickstart" >}}
{{< tile-card color="bg-redis-yellow-500" title="SDK quickstart" description="Explore Redis Agent Memory with the Python or TypeScript SDK" url="/develop/ai/context-engine/agent-memory/sdk-quickstart" >}}
{{< tile-card color="bg-teal-300" title="REST API" description="Explore Redis Agent Memory with curl" url="/develop/ai/context-engine/agent-memory/rest-api-quickstart" >}}
</div>

Expand Down Expand Up @@ -117,16 +116,11 @@ Get started with Redis Agent Memory on Redis Cloud or join the private preview f

After your Redis Agent Memory service is ready, choose a client. Each quickstart follows the same travel planning scenario through session memory, automatic extraction, summarization, custom memory types, and sensitive-data exclusions.

<div class="grid grid-cols-1 md:grid-cols-3 gap-6 my-6">
<div class="p-5 border border-redis-pen-300 rounded-lg">
<h3 class="text-redis-ink-900 font-semibold mb-3">Python SDK</h3>
<p>Explore the Redis Agent Memory workflow with the Python SDK.</p>
<p><a href="{{< relref "/develop/ai/context-engine/agent-memory/python-sdk-quickstart" >}}">Open the Python quickstart</a></p>
</div>
<div class="grid grid-cols-1 md:grid-cols-2 gap-6 my-6">
<div class="p-5 border border-redis-pen-300 rounded-lg">
<h3 class="text-redis-ink-900 font-semibold mb-3">TypeScript SDK</h3>
<p>Explore the Redis Agent Memory workflow with the TypeScript SDK.</p>
<p><a href="{{< relref "/develop/ai/context-engine/agent-memory/typescript-sdk-quickstart" >}}">Open the TypeScript quickstart</a></p>
<h3 class="text-redis-ink-900 font-semibold mb-3">Python or TypeScript SDK</h3>
<p>Explore the Redis Agent Memory workflow with the Python or TypeScript SDK.</p>
<p><a href="{{< relref "/develop/ai/context-engine/agent-memory/sdk-quickstart" >}}">Open the SDK quickstart</a></p>
</div>
<div class="p-5 border border-redis-pen-300 rounded-lg">
<h3 class="text-redis-ink-900 font-semibold mb-3">REST API</h3>
Expand Down
7 changes: 3 additions & 4 deletions content/develop/ai/context-engine/agent-memory/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Redis Agent Memory can automatically summarize older session events and extract

| Client | Use it when | Package and quickstart |
|:-------|:------------|:-----------------------|
| Python SDK | Your application or agent uses Python. | Install [`redis-agent-memory`](https://pypi.org/project/redis-agent-memory/) and follow the [Python SDK quickstart](/content/develop/ai/context-engine/agent-memory/python-sdk-quickstart.md). |
| TypeScript SDK | Your application or agent uses JavaScript or TypeScript. | Install [`@redis-iris/agent-memory`](https://www.npmjs.com/package/@redis-iris/agent-memory) and follow the [TypeScript SDK quickstart](/content/develop/ai/context-engine/agent-memory/typescript-sdk-quickstart.md). |
| Python SDK | Your application or agent uses Python. | Install [`redis-agent-memory`](https://pypi.org/project/redis-agent-memory/) and follow the [SDK quickstart](/content/develop/ai/context-engine/agent-memory/sdk-quickstart.md). |
| TypeScript SDK | Your application or agent uses JavaScript or TypeScript. | Install [`@redis-iris/agent-memory`](https://www.npmjs.com/package/@redis-iris/agent-memory) and follow the [SDK quickstart](/content/develop/ai/context-engine/agent-memory/sdk-quickstart.md). |
| REST API | You need language-independent HTTP access or don't want an SDK dependency. | No package required. Follow the [REST API quickstart](/content/develop/ai/context-engine/agent-memory/rest-api-quickstart.md). |

## Connect to a Redis Agent Memory service
Expand Down Expand Up @@ -173,8 +173,7 @@ Follow any of the client quickstarts to create and search long-term memory. For

## References

* [Python SDK quickstart](/content/develop/ai/context-engine/agent-memory/python-sdk-quickstart.md)
* [TypeScript SDK quickstart](/content/develop/ai/context-engine/agent-memory/typescript-sdk-quickstart.md)
* [SDK quickstart](/content/develop/ai/context-engine/agent-memory/sdk-quickstart.md)
* [Python SDK reference](https://pypi.org/project/redis-agent-memory/)
* [TypeScript SDK reference](https://www.npmjs.com/package/@redis-iris/agent-memory)
* [REST API quickstart](/content/develop/ai/context-engine/agent-memory/rest-api-quickstart.md)
Expand Down
2 changes: 1 addition & 1 deletion content/develop/ai/context-engine/agent-memory/rest-api-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,6 @@ See [sensitive-data exclusions](/content/operate/iris/agent-memory/create-servic

## Next steps

* Follow the [Python SDK quickstart](/content/develop/ai/context-engine/agent-memory/python-sdk-quickstart.md) or [TypeScript SDK quickstart](/content/develop/ai/context-engine/agent-memory/typescript-sdk-quickstart.md).
* Follow the [SDK quickstart](/content/develop/ai/context-engine/agent-memory/sdk-quickstart.md).
* Learn when to [create long term memories directly](/content/develop/ai/context-engine/agent-memory/developer-guide.md#create-long-term-memories).
* Use the [Redis Agent Memory API reference](/content/develop/ai/context-engine/agent-memory/api-reference.md) for endpoint and schema details.
Loading
Loading