Peer Paradigm Documentation (#133)
* new layout boilerplate * feat: new sdk documentation * feat: features documentation * fix (docs): Update API Reference * chore (mintlify): Upgrade mintlify * fix (docs): titles * feat: glossary of terms * feat (docs): Add Contextual Menu * chore: clean up architecture.mdx * chore: remove old/unused files, clean up architecture/intro * fix: use `id` over `name` in curl requests * chore: nits on faq * chore: refactor mermaid * feat: quickstart * chore: quickstart doc casing + info about dialectic response * chore: update discord spellbook * chore: update streaming-response, dialectic-endpoint, remove old simple-memory * chore: ts everywhere, update guided tutorial * add get context, search spellbooks * chore: rm faq page * fix contribution page * feat: platform overview and screen grabs * add get context to features * chore: fix self-hosting page * chore: move deriver description into architecture, flesh it out, stub out dialectic architecture * add versioning to docs * quickstart reformat and links * fix v1 api reference * chore: rm deriver from docs sidebar * chore: fix internal links * add sdk changelog and update latest release to 2.0.0 for api changelog * glossary updates and icons * ♻️ Feat: layout for architecture page feat: layout reformat for architecture page * fix changelog * ✨ Feat: vibe coder one-shot prompts feat: vibe coder one-shot prompts * chore: align get context text to spellbook * condense changelog pages * feat: add working-rep spellbook * chore: rename Changelog group * chore: Code Rabbit Suggestions * fix (docs): Update Changelog and API Reference Introduction * fix: remove accordion from glossary * feat: document new filtering system * feat: add telegram bot guide (using new template repo) * checkpoint * Docs MVP * chore (docs): Code Rabbit * Reorganization --------- Co-authored-by: Erosika <eri@plasticlabs.ai> Co-authored-by: Benjamin McCormick <docterformer@protonmail.com> Co-authored-by: Rajat Ahuja <rahuja445@gmail.com>
This commit is contained in:
Vineeth Voruganti
GitHub
parent
c36d2ac449
commit
326ea24955
|
|
@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||
- Internal metadata to store Honcho's state no longer exposed in API
|
||||
- Batch message operations and enhanced message querying with token and message count limits
|
||||
- Search and summary functionalities scoped by workspace, peer, and session
|
||||
- Ability to search message histories using semantic search with cosine
|
||||
similarity
|
||||
- Session context retrieval with summaries and token allocation
|
||||
- HNSW Index for Documents Table
|
||||
- Centralized Configuration via Environment Variables or `config.toml` file
|
||||
|
|
@ -36,6 +38,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||
- Queue processing now works on 'work units' instead of sessions
|
||||
- Message token counting updated with tiktoken integration and fallback heuristic
|
||||
- Queue and message processing updated to handle sender/target and task types for multi-peer scenarios
|
||||
- Resource filtering expanded to include logical operators
|
||||
|
||||
### Fixed
|
||||
|
||||
|
|
|
|||
29
README.md
29
README.md
|
|
@ -1,13 +1,13 @@
|
|||
# 🫡 Honcho
|
||||
|
||||
|
||||
|
||||
[](https://discord.gg/plasticlabs)
|
||||
[](https://arxiv.org/abs/2310.06983)
|
||||
|
||||
|
||||
[](https://twitter.com/plastic_labs)
|
||||
[](https://pypi.org/project/honcho-ai/)
|
||||
[](https://npmjs.org/package/honcho-ai)
|
||||
[](https://npmjs.org/package/@honcho-ai/sdk)
|
||||
|
||||
Honcho is an infrastructure layer for building AI agents with social cognition and theory-of-mind capabilities. It enables developers to create AI agents and LLM-powered applications that are personalized to their end users by leveraging the inherent theory-of-mind capabilities of LLMs to build coherent models of user psychology over time.
|
||||
|
||||
|
|
@ -41,13 +41,26 @@ The Honcho project is split between several repositories with this one hosting
|
|||
the core service logic. This is implemented as a FastAPI server/API to store
|
||||
data about an application's state.
|
||||
|
||||
There are also client-sdks that are created using
|
||||
[Stainless](https://www.stainlessapi.com/). Currently, there is a [Python](https://github.com/plastic-labs/honcho-python) and
|
||||
[TypeScript/JavaScript](https://github.com/plastic-labs/honcho-node) SDK available.
|
||||
There are also client sdks in implemented in the `sdks/` directory with support
|
||||
for Python and TypeScript. These SDKs wrap core SDKs that are generated using
|
||||
[Stainless](https://www.stainlessapi.com/).
|
||||
|
||||
Examples on how to use the SDK are located within each SDK repository. There is
|
||||
also SDK example usage available in the [API Reference](https://docs.honcho.dev/api-reference/introduction)
|
||||
along with various guides.
|
||||
- [Python](https://pypi.org/project/honcho-ai/)
|
||||
- [TypeScript](https://www.npmjs.com/package/@honcho-ai/sdk)
|
||||
|
||||
We recommend using the official client SDKs instead of the core ones for better
|
||||
developer experience, however for any custom use cases you can still access the
|
||||
core SDKs in their own repos:
|
||||
|
||||
[Honcho Core Python](https://github.com/plastic-labs/honcho-python-core)
|
||||
[Honcho Core TypeScript](https://github.com/plastic-labs/honcho-node-core)
|
||||
|
||||
Examples on how to use the SDK are located within each SDK folder and in the
|
||||
[SDK Reference](https://docs.honcho.dev/v2/documentation/tutorial/SDK)
|
||||
|
||||
There are also documented examples of how to use the core SDKs in the
|
||||
[API Reference](https://docs.honcho.dev/api-reference/introduction) section of
|
||||
the documentation.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: "SDK and API Compatibility Guide"
|
||||
description: "Compatibility guide for Honcho's SDKs and API"
|
||||
icon: "shield-check"
|
||||
---
|
||||
|
||||
This guide helps you understand which versions of Honcho's API are compatible with which SDK versions.
|
||||
|
||||
## Version Compatibility
|
||||
|
||||
### Honcho API v2.0.0 (Current)
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="TypeScript SDK" icon="js">
|
||||
**Compatible Version:** v1.0.2
|
||||
|
||||
Install with:
|
||||
```bash
|
||||
npm install @honcho-ai/sdk@1.0.2
|
||||
```
|
||||
</Card>
|
||||
|
||||
<Card title="Python SDK" icon="python">
|
||||
**Compatible Version:** v1.0.2
|
||||
|
||||
Install with:
|
||||
```bash
|
||||
pip install honcho-ai==1.0.2
|
||||
```
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Version Compatibility Table
|
||||
|
||||
| Honcho API Version | TypeScript SDK | Python SDK | Notes |
|
||||
|-------------------|---------------|------------|-------|
|
||||
| v2.0.0 (Current) | v1.0.2 | v1.0.2 | Full compatibility with new peer architecture |
|
||||
|
|
@ -0,0 +1,142 @@
|
|||
---
|
||||
title: "Changelog"
|
||||
icon: "clock-rotate-left"
|
||||
---
|
||||
|
||||
Welcome to the Honcho changelog! This section documents all notable changes to the Honcho API and SDKs.
|
||||
|
||||
|
||||
<Accordion title="How to Read This Changelog">
|
||||
Each release is documented with:
|
||||
|
||||
- **Added**: New features and capabilities
|
||||
- **Changed**: Modifications to existing functionality
|
||||
- **Deprecated**: Features that will be removed in future versions
|
||||
- **Removed**: Features that have been removed
|
||||
- **Fixed**: Bug fixes and corrections
|
||||
- **Security**: Security-related improvements
|
||||
|
||||
## Version Format
|
||||
|
||||
Honcho follows [Semantic Versioning](https://semver.org/):
|
||||
- **MAJOR** version for incompatible API changes
|
||||
- **MINOR** version for backwards-compatible functionality additions
|
||||
- **PATCH** version for backwards-compatible bug fixes
|
||||
</Accordion>
|
||||
|
||||
### Honcho API and SDK Changelogs
|
||||
<Tabs>
|
||||
<Tab title="Honcho API">
|
||||
<Update label="v2.0.0 (Current)">
|
||||
### Added
|
||||
|
||||
- Ability to get a peer's working representation
|
||||
- Metadata to all data primitives (Workspaces, Peers, Sessions, Messages)
|
||||
- Internal metadata to store Honcho's state no longer exposed in API
|
||||
- Batch message operations and enhanced message querying with token and message count limits
|
||||
- Search and summary functionalities scoped by workspace, peer, and session
|
||||
- Ability to search message histories using semantic search with cosine
|
||||
similarity
|
||||
- Session context retrieval with summaries and token allocatio
|
||||
- HNSW Index for Documents Table
|
||||
- Centralized Configuration via Environment Variables or config.toml file
|
||||
|
||||
### Changed
|
||||
|
||||
- New architecture centered around the concept of a "peer" replaces the former
|
||||
"app"/"user"/"session" paradigm
|
||||
- Workspaces replace "apps" as top-level namespace
|
||||
- Peers replace "users"
|
||||
- Sessions no longer nested beneath peers and no longer limited to a single
|
||||
user-assistant model. A session exists independently of any one peer and
|
||||
peers can be added to and removed from sessions.
|
||||
- Dialectic API is now part of the Peer, not the Session
|
||||
- Dialectic API now allows queries to be scoped to a session or "targeted"
|
||||
to a fellow peer
|
||||
- Database schema migrated to adopt workspace/peer/session naming and structure
|
||||
- Authentication and JWT scopes updated to workspace/peer/session hierarchy
|
||||
- Queue processing now works on 'work units' instead of sessions
|
||||
- Message token counting updated with tiktoken integration and fallback heuristic
|
||||
- Queue and message processing updated to handle sender/target and task types for multi-peer scenarios
|
||||
- Resource filtering expanded to include logical operators
|
||||
|
||||
### Fixed
|
||||
|
||||
- Improved error handling and validation for batch message operations and metadata
|
||||
- Database Sessions to be more atomic to reduce idle in transaction time
|
||||
|
||||
### Removed
|
||||
|
||||
- Metamessages removed in favor of metadata
|
||||
- Collections and Documents no longer exposed in the API, solely internal
|
||||
- Obsolete tests for apps, users, collections, documents, and metamessages
|
||||
---
|
||||
</Update>
|
||||
|
||||
<Update label="v1.1.0">
|
||||
### Added
|
||||
|
||||
- Normalize resources to remove joins and increase query performance
|
||||
- Query tracing for debugging
|
||||
|
||||
### Changed
|
||||
|
||||
- `/list` endpoints to not require a request body
|
||||
- `metamessage_type` to `label` with backwards compatability
|
||||
- Database Provisioning to rely on alembic
|
||||
- Database Session Manager to explicitly rollback transactions before closing
|
||||
the connection
|
||||
|
||||
### Fixed
|
||||
|
||||
- Alembic Migrations to include initial database migrations
|
||||
- Sentry Middleware to not report Honcho Exceptions
|
||||
</Update>
|
||||
|
||||
<Update label="v1.0.0">
|
||||
### Added
|
||||
|
||||
- JWT based API authentication
|
||||
- Configurable logging
|
||||
- Consolidated LLM Inference via `ModelClient` class
|
||||
- Dynamic logging configurable via environment variables
|
||||
|
||||
### Changed
|
||||
|
||||
- Deriver & Dialectic API to use Hybrid Memory Architecture
|
||||
- Metamessages are not strictly tied to a message
|
||||
- Database provisioning is a separate script instead of happening on startup
|
||||
- Consolidated `session/chat` and `session/chat/stream` endpoints
|
||||
</Update>
|
||||
|
||||
## Previous Releases
|
||||
|
||||
For a complete history of all releases, see our [GitHub Releases](https://github.com/plastic-labs/honcho/tags) page.
|
||||
</Tab>
|
||||
|
||||
<Tab title="Python SDK">
|
||||
[Python SDK](https://pypi.org/project/honcho-ai/)
|
||||
<Update label="v1.0.2 (Current)">
|
||||
### Fixed
|
||||
|
||||
- Properly handle AsyncClient
|
||||
</Update>
|
||||
</Tab>
|
||||
|
||||
<Tab title="TypeScript SDK">
|
||||
[TypeScript SDK](https://www.npmjs.com/package/@honcho-ai/sdk)
|
||||
<Update label="v1.0.2 (Current)">
|
||||
### Fixed
|
||||
|
||||
- Create default workspace on Honcho client instantiation
|
||||
- Simplified Honcho client import path
|
||||
</Update>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you encounter issues using the Honcho API or its SDKs:
|
||||
|
||||
1. Open an issue on [GitHub](https://github.com/plastic-labs/honcho/issues)
|
||||
2. Join our [Discord community](http://discord.gg/plasticlabs) for support
|
||||
|
|
@ -0,0 +1,359 @@
|
|||
{
|
||||
"$schema": "https://mintlify.com/docs.json",
|
||||
"theme": "mint",
|
||||
"name": "Honcho",
|
||||
"colors": {
|
||||
"primary": "#FF5A7E",
|
||||
"light": "#FF5A7E",
|
||||
"dark": "#FF5A7E"
|
||||
},
|
||||
"favicon": "/favicon.svg",
|
||||
"contextual": {
|
||||
"options": ["copy", "view", "chatgpt", "claude"]
|
||||
},
|
||||
"navigation": {
|
||||
"versions": [
|
||||
{
|
||||
"version": "v2.0.0",
|
||||
"api": {
|
||||
"openapi": ["openapi.documented.yml"]
|
||||
},
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Introduction",
|
||||
"pages": [
|
||||
"v2/documentation/introduction/overview",
|
||||
"v2/documentation/introduction/quickstart"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Core Concepts",
|
||||
"pages": [
|
||||
"v2/documentation/core-concepts/glossary",
|
||||
"v2/documentation/core-concepts/architecture",
|
||||
"v2/documentation/core-concepts/features"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Tutorial",
|
||||
"pages": [
|
||||
"v2/documentation/tutorial/overview",
|
||||
"v2/documentation/tutorial/guided-tutorial",
|
||||
"v2/documentation/tutorial/sdk"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Spellbooks",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": [
|
||||
"v2/guides/overview",
|
||||
"v2/guides/ai-assisted-setup",
|
||||
"v2/guides/mcp"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Application Interfaces",
|
||||
"pages": ["v2/guides/discord", "v2/guides/telegram"]
|
||||
},
|
||||
{
|
||||
"group": "Design Patterns",
|
||||
"pages": [
|
||||
"v2/guides/dialectic-endpoint",
|
||||
"v2/guides/get-context",
|
||||
"v2/guides/search",
|
||||
"v2/guides/working-rep",
|
||||
"v2/guides/streaming-response",
|
||||
"v2/guides/using-filters"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Contributing",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"v2/contributing/guidelines",
|
||||
"v2/contributing/self-hosting",
|
||||
"v2/contributing/configuration",
|
||||
"v2/contributing/license"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "API Reference",
|
||||
"groups": [
|
||||
{
|
||||
"group": "API Documentation",
|
||||
"pages": ["v2/api-reference/introduction"]
|
||||
},
|
||||
{
|
||||
"group": "workspaces",
|
||||
"pages": [
|
||||
"v2/api-reference/endpoint/workspaces/get-or-create-workspace",
|
||||
"v2/api-reference/endpoint/workspaces/get-all-workspaces",
|
||||
"v2/api-reference/endpoint/workspaces/update-workspace",
|
||||
"v2/api-reference/endpoint/workspaces/search-workspace"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "peers",
|
||||
"pages": [
|
||||
"v2/api-reference/endpoint/peers/get-peers",
|
||||
"v2/api-reference/endpoint/peers/get-or-create-peer",
|
||||
"v2/api-reference/endpoint/peers/update-peer",
|
||||
"v2/api-reference/endpoint/peers/get-sessions-for-peer",
|
||||
"v2/api-reference/endpoint/peers/chat",
|
||||
"v2/api-reference/endpoint/peers/create-messages-for-peer",
|
||||
"v2/api-reference/endpoint/peers/get-messages-for-peer",
|
||||
"v2/api-reference/endpoint/peers/get-working-representation",
|
||||
"v2/api-reference/endpoint/peers/search-peer"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "sessions",
|
||||
"pages": [
|
||||
"v2/api-reference/endpoint/sessions/get-or-create-session",
|
||||
"v2/api-reference/endpoint/sessions/get-sessions",
|
||||
"v2/api-reference/endpoint/sessions/update-session",
|
||||
"v2/api-reference/endpoint/sessions/delete-session",
|
||||
"v2/api-reference/endpoint/sessions/clone-session",
|
||||
"v2/api-reference/endpoint/sessions/get-session-peers",
|
||||
"v2/api-reference/endpoint/sessions/set-session-peers",
|
||||
"v2/api-reference/endpoint/sessions/add-peers-to-session",
|
||||
"v2/api-reference/endpoint/sessions/remove-peers-from-session",
|
||||
"v2/api-reference/endpoint/sessions/get-peer-config",
|
||||
"v2/api-reference/endpoint/sessions/set-peer-config",
|
||||
"v2/api-reference/endpoint/sessions/get-session-context",
|
||||
"v2/api-reference/endpoint/sessions/search-session"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "messages",
|
||||
"pages": [
|
||||
"v2/api-reference/endpoint/messages/create-messages-for-session",
|
||||
"v2/api-reference/endpoint/messages/get-messages",
|
||||
"v2/api-reference/endpoint/messages/get-message",
|
||||
"v2/api-reference/endpoint/messages/update-message"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "keys",
|
||||
"pages": ["v2/api-reference/endpoint/keys/create-key"]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Changelog",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Overview",
|
||||
"pages": [
|
||||
"changelog/introduction",
|
||||
"changelog/compatibility-guide"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "v1.1.0",
|
||||
"api": {
|
||||
"openapi": ["openapi.json"]
|
||||
},
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "Documentation",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Get Started",
|
||||
"pages": [
|
||||
"v1/getting-started/introduction",
|
||||
"v1/getting-started/quickstart",
|
||||
"v1/getting-started/architecture"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"v1/contributing/guidelines",
|
||||
"v1/contributing/self-hosting",
|
||||
"v1/contributing/deploying",
|
||||
"v1/contributing/license"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Spellbooks and Tutorials",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": ["v1/guides/overview", "v1/guides/streaming-response"]
|
||||
},
|
||||
{
|
||||
"group": "Application Interfaces",
|
||||
"pages": ["v1/guides/discord", "v1/guides/honcho-mcp"]
|
||||
},
|
||||
{
|
||||
"group": "Personal Memory",
|
||||
"pages": ["v1/guides/dialectic-endpoint"]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "API Reference",
|
||||
"groups": [
|
||||
{
|
||||
"group": "API Documentation",
|
||||
"pages": ["v1/api-reference/introduction"]
|
||||
},
|
||||
{
|
||||
"group": "apps",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/apps/get-app",
|
||||
"v1/api-reference/endpoint/apps/get-all-apps",
|
||||
"v1/api-reference/endpoint/apps/update-app",
|
||||
"v1/api-reference/endpoint/apps/get-app-by-name",
|
||||
"v1/api-reference/endpoint/apps/create-app",
|
||||
"v1/api-reference/endpoint/apps/get-or-create-app"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "sessions",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/sessions/get-sessions",
|
||||
"v1/api-reference/endpoint/sessions/create-session",
|
||||
"v1/api-reference/endpoint/sessions/get-session",
|
||||
"v1/api-reference/endpoint/sessions/update-session",
|
||||
"v1/api-reference/endpoint/sessions/delete-session",
|
||||
"v1/api-reference/endpoint/sessions/chat",
|
||||
"v1/api-reference/endpoint/sessions/clone-session"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "users",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/users/get-users",
|
||||
"v1/api-reference/endpoint/users/create-user",
|
||||
"v1/api-reference/endpoint/users/get-user-by-name",
|
||||
"v1/api-reference/endpoint/users/get-user",
|
||||
"v1/api-reference/endpoint/users/get-or-create-user",
|
||||
"v1/api-reference/endpoint/users/update-user"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "messages",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/messages/get-messages",
|
||||
"v1/api-reference/endpoint/messages/create-message-for-session",
|
||||
"v1/api-reference/endpoint/messages/create-batch-messages-for-session",
|
||||
"v1/api-reference/endpoint/messages/get-message",
|
||||
"v1/api-reference/endpoint/messages/update-message"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "keys",
|
||||
"pages": ["v1/api-reference/endpoint/keys/create-key"]
|
||||
},
|
||||
{
|
||||
"group": "metamessages",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/metamessages/create-metamessage",
|
||||
"v1/api-reference/endpoint/metamessages/get-metamessages",
|
||||
"v1/api-reference/endpoint/metamessages/get-metamessage",
|
||||
"v1/api-reference/endpoint/metamessages/update-metamessage"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "collections",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/collections/get-collections",
|
||||
"v1/api-reference/endpoint/collections/create-collection",
|
||||
"v1/api-reference/endpoint/collections/get-collection-by-name",
|
||||
"v1/api-reference/endpoint/collections/get-collection",
|
||||
"v1/api-reference/endpoint/collections/update-collection",
|
||||
"v1/api-reference/endpoint/collections/delete-collection"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "documents",
|
||||
"pages": [
|
||||
"v1/api-reference/endpoint/documents/get-documents",
|
||||
"v1/api-reference/endpoint/documents/create-document",
|
||||
"v1/api-reference/endpoint/documents/get-document",
|
||||
"v1/api-reference/endpoint/documents/update-document",
|
||||
"v1/api-reference/endpoint/documents/delete-document",
|
||||
"v1/api-reference/endpoint/documents/query-documents"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"tab": "Changelog",
|
||||
"groups": [
|
||||
{
|
||||
"group": "Overview",
|
||||
"pages": [
|
||||
"changelog/introduction",
|
||||
"changelog/compatibility-guide"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"global": {
|
||||
"anchors": [
|
||||
{
|
||||
"anchor": "Managed Platform",
|
||||
"href": "https://app.honcho.dev",
|
||||
"icon": "book-open-cover"
|
||||
},
|
||||
{
|
||||
"anchor": "Community",
|
||||
"href": "https://discord.gg/honcho",
|
||||
"icon": "discord"
|
||||
},
|
||||
{
|
||||
"anchor": "Blog",
|
||||
"href": "https://blog.plasticlabs.ai",
|
||||
"icon": "newspaper"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"logo": {
|
||||
"light": "/logo/honcho-dark.svg",
|
||||
"dark": "/logo/honcho-light.svg"
|
||||
},
|
||||
"navbar": {
|
||||
"primary": {
|
||||
"type": "github",
|
||||
"href": "https://github.com/plastic-labs/honcho"
|
||||
}
|
||||
},
|
||||
"footer": {
|
||||
"socials": {
|
||||
"twitter": "https://twitter.com/plastic_labs",
|
||||
"github": "https://github.com/plastic-labs",
|
||||
"linkedin": "https://www.linkedin.com/company/plasticlabs"
|
||||
}
|
||||
},
|
||||
"integrations": {
|
||||
"posthog": {
|
||||
"apiKey": "phc_1yrzzcgywqXGcerkkI4g7C0YfyPMcAKNOOvGcjTCiUk"
|
||||
}
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 172 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 160 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 211 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 665 KiB |
169
docs/mint.json
169
docs/mint.json
|
|
@ -1,169 +0,0 @@
|
|||
{
|
||||
"$schema": "https://mintlify.com/schema.json",
|
||||
"name": "Honcho",
|
||||
"logo": {
|
||||
"dark": "/logo/honcho-light.svg",
|
||||
"light": "/logo/honcho-dark.svg"
|
||||
},
|
||||
"favicon": "/favicon.svg",
|
||||
"colors": {
|
||||
"primary": "#FF5A7E",
|
||||
"light": "#FF5A7E",
|
||||
"dark": "#FF5A7E",
|
||||
"anchors": {
|
||||
"from": "#FF5A7E",
|
||||
"to": "#FF5A7E"
|
||||
}
|
||||
},
|
||||
"topbarCtaButton": {
|
||||
"type": "github",
|
||||
"url": "https://github.com/plastic-labs/honcho"
|
||||
},
|
||||
"tabs": [
|
||||
{
|
||||
"name": "Guides",
|
||||
"url": "guides"
|
||||
},
|
||||
{
|
||||
"name": "API Reference",
|
||||
"url": "api-reference"
|
||||
}
|
||||
],
|
||||
"anchors": [
|
||||
{
|
||||
"name": "Community",
|
||||
"icon": "discord",
|
||||
"url": "https://discord.gg/plasticlabs"
|
||||
},
|
||||
{
|
||||
"name": "Blog",
|
||||
"icon": "newspaper",
|
||||
"url": "https://blog.plasticlabs.ai"
|
||||
}
|
||||
],
|
||||
"navigation": [
|
||||
{
|
||||
"group": "Get Started",
|
||||
"pages": [
|
||||
"getting-started/introduction",
|
||||
"getting-started/quickstart",
|
||||
"getting-started/architecture"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contributing",
|
||||
"pages": [
|
||||
"contributing/guidelines",
|
||||
"contributing/self-hosting",
|
||||
"contributing/deploying",
|
||||
"contributing/license"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Getting Started",
|
||||
"pages": ["guides/overview", "guides/streaming-response"]
|
||||
},
|
||||
{
|
||||
"group": "Application Interfaces",
|
||||
"pages": ["guides/discord", "guides/honcho-mcp"]
|
||||
},
|
||||
{
|
||||
"group": "Personal Memory",
|
||||
"pages": ["guides/dialectic-endpoint"]
|
||||
},
|
||||
{
|
||||
"group": "API Documentation",
|
||||
"pages": ["api-reference/introduction"]
|
||||
},
|
||||
{
|
||||
"group": "apps",
|
||||
"pages": [
|
||||
"api-reference/endpoint/apps/get-app",
|
||||
"api-reference/endpoint/apps/get-all-apps",
|
||||
"api-reference/endpoint/apps/update-app",
|
||||
"api-reference/endpoint/apps/get-app-by-name",
|
||||
"api-reference/endpoint/apps/create-app",
|
||||
"api-reference/endpoint/apps/get-or-create-app"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "users",
|
||||
"pages": [
|
||||
"api-reference/endpoint/users/get-users",
|
||||
"api-reference/endpoint/users/create-user",
|
||||
"api-reference/endpoint/users/get-user-by-name",
|
||||
"api-reference/endpoint/users/get-user",
|
||||
"api-reference/endpoint/users/get-or-create-user",
|
||||
"api-reference/endpoint/users/update-user"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "sessions",
|
||||
"pages": [
|
||||
"api-reference/endpoint/sessions/get-sessions",
|
||||
"api-reference/endpoint/sessions/create-session",
|
||||
"api-reference/endpoint/sessions/get-session",
|
||||
"api-reference/endpoint/sessions/update-session",
|
||||
"api-reference/endpoint/sessions/delete-session",
|
||||
"api-reference/endpoint/sessions/chat",
|
||||
"api-reference/endpoint/sessions/clone-session"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "messages",
|
||||
"pages": [
|
||||
"api-reference/endpoint/messages/get-messages",
|
||||
"api-reference/endpoint/messages/create-message-for-session",
|
||||
"api-reference/endpoint/messages/create-batch-messages-for-session",
|
||||
"api-reference/endpoint/messages/get-message",
|
||||
"api-reference/endpoint/messages/update-message"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "metamessages",
|
||||
"pages": [
|
||||
"api-reference/endpoint/metamessages/create-metamessage",
|
||||
"api-reference/endpoint/metamessages/get-metamessages",
|
||||
"api-reference/endpoint/metamessages/get-metamessage",
|
||||
"api-reference/endpoint/metamessages/update-metamessage"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "collections",
|
||||
"pages": [
|
||||
"api-reference/endpoint/collections/get-collections",
|
||||
"api-reference/endpoint/collections/create-collection",
|
||||
"api-reference/endpoint/collections/get-collection-by-name",
|
||||
"api-reference/endpoint/collections/get-collection",
|
||||
"api-reference/endpoint/collections/update-collection",
|
||||
"api-reference/endpoint/collections/delete-collection"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "documents",
|
||||
"pages": [
|
||||
"api-reference/endpoint/documents/get-documents",
|
||||
"api-reference/endpoint/documents/create-document",
|
||||
"api-reference/endpoint/documents/get-document",
|
||||
"api-reference/endpoint/documents/update-document",
|
||||
"api-reference/endpoint/documents/delete-document",
|
||||
"api-reference/endpoint/documents/query-documents"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "keys",
|
||||
"pages": ["api-reference/endpoint/keys/create-key"]
|
||||
}
|
||||
],
|
||||
"footerSocials": {
|
||||
"twitter": "https://twitter.com/plastic_labs",
|
||||
"github": "https://github.com/plastic-labs",
|
||||
"linkedin": "https://www.linkedin.com/company/plasticlabs"
|
||||
},
|
||||
"openapi": ["/openapi.json"],
|
||||
"analytics": {
|
||||
"posthog": {
|
||||
"apiKey": "phc_1yrzzcgywqXGcerkkI4g7C0YfyPMcAKNOOvGcjTCiUk"
|
||||
}
|
||||
}
|
||||
}
|
||||
3475
docs/openapi.json
3475
docs/openapi.json
File diff suppressed because it is too large
Load Diff
|
|
@ -4,15 +4,18 @@
|
|||
"description": "## Setting Up `honcho-docs` Locally",
|
||||
"main": ".pnp.js",
|
||||
"scripts": {
|
||||
"dev": "mintlify dev",
|
||||
"dev": "mint dev",
|
||||
"openapi": "npx @mintlify/scraping openapi-file openapi.json -o api-reference/endpoint",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@mintlify/scraping": "^3.0.92",
|
||||
"@mintlify/scraping": "^3.0.189",
|
||||
"honcho-ai": "^0.0.11",
|
||||
"mintlify": "^4.0.531"
|
||||
"mintlify": "^4.1.96"
|
||||
},
|
||||
"devDependencies": {
|
||||
"mint": "^4.1.96"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
1861
docs/pnpm-lock.yaml
1861
docs/pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1 @@
|
|||
This subdirectory contains the app/user/session paradigm documentation for Honcho (Honcho v1.1.0).
|
||||
|
|
@ -4,7 +4,7 @@ title: 'Introduction'
|
|||
|
||||
This section of the documentation goes over all of the different API endpoints available in the Honcho
|
||||
Server. They largely map to CRUD operations for each of the core primitives. For information about the core
|
||||
primitives consult [Architecture](/getting-started/Architecture)
|
||||
primitives consult [Architecture](/v1/getting-started/architecture)
|
||||
|
||||
<Warning>
|
||||
This part of the documentation is autogenerated for the most up to date and accurate API spec view the
|
||||
|
|
@ -95,4 +95,4 @@ Repeat step 3.
|
|||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)
|
||||
Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/introduction)
|
||||
|
|
@ -24,14 +24,14 @@ Get started below!
|
|||
<Card
|
||||
title="Quickstart"
|
||||
icon="bolt"
|
||||
href="/getting-started/quickstart"
|
||||
href="/v1/getting-started/quickstart"
|
||||
>
|
||||
Quickly set up a local environment to interface with the Honcho API
|
||||
</Card>
|
||||
<Card
|
||||
title="Architecture"
|
||||
icon="building"
|
||||
href="/getting-started/architecture"
|
||||
href="/v1/getting-started/architecture"
|
||||
>
|
||||
Get an overview of the different primitives and structure of Honcho
|
||||
</Card>
|
||||
|
|
@ -130,4 +130,4 @@ for await (const session of honcho.apps.users.sessions.list(app.id, user.id)) {
|
|||
|
||||
This is a super simple overview of how to get up and running with the Honcho SDK. We covered the basic methods for reading and writing from the hosted storage service. Next, we'll cover alternative forms of hosting Honcho.
|
||||
|
||||
For a more detailed look at the SDK check out the SDK reference [here](/api-reference).
|
||||
For a more detailed look at the SDK check out the SDK reference [here](/v1/api-reference).
|
||||
|
|
@ -154,7 +154,7 @@ def get_session(user_id, location_id, create=False):
|
|||
|
||||
# Query for *active* sessions with both user_id and location_id
|
||||
sessions_iter = honcho.apps.users.sessions.list(
|
||||
app_id=app.id, user_id=user_id, reverse=True, is_active=True
|
||||
app_id=app.id, user_id=user_id, reverse=True, filter={"is_active": True}
|
||||
)
|
||||
sessions = list(session for session in sessions_iter)
|
||||
|
||||
|
|
@ -175,7 +175,7 @@ def get_session(user_id, location_id, create=False):
|
|||
return None, False
|
||||
```
|
||||
|
||||
You can see the `list` method on the sessions object similarly returns an iterable. This is a common pattern in Honcho--use list comprehension to create your new python list. Then loop through those session objects to find the appropriate `location_id` in the metadata, and if none are found then create a new session. You'll also notice we list messages in `reverse=True` order--this means you will get the most recent ones first. We also support native filtering by active sessions.
|
||||
You can see the `list` method on the sessions object similarly returns an iterable. This is a common pattern in Honcho--use list comprehension to create your new python list. Then loop through those session objects to find the appropriate `location_id` in the metadata, and if none are found then create a new session. You'll also notice we list messages in `reverse=True` order--this means you will get the most recent ones first. We also support native filtering by active sessions and any other fields or user-defined metadata on the session object.
|
||||
|
||||
The next helper function we create is called `llm`. This simplifies constructing the chat message object we're going to send to the inference provider.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1 @@
|
|||
This subdirectory contains the peer-paradigm documentation for Honcho (Honcho v2.0.0 onwards).
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/keys
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/sessions/{session_id}/messages/
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: get /v1/workspaces/{workspace_id}/sessions/{session_id}/messages/{message_id}
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/sessions/{session_id}/messages/list
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: put /v1/workspaces/{workspace_id}/sessions/{session_id}/messages/{message_id}
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/chat
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/messages
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/messages/list
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/list
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/sessions
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/representation
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/peers/{peer_id}/search
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: put /v1/workspaces/{workspace_id}/peers/{peer_id}
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/sessions/{session_id}/peers
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: get /v1/workspaces/{workspace_id}/sessions/{session_id}/clone
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: delete /v1/workspaces/{workspace_id}/sessions/{session_id}
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/sessions
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: get /v1/workspaces/{workspace_id}/sessions/{session_id}/peers/{peer_id}/config
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: get /v1/workspaces/{workspace_id}/sessions/{session_id}/context
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: get /v1/workspaces/{workspace_id}/sessions/{session_id}/peers
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
openapi: post /v1/workspaces/{workspace_id}/sessions/list
|
||||
---
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue