Models

These models are used for argument and return value validation. They are based on the pydantic package.

Definitions

class avatars.models.CreditsInfo

credits: Annotated[int | None, Field(title='Credits')] = None

is_credit_enabled: Annotated[bool, Field(title='Is Credit Enabled')] [Required]

class avatars.models.FileCredentials

access_key_id: Annotated[str, Field(title='Access Key Id')] [Required]

jwt_token: Annotated[str | None, Field(title='Jwt Token')] = ''

secret_access_key: Annotated[str, Field(title='Secret Access Key')] [Required]

class avatars.models.ForgottenPasswordRequest

email: Annotated[str, Field(title='Email')] [Required]

class avatars.models.JobCreateRequest

depends_on: Annotated[List[str] | None, Field(title='Depends On')] = []

parameters_name: Annotated[str, Field(title='Parameters Name')] [Required]

set_name: Annotated[str, Field(title='Set Name')] [Required]

class avatars.models.JobCreateResponse

Location: Annotated[str, Field(title='Location')] [Required]

name: Annotated[str, Field(title='Name')] [Required]

class avatars.models.JobKind(*values)

standard = 'standard'

privacy_metrics = 'privacy_metrics'

signal_metrics = 'signal_metrics'

report = 'report'

advice = 'advice'

class avatars.models.JobResponse

created_at: Annotated[datetime, Field(title='Created At')] [Required]

done: Annotated[bool, Field(title='Done')] [Required]

exception: Annotated[str, Field(title='Exception')] [Required]

kind: JobKind [Required]

name: Annotated[str, Field(title='Name')] [Required]

parameters_name: Annotated[str, Field(title='Parameters Name')] [Required]

progress: Annotated[float | None, Field(title='Progress')] = None

set_name: Annotated[str, Field(title='Set Name')] [Required]

status: Annotated[str, Field(title='Status')] [Required]

class avatars.models.JobResponseList

jobs: Annotated[List[JobResponse], Field(title='Jobs')] [Required]

class avatars.models.LoginResponse

access_token: Annotated[str, Field(title='Access Token')] [Required]

refresh_token: Annotated[str | None, Field(title='Refresh Token')] = None

token_type: Annotated[str, Field(title='Token Type')] [Required]

class avatars.models.ResetPasswordRequest

email: Annotated[str, Field(title='Email')] [Required]

new_password: Annotated[str, Field(title='New Password')] [Required]

new_password_repeated: Annotated[str, Field(title='New Password Repeated')] [Required]

token: Annotated[UUID, Field(title='Token')] [Required]

class avatars.models.UserRole(*values)

admin = 'admin'

user = 'user'

class avatars.models.ValidationError

loc: Annotated[List[str | int], Field(title='Location')] [Required]

msg: Annotated[str, Field(title='Message')] [Required]

type: Annotated[str, Field(title='Error Type')] [Required]

class avatars.models.GrantTypeItem

root: Annotated[str, Field(pattern='^password$')] [Required]

Constraints:

• pattern = ^password$

class avatars.models.Login

client_id: Annotated[str | None, Field(title='Client Id')] = None

client_secret: Annotated[str | None, Field(title='Client Secret')] = None

grant_type: Annotated[GrantTypeItem | None, Field(title='Grant Type')] = None

password: Annotated[str, Field(title='Password')] [Required]

scope: Annotated[str | None, Field(title='Scope')] = ''

username: Annotated[str, Field(title='Username')] [Required]

class avatars.models.CreateDataset

file: Annotated[bytes, Field(title='File')] [Required]

class avatars.models.CreateUser

Create a user, either with an email, or a username.

The choice will depend on how your server is setup.

email: Annotated[str | None, Field(title='Email')] = None

password: Annotated[str | None, Field(title='Password')] = None

role: UserRole | None = UserRole.user

username: Annotated[str | None, Field(title='Username')] = None

class avatars.models.FileAccess

credentials: FileCredentials [Required]

url: Annotated[str, Field(title='Url')] [Required]

class avatars.models.HTTPValidationError

detail: Annotated[List[ValidationError] | None, Field(title='Detail')] = None

class avatars.models.User

email: Annotated[str | None, Field(title='Email')] = None

id: Annotated[UUID, Field(title='Id')] [Required]

organization_id: Annotated[UUID, Field(title='Organization Id')] [Required]

role: UserRole | None = UserRole.user

username: Annotated[str | None, Field(title='Username')] = None

class avatars.models.Processor(*args, **kwargs)

preprocess(df: DataFrame) → DataFrame

postprocess(source: DataFrame, dest: DataFrame) → DataFrame