@elizaos/schemas 2.0.0-alpha.10

package/eliza/v1/environment.proto

@@ -0,0 +1,91 @@
+// environment.proto - Environment types (Entity, Room, World) for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "google/protobuf/struct.proto";
+
+// Entity component - extensible data attached to entities
+message Component {
+  string id = 1;
+  string entity_id = 2;
+  string agent_id = 3;
+  string room_id = 4;
+  string world_id = 5;
+  string source_entity_id = 6;
+  string type = 7;
+  int64 created_at = 8;
+  google.protobuf.Struct data = 9;
+}
+
+// Represents an entity (user, agent, or other actor)
+message Entity {
+  // Unique identifier, optional on creation
+  optional string id = 1;
+  // Names of the entity
+  repeated string names = 2;
+  // Additional metadata
+  google.protobuf.Struct metadata = 3;
+  // Agent ID this entity is related to
+  string agent_id = 4;
+  // Optional array of components
+  repeated Component components = 5;
+}
+
+// World ownership metadata
+message WorldOwnership {
+  string owner_id = 1;
+}
+
+// World metadata
+message WorldMetadata {
+  optional WorldOwnership ownership = 1;
+  // Role assignments keyed by entity ID
+  map<string, string> roles = 2;
+  // Additional dynamic metadata
+  google.protobuf.Struct extra = 3;
+}
+
+// Represents a world (server, guild, or top-level container)
+message World {
+  string id = 1;
+  optional string name = 2;
+  string agent_id = 3;
+  optional string message_server_id = 4;
+  optional WorldMetadata metadata = 5;
+}
+
+// Room metadata (dynamic key-value pairs)
+message RoomMetadata {
+  google.protobuf.Struct values = 1;
+}
+
+// Represents a room (channel, chat, or conversation container)
+message Room {
+  string id = 1;
+  optional string name = 2;
+  optional string agent_id = 3;
+  string source = 4;
+  string type = 5;
+  optional string channel_id = 6;
+  optional string message_server_id = 7;
+  optional string world_id = 8;
+  optional RoomMetadata metadata = 9;
+}
+
+// Room participant with entity details
+message Participant {
+  string id = 1;
+  Entity entity = 2;
+}
+
+// Represents a relationship between entities
+message Relationship {
+  string id = 1;
+  string source_entity_id = 2;
+  string target_entity_id = 3;
+  string agent_id = 4;
+  repeated string tags = 5;
+  google.protobuf.Struct metadata = 6;
+  optional string created_at = 7;
+}

package/eliza/v1/events.proto

