hap.types.engines

HAP type definitions for Haive engines.

This module defines HAP protocol types for exposing Haive engine configurations and capabilities through the protocol.

Classes

AugLLMConfigInfo	Information about AugLLMConfig engine.
DocumentEngineInfo	Information about document processing engines.
EngineCapability	Describes a specific capability of an engine.
EngineExecutionRequest	Request to execute an engine.
EngineExecutionResult	Result from engine execution.
EngineInfo	Information about a Haive engine exposed through HAP.
RetrieverEngineInfo	Information about retriever engines.
ToolEngineInfo	Information about tool engines.
VectorStoreEngineInfo	Information about vector store engines.

Module Contents

class hap.types.engines.AugLLMConfigInfo(/, **data: Any)

Bases: EngineInfo

Information about AugLLMConfig engine.

Parameters:

data (Any)

engine_type: Literal['LLM'] = 'LLM'

has_prompt_template: bool = None

has_structured_output: bool = None

has_tools: bool = None

llm_provider: str | None = None

max_tokens: int | None = None

model: str | None = None

structured_output_model: str | None = None

system_message: str | None = None

temperature: float | None = None

tool_count: int = None

class hap.types.engines.DocumentEngineInfo(/, **data: Any)

Bases: EngineInfo

Information about document processing engines.

Parameters:

data (Any)

engine_type: Literal['DOCUMENT'] = 'DOCUMENT'

loader_types: list[str] = None

splitter_types: list[str] = None

transformer_types: list[str] = None

class hap.types.engines.EngineCapability(/, **data: Any)

Bases: pydantic.BaseModel

Describes a specific capability of an engine.

Parameters:

data (Any)

description: str = None

name: str = None

output_fields: list[str] = None

parameters: dict[str, Any] = None

required_fields: list[str] = None

class hap.types.engines.EngineExecutionRequest(/, **data: Any)

Bases: pydantic.BaseModel

Request to execute an engine.

Parameters:

data (Any)

capability: str | None = None

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

engine_name: str = None

input_data: dict[str, Any] = None

class hap.types.engines.EngineExecutionResult(/, **data: Any)

Bases: pydantic.BaseModel

Result from engine execution.

Parameters:

data (Any)

duration_ms: float | None = None

error: str | None = None

metadata: dict[str, Any] = None

result: Any | None = None

status: Literal['success', 'error'] = None

class hap.types.engines.EngineInfo(/, **data: Any)

Bases: haive.hap.types.BaseInfo

Information about a Haive engine exposed through HAP.

Engines are configuration/factory classes that create runtime objects. This captures their metadata and capabilities.

Parameters:

data (Any)

capabilities: list[str] = None

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

engine_class: str = None

engine_type: str = None

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

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

version: str = None

class hap.types.engines.RetrieverEngineInfo(/, **data: Any)

Bases: EngineInfo

Information about retriever engines.

Parameters:

data (Any)

embedding_model: str | None = None

engine_type: Literal['RETRIEVER'] = 'RETRIEVER'

retriever_type: str = None

search_kwargs: dict[str, Any] = None

vector_store_type: str | None = None

class hap.types.engines.ToolEngineInfo(/, **data: Any)

Bases: EngineInfo

Information about tool engines.

Parameters:

data (Any)

engine_type: Literal['TOOL'] = 'TOOL'

tool_names: list[str] = None

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

class hap.types.engines.VectorStoreEngineInfo(/, **data: Any)

Bases: EngineInfo

Information about vector store engines.

Parameters:

data (Any)

collection_name: str | None = None

document_count: int | None = None

embedding_dimensions: int | None = None

engine_type: Literal['VECTORSTORE'] = 'VECTORSTORE'

store_type: str = None