SAMPrompt

SAM model of the Prompt 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.prompt.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: 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.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.prompt.SAMPromptMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API Prompt Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | 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.

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

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.prompt.SAMPromptSpecConfig(*, ipAddress: str | None = None, llmclient: str | None = None, sessionKey: str | None = None, url: str | None = None, userAgent: str | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Prompt Manifest Prompt.spec.config.

ipAddress: str | None

Prompt.spec.configuration.ipAddress[str].

Read only. The IP address of the client that started the chat session.

llmclient: str | None

Prompt.spec.configuration.llmclient[str].

Read only. The name of the LLMClient of the chat session.

sessionKey: str | None

Prompt.spec.configuration.sessionKey[str].

Read only. The session key of the Prompt’s chat session.

url: str | None

Prompt.spec.configuration.url[str].

Read only. The url at which the chat session was started.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

userAgent: str | None

Prompt.spec.configuration.userAgent[str].

Read only. The user agent of the client that started the chat session.

class smarter.models.sam.prompt.SAMPromptStatus(*, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, **extra_data: Any)

Bases: SAMModel

Smarter API Prompt Manifest - Status class.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[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.

class smarter.models.sam.prompt.SAMPrompt(*, apiVersion: str, kind: str, metadata: SAMPromptMetadata, spec: SAMPromptSpecConfig, status: SAMPromptStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - Prompt.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

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

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

spec: SAMPromptSpecConfig

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

status: SAMPromptStatus | None

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

Stateful status information about the Prompt.