Expand description
Core types (requests, responses, errors). Core types used throughout the A.R.E.S server.
This module contains all the common data structures used for:
- API requests and responses
- Agent configuration and context
- Memory and user preferences
- Tool definitions and calls
- RAG (Retrieval Augmented Generation)
- Authentication
- Error handling
Structs§
- Agent
Context - Context passed to agents during request processing.
- Chat
Request - Request payload for chat endpoints.
- Chat
Response - Response from chat endpoints.
- Claims
- JWT claims embedded in access tokens.
- Document
- A document in the RAG knowledge base.
- Document
Metadata - Metadata associated with a document.
- Login
Request - Request payload for user login.
- Memory
Fact - A fact learned about a user.
- Message
- A single message in a conversation.
- Preference
- A user preference entry.
- RagDelete
Collection Request - Request to delete a collection.
- RagDelete
Collection Response - Response from collection deletion.
- RagIngest
Request - Request to ingest a document into the RAG system.
- RagIngest
Response - Response from document ingestion.
- RagSearch
Request - Request to search the RAG system.
- RagSearch
Response - Response from RAG search.
- RagSearch
Result - Single search result.
- Register
Request - Request payload for user registration.
- Research
Request - Request payload for deep research endpoints.
- Research
Response - Response from deep research endpoints.
- Search
Filter - A filter to apply during search.
- Search
Query - Query parameters for semantic search.
- Search
Result - A single search result with relevance score.
- Source
- A source reference used in responses.
- Token
Response - Response containing authentication tokens.
- Tool
Call - A request to call a tool.
- Tool
Definition - Definition of a tool that can be called by an LLM.
- Tool
Result - Result from executing a tool.
- User
Memory - User memory containing preferences and learned facts.
- Workflow
Request - Request payload for workflow execution endpoints.
Enums§
- Agent
Type - Available agent types in the system.
- AppError
- Application-wide error type.
- Error
Code - Error codes for programmatic error handling. These are stable identifiers that clients can use to handle specific error cases.
- Message
Role - Role of a message sender in a conversation.
Type Aliases§
- Result
- A specialized Result type for A.R.E.S operations.