mirror of
https://github.com/smkrv/ha-text-ai.git
synced 2026-07-21 22:54:00 +08:00
SMKRV
31560a8835
Security: - Make validate_endpoint async with hass.async_add_executor_job for DNS resolution - Use _RestrictedIPError instead of fragile string matching for IP check flow - Add is_multicast/is_unspecified to SSRF IP restriction checks - Remove resolved private IP from error messages (generic message) - Remove raw endpoint from __init__.py error log - Sanitize error messages in metrics: strip URLs, API keys, Gemini key patterns - Truncate API error response bodies before logging (512 chars) - Use generic error messages in Gemini exception handlers (no str(e) interpolation) - Pass api_key as explicit APIClient constructor parameter (not from header) - Add defensive validation: Gemini provider requires api_key at construction Code quality: - Add constants: DEFAULT_INSTANCE_NAME, MIN/MAX_CONTEXT_MESSAGES, MIN/MAX_HISTORY_SIZE - Replace all hardcoded schema ranges with named constants - Move datetime import to module level in history.py - Remove unused full_history/full_history_available keys - Chain socket.gaierror properly with raise...from
188 lines
6.2 KiB
Python
188 lines
6.2 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
|
|
"""
|
|
import os
|
|
import json
|
|
from typing import Final
|
|
from homeassistant.const import Platform
|
|
import logging
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
# 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
|
|
]
|
|
|
|
# Read version from manifest.json
|
|
MANIFEST_PATH = os.path.join(os.path.dirname(__file__), "manifest.json")
|
|
try:
|
|
with open(MANIFEST_PATH) as manifest_file:
|
|
manifest = json.load(manifest_file)
|
|
VERSION = manifest.get("version", "unknown")
|
|
except FileNotFoundError:
|
|
VERSION = "unknown"
|
|
_LOGGER.warning("manifest.json not found at %s", MANIFEST_PATH)
|
|
except json.JSONDecodeError as err:
|
|
VERSION = "unknown"
|
|
_LOGGER.error("Error decoding JSON from manifest.json: %s", err)
|
|
except Exception as err:
|
|
VERSION = "unknown"
|
|
_LOGGER.error("Error reading manifest.json: %s", err)
|
|
|
|
# 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_IS_ANTHROPIC: Final = "is_anthropic"
|
|
CONF_CONTEXT_MESSAGES: Final = "context_messages"
|
|
CONF_STRUCTURED_OUTPUT: Final = "structured_output"
|
|
CONF_JSON_SCHEMA: Final = "json_schema"
|
|
|
|
ABSOLUTE_MAX_HISTORY_SIZE = 500
|
|
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_TIMEOUT: Final = 30
|
|
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_TIMEOUT: Final = 30 # Legacy constant, use CONF_API_TIMEOUT from config
|
|
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"
|