@@ -0,0 +1,235 @@
+// events.proto - Event types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/environment.proto";
+import "eliza/v1/memory.proto";
+import "eliza/v1/model.proto";
+import "eliza/v1/primitives.proto";
+import "google/protobuf/struct.proto";
+
+// Standard event types across all platforms
+enum EventType {
+  EVENT_TYPE_UNSPECIFIED = 0;
+
+  // World events
+  EVENT_TYPE_WORLD_JOINED = 1;
+  EVENT_TYPE_WORLD_CONNECTED = 2;
+  EVENT_TYPE_WORLD_LEFT = 3;
+
+  // Entity events
+  EVENT_TYPE_ENTITY_JOINED = 4;
+  EVENT_TYPE_ENTITY_LEFT = 5;
+  EVENT_TYPE_ENTITY_UPDATED = 6;
+
+  // Room events
+  EVENT_TYPE_ROOM_JOINED = 7;
+  EVENT_TYPE_ROOM_LEFT = 8;
+
+  // Message events
+  EVENT_TYPE_MESSAGE_RECEIVED = 9;
+  EVENT_TYPE_MESSAGE_SENT = 10;
+  EVENT_TYPE_MESSAGE_DELETED = 11;
+
+  // Channel events
+  EVENT_TYPE_CHANNEL_CLEARED = 12;
+
+  // Voice events
+  EVENT_TYPE_VOICE_MESSAGE_RECEIVED = 13;
+  EVENT_TYPE_VOICE_MESSAGE_SENT = 14;
+
+  // Interaction events
+  EVENT_TYPE_REACTION_RECEIVED = 15;
+  EVENT_TYPE_POST_GENERATED = 16;
+  EVENT_TYPE_INTERACTION_RECEIVED = 17;
+
+  // Run events
+  EVENT_TYPE_RUN_STARTED = 18;
+  EVENT_TYPE_RUN_ENDED = 19;
+  EVENT_TYPE_RUN_TIMEOUT = 20;
+
+  // Action events
+  EVENT_TYPE_ACTION_STARTED = 21;
+  EVENT_TYPE_ACTION_COMPLETED = 22;
+
+  // Evaluator events
+  EVENT_TYPE_EVALUATOR_STARTED = 23;
+  EVENT_TYPE_EVALUATOR_COMPLETED = 24;
+
+  // Model events
+  EVENT_TYPE_MODEL_USED = 25;
+
+  // Embedding events
+  EVENT_TYPE_EMBEDDING_GENERATION_REQUESTED = 26;
+  EVENT_TYPE_EMBEDDING_GENERATION_COMPLETED = 27;
+  EVENT_TYPE_EMBEDDING_GENERATION_FAILED = 28;
+
+  // Control events
+  EVENT_TYPE_CONTROL_MESSAGE = 29;
+}
+
+// Platform-specific event type prefix
+enum PlatformPrefix {
+  PLATFORM_PREFIX_UNSPECIFIED = 0;
+  PLATFORM_PREFIX_DISCORD = 1;
+  PLATFORM_PREFIX_TELEGRAM = 2;
+  PLATFORM_PREFIX_X = 3;
+}
+
+// Base payload interface for all events
+message EventPayload {
+  string source = 1;
+}
+
+// Payload for world-related events
+message WorldPayload {
+  string source = 1;
+  World world = 2;
+  repeated Room rooms = 3;
+  repeated Entity entities = 4;
+}
+
+// Payload for entity-related events
+message EntityPayload {
+  string source = 1;
+  string entity_id = 2;
+  optional string world_id = 3;
+  optional string room_id = 4;
+  optional EntityMetadata metadata = 5;
+}
+
+// Entity metadata for events
+message EntityMetadata {
+  string original_id = 1;
+  string username = 2;
+  optional string display_name = 3;
+  google.protobuf.Struct extra = 4;
+}
+
+// Payload for message-related events
+message MessagePayload {
+  string source = 1;
+  Memory message = 2;
+}
+
+// Payload for channel cleared events
+message ChannelClearedPayload {
+  string source = 1;
+  string room_id = 2;
+  string channel_id = 3;
+  int32 memory_count = 4;
+}
+
+// Payload for events invoked without a message
+message InvokePayload {
+  string source = 1;
+  string world_id = 2;
+  string user_id = 3;
+  string room_id = 4;
+}
+
+// Run status enumeration
+enum RunStatus {
+  RUN_STATUS_UNSPECIFIED = 0;
+  RUN_STATUS_STARTED = 1;
+  RUN_STATUS_COMPLETED = 2;
+  RUN_STATUS_TIMEOUT = 3;
+}
+
+// Payload for run events
+message RunEventPayload {
+  string source = 1;
+  string run_id = 2;
+  string message_id = 3;
+  string room_id = 4;
+  string entity_id = 5;
+  int64 start_time = 6;
+  RunStatus status = 7;
+  optional int64 end_time = 8;
+  optional int64 duration = 9;
+  optional string error = 10;
+}
+
+// Payload for action events
+message ActionEventPayload {
+  string source = 1;
+  string room_id = 2;
+  string world_id = 3;
+  Content content = 4;
+  optional string message_id = 5;
+}
+
+// Payload for evaluator events
+message EvaluatorEventPayload {
+  string source = 1;
+  string evaluator_id = 2;
+  string evaluator_name = 3;
+  optional int64 start_time = 4;
+  optional bool completed = 5;
+  optional string error = 6;
+}
+
+// Token usage for model events
+message ModelTokenUsage {
+  int32 prompt = 1;
+  int32 completion = 2;
+  int32 total = 3;
+}
+
+// Payload for model events
+message ModelEventPayload {
+  string source = 1;
+  string provider = 2;
+  ModelType type = 3;
+  string prompt = 4;
+  optional ModelTokenUsage tokens = 5;
+}
+
+// Embedding priority enumeration
+enum EmbeddingPriority {
+  EMBEDDING_PRIORITY_UNSPECIFIED = 0;
+  EMBEDDING_PRIORITY_HIGH = 1;
+  EMBEDDING_PRIORITY_NORMAL = 2;
+  EMBEDDING_PRIORITY_LOW = 3;
+}
+
+// Payload for embedding generation events
+message EmbeddingGenerationPayload {
+  string source = 1;
+  Memory memory = 2;
+  EmbeddingPriority priority = 3;
+  optional int32 retry_count = 4;
+  optional int32 max_retries = 5;
+  repeated float embedding = 6;
+  optional string error = 7;
+  optional string run_id = 8;
+}
+
+// Control message action enumeration
+enum ControlMessageAction {
+  CONTROL_MESSAGE_ACTION_UNSPECIFIED = 0;
+  CONTROL_MESSAGE_ACTION_DISABLE_INPUT = 1;
+  CONTROL_MESSAGE_ACTION_ENABLE_INPUT = 2;
+}
+
+// UI control payload
+message UIControlPayload {
+  ControlMessageAction action = 1;
+  optional string target = 2;
+  optional string reason = 3;
+  optional int32 duration = 4;
+}
+
+// Control message
+message ControlMessage {
+  string type = 1; // Always "control"
+  UIControlPayload payload = 2;
+  string room_id = 3;
+}
+
+// Payload for control message events
+message ControlMessagePayload {
+  string source = 1;
+  ControlMessage message = 2;
+}

