Django ORM<a class="headerlink" href="#module-smarter.apps.provider.models" title="Link to this heading">

Base url. The base URL for the provider’s API.

Type:: Type

property can_activate: bool: Check if the provider can be activated.

connectivity_test_path

Connectivity test path. The URL to test connectivity with the provider’s API.

Type:: Type

contact_email

EmailField

Contact email. The contact email of the provider.

Type:: Type

contact_email_verified

Contact email verified. The date and time when the contact email was verified.

Type:: Type

created_at

Created at

Timestamp indicating when the model instance was created.

This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:: Type

deactivate()[source]: Deactivate the provider.

default_model

Default model. The default model to use for the provider.

Type:: Type

deprecate()[source]: Deprecate the provider.

description

Description. A brief description of this resource. Be verbose, but not too verbose.

Type:: Type

docs_url

Docs url. The documentation URL of the provider.

Type:: Type

flag()[source]: Flag the provider.

classmethod get_cached_provider_by_account_id_and_name(invalidate=False, account_id=None, name=None)[source]

Get a cached provider by account ID and name.

Return type:: Optional[Provider]

classmethod get_cached_provider_by_user_and_name(invalidate=False, user=None, name='')[source]

Return a single instance of Provider by name for the given user.

This method caches the results to improve performance.

Parameters:

user (Optional[User]) – The user whose provider should be retrieved.
name (Optional[str]) – The name of the provider to retrieve.

Returns:

A Provider instance if found, otherwise None.

Return type:

Optional[Provider]

classmethod get_cached_providers_for_user(invalidate=False, user=None)[source]

Get cached providers for a user.

Return type:: Sequence[Provider]

get_status_display(*, field=<django.db.models.CharField: status>): Shows the label of the status. See get_FOO_display() for more information.

id

Primary key: ID

Type:: Type

is_active

Is active

Type:: Type

is_default

Is default

Type:: Type

is_deprecated

Is deprecated

Type:: Type

is_featured

Is featured

Type:: Type

is_flagged

Is flagged

Type:: Type

property is_official_provider: bool: Check if the provider is an official provider.

is_suspended

Is suspended

Type:: Type

is_verified

Is verified

Type:: Type

logo

ImageField

Logo. The logo of the provider.

Type:: Type

property manifest_url: str | None

Returns the URL to the plugin’s manifest.

This property constructs the URL to the plugin’s manifest based on its kind and RFC 1034-compliant name. The URL follows the pattern: /plugins/{kind}/{name}/manifest/, where {kind} is the RFC 1034-compliant kind of the plugin, and {name} is the RFC 1034-compliant name of the plugin.

Example:

self.rfc1034_compliant_kind  # 'static'
self.rfc1034_compliant_name  # 'example-plugin
self.manifest_url  # '/plugins/static/example-plugin/manifest/'

name

Name. Name in camelCase, e.g., ‘apiKey’, no special characters.

Type:: Type

objects: MetaDataWithOwnershipModelManager = <smarter.apps.account.models.metadata_with_ownership.MetaDataWithOwnershipModelManager object>

ownership_requested

EmailField

Ownership requested. The email address of an alternative contact who has requested to take ownership of the provider.

Type:: Type

privacy_policy_url

Privacy policy url. The privacy policy URL of the provider.

Type:: Type

production_api_key(mask=True)[source]

Return the production API key for the provider.

Return type:: str

providermodel_set

Reverse ForeignKey from ProviderModel

All Provider Models of this Provider (related name of provider)

Type:: Type

providerverification_set

Reverse ForeignKey from ProviderVerification

All Provider Verifications of this Provider (related name of provider)

Type:: Type

reset()[source]: Reset the provider to its initial state.

property rfc1034_compliant_name: str | None

Returns a URL-friendly name for the llm_client.

This property returns an RFC 1034-compliant name for the llm_client, suitable for use in URLs and DNS labels.

Example:

self.name = 'Example LLMClient 1'
self.rfc1034_compliant_name  # 'example-llm_client-1'

Returns:: The RFC 1034-compliant name, or None if self.name is not set.
Return type:: Optional[str]

status

Status

Choices:

unverified
verifying
failed
verified
suspended
deprecated

Type:: Type

support_email

EmailField

Support email. The support email of the provider.

Type:: Type

support_email_verified

Support email verified. The date and time when the support email was verified.

Type:: Type

suspend()[source]: Suspend the provider.

tagged_items

Reverse GenericRelation from Provider

All + of this tagged item (related name of tagged_items)

Type:: Type

tags = <taggit.managers._TaggableManager object>

terms_of_service_url

Terms of service url. The terms of service URL of the provider.

Type:: Type

test_connectivity()[source]

Test connectivity to the provider’s API.

This method should be overridden by subclasses to implement specific connectivity tests.

Return type:: bool

