Skip to content
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.

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

Add support: MemoryExport API #2129

Merged
merged 8 commits into from
Jan 9, 2025
Merged

Add support: MemoryExport API #2129

merged 8 commits into from
Jan 9, 2025

Conversation

Dev-Khant
Copy link
Member

Description

Add support for a new API: MemoryExport. This helps in extracting memories into a structured format based on pydantic schema provided.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Made sure Checks passed

@Dev-Khant Dev-Khant changed the title Add support: MemoryExport Add support: MemoryExport API Jan 9, 2025
---
title: 'Get Memory Export'
openapi: get /v1/exports/
---
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to add some description here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openapi: post /v1/exports/
---

Create a structured export of memories based on a provided Pydantic schema. This feature allows you to extract memories in a structured format that matches your schema definition. The export will consider `all memories` that match the parameters you provide, such as `user_id`, `agent_id`, `run_id`, or `session_id`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Submit a job to create a structured export of memories using a customizable Pydantic schema. This process may take some time to complete, especially if you’re exporting a large number of memories. You can tailor the export by applying various filters (e.g., user_id, agent_id, run_id, or session_id) and by modifying the Pydantic schema to ensure the final data matches your exact needs.

docs/openapi.json Outdated Show resolved Hide resolved
Co-authored-by: Deshraj Yadav <[email protected]>
@Dev-Khant Dev-Khant merged commit 21854c6 into main Jan 9, 2025
5 checks passed
@deshraj deshraj deleted the user/dev/memoryexport branch January 9, 2025 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants