SAMSqlPlugin

smarter.models.sam.sqlplugin

SAM model of the SqlPlugin kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.sqlplugin.ParameterType

Bases: enum.Enum

Enum for parameter types.

class smarter.models.sam.sqlplugin.SAMDependency

Bases: smarter.models.sam.base.SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

class smarter.models.sam.sqlplugin.SAMPluginCommonMetadata

Bases: smarter.models.sam.base.SAMModel

Smarter API Plugin Manifest - common Metadata class.

annotations: None | list[dict[str, str | int | float | bool | datetime.date | datetime.datetime | Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern='^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$')] | uuid.UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

pluginClass: str

The class of the plugin.

one of: [‘api’, ‘imagesearch’, ‘skill’, ‘sql’, ‘static’, ‘websearch’]

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

class smarter.models.sam.sqlplugin.SAMPluginCommonSpecPrompt

Bases: smarter.models.sam.base.SAMModel

Smarter API Plugin Manifest - Spec - Prompt class.

maxTokens: Optional

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

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

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: str

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.

temperature: Optional

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.

class smarter.models.sam.sqlplugin.SAMPluginCommonSpecSelector

Bases: smarter.models.sam.base.SAMModel

Smarter API Plugin Manifest - Spec - Selector class.

directive: str

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

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.

class smarter.models.sam.sqlplugin.SAMPluginCommonStatus

Bases: smarter.models.sam.base.SAMModel

Smarter API Plugin Manifest - Status class.

accountNumber: str

Plugin.status.account_number: The account owner of this Plugin.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[smarter.models.sam.sqlplugin.SAMDependency] | None

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

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Plugin.status.account_number: The Smarter user who created this Plugin.

Read only.

class smarter.models.sam.sqlplugin.TestValue

Bases: smarter.models.sam.base.SAMModel

TestValue class for SqlPlugin and ApiPlugin test values.

name: str

The name of the parameter being tested.

value: Any

The test value for the parameter.

class smarter.models.sam.sqlplugin.Parameter

Bases: smarter.models.sam.base.SAMModel

Parameter class for parameterized Plugins.

This structure is intended to match that which is used in the OpenAPI function calling specification. It is used to define the parameters that a plugin can accept, and also for creating the function calling prompt api.

default: Any | None

The default value of the parameter, if any.

description: str | None

A description of the parameter.

enum: list[str] | None

A list of allowed values for the parameter.

Example: [‘Celsius’, ‘Fahrenheit’]

name: str

The name of the parameter.

required: bool | None

Whether the parameter is required.

type: ParameterType

The data type of the parameter (one of: string, number, integer, boolean, object, array, null).

class smarter.models.sam.sqlplugin.SqlData

Bases: smarter.models.sam.base.SAMModel

Smarter API - generic API Connection class.

limit: Optional

The maximum number of rows to return from the query.

Must be a non-negative integer.

parameters: list[smarter.models.sam.sqlplugin.Parameter] | None

A JSON dict containing parameter names and data types.

Example: {‘unit’: {‘type’: ‘string’, ‘enum’: [‘Celsius’, ‘Fahrenheit’], ‘description’: ‘The temperature unit to use.’}}

sqlQuery: str

The SQL query that this plugin will execute when invoked by the user prompt.

testValues: list[smarter.models.sam.sqlplugin.TestValue] | None

A JSON dict containing test values for each parameter.

Example: {‘product_id’: 1234}.

class smarter.models.sam.sqlplugin.SAMSqlPluginSpec

Bases: smarter.models.sam.base.SAMModel

Smarter API SqlData Connection Manifest SqlConnection.spec.

connection: str

SqlPlugin.spec.selector[obj]: the name of an existing SqlConnector to use for the SqlPlugin.

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.

sqlData: SqlData

SqlPlugin.spec.selector[obj]: the SqlData to use for the SqlPlugin.

class smarter.models.sam.sqlplugin.SAMSqlPlugin

Bases: smarter.models.sam.base.SAMModel

Smarter API Manifest - Sql Connection Model.

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMPluginCommonMetadata

Plugin.metadata[obj]: Required, the Plugin metadata.

spec: SAMSqlPluginSpec

SqlPlugin.spec[obj]: Required, the SqlPlugin specification.

status: smarter.models.sam.sqlplugin.SAMPluginCommonStatus | None

Plugin.status[obj]: Optional, Read-only.

Stateful status information about the Plugin.