@elizaos/schemas 2.0.0-alpha.10

package/eliza/v1/messaging.proto

@@ -0,0 +1,67 @@
+// messaging.proto - Messaging types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/memory.proto";
+import "eliza/v1/primitives.proto";
+
+// Socket message type enumeration
+enum SocketMessageType {
+  SOCKET_MESSAGE_TYPE_UNSPECIFIED = 0;
+  SOCKET_MESSAGE_TYPE_ROOM_JOINING = 1;
+  SOCKET_MESSAGE_TYPE_SEND_MESSAGE = 2;
+  SOCKET_MESSAGE_TYPE_MESSAGE = 3;
+  SOCKET_MESSAGE_TYPE_ACK = 4;
+  SOCKET_MESSAGE_TYPE_THINKING = 5;
+  SOCKET_MESSAGE_TYPE_CONTROL = 6;
+}
+
+// Target information for message routing
+message TargetInfo {
+  string source = 1;
+  optional string room_id = 2;
+  optional string channel_id = 3;
+  optional string server_id = 4;
+  optional string entity_id = 5;
+  optional string thread_id = 6;
+}
+
+// Message stream chunk payload
+message MessageStreamChunkPayload {
+  string message_id = 1;
+  string chunk = 2;
+  int32 index = 3;
+  string channel_id = 4;
+  string agent_id = 5;
+}
+
+// Message stream error payload
+message MessageStreamErrorPayload {
+  string message_id = 1;
+  string channel_id = 2;
+  string agent_id = 3;
+  string error = 4;
+  optional string partial_text = 5;
+}
+
+// Handler options for async message processing
+message MessageHandlerOptions {
+  // Note: Callbacks cannot be represented in proto
+  // These should be handled at the application layer
+}
+
+// Result of sending a message to an agent
+message MessageResult {
+  string message_id = 1;
+  optional Memory user_message = 2;
+  repeated Content agent_responses = 3;
+  optional MessageUsage usage = 4;
+}
+
+// Usage information for billing
+message MessageUsage {
+  int32 input_tokens = 1;
+  int32 output_tokens = 2;
+  string model = 3;
+}

package/eliza/v1/model.proto