property tos_accepted: bool: Check if the terms of service have been accepted.

tos_accepted_at

Tos accepted at. The date and time when the terms of service were accepted.

Type:: Type

tos_accepted_by

ForeignKey to User

Tos accepted by. The user who accepted the terms of service. (related name: tos_accepted_by)

Type:: Type

tos_accepted_by_id: Internal field, use tos_accepted_by instead.

undeprecate()[source]: Undeprecate the provider.

unflag()[source]: Unflag the provider.

unsuspend()[source]: Unsuspend the provider.

updated_at

Updated at

Timestamp indicating when the model instance was last updated.

This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:: Type

user_profile

ForeignKey to UserProfile

User profile (related name: provider)

Type:: Type

user_profile_id: Internal field, use user_profile instead.

validate()[source]

Validate the provider before saving.

Return type:: None

vector_databases

Reverse ForeignKey from EmbeddingsInterface

All vector databases of this Provider (related name of provider)

Type:: Type

verify()[source]

Request a batch of acceptance tests.

Set the status but don’t change the is_verified flag. This is used to indicate that the provider is being verified but has not yet been activated.

version

Version. Semantic version in the format MAJOR.MINOR.PATCH, e.g., ‘1.0.0’.

Type:: Type

website_url

Website url. The website_url URL of the provider.

Type:: Type

class smarter.apps.provider.models.ProviderModel(*args, **kwargs)[source]

Bases: TimestampedModel

Provider completion models for a provider.

Parameters:

id (Unknown) – Primary key: ID
created_at (Unknown) – Created at
updated_at (Unknown) – Updated at
name (Unknown) – Name
description (Unknown) – Description
is_default (Unknown) – Is default
is_active (Unknown) – Is active
is_deprecated (Unknown) – Is deprecated
is_flagged (Unknown) – Is flagged
is_suspended (Unknown) – Is suspended
max_completion_tokens (Unknown) – Max completion tokens
temperature (Unknown) – Temperature
top_p (Unknown) – Top p
supports_text_input (Unknown) – Supports text input
supports_text_generation (Unknown) – Supports text generation
supports_translation (Unknown) – Supports translation
supports_summarization (Unknown) – Supports summarization
supports_streaming (Unknown) – Supports streaming
supports_tools (Unknown) – Supports tools
supports_image_input (Unknown) – Supports image input
supports_audio_input (Unknown) – Supports audio input
supports_embedding (Unknown) – Supports embedding
supports_fine_tuning (Unknown) – Supports fine tuning
supports_search (Unknown) – Supports search
supports_code_interpreter (Unknown) – Supports code interpreter
supports_image_generation (Unknown) – Supports image generation
supports_audio_generation (Unknown) – Supports audio generation

Relationship fields:

Parameters:: provider (Unknown) – Provider (related name: providermodel)

Reverse relationships:

Parameters:

providermodelverification (Unknown) – All Provider Model Verifications of this Provider Model (related name of provider_model)
vector_databases (Unknown) – All vector databases of this Provider Model (related name of provider_model)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

exception NotUpdated: Bases: ObjectNotUpdated, DatabaseError

created_at

Created at

Timestamp indicating when the model instance was created.

This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:: Type

description

Description

Type:: Type

id

Primary key: ID

Type:: Type

is_active

Is active

Type:: Type

is_default

Is default

Type:: Type

is_deprecated

Is deprecated

Type:: Type

is_flagged

Is flagged

Type:: Type

is_suspended

Is suspended

Type:: Type

max_completion_tokens

PositiveIntegerField

Max completion tokens

Type:: Type

name

Name

Type:: Type

objects = <django.db.models.Manager object>

provider

ForeignKey to Provider

Provider (related name: providermodel)

Type:: Type

provider_id: Internal field, use provider instead.

providermodelverification_set

Reverse ForeignKey from ProviderModelVerification

All Provider Model Verifications of this Provider Model (related name of provider_model)

Type:: Type

supports_audio_generation

Supports audio generation

Type:: Type

supports_audio_input

Supports audio input

Type:: Type

supports_code_interpreter

Supports code interpreter

Type:: Type

supports_embedding

Supports embedding

Type:: Type

supports_fine_tuning

Supports fine tuning

Type:: Type

supports_image_generation

Supports image generation

Type:: Type

supports_image_input

Supports image input

Type:: Type

supports_search

Supports search

Type:: Type

supports_streaming

Supports streaming

Type:: Type

supports_summarization

Supports summarization

Type:: Type

supports_text_generation

Supports text generation

Type:: Type

supports_text_input

Supports text input

Type:: Type

supports_tools

Supports tools

Type:: Type

supports_translation

Supports translation

Type:: Type

temperature

FloatField

Temperature

Type:: Type

top_p

FloatField

Top p

Type:: Type

updated_at

Updated at

