hap.types.schemas

HAP type definitions for Haive state schemas.

This module defines HAP protocol types for exposing Haive state schemas, which are the foundation of agent state management.

Classes

DocumentStateInfo	Information about document-oriented state schemas.
FieldInfo	Information about a field in a state schema.
MessagesStateInfo	Information about the common MessagesState schema.
MetaStateSchemaInfo	Information about meta-capable state schemas.
SchemaCompositionRequest	Request to compose multiple schemas.
SchemaCreationRequest	Request to create a new state schema dynamically.
SchemaDiffResult	Result of comparing two schemas.
SchemaField	Detailed field definition for schema operations.
SchemaValidationRequest	Request to validate data against a schema.
SchemaValidationResult	Result of schema validation.
StateSchemaInfo	Information about a StateSchema exposed through HAP.

Module Contents

class hap.types.schemas.DocumentStateInfo(/, **data: Any)

Bases: StateSchemaInfo

Information about document-oriented state schemas.

Parameters:

data (Any)

document_fields: list[str] = None

supports_chunking: bool = None

supports_embeddings: bool = None

class hap.types.schemas.FieldInfo(/, **data: Any)

Bases: pydantic.BaseModel

Information about a field in a state schema.

Parameters:

data (Any)

default: Any | None = None

description: str | None = None

has_reducer: bool = None

is_shared: bool = None

name: str = None

reducer_name: str | None = None

required: bool = None

type: str = None

validation_rules: list[str] = None

class hap.types.schemas.MessagesStateInfo(/, **data: Any)

Bases: StateSchemaInfo

Information about the common MessagesState schema.

Parameters:

data (Any)

has_memory_integration: bool = None

message_field_name: str = None

schema_class: Literal['MessagesState'] = 'MessagesState'

supports_message_operations: bool = None

class hap.types.schemas.MetaStateSchemaInfo(/, **data: Any)

Bases: StateSchemaInfo

Information about meta-capable state schemas.

Parameters:

data (Any)

embedded_agent_type: str | None = None

execution_tracking: bool = None

schema_class: Literal['MetaStateSchema'] = 'MetaStateSchema'

supports_agent_embedding: bool = None

supports_recompilation: bool = None

class hap.types.schemas.SchemaCompositionRequest(/, **data: Any)

Bases: pydantic.BaseModel

Request to compose multiple schemas.

Parameters:

data (Any)

composition_type: Literal['merge', 'union', 'intersection'] = None

conflict_resolution: Literal['first', 'last', 'error'] = None

name: str | None = None

schemas: list[str] = None

class hap.types.schemas.SchemaCreationRequest(/, **data: Any)

Bases: pydantic.BaseModel

Request to create a new state schema dynamically.

Parameters:

data (Any)

base_class: str = None

engine_io_mappings: dict[str, dict[str, list[str]]] | None = None

fields: list[SchemaField] = None

name: str = None

reducer_fields: dict[str, str] | None = None

shared_fields: list[str] | None = None

class hap.types.schemas.SchemaDiffResult(/, **data: Any)

Bases: pydantic.BaseModel

Result of comparing two schemas.

Parameters:

data (Any)

added_fields: list[str] = None

breaking_changes: list[str] = None

compatible: bool = None

modified_fields: dict[str, dict[str, Any]] = None

removed_fields: list[str] = None

class hap.types.schemas.SchemaField(/, **data: Any)

Bases: pydantic.BaseModel

Detailed field definition for schema operations.

Parameters:

data (Any)

default_factory: str | None = None

json_schema_extra: dict[str, Any] | None = None

name: str = None

serializer: str | None = None

type: str = None

validator: str | None = None

class hap.types.schemas.SchemaValidationRequest(/, **data: Any)

Bases: pydantic.BaseModel

Request to validate data against a schema.

Parameters:

data (Any)

data: dict[str, Any] = None

schema_name: str = None

strict: bool = None

class hap.types.schemas.SchemaValidationResult(/, **data: Any)

Bases: pydantic.BaseModel

Result of schema validation.

Parameters:

data (Any)

coerced_data: dict[str, Any] | None = None

errors: list[dict[str, Any]] = None

valid: bool = None

warnings: list[str] = None

class hap.types.schemas.StateSchemaInfo(/, **data: Any)

Bases: haive.hap.types.BaseInfo

Information about a StateSchema exposed through HAP.

Parameters:

data (Any)

base_class: str = None

engine_io_mappings: dict[str, dict[str, list[str]]] = None

fields: list[FieldInfo] = None

metadata: dict[str, Any] = None

reducer_fields: dict[str, str] = None

schema_class: str = None

shared_fields: list[str] = None

structured_models: dict[str, str] = None