Hindsight API参考：REST接口完整文档

Hindsight API参考REST接口完整文档【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsightHindsight是一个强大的Agent Memory系统提供了全面的REST API接口让开发者能够轻松集成持久化记忆功能到AI应用中。本文档将详细介绍Hindsight的REST API接口帮助开发者快速上手并充分利用其强大的记忆管理能力。API概述Hindsight API基于REST架构设计使用标准的HTTP方法和状态码支持JSON格式的请求和响应。所有API端点都以/v1为前缀确保版本兼容性和未来扩展性。Hindsight API的核心功能包括记忆管理存储、检索、更新、删除实体识别与关系管理观察与反思能力文档处理与文件存储审计日志与监控Hindsight API架构示意图展示了主要功能模块和数据流基础信息基础URL所有API请求的基础URL为http://your-hindsight-instance/v1认证方式Hindsight API支持通过HTTP头部进行认证Authorization: Bearer your-api-key响应格式所有API响应均采用JSON格式包含以下标准字段success: 请求是否成功data: 响应数据成功时error: 错误信息失败时request_id: 请求唯一标识符用于追踪和调试核心API端点记忆管理存储记忆端点:POST /v1/default/banks/{bank_id}/memories功能: 存储新的记忆项支持批量操作和自动事实提取请求示例:{ items: [ { content: Alice works at Google on the AI team, context: team meeting, timestamp: 2024-01-15T10:30:00Z, tags: [work, team] } ], async: false }响应示例:{ success: true, bank_id: user123, items_count: 1, async: false, usage: { input_tokens: 50, output_tokens: 20, total_tokens: 70 } }检索记忆端点:POST /v1/default/banks/{bank_id}/memories/recall功能: 根据查询检索相关记忆支持语义搜索和过滤请求示例:{ query: What does Alice do for work?, budget: mid, include: { entities: { max_tokens: 500 } } }响应示例:{ results: [ { id: 123e4567-e89b-12d3-a456-426614174000, text: Alice works at Google on the AI team, type: world, entities: [Alice, Google], context: team meeting, occurred_start: 2024-01-15T10:30:00Z } ], entities: { Alice: { canonical_name: Alice, entity_id: 123e4567-e89b-12d3-a456-426614174001, observations: [ { mentioned_at: 2024-01-15T10:30:00Z, text: Alice works at Google on the AI team } ] } } }反思与回答生成端点:POST /v1/default/banks/{bank_id}/reflect功能: 基于记忆生成回答结合上下文和实体信息请求示例:{ query: Tell me about Alices job, budget: low, include: { facts: {} } }响应示例:{ text: Alice works at Google on the AI team., based_on: { memories: [ { id: 123e4567-e89b-12d3-a456-426614174000, text: Alice works at Google on the AI team, type: world } ] }, usage: { input_tokens: 150, output_tokens: 20, total_tokens: 170 } }实体管理列出实体端点:GET /v1/default/banks/{bank_id}/entities功能: 获取记忆库中的所有实体列表支持分页和过滤请求参数:limit: 每页实体数量默认100offset: 分页偏移量默认0响应示例:{ items: [ { id: 123e4567-e89b-12d3-a456-426614174001, canonical_name: Alice, mention_count: 5, first_seen: 2024-01-15T10:30:00Z, last_seen: 2024-01-20T14:15:00Z } ], total: 1, limit: 100, offset: 0 }获取实体详情端点:GET /v1/default/banks/{bank_id}/entities/{entity_id}功能: 获取特定实体的详细信息和相关观察响应示例:{ id: 123e4567-e89b-12d3-a456-426614174001, canonical_name: Alice, mention_count: 5, first_seen: 2024-01-15T10:30:00Z, last_seen: 2024-01-20T14:15:00Z, observations: [ { text: Alice works at Google on the AI team, mentioned_at: 2024-01-15T10:30:00Z }, { text: Alice specializes in machine learning, mentioned_at: 2024-01-20T14:15:00Z } ] }文档管理上传文件并处理端点:POST /v1/default/banks/{bank_id}/files/retain功能: 上传文件并自动处理为记忆支持多种格式请求参数:files: 要上传的文件request: JSON字符串包含处理选项响应示例:{ operation_ids: [ 550e8400-e29b-41d4-a716-446655440000 ] }列出文档端点:GET /v1/default/banks/{bank_id}/documents功能: 获取记忆库中的所有文档列表响应示例:{ items: [ { id: doc_123, bank_id: user123, created_at: 2024-01-20T14:15:00Z, memory_unit_count: 10, tags: [report, Q1] } ], total: 1, limit: 100, offset: 0 }高级功能精神模型管理精神模型是Hindsight的高级功能允许创建和维护结构化的知识表示。创建精神模型:POST /v1/default/banks/{bank_id}/mental-models列出精神模型:GET /v1/default/banks/{bank_id}/mental-models刷新精神模型:POST /v1/default/banks/{bank_id}/mental-models/{model_id}/refresh审计日志Hindsight提供详细的审计日志功能记录所有关键操作列出审计日志:GET /v1/default/banks/{bank_id}/audit-logs获取审计统计:GET /v1/default/banks/{bank_id}/audit-logs/stats审计日志统计图表展示API调用趋势和操作类型分布错误处理Hindsight API使用标准HTTP状态码表示请求结果200: 请求成功400: 请求参数错误401: 未授权404: 资源不存在500: 服务器内部错误错误响应格式{ detail: [ { loc: [path, bank_id], msg: Bank not found, type: value_error } ] }快速开始要开始使用Hindsight API请按照以下步骤操作安装Hindsight: 按照官方文档安装和配置Hindsight服务获取API密钥: 在管理界面创建API密钥发送请求: 使用您喜欢的HTTP客户端发送API请求示例Python代码import requests API_KEY your-api-key BANK_ID your-bank-id BASE_URL http://your-hindsight-instance/v1 headers { Authorization: fBearer {API_KEY}, Content-Type: application/json } # 存储记忆 response requests.post( f{BASE_URL}/default/banks/{BANK_ID}/memories, headersheaders, json{ items: [ { content: Hindsight API is easy to use!, context: documentation example } ] } ) print(response.json())总结Hindsight提供了全面而强大的REST API接口使开发者能够轻松构建具有持久记忆能力的AI应用。通过本文档介绍的端点和功能您可以实现记忆存储、检索、实体管理、文档处理等核心功能。如需了解更多详细信息请参考完整的API文档或查看源代码hindsight-api/Hindsight API设计注重灵活性和可扩展性支持从简单的记忆存储到复杂的知识图谱构建满足各种AI应用的记忆需求。无论您是构建聊天机器人、智能助手还是复杂的决策系统Hindsight都能为您的AI提供可靠、高效的记忆支持。【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsight创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考