@@ -0,0 +1,183 @@
+// model.proto - Model types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// LLM Mode for overriding model selection
+enum LLMMode {
+  LLM_MODE_UNSPECIFIED = 0;
+  LLM_MODE_DEFAULT = 1; // Use the model type as specified
+  LLM_MODE_SMALL = 2; // Override to use TEXT_SMALL
+  LLM_MODE_LARGE = 3; // Override to use TEXT_LARGE
+}
+
+// Model type enumeration
+enum ModelType {
+  MODEL_TYPE_UNSPECIFIED = 0;
+  MODEL_TYPE_TEXT_SMALL = 1;
+  MODEL_TYPE_TEXT_LARGE = 2;
+  MODEL_TYPE_TEXT_EMBEDDING = 3;
+  MODEL_TYPE_TEXT_TOKENIZER_ENCODE = 4;
+  MODEL_TYPE_TEXT_TOKENIZER_DECODE = 5;
+  MODEL_TYPE_TEXT_REASONING_SMALL = 6;
+  MODEL_TYPE_TEXT_REASONING_LARGE = 7;
+  MODEL_TYPE_TEXT_COMPLETION = 8;
+  MODEL_TYPE_IMAGE = 9;
+  MODEL_TYPE_IMAGE_DESCRIPTION = 10;
+  MODEL_TYPE_TRANSCRIPTION = 11;
+  MODEL_TYPE_TEXT_TO_SPEECH = 12;
+  MODEL_TYPE_AUDIO = 13;
+  MODEL_TYPE_VIDEO = 14;
+  MODEL_TYPE_OBJECT_SMALL = 15;
+  MODEL_TYPE_OBJECT_LARGE = 16;
+}
+
+// Response format specification
+message ResponseFormat {
+  string type = 1; // "json_object" | "text"
+}
+
+// Parameters for generating text using a language model
+message GenerateTextParams {
+  string prompt = 1;
+  optional int32 max_tokens = 2;
+  optional int32 min_tokens = 3;
+  optional double temperature = 4;
+  optional double top_p = 5;
+  optional int32 top_k = 6;
+  optional double min_p = 7;
+  optional int32 seed = 8;
+  optional double repetition_penalty = 9;
+  optional double frequency_penalty = 10;
+  optional double presence_penalty = 11;
+  repeated string stop_sequences = 12;
+  optional string user = 13;
+  optional ResponseFormat response_format = 14;
+  optional bool stream = 15;
+}
+
+// Token usage information
+message TokenUsage {
+  int32 prompt_tokens = 1;
+  int32 completion_tokens = 2;
+  int32 total_tokens = 3;
+}
+
+// Text stream chunk
+message TextStreamChunk {
+  string text = 1;
+  bool done = 2;
+}
+
+// Options for the simplified generateText API
+message GenerateTextOptions {
+  optional bool include_character = 1;
+  ModelType model_type = 2;
+  optional int32 max_tokens = 3;
+  optional double temperature = 4;
+  optional double frequency_penalty = 5;
+  optional double presence_penalty = 6;
+  repeated string stop_sequences = 7;
+}
+
+// Structured response from text generation
+message GenerateTextResult {
+  string text = 1;
+  optional TokenUsage usage = 2;
+}
+
+// Parameters for text tokenization
+message TokenizeTextParams {
+  string prompt = 1;
+  ModelType model_type = 2;
+}
+
+// Parameters for detokenization
+message DetokenizeTextParams {
+  repeated int32 tokens = 1;
+  ModelType model_type = 2;
+}
+
+// Parameters for text embedding
+message TextEmbeddingParams {
+  string text = 1;
+}
+
+// Parameters for image generation
+message ImageGenerationParams {
+  string prompt = 1;
+  optional string size = 2;
+  optional int32 count = 3;
+}
+
+// Parameters for image description
+message ImageDescriptionParams {
+  string image_url = 1;
+  optional string prompt = 2;
+}
+
+// Image description result
+message ImageDescriptionResult {
+  string title = 1;
+  string description = 2;
+}
+
+// Parameters for transcription
+message TranscriptionParams {
+  string audio_url = 1;
+  optional string prompt = 2;
+}
+
+// Parameters for text-to-speech
+message TextToSpeechParams {
+  string text = 1;
+  optional string voice = 2;
+  optional double speed = 3;
+}
+
+// Parameters for audio processing
+message AudioProcessingParams {
+  string audio_url = 1;
+  string processing_type = 2;
+}
+
+// Parameters for video processing
+message VideoProcessingParams {
+  string video_url = 1;
+  string processing_type = 2;
+}
+
+// JSON Schema for object generation
+message JSONSchema {
+  string type = 1;
+  map<string, JSONSchema> properties = 2;
+  repeated string required = 3;
+  optional JSONSchema items = 4;
+  google.protobuf.Struct extra = 5;
+}
+
+// Parameters for object generation
+message ObjectGenerationParams {
+  string prompt = 1;
+  optional JSONSchema schema = 2;
+  optional string output = 3; // "object" | "array" | "enum"
+  repeated string enum_values = 4;
+  ModelType model_type = 5;
+  optional double temperature = 6;
+  optional int32 max_tokens = 7;
+  repeated string stop_sequences = 8;
+}
+
+// Image generation result
+message ImageGenerationResult {
+  string url = 1;
+}
+
+// Model handler registration info
+message ModelHandlerInfo {
+  string provider = 1;
+  optional int32 priority = 2;
+  optional int32 registration_order = 3;
+}

package/eliza/v1/payment.proto

@@ -0,0 +1,45 @@
+// payment.proto - x402 payment schema types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Payment configuration definition for x402-enabled routes
+message PaymentConfigDefinition {
+  string network = 1;
+  string asset_namespace = 2;
+  string asset_reference = 3;
+  string payment_address = 4;
+  string symbol = 5;
+  optional string chain_id = 6;
+}
+
+// x402 configuration for a paid route
+message X402Config {
+  uint32 price_in_cents = 1;
+  repeated string payment_configs = 2;
+}
+
+// x402 "accepts" entry describing payment terms
+message X402Accepts {
+  string scheme = 1;
+  string network = 2;
+  string max_amount_required = 3;
+  string resource = 4;
+  string description = 5;
+  string mime_type = 6;
+  string pay_to = 7;
+  uint32 max_timeout_seconds = 8;
+  string asset = 9;
+  optional google.protobuf.Struct output_schema = 10;
+  optional google.protobuf.Struct extra = 11;
+}
+
+// x402 payment-required response payload
+message X402Response {
+  uint32 x402_version = 1;
+  optional string error = 2;
+  repeated X402Accepts accepts = 3;
+  optional string payer = 4;
+}