Timestamp indicating when the model instance was last updated.

This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:: Type

vector_databases

Reverse ForeignKey from EmbeddingsInterface

All vector databases of this Provider Model (related name of provider_model)

Type:: Type

class smarter.apps.provider.models.ProviderModelTypedDict[source]

Bases: TypedDict

TypedDict for provider model information.

api_key: str

base_url: str

max_completion_tokens: int

model: str

provider_id: int

provider_name: str

supports_audio_generation: bool

supports_audio_input: bool

supports_code_interpreter: bool

supports_embedding: bool

supports_fine_tuning: bool

supports_image_generation: bool

supports_image_input: bool

supports_search: bool

supports_streaming: bool

supports_summarization: bool

supports_text_generation: bool

supports_text_input: bool

supports_tools: bool

supports_translation: bool

temperature: float

top_p: float

class smarter.apps.provider.models.ProviderModelVerification(*args, **kwargs)[source]

Bases: TimestampedModel

Provider completion model verifications for a provider.

Parameters:

id (Unknown) – Primary key: ID
created_at (Unknown) – Created at
updated_at (Unknown) – Updated at
verification_type (Unknown) – Verification type
is_successful (Unknown) – Is successful
error_message (Unknown) – Error message

Relationship fields:

Parameters:: provider_model (Unknown) – Provider model (related name: providermodelverification)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

exception NotUpdated: Bases: ObjectNotUpdated, DatabaseError

created_at

Created at

Timestamp indicating when the model instance was created.

This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:: Type

error_message

Error message

Type:: Type

get_verification_type_display(*, field=<django.db.models.CharField: verification_type>): Shows the label of the verification_type. See get_FOO_display() for more information.

id

Primary key: ID

Type:: Type

is_successful

Is successful

Type:: Type

property is_valid: bool: Check if the verification is valid.

property next_verification: datetime: Get the next verification time.

objects = <django.db.models.Manager object>

provider_model

ForeignKey to ProviderModel

Provider model (related name: providermodelverification)

Type:: Type

provider_model_id: Internal field, use provider_model instead.

updated_at

Updated at

Timestamp indicating when the model instance was last updated.

This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:: Type

verification_type

Verification type

Choices:

streaming
tools
text_input
image_input
audio_input
fine_tuning
search
code_interpreter
text_to_image
text_to_audio
and 3 more

Type:: Type

class smarter.apps.provider.models.ProviderModelVerificationTypes(*values)[source]

Bases: TextChoices

AUDIO_INPUT = 'audio_input'

CODE_INTERPRETER = 'code_interpreter'

FINE_TUNING = 'fine_tuning'

IMAGE_INPUT = 'image_input'

SEARCH = 'search'

STREAMING = 'streaming'

SUMMARIZATION = 'summarization'

TEXT_INPUT = 'text_input'

TEXT_TO_AUDIO = 'text_to_audio'

TEXT_TO_IMAGE = 'text_to_image'

TEXT_TO_TEXT = 'text_to_text'

TOOLS = 'tools'

TRANSLATION = 'translation'

class smarter.apps.provider.models.ProviderStatus(*values)[source]

Bases: TextChoices

DEPRECATED = 'deprecated'

FAILED = 'failed'

SUSPENDED = 'suspended'

UNVERIFIED = 'unverified'

VERIFIED = 'verified'

VERIFYING = 'verifying'

class smarter.apps.provider.models.ProviderVerification(*args, **kwargs)[source]

Bases: TimestampedModel

Provider completion model verifications for a provider.

Parameters:

id (Unknown) – Primary key: ID
created_at (Unknown) – Created at
updated_at (Unknown) – Updated at
verification_type (Unknown) – Verification type
is_successful (Unknown) – Is successful
error_message (Unknown) – Error message

Relationship fields:

Parameters:: provider (Unknown) – Provider (related name: providerverification)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

exception NotUpdated: Bases: ObjectNotUpdated, DatabaseError

created_at

Created at

Timestamp indicating when the model instance was created.

This field is automatically set to the current date and time when the instance is first created. It is indexed in the database for efficient querying.

Type:: Type

error_message

Error message

Type:: Type

get_verification_type_display(*, field=<django.db.models.CharField: verification_type>): Shows the label of the verification_type. See get_FOO_display() for more information.

id

Primary key: ID

Type:: Type

is_successful

Is successful

Type:: Type

property is_valid: bool: Check if the verification is valid.

property next_verification: datetime: Get the next verification time.

objects = <django.db.models.Manager object>

provider

ForeignKey to Provider

Provider (related name: providerverification)

Type:: Type

provider_id: Internal field, use provider instead.

updated_at

Updated at

Timestamp indicating when the model instance was last updated.

This field is automatically updated to the current date and time whenever the instance is saved. It is indexed in the database for efficient querying.

Type:: Type

verification_type