package/eliza/v1/ipc.proto

@@ -0,0 +1,212 @@
+// ipc.proto - Inter-Process Communication types for cross-language plugin interop
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/components.proto";
+import "eliza/v1/memory.proto";
+import "eliza/v1/plugin.proto";
+import "eliza/v1/service.proto";
+import "eliza/v1/state.proto";
+import "google/protobuf/struct.proto";
+
+// Interop protocol enumeration
+enum InteropProtocol {
+  INTEROP_PROTOCOL_UNSPECIFIED = 0;
+  INTEROP_PROTOCOL_WASM = 1;
+  INTEROP_PROTOCOL_FFI = 2;
+  INTEROP_PROTOCOL_IPC = 3;
+  INTEROP_PROTOCOL_NATIVE = 4;
+}
+
+// Plugin language enumeration
+enum PluginLanguage {
+  PLUGIN_LANGUAGE_UNSPECIFIED = 0;
+  PLUGIN_LANGUAGE_TYPESCRIPT = 1;
+  PLUGIN_LANGUAGE_RUST = 2;
+  PLUGIN_LANGUAGE_PYTHON = 3;
+}
+
+// Plugin interop configuration
+message PluginInteropConfig {
+  InteropProtocol protocol = 1;
+  optional string wasm_path = 2;
+  optional string shared_lib_path = 3;
+  optional string ipc_command = 4;
+  optional int32 ipc_port = 5;
+  optional string cwd = 6;
+}
+
+// Cross-language plugin manifest
+message CrossLanguagePluginManifest {
+  string name = 1;
+  string description = 2;
+  string version = 3;
+  PluginLanguage language = 4;
+  optional PluginInteropConfig interop = 5;
+  map<string, string> config = 6;
+  repeated string dependencies = 7;
+  repeated ActionManifest actions = 8;
+  repeated ProviderManifest providers = 9;
+  repeated EvaluatorManifest evaluators = 10;
+  repeated ServiceManifest services = 11;
+  repeated RouteManifest routes = 12;
+  map<string, EventHandlerList> events = 13;
+}
+
+// Base IPC message
+message IPCMessage {
+  string type = 1;
+  string id = 2;
+}
+
+// Action invocation request
+message ActionInvokeRequest {
+  string type = 1; // "action.invoke"
+  string id = 2;
+  string action = 3;
+  Memory memory = 4;
+  optional State state = 5;
+  google.protobuf.Struct options = 6;
+}
+
+// Action result response
+message ActionResultResponse {
+  string type = 1; // "action.result"
+  string id = 2;
+  ActionResult result = 3;
+}
+
+// Action validation request
+message ActionValidateRequest {
+  string type = 1; // "action.validate"
+  string id = 2;
+  string action = 3;
+  Memory memory = 4;
+  optional State state = 5;
+}
+
+// Validation result response
+message ValidationResponse {
+  string type = 1; // "validate.result"
+  string id = 2;
+  bool valid = 3;
+}
+
+// Provider get request
+message ProviderGetRequest {
+  string type = 1; // "provider.get"
+  string id = 2;
+  string provider = 3;
+  Memory memory = 4;
+  State state = 5;
+}
+
+// Provider result response
+message ProviderResultResponse {
+  string type = 1; // "provider.result"
+  string id = 2;
+  ProviderResult result = 3;
+}
+
+// Evaluator invocation request
+message EvaluatorInvokeRequest {
+  string type = 1; // "evaluator.invoke"
+  string id = 2;
+  string evaluator = 3;
+  Memory memory = 4;
+  optional State state = 5;
+}
+
+// Service start request
+message ServiceStartRequest {
+  string type = 1; // "service.start"
+  string id = 2;
+  string service = 3;
+}
+
+// Service stop request
+message ServiceStopRequest {
+  string type = 1; // "service.stop"
+  string id = 2;
+  string service = 3;
+}
+
+// Service response
+message ServiceResponse {
+  string type = 1; // "service.response"
+  string id = 2;
+  bool success = 3;
+  optional string error = 4;
+}
+
+// Route handler request
+message RouteHandlerRequest {
+  string type = 1; // "route.handle"
+  string id = 2;
+  string path = 3;
+  string method = 4;
+  google.protobuf.Struct body = 5;
+  map<string, string> params = 6;
+  map<string, string> query = 7;
+  map<string, string> headers = 8;
+}
+
+// Route handler response
+message RouteHandlerResponse {
+  string type = 1; // "route.response"
+  string id = 2;
+  int32 status = 3;
+  map<string, string> headers = 4;
+  google.protobuf.Value body = 5;
+}
+
+// Plugin initialization request
+message PluginInitRequest {
+  string type = 1; // "plugin.init"
+  string id = 2;
+  map<string, string> config = 3;
+}
+
+// Plugin initialization response
+message PluginInitResponse {
+  string type = 1; // "plugin.init.result"
+  string id = 2;
+  bool success = 3;
+  optional string error = 4;
+}
+
+// Error response
+message ErrorResponse {
+  string type = 1; // "error"
+  string id = 2;
+  string error = 3;
+  google.protobuf.Struct details = 4;
+}
+
+// Union of all IPC request types
+message IPCRequest {
+  oneof request {
+    ActionInvokeRequest action_invoke = 1;
+    ActionValidateRequest action_validate = 2;
+    ProviderGetRequest provider_get = 3;
+    EvaluatorInvokeRequest evaluator_invoke = 4;
+    ServiceStartRequest service_start = 5;
+    ServiceStopRequest service_stop = 6;
+    RouteHandlerRequest route_handle = 7;
+    PluginInitRequest plugin_init = 8;
+  }
+}
+
+// Union of all IPC response types
+message IPCResponse {
+  oneof response {
+    ActionResultResponse action_result = 1;
+    ValidationResponse validation = 2;
+    ProviderResultResponse provider_result = 3;
+    ServiceResponse service = 4;
+    RouteHandlerResponse route = 5;
+    PluginInitResponse plugin_init = 6;
+    ErrorResponse error = 7;
+  }
+}