package/eliza/v1/plugin.proto

@@ -0,0 +1,94 @@
+// plugin.proto - Plugin types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/agent.proto";
+import "eliza/v1/components.proto";
+import "eliza/v1/service.proto";
+import "google/protobuf/struct.proto";
+import "eliza/v1/payment.proto";
+
+// HTTP method enumeration for routes
+enum HttpMethod {
+  HTTP_METHOD_UNSPECIFIED = 0;
+  HTTP_METHOD_GET = 1;
+  HTTP_METHOD_POST = 2;
+  HTTP_METHOD_PUT = 3;
+  HTTP_METHOD_PATCH = 4;
+  HTTP_METHOD_DELETE = 5;
+  HTTP_METHOD_STATIC = 6;
+}
+
+// Route manifest for plugin routes
+message RouteManifest {
+  HttpMethod method = 1;
+  string path = 2;
+  optional string name = 3;
+  optional bool public = 4;
+  optional bool is_multipart = 5;
+  optional string file_path = 6;
+  optional X402Config x402 = 7;
+}
+
+// JSON Schema type definition for component validation
+message JSONSchemaDefinition {
+  string type = 1; // "string" | "number" | "boolean" | "object" | "array" | "null"
+  map<string, JSONSchemaDefinition> properties = 2;
+  optional JSONSchemaDefinition items = 3;
+  repeated string required = 4;
+  repeated string enum_values = 5;
+  optional string description = 6;
+}
+
+// Component type definition for entity components
+message ComponentTypeDefinition {
+  string name = 1;
+  JSONSchemaDefinition schema = 2;
+}
+
+// Plugin manifest (metadata for cross-language interop)
+message PluginManifest {
+  string name = 1;
+  string description = 2;
+
+  // Plugin configuration
+  map<string, string> config = 3;
+
+  // Component definitions
+  repeated ActionManifest actions = 4;
+  repeated ProviderManifest providers = 5;
+  repeated EvaluatorManifest evaluators = 6;
+  repeated ServiceManifest services = 7;
+  repeated RouteManifest routes = 8;
+  repeated ComponentTypeDefinition component_types = 9;
+
+  // Event handlers keyed by event type
+  map<string, EventHandlerList> events = 10;
+
+  // Dependencies
+  repeated string dependencies = 11;
+  repeated string test_dependencies = 12;
+
+  // Priority for plugin ordering
+  optional int32 priority = 13;
+
+  // Custom schema for plugin-specific configuration
+  google.protobuf.Struct schema = 14;
+}
+
+// List of event handler names
+message EventHandlerList {
+  repeated string handlers = 1;
+}
+
+// Project agent configuration
+message ProjectAgentManifest {
+  Character character = 1;
+  repeated string plugins = 2;
+}
+
+// Project manifest
+message ProjectManifest {
+  repeated ProjectAgentManifest agents = 1;
+}

package/eliza/v1/primitives.proto

