# AveniECA Python SDK

## Docs

- [Working with Aggregates](https://mintlify.wiki/aveni-hub/avenieca-python/advanced/aggregates.md): Learn how to create and manage aggregate ESS from multiple state vectors
- [Best Practices](https://mintlify.wiki/aveni-hub/avenieca-python/advanced/best-practices.md): Production-ready patterns for building robust AveniECA applications
- [Embeddings and Vector Search](https://mintlify.wiki/aveni-hub/avenieca-python/advanced/embeddings-search.md): Learn how to use embeddings for semantic search across ESS and documents
- [Advanced Predictions](https://mintlify.wiki/aveni-hub/avenieca-python/advanced/predictions.md): Deep dive into Cortex predictions and interpreting results
- [Authentication](https://mintlify.wiki/aveni-hub/avenieca-python/api/authentication.md): Configure authentication for the AveniECA API
- [Cortex (Predictions)](https://mintlify.wiki/aveni-hub/avenieca-python/api/cortex.md): Use the Cortex API to predict next states
- [Documents](https://mintlify.wiki/aveni-hub/avenieca-python/api/documents.md): Manage documents in AveniECA
- [Embeddings](https://mintlify.wiki/aveni-hub/avenieca-python/api/embeddings.md): Manage embedding inputs in AveniECA
- [Error Handling](https://mintlify.wiki/aveni-hub/avenieca-python/api/error-handling.md): Handle errors in the AveniECA API
- [ESS (Episodic State Storage)](https://mintlify.wiki/aveni-hub/avenieca-python/api/ess.md): Manage episodic state storage in AveniECA
- [REST API Overview](https://mintlify.wiki/aveni-hub/avenieca-python/api/overview.md): Overview of the AveniECA REST API client
- [Retrieval](https://mintlify.wiki/aveni-hub/avenieca-python/api/retrieval.md): Query documents using natural language
- [Sequences](https://mintlify.wiki/aveni-hub/avenieca-python/api/sequences.md): Manage sequences in AveniECA
- [Digital Twins](https://mintlify.wiki/aveni-hub/avenieca-python/concepts/digital-twins.md): Understanding digital twins and their role in the AveniECA framework
- [Modules](https://mintlify.wiki/aveni-hub/avenieca-python/concepts/modules.md): Understanding modules, organization, and aggregates in AveniECA
- [Overview](https://mintlify.wiki/aveni-hub/avenieca-python/concepts/overview.md): Understanding the AveniECA framework and the ECA model
- [Signals](https://mintlify.wiki/aveni-hub/avenieca-python/concepts/signals.md): Understanding the Signal data structure and state representation in AveniECA
- [Installation](https://mintlify.wiki/aveni-hub/avenieca-python/installation.md): Install and configure the AveniECA Python SDK
- [Introduction](https://mintlify.wiki/aveni-hub/avenieca-python/introduction.md): Python SDK for streaming state and interacting with AveniECA instances
- [Quickstart](https://mintlify.wiki/aveni-hub/avenieca-python/quickstart.md): Get started with AveniECA streaming and REST API
- [API Configuration](https://mintlify.wiki/aveni-hub/avenieca-python/reference/api-config.md): Configure authentication credentials for the AveniECA API
- [Broker Configuration](https://mintlify.wiki/aveni-hub/avenieca-python/reference/broker-config.md): Configure Kafka broker settings for real-time signal streaming
- [Consumer](https://mintlify.wiki/aveni-hub/avenieca-python/reference/consumer.md): API reference for the Consumer class
- [Cortex API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/cortex-api.md): Make predictions using the Cortex prediction engine
- [Document API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/document-api.md): Manage documents for retrieval and embedding
- [ECA](https://mintlify.wiki/aveni-hub/avenieca-python/reference/eca.md): Main client for the AveniECA Python SDK
- [Embedding API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/embedding-api.md): Manage embedding inputs that map states to human-readable values
- [ESS API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/ess-api.md): Manage twins and aggregates in the Embodied State Space
- [Event](https://mintlify.wiki/aveni-hub/avenieca-python/reference/event.md): API reference for the Event producer class
- [Hash Utilities](https://mintlify.wiki/aveni-hub/avenieca-python/reference/hash-utils.md): Generate secure hashes for embedding inputs and data integrity
- [Data Models](https://mintlify.wiki/aveni-hub/avenieca-python/reference/models.md): Complete reference for all data models in the AveniECA Python SDK
- [Response API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/response-api.md): Retrieve stored prediction responses
- [Retrieval API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/retrieval-api.md): Query documents using natural language
- [Sequence API](https://mintlify.wiki/aveni-hub/avenieca-python/reference/sequence-api.md): Manage sequences of twins and aggregates over time
- [Signal](https://mintlify.wiki/aveni-hub/avenieca-python/reference/signal.md): Data structure representing a signal in the AveniECA system
- [Signal Utilities](https://mintlify.wiki/aveni-hub/avenieca-python/reference/signal-utils.md): Utility functions for processing and validating signal state data
- [Stream](https://mintlify.wiki/aveni-hub/avenieca-python/reference/stream.md): API reference for the Stream producer class
- [Broker Configuration](https://mintlify.wiki/aveni-hub/avenieca-python/streaming/configuration.md): Kafka broker configuration for producers and consumers
- [Consumer](https://mintlify.wiki/aveni-hub/avenieca-python/streaming/consumer.md): Consuming and processing messages from Kafka topics
- [Event Producer](https://mintlify.wiki/aveni-hub/avenieca-python/streaming/event-producer.md): Event-driven publishing for on-demand signal transmission
- [Kafka Streaming Overview](https://mintlify.wiki/aveni-hub/avenieca-python/streaming/overview.md): Understanding Kafka streaming in AveniECA - producers, consumers, and architecture
- [Stream Producer](https://mintlify.wiki/aveni-hub/avenieca-python/streaming/stream-producer.md): Continuous streaming with automatic sync rate timing

## OpenAPI Specs

- [openapi](https://mintlify.wiki/aveni-hub/avenieca-python/api-reference/openapi.json)