package/eliza/v1/knowledge.proto

@@ -0,0 +1,25 @@
+// knowledge.proto - Knowledge types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/memory.proto";
+import "eliza/v1/primitives.proto";
+
+// Represents a single item of knowledge stored by the agent.
+message KnowledgeRecord {
+  // Unique identifier for the knowledge item (UUID string).
+  string id = 1;
+  // Content of the knowledge item.
+  Content content = 2;
+  // Optional metadata associated with this knowledge item.
+  optional MemoryMetadata metadata = 3;
+}
+
+// Directory-based knowledge source configuration.
+message DirectoryItem {
+  // Path to a directory containing knowledge files.
+  string directory = 1;
+  // Whether this knowledge is shared across characters.
+  optional bool shared = 2;
+}

package/eliza/v1/memory.proto

@@ -0,0 +1,91 @@
+// memory.proto - Memory types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/primitives.proto";
+import "google/protobuf/struct.proto";
+
+// Base memory metadata
+message BaseMetadata {
+  string type = 1;
+  optional string source = 2;
+  optional string source_id = 3;
+  optional string scope = 4;
+  optional int64 timestamp = 5;
+  repeated string tags = 6;
+}
+
+// Document-specific metadata
+message DocumentMetadata {
+  BaseMetadata base = 1;
+}
+
+// Fragment-specific metadata
+message FragmentMetadata {
+  BaseMetadata base = 1;
+  string document_id = 2;
+  int32 position = 3;
+}
+
+// Message-specific metadata
+message MessageMetadata {
+  BaseMetadata base = 1;
+  optional string trajectory_step_id = 2;
+  optional string benchmark_context = 3;
+}
+
+// Description-specific metadata
+message DescriptionMetadata {
+  BaseMetadata base = 1;
+}
+
+// Custom metadata with dynamic properties
+message CustomMetadata {
+  BaseMetadata base = 1;
+  google.protobuf.Struct custom_data = 2;
+}
+
+// Union of all memory metadata types
+message MemoryMetadata {
+  oneof metadata {
+    DocumentMetadata document = 1;
+    FragmentMetadata fragment = 2;
+    MessageMetadata message = 3;
+    DescriptionMetadata description = 4;
+    CustomMetadata custom = 5;
+  }
+}
+
+// Represents a stored memory/message
+message Memory {
+  // Optional unique identifier
+  optional string id = 1;
+  // Associated entity ID
+  string entity_id = 2;
+  // Associated agent ID
+  optional string agent_id = 3;
+  // Optional creation timestamp in milliseconds since epoch
+  optional int64 created_at = 4;
+  // Memory content
+  Content content = 5;
+  // Optional embedding vector for semantic search
+  repeated float embedding = 6;
+  // Associated room ID
+  string room_id = 7;
+  // Associated world ID (optional)
+  optional string world_id = 8;
+  // Whether memory is unique (used to prevent duplicates)
+  optional bool unique = 9;
+  // Embedding similarity score (set when retrieved via search)
+  optional float similarity = 10;
+  // Metadata for the memory
+  optional MemoryMetadata metadata = 11;
+}
+
+// Specialized memory type for messages with enhanced type checking
+message MessageMemory {
+  Memory memory = 1;
+  // Note: In proto, we can't enforce that content.text is required
+  // This should be validated at the application layer
+}