@@ -0,0 +1,94 @@
+// primitives.proto - Core primitive types for elizaOS
+// Single source of truth for TypeScript, Python, and Rust
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// UUID string type (format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
+// Note: Proto doesn't have a native UUID type, so we use string
+// Validation should be done at the application layer
+message UUID {
+  string value = 1;
+}
+
+// The default/nil UUID used when no room or world is specified
+// Value: 00000000-0000-0000-0000-000000000000
+// Using a constant message pattern for language interop
+message DefaultUUID {
+  string value = 1; // Always "00000000-0000-0000-0000-000000000000"
+}
+
+// Represents a media attachment
+message Media {
+  // Unique identifier
+  string id = 1;
+  // Media URL
+  string url = 2;
+  // Media title
+  optional string title = 3;
+  // Media source
+  optional string source = 4;
+  // Media description
+  optional string description = 5;
+  // Text content
+  optional string text = 6;
+  // Content type (e.g. "image", "video", "audio", "document", "link")
+  optional string content_type = 7;
+}
+
+// Platform-provided metadata about mentions
+// Contains ONLY technical facts from the platform API
+message MentionContext {
+  // Platform native mention (@Discord, @Telegram, etc.)
+  bool is_mention = 1;
+  // Reply to agent's message
+  bool is_reply = 2;
+  // In a thread with agent
+  bool is_thread = 3;
+  // Platform-specific mention type for debugging/logging
+  optional string mention_type = 4; // "platform_mention" | "reply" | "thread" | "none"
+}
+
+// Represents the content of a memory, message, or other information.
+// Primary data structure for messages exchanged between users, agents, and the system.
+message Content {
+  // The agent's internal thought process
+  optional string thought = 1;
+  // The main text content visible to users
+  optional string text = 2;
+  // Actions to be performed
+  repeated string actions = 3;
+  // Providers to use for context generation
+  repeated string providers = 4;
+  // Source/origin of the content (e.g., 'discord', 'telegram')
+  optional string source = 5;
+  // Target/destination for responses
+  optional string target = 6;
+  // URL of the original message/post
+  optional string url = 7;
+  // UUID of parent message if this is a reply/thread
+  optional string in_reply_to = 8;
+  // Array of media attachments
+  repeated Media attachments = 9;
+  // Channel type where this content was sent
+  optional string channel_type = 10;
+  // Platform-provided metadata about mentions
+  optional MentionContext mention_context = 11;
+  // Internal message ID used for streaming coordination
+  optional string response_message_id = 12;
+  // Response ID for message tracking
+  optional string response_id = 13;
+  // Whether this is a simple response (no actions required)
+  optional bool simple = 14;
+  // Type marker for internal use
+  optional string type = 15;
+  // Additional dynamic properties for plugin extensions
+  google.protobuf.Struct data = 16;
+}
+
+// Generic metadata type (JSON-serializable key-value pairs)
+message Metadata {
+  google.protobuf.Struct values = 1;
+}

package/eliza/v1/prompts.proto

@@ -0,0 +1,43 @@
+// prompts.proto - Prompt-related data structures for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Information about a field for prompt building.
+message PromptFieldInfo {
+  string id = 1;
+  string type = 2;
+  string label = 3;
+  optional string description = 4;
+  optional string criteria = 5;
+}
+
+// Options for building a prompt from a template.
+message BuildPromptOptions {
+  // Template string (function templates are runtime-only).
+  string template = 1;
+  // State values to substitute into the template.
+  google.protobuf.Struct state = 2;
+  // Optional default values for template variables.
+  map<string, string> defaults = 3;
+}
+
+// Result of building a prompt from a template.
+message BuiltPrompt {
+  string prompt = 1;
+  optional string system = 2;
+  repeated string substituted_variables = 3;
+  repeated string missing_variables = 4;
+}
+
+// Configuration for a prompt template.
+message PromptTemplateConfig {
+  string template = 1;
+  string name = 2;
+  optional string description = 3;
+  map<string, string> defaults = 4;
+  repeated string required_variables = 5;
+  repeated string optional_variables = 6;
+}

package/eliza/v1/service.proto

@@ -0,0 +1,43 @@
+// service.proto - Service types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Service type enumeration
+enum ServiceType {
+  SERVICE_TYPE_UNSPECIFIED = 0;
+  SERVICE_TYPE_TRANSCRIPTION = 1;
+  SERVICE_TYPE_VIDEO = 2;
+  SERVICE_TYPE_BROWSER = 3;
+  SERVICE_TYPE_PDF = 4;
+  SERVICE_TYPE_REMOTE_FILES = 5; // aws_s3
+  SERVICE_TYPE_WEB_SEARCH = 6;
+  SERVICE_TYPE_EMAIL = 7;
+  SERVICE_TYPE_TEE = 8;
+  SERVICE_TYPE_TASK = 9;
+  SERVICE_TYPE_WALLET = 10;
+  SERVICE_TYPE_LP_POOL = 11;
+  SERVICE_TYPE_TOKEN_DATA = 12;
+  SERVICE_TYPE_MESSAGE_SERVICE = 13;
+  SERVICE_TYPE_MESSAGE = 14;
+  SERVICE_TYPE_POST = 15;
+  SERVICE_TYPE_UNKNOWN = 16;
+}
+
+// Service manifest (metadata only, for cross-language interop)
+message ServiceManifest {
+  ServiceType type = 1;
+  optional string description = 2;
+  optional string capability_description = 3;
+  google.protobuf.Struct config = 4;
+}
+
+// Standardized service error type
+message ServiceError {
+  string code = 1;
+  string message = 2;
+  google.protobuf.Struct details = 3;
+  optional string cause = 4;
+}