Source code for smarter.apps.prompt.manifest.models.chat_plugin_usage.model

"""Smarter API ChatPluginUsage Manifest"""

from typing import ClassVar, Optional

from pydantic import Field

from smarter.apps.prompt.manifest.models.chat_plugin_usage.const import MANIFEST_KIND
from smarter.lib.manifest.enum import SAMKeys
from smarter.lib.manifest.models import AbstractSAMBase

from .metadata import SAMChatPluginUsageMetadata
from .spec import SAMChatPluginUsageSpecConfig
from .status import SAMChatPluginUsageStatus

MODULE_IDENTIFIER = MANIFEST_KIND




class SAMChatPluginUsage(AbstractSAMBase):
    """Smarter API Manifest - ChatPluginUsage"""

    class_identifier: ClassVar[str] = MODULE_IDENTIFIER

    metadata: SAMChatPluginUsageMetadata = Field(
        ...,
        description=f"{class_identifier}.{SAMKeys.METADATA.value}[obj]: Required, the {MANIFEST_KIND} metadata.",
    )
    spec: SAMChatPluginUsageSpecConfig = Field(
        ...,
        description=f"{class_identifier}.{SAMKeys.SPEC.value}[obj]: Required, the {MANIFEST_KIND} specification.",
    )
    status: Optional[SAMChatPluginUsageStatus] = Field(
        default=None,
        description=f"{class_identifier}.{SAMKeys.STATUS.value}[obj]: Optional, Read-only. Stateful status information about the {MANIFEST_KIND}.",
    )