package/eliza/v1/message_service.proto

@@ -0,0 +1,48 @@
+// message_service.proto - Message processing types for elizaOS
+syntax = "proto3";
+
+package eliza.v1;
+
+import "eliza/v1/memory.proto";
+import "eliza/v1/primitives.proto";
+import "eliza/v1/state.proto";
+
+// Model type configuration for shouldRespond evaluation.
+enum ShouldRespondModelType {
+  SHOULD_RESPOND_MODEL_TYPE_UNSPECIFIED = 0;
+  SHOULD_RESPOND_MODEL_TYPE_SMALL = 1;
+  SHOULD_RESPOND_MODEL_TYPE_LARGE = 2;
+}
+
+// Configuration options for message processing.
+message MessageProcessingOptions {
+  optional int32 max_retries = 1;
+  optional int64 timeout_duration = 2;
+  optional bool use_multi_step = 3;
+  optional int32 max_multi_step_iterations = 4;
+  optional ShouldRespondModelType should_respond_model = 5;
+}
+
+// Processing mode used by message handler.
+enum MessageProcessingMode {
+  MESSAGE_PROCESSING_MODE_UNSPECIFIED = 0;
+  MESSAGE_PROCESSING_MODE_SIMPLE = 1;
+  MESSAGE_PROCESSING_MODE_ACTIONS = 2;
+  MESSAGE_PROCESSING_MODE_NONE = 3;
+}
+
+// Result of message processing.
+message MessageProcessingResult {
+  bool did_respond = 1;
+  optional Content response_content = 2;
+  repeated Memory response_messages = 3;
+  State state = 4;
+  optional MessageProcessingMode mode = 5;
+}
+
+// Response decision from the shouldRespond logic.
+message ResponseDecision {
+  bool should_respond = 1;
+  bool skip_evaluation = 2;
+  string reason = 3;
+}