mirror of
https://github.com/smkrv/ha-text-ai.git
synced 2026-07-22 07:03:58 +08:00
SMKRV
a8a91972ba
Phase A — Critical: - Remove dual timeout stacking in coordinator._send_to_api - Add Gemini-specific asyncio.timeout (sync SDK via to_thread) - Store full text in history for context; cap per-field at 32KB on disk - Fix instance lookup to match by normalized_name - Add Bearer/sk-/x-api-key credential sanitization patterns Phase B — Dead code removal: - Merge async_ask_question/async_process_question into single method - Remove dead is_anthropic flag from coordinator and __init__ - Remove unused DEFAULT_TIMEOUT and API_TIMEOUT constants - Remove redundant _create_history_dir calls - Consolidate async_check_api to use provider registry Phase C — Config flow correctness: - Truncate name before uniqueness check (prevent post-truncation collisions) - Add async_set_unique_id + _abort_if_unique_id_configured - Extract shared _build_parameter_schema for ConfigFlow/OptionsFlow dedup Phase D — UX improvements: - Optimize history write: serialize from memory, single file write - Show last 5 history entries in sensor attributes (was 1) - Return actual error type in ask_question service response - Add dedicated api_key_required error for provider/endpoint changes - Pass config_entry to DataUpdateCoordinator (HA 2024.8+) Phase E — Cleanup: - Extract _apply_structured_output for OpenAI/DeepSeek dedup - Reduce ABSOLUTE_MAX_HISTORY_SIZE to 200 with Final annotation - Remove dead translation keys (queued, invalid_characters) - Migrate to _attr_has_entity_name = True - Add from __future__ import annotations to all modules - Remove redundant api_status sensor attribute - Add missing translation keys (last_model, last_timestamp, etc.) Review agent fixes: - Add archive file cleanup (max 3 archives) to prevent disk exhaustion - Per-entry storage cap (32KB per field) for history on disk
169 lines
5.5 KiB
Python
169 lines
5.5 KiB
Python
"""
|
|
Constants for the HA text AI integration.
|
|
|
|
@license: CC BY-NC-SA 4.0 International
|
|
@author: SMKRV
|
|
@github: https://github.com/smkrv/ha-text-ai
|
|
@source: https://github.com/smkrv/ha-text-ai
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
from typing import Final
|
|
from homeassistant.const import Platform
|
|
|
|
# Domain and platforms
|
|
DOMAIN: Final = "ha_text_ai"
|
|
PLATFORMS: list[Platform] = [Platform.SENSOR]
|
|
|
|
# Provider configuration
|
|
CONF_API_PROVIDER: Final = "api_provider"
|
|
API_PROVIDER_OPENAI: Final = "openai"
|
|
API_PROVIDER_ANTHROPIC: Final = "anthropic"
|
|
API_PROVIDER_DEEPSEEK: Final = "deepseek"
|
|
API_PROVIDER_GEMINI: Final = "gemini"
|
|
|
|
API_PROVIDERS: Final = [
|
|
API_PROVIDER_OPENAI,
|
|
API_PROVIDER_ANTHROPIC,
|
|
API_PROVIDER_DEEPSEEK,
|
|
API_PROVIDER_GEMINI
|
|
]
|
|
|
|
VERSION: Final = "2.4.0"
|
|
|
|
# Default endpoints
|
|
DEFAULT_OPENAI_ENDPOINT: Final = "https://api.openai.com/v1"
|
|
DEFAULT_ANTHROPIC_ENDPOINT: Final = "https://api.anthropic.com"
|
|
DEFAULT_DEEPSEEK_ENDPOINT: Final = "https://api.deepseek.com"
|
|
DEFAULT_GEMINI_ENDPOINT: Final = "https://generativelanguage.googleapis.com/v1beta"
|
|
|
|
# Configuration constants
|
|
CONF_MODEL: Final = "model"
|
|
CONF_TEMPERATURE: Final = "temperature"
|
|
CONF_MAX_TOKENS: Final = "max_tokens"
|
|
CONF_API_ENDPOINT: Final = "api_endpoint"
|
|
CONF_REQUEST_INTERVAL: Final = "request_interval"
|
|
CONF_API_TIMEOUT: Final = "api_timeout"
|
|
CONF_INSTANCE: Final = "instance"
|
|
CONF_MAX_HISTORY_SIZE: Final = "max_history_size" # Correct constant name
|
|
CONF_CONTEXT_MESSAGES: Final = "context_messages"
|
|
CONF_STRUCTURED_OUTPUT: Final = "structured_output"
|
|
CONF_JSON_SCHEMA: Final = "json_schema"
|
|
|
|
ABSOLUTE_MAX_HISTORY_SIZE: Final = 200 # Hard cap; UI allows max MAX_HISTORY_SIZE (100)
|
|
MAX_ATTRIBUTE_SIZE = 4 * 1024
|
|
MAX_HISTORY_FILE_SIZE = 1 * 1024 * 1024
|
|
# Default values
|
|
DEFAULT_MODEL: Final = "gpt-4o-mini"
|
|
DEFAULT_ANTHROPIC_MODEL: Final = "claude-sonnet-4-6"
|
|
DEFAULT_DEEPSEEK_MODEL: Final = "deepseek-chat"
|
|
DEFAULT_GEMINI_MODEL: Final = "gemini-2.0-flash"
|
|
DEFAULT_TEMPERATURE: Final = 0.1
|
|
DEFAULT_MAX_TOKENS: Final = 1000
|
|
DEFAULT_REQUEST_INTERVAL: Final = 1.0
|
|
DEFAULT_API_TIMEOUT: Final = 30
|
|
DEFAULT_MAX_HISTORY: Final = 50
|
|
DEFAULT_NAME: Final = "HA Text AI"
|
|
DEFAULT_NAME_PREFIX = "ha_text_ai"
|
|
DEFAULT_INSTANCE_NAME: Final = "my_assistant"
|
|
DEFAULT_CONTEXT_MESSAGES: Final = 5
|
|
MIN_CONTEXT_MESSAGES: Final = 1
|
|
MAX_CONTEXT_MESSAGES: Final = 20
|
|
MIN_HISTORY_SIZE: Final = 1
|
|
MAX_HISTORY_SIZE: Final = 100
|
|
|
|
TRUNCATION_INDICATOR = " ... "
|
|
|
|
# Parameter constraints
|
|
MIN_TEMPERATURE: Final = 0.0
|
|
MAX_TEMPERATURE: Final = 2.0
|
|
MIN_MAX_TOKENS: Final = 1
|
|
MAX_MAX_TOKENS: Final = 100000
|
|
MIN_REQUEST_INTERVAL: Final = 0.1
|
|
MAX_REQUEST_INTERVAL: Final = 60.0
|
|
MIN_API_TIMEOUT: Final = 5
|
|
MAX_API_TIMEOUT: Final = 600
|
|
|
|
# API constants
|
|
API_RETRY_COUNT: Final = 3
|
|
|
|
# Service names
|
|
SERVICE_ASK_QUESTION: Final = "ask_question"
|
|
SERVICE_CLEAR_HISTORY: Final = "clear_history"
|
|
SERVICE_GET_HISTORY: Final = "get_history"
|
|
SERVICE_SET_SYSTEM_PROMPT: Final = "set_system_prompt"
|
|
|
|
# Attribute keys
|
|
ATTR_QUESTION: Final = "question"
|
|
ATTR_RESPONSE: Final = "response"
|
|
ATTR_INSTANCE: Final = "instance"
|
|
ATTR_MODEL: Final = "model"
|
|
ATTR_TEMPERATURE: Final = "temperature"
|
|
ATTR_MAX_TOKENS: Final = "max_tokens"
|
|
ATTR_SYSTEM_PROMPT: Final = "system_prompt"
|
|
ATTR_API_STATUS: Final = "api_status"
|
|
ATTR_ERROR_COUNT: Final = "error_count"
|
|
ATTR_CONVERSATION_HISTORY: Final = "conversation_history"
|
|
|
|
# Sensor attributes
|
|
ATTR_TOTAL_RESPONSES: Final = "total_responses"
|
|
ATTR_TOTAL_ERRORS: Final = "total_errors"
|
|
ATTR_AVG_RESPONSE_TIME: Final = "average_response_time"
|
|
ATTR_LAST_REQUEST_TIME: Final = "last_request_time"
|
|
ATTR_LAST_ERROR: Final = "last_error"
|
|
ATTR_IS_PROCESSING: Final = "is_processing"
|
|
ATTR_IS_RATE_LIMITED: Final = "is_rate_limited"
|
|
ATTR_IS_MAINTENANCE: Final = "is_maintenance"
|
|
ATTR_API_VERSION: Final = "api_version"
|
|
ATTR_ENDPOINT_STATUS: Final = "endpoint_status"
|
|
ATTR_PERFORMANCE_METRICS: Final = "performance_metrics"
|
|
ATTR_HISTORY_SIZE: Final = "history_size"
|
|
ATTR_UPTIME: Final = "uptime"
|
|
ATTR_API_PROVIDER: Final = "api_provider"
|
|
ATTR_METRICS: Final = "metrics"
|
|
ATTR_STATE: Final = "state"
|
|
ATTR_LAST_RESPONSE: Final = "last_response"
|
|
ATTR_ERROR: Final = "error"
|
|
ATTR_TIMESTAMP: Final = "timestamp"
|
|
|
|
# Sensor metrics
|
|
METRIC_TOTAL_TOKENS: Final = "total_tokens"
|
|
METRIC_PROMPT_TOKENS: Final = "prompt_tokens"
|
|
METRIC_COMPLETION_TOKENS: Final = "completion_tokens"
|
|
METRIC_SUCCESSFUL_REQUESTS: Final = "successful_requests"
|
|
METRIC_FAILED_REQUESTS: Final = "failed_requests"
|
|
METRIC_AVERAGE_LATENCY: Final = "average_latency"
|
|
METRIC_MAX_LATENCY: Final = "max_latency"
|
|
METRIC_MIN_LATENCY: Final = "min_latency"
|
|
|
|
# Error messages
|
|
ERROR_INVALID_API_KEY: Final = "invalid_api_key"
|
|
ERROR_CANNOT_CONNECT: Final = "cannot_connect"
|
|
ERROR_UNKNOWN: Final = "unknown_error"
|
|
ERROR_INVALID_MODEL: Final = "invalid_model"
|
|
ERROR_RATE_LIMIT: Final = "rate_limit_exceeded"
|
|
ERROR_CONTEXT_LENGTH: Final = "context_length_exceeded"
|
|
ERROR_API_ERROR: Final = "api_error"
|
|
ERROR_TIMEOUT: Final = "timeout_error"
|
|
ERROR_INVALID_INSTANCE: Final = "invalid_instance"
|
|
ERROR_NAME_EXISTS: Final = "name_exists"
|
|
|
|
# Entity attributes
|
|
ENTITY_ICON: Final = "mdi:robot"
|
|
ENTITY_ICON_ERROR: Final = "mdi:robot-dead"
|
|
ENTITY_ICON_PROCESSING: Final = "mdi:robot-excited"
|
|
|
|
# State attributes
|
|
STATE_READY: Final = "ready"
|
|
STATE_PROCESSING: Final = "processing"
|
|
STATE_ERROR: Final = "error"
|
|
STATE_INITIALIZING: Final = "initializing"
|
|
STATE_MAINTENANCE: Final = "maintenance"
|
|
STATE_RATE_LIMITED: Final = "rate_limited"
|
|
STATE_DISCONNECTED: Final = "disconnected"
|
|
|
|
# Event names
|
|
EVENT_RESPONSE_RECEIVED: Final = f"{DOMAIN}_response_received"
|
|
EVENT_ERROR_OCCURRED: Final = f"{DOMAIN}_error_occurred"
|
|
EVENT_STATE_CHANGED: Final = f"{DOMAIN}_state_changed"
|