"""
SAM model of the ``ImageSearchPlugin`` 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 enum import Enum
from typing import Any, Optional, Union
from uuid import UUID
from pydantic import Field, PositiveInt, confloat, conint, constr
from smarter.models.sam.base import SAMModel
[docs]
class ImageSearchFilters(SAMModel):
"""
Smarter API - ImageSearchPlugin.spec.imageSearchData.filters.
Smarter applies these to the Brave Image Search API's results.
"""
allowedDomains: list[str] | None = Field(None, title="Alloweddomains")
"""ImageSearchPlugin.spec.filters.allowedDomains[list]: if not empty, only images from web pages on these domains, and their subdomains."""
blockedDomains: list[str] | None = Field(None, title="Blockeddomains")
"""ImageSearchPlugin.spec.filters.blockedDomains[list]: never images on these domains, nor from web pages on them, including their subdomains."""
fileType: str | None = Field(None, title="Filetype")
"""
ImageSearchPlugin.spec.filters.fileType[str]: only images of these file types, separated by '|', e.g. jpg|png.
Any of: ['jpg', 'png', 'gif', 'svg', 'webp', 'avif', 'bmp', 'ico']
"""
minHeight: conint(ge=1, le=10000) | None = Field(None, title="Minheight")
"""
ImageSearchPlugin.spec.filters.minHeight[int]: only images at least this many pixels high.
Images whose height Brave does not report are skipped.
"""
minWidth: conint(ge=1, le=10000) | None = Field(None, title="Minwidth")
"""ImageSearchPlugin.spec.filters.minWidth[int]: only images at least this many pixels wide. Images whose width Brave does not report are skipped."""
[docs]
class Safesearch(Enum):
"""
ImageSearchPlugin.spec.searchParams.safesearch[str]: adult content filtering.
One of: ['off', 'strict']
"""
off = "off"
strict = "strict"
[docs]
class ImageSearchParams(SAMModel):
"""
Smarter API - ImageSearchPlugin.spec.imageSearchData.searchParams.
These map 1:1 to the query parameters of the Brave Image Search API, except for ``q``, the
query itself, which the LLM supplies. See ``imageSearchData.queryTerms``.
"""
count: conint(ge=1, le=20) | None = Field(10, title="Count")
"""ImageSearchPlugin.spec.searchParams.count[int]: the maximum number of images per search, 1 to 20."""
country: str | None = Field(None, title="Country")
"""ImageSearchPlugin.spec.searchParams.country[str]: a two letter country code, e.g. us, or all for worldwide results."""
safesearch: Safesearch | None = Field("strict", title="Safesearch")
"""
ImageSearchPlugin.spec.searchParams.safesearch[str]: adult content filtering.
One of: ['off', 'strict']
"""
searchLang: str | None = Field(None, title="Searchlang")
"""ImageSearchPlugin.spec.searchParams.searchLang[str]: prefer images from content in this language, e.g. en or pt-br."""
spellcheck: bool | None = Field(True, title="Spellcheck")
"""ImageSearchPlugin.spec.searchParams.spellcheck[bool]: whether Brave may correct the spelling of the query."""
[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 ImageSearchData(SAMModel):
"""Smarter API - ImageSearchPlugin.spec.imageSearchData."""
apiKey: str | None = Field("brave_search_api_key", title="Apikey")
"""
ImageSearchPlugin.spec.apiKey[str]: the name of the Smarter Secret that contains a Brave Search API key.
The api key itself is never included in the manifest.
"""
cacheTtl: conint(ge=0, le=604800) | None = Field(604800, title="Cachettl")
"""
ImageSearchPlugin.spec.cacheTtl[int]: seconds to cache search results.
0 disables caching.
"""
filters: ImageSearchFilters | None = None
"""ImageSearchPlugin.spec.filters[obj]: the filters that Smarter applies to the search results."""
llmSearchParams: bool | None = Field(False, title="Llmsearchparams")
"""
ImageSearchPlugin.spec.llmSearchParams[bool]: whether the LLM may set every Brave Image Search API parameter in each tool call: count (up to 20), country, search_lang, safesearch and spellcheck.
searchParams are then the defaults. If false, the LLM may only lower the count.
"""
queryTerms: constr(max_length=400) | None = Field(None, title="Queryterms")
"""
ImageSearchPlugin.spec.queryTerms[str]: optional search terms appended to every query that the LLM sends, e.g. 'black and white photograph'.
The LLM always supplies the query itself, e.g. 'formula 1 race cars', so that Brave searches for 'formula 1 race cars black and white photograph'.
"""
searchParams: ImageSearchParams | None = None
"""ImageSearchPlugin.spec.searchParams[obj]: the Brave Image Search API query parameters."""
timeout: conint(ge=1, le=60) | None = Field(10, title="Timeout")
"""ImageSearchPlugin.spec.timeout[int]: seconds to wait for each web request, 1 to 60."""
validateUrls: bool | None = Field(True, title="Validateurls")
"""
ImageSearchPlugin.spec.validateUrls[bool]: only return image urls that respond to a request with HTTP 200, and not with a web page.
Urls are always https.
"""
[docs]
class SAMImageSearchPluginSpec(SAMModel):
"""Smarter API Manifest - ImageSearchPlugin.spec."""
imageSearchData: ImageSearchData | None = None
"""ImageSearchPlugin.spec.imageSearchData[obj]: the image search configuration of the ImageSearchPlugin."""
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 SAMImageSearchPlugin(SAMModel):
"""Smarter API Manifest - ImageSearchPlugin Model."""
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: SAMImageSearchPluginSpec
"""ImageSearchPlugin.spec[obj]: Required, the ImageSearchPlugin specification."""
status: SAMPluginCommonStatus | None = None
"""
Plugin.status[obj]: Optional, Read-only.
Stateful status information about the Plugin.
"""