"""
SAM model of the ``Plugin`` kind, generated from the Smarter platform's JSON Schema.
Do not edit: run ``scripts/generate_sam_models.py``. See :mod:`smarter.models.sam`.
"""
from __future__ import annotations
from datetime import date, datetime
from typing import Any, Optional, Union
from uuid import UUID
from pydantic import Field, PositiveInt, confloat, constr
from smarter.models.sam.base import SAMModel
[docs]
class SAMDependency(SAMModel):
"""A resource that depends on the resource that a manifest describes."""
kind: str = Field(..., title="Kind")
"""
Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.
Read only.
"""
name: str = Field(..., title="Name")
"""
Name[String]: The name of the resource that depends on this resource.
Read only.
"""
[docs]
class SAMPluginCommonSpecPrompt(SAMModel):
"""Smarter API Plugin Manifest - Spec - Prompt class."""
maxTokens: PositiveInt | None = Field(2048, title="Maxtokens")
"""
Plugin.spec.prompt.maxTokens[int].
Optional. The maxTokens of the Plugin. Defaults to 2048. The maximum number of tokens the LLM should generate in the prompt response.
"""
model: str | None = Field("gpt-6-luna", title="Model")
"""
Plugin.spec.prompt.model[str] Optional.
The model of the Plugin. Defaults to gpt-6-luna. Must be one of: ['chat-latest', 'gpt-4.1', 'gpt-4.1-2025-04-14', 'gpt-4.1-mini', 'gpt-4.1-mini-2025-04-14', 'gpt-4o', 'gpt-4o-2024-08-06', 'gpt-4o-2024-11-20', 'gpt-4o-mini', 'gpt-4o-mini-2024-07-18', 'gpt-5-search-api', 'gpt-5-search-api-2025-10-14', 'gpt-5.2', 'gpt-5.2-2025-12-11', 'gpt-5.4', 'gpt-5.4-2026-03-05', 'gpt-5.4-mini', 'gpt-5.4-mini-2026-03-17', 'gpt-5.5', 'gpt-5.5-2026-04-23', 'gpt-5.6-luna', 'gpt-5.6-sol', 'gpt-5.6-terra', 'gpt-6-astra', 'gpt-6-luna', 'gpt-6-sol', 'gpt-6.1-sol']
"""
provider: str | None = Field("openai", title="Provider")
"""
Plugin.spec.prompt.provider[str].
Optional. The provider of the LLM. Defaults to openai. The provider is the vendor name for the LLM service that will be used to generate the prompt response.
"""
systemRole: constr(max_length=32768) = Field(..., title="Systemrole")
"""
Plugin.spec.prompt.systemRole[str].
Required. The system role that the Plugin will use for the LLM text completion prompt. Be verbose and specific. Ensure that systemRole accurately conveys to the LLM how you want it to use the Plugin data that is returned. The maximum length is 32768 characters.
"""
temperature: confloat(ge=0.0, le=1.0) | None = Field(1.0, title="Temperature")
"""
Plugin.spec.prompt.temperature[float] Optional.
The temperature of the Plugin. Defaults to 1.0. Should be between 0 and 1.0. The higher the temperature, the more creative the response. The lower the temperature, the more predictable the response.
"""
[docs]
class SAMPluginCommonSpecSelector(SAMModel):
"""Smarter API Plugin Manifest - Spec - Selector class."""
directive: str = Field(..., title="Directive")
"""
Plugin.spec.selector.directive[str]: Required.
the kind of selector directive to use for the Plugin. Must be one of: ['search_terms', 'always', 'llm']
"""
searchTerms: list[str] | None = Field(None, title="Searchterms")
"""
Plugin.spec.selector.searchTerms[list].
Optional. The keyword search terms to use when the Plugin directive is 'search_terms'. Keywords are most effective when constrained to 1 or 2 words each and lists are limited to a few dozen items.
"""
[docs]
class SAMPluginCommonStatus(SAMModel):
"""Smarter API Plugin Manifest - Status class."""
accountNumber: str = Field(..., title="Accountnumber")
"""
Plugin.status.account_number: The account owner of this Plugin.
Read only.
"""
created: datetime = Field(..., title="Created")
"""
The date in which this resource was created.
Read only.
"""
dependencies: list[SAMDependency] | None = Field(None, title="Dependencies")
"""
Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.
Lists only the resources that you can read. Read only.
"""
modified: datetime = Field(..., title="Modified")
"""
The date in which this resource was most recently changed.
Read only.
"""
recordLocator: str = Field(..., title="Recordlocator")
"""
RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.
Read only.
"""
username: str = Field(..., title="Username")
"""
Plugin.status.account_number: The Smarter user who created this Plugin.
Read only.
"""
[docs]
class SAMPluginStaticSpecData(SAMModel):
"""Smarter API Plugin Manifest Plugin.spec.data."""
staticData: dict[str, Any] | None = Field(None, title="Staticdata")
"""
Plugin.spec.data.staticData[obj]: The static data returned by the Plugin when the class is 'static'.
LLM's are adept at understanding the context of json data structures. Try to provide granular and specific data elements.
"""
[docs]
class SAMPluginStaticSpec(SAMModel):
"""Smarter API Plugin Manifest Plugin.spec."""
data: SAMPluginStaticSpecData
"""
Plugin.spec.data[obj]: the json data returned by the Plugin.
This should be one of the following kinds: ['api', 'static', 'skill', 'static', 'sql', 'websearch', 'imagesearch']
"""
prompt: SAMPluginCommonSpecPrompt
"""Plugin.spec.prompt[obj]: the LLM prompt engineering to apply to the Plugin."""
selector: SAMPluginCommonSpecSelector
"""Plugin.spec.selector[obj]: the selector logic to use for the Plugin."""
[docs]
class SAMPlugin(SAMModel):
"""Smarter API Manifest - Plugin."""
apiVersion: str = Field(..., title="Apiversion")
"""
ApiVersion[String]: Required.
The API version of the AbstractSAMBase.
"""
kind: str = Field(..., title="Kind")
"""
Kind[String]: Required.
The kind of resource described by the manifest.
"""
metadata: SAMPluginCommonMetadata
"""Plugin.metadata[obj]: Required, the Plugin metadata."""
spec: SAMPluginStaticSpec
"""Plugin.spec[obj]: Required, the Plugin specification."""
status: SAMPluginCommonStatus | None = None
"""
Plugin.status[obj]: Optional, Read-only.
Stateful status information about the Plugin.
"""