Aible API

Prefix: v1

/v1/account/<id:int>/communicate (mjolnir.account.communicate)[POST, PATCH, HEAD, GET, PUT, DELETE] -> bytes | str | dict[str, Any] | list[str] | mjolnir.HTML

communicate

Open a channel to the Cloud Account API and mirror the request to it.

Requires:
    - Account features to include "communication-relay"

Intended to be drop in compatible for CORS to direct Cloud Account API endpoints without issues.

Expected behavior is that a client will first call `/v1/account/<id:int>/foreign_sts`,

Then get a set of Authorization headers
Then just call this route with the path in the Cloud Account

This design is tolerant for:
    - Being handed both current user's Auth key *AND* the foreign_sts key
        (we send the STS key preferentially)
    - Being handed just an STS key
    - Being handed just the user's tenant token


Return-only definitions: bytes | str | dict[str, Any] | list[str] | mjolnir.HTML

/v1/account/<id:int>/communicate/<path:path> (mjolnir.account.communicate)[POST, PATCH, HEAD, GET, PUT, DELETE] -> bytes | str | dict[str, Any] | list[str] | mjolnir.HTML

communicate

Open a channel to the Cloud Account API and mirror the request to it.

Requires:
    - Account features to include "communication-relay"

Intended to be drop in compatible for CORS to direct Cloud Account API endpoints without issues.

Expected behavior is that a client will first call `/v1/account/<id:int>/foreign_sts`,

Then get a set of Authorization headers
Then just call this route with the path in the Cloud Account

This design is tolerant for:
    - Being handed both current user's Auth key *AND* the foreign_sts key
        (we send the STS key preferentially)
    - Being handed just an STS key
    - Being handed just the user's tenant token


Return-only definitions: bytes | str | dict[str, Any] | list[str] | mjolnir.HTML

/v1/accounts (mjolnir.account.create)[POST] -> Account

create

With NewAccount defined as 

{
    "type": 'AWS' | 'GCP' | 'AZURE'
    "name": str
    "configuration": NewAWSAccount | NewGCPAccount | NewAzureAccount | dict
}

Return-only definitions: Account

With Account defined as 

{
    "tenant_id": int
    "id": int
    "type": 'AWS' | 'GCP' | 'AZURE'
    "name": SafeString
    "configuration": dict[str, Any]
    "status": 'PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "annotations": list[horcrux.aible.annotations.Annotation]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<id:int>/foreign_sts (mjolnir.account.create_foreign_sts_token)[GET] -> ForeignSTSSession

create_foreign_sts_token

Create a session with the cloud account on behalf of the current user
to make authenticated requests on the cloud account's API.


Return-only definitions: ForeignSTSSession

With ForeignSTSSession defined as 

{
    "expires_on": EpochDateTime
    "on_behalf_of": Author
    "issued_at": EpochDateTime
    "expires_on_epoch": int | float
    "headers": list[tuple[str, str]]
    "base_url": str
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<id:int>/setup.sh (mjolnir.account.create_setup_script)[GET] -> mjolnir.ShellScript
```
create_setup_script


Return-only definitions: mjolnir.ShellScript
```

/v1/account/<id:int> (mjolnir.account.delete)[DELETE] -> Account

delete


Return-only definitions: Account

With Account defined as 

{
    "tenant_id": int
    "id": int
    "type": 'AWS' | 'GCP' | 'AZURE'
    "name": SafeString
    "configuration": dict[str, Any]
    "status": 'PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "annotations": list[horcrux.aible.annotations.Annotation]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<id:int> (mjolnir.account.get)[GET] -> Account

get


Return-only definitions: Account

With Account defined as 

{
    "tenant_id": int
    "id": int
    "type": 'AWS' | 'GCP' | 'AZURE'
    "name": SafeString
    "configuration": dict[str, Any]
    "status": 'PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "annotations": list[horcrux.aible.annotations.Annotation]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/accounts (mjolnir.account.list_all)[GET] -> tuple[horcrux.aible.account.Account, ...]
```
list_all


Return-only definitions: tuple[horcrux.aible.account.Account, ...]
```

/v1/account/<id:int>/resources (mjolnir.account.list_resources_for_account)[GET] -> dict[str, str]

list_resources_for_account

returns a list of pre-signed urls for all resources including the resources.json upgrades file.
This list is created from the contents of the two directories:
    s3://<domain>/<env>/notebooks/


Return-only definitions: dict[str, str]

/v1/account/<id:int>/presigned_url (mjolnir.account.presigned_url)[POST] -> PresignedURL

presigned_url

    Given an account_id and a file name, should generate a presigned url to upload the
    training data to

With NewDataInfo defined as 

{
    "file_name": str
}

Return-only definitions: PresignedURL

With PresignedURL defined as 

{
    "data_url": str
    "presigned_url": str | dict
}

/v1/account/<id:int> (mjolnir.account.update)[PATCH] -> Account

update

Where UpdateAWSAccount is defined by 

{
    "status": Optional['PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR']
    "name": Optional[str]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
    "configuration": Optional[UpdateAWSConfiguration]
}

Where UpdateAzureAccount is defined by 

{
    "status": Optional['PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR']
    "name": Optional[str]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
    "configuration": Optional[UpdateAzureConfiguration]
}

Where UpdateAWSConfiguration is defined by 

{
    "release_version": Optional[str]
    "cloud_base_url": Optional[URL]
    "features": Optional[frozenset[str]]
    "aws_account_id": Optional[str]
    "iam_role": Optional[ARN]
    "arn_role": Optional[ARN]
    "external_id": Optional[str]
    "bucket": Optional[str]
    "resource_limits": Optional[dict]
    "stack_id": Optional[str]
    "stack_arn": Optional[ARN]
    "lambda_rpc_arn": Optional[ARN]
    "schema_arn": Optional[ARN]
    "lambda_api_endpoint": Optional[URL]
}

Where UpdateAzureConfiguration is defined by 

{
    "release_version": Optional[str]
    "cloud_base_url": Optional[URL]
    "features": Optional[frozenset[str]]
    "azure_subscription_id": Optional[str]
    "region_name": Optional[str]
    "group_id": Optional[str]
}

Return-only definitions: Account

With Account defined as 

{
    "tenant_id": int
    "id": int
    "type": 'AWS' | 'GCP' | 'AZURE'
    "name": SafeString
    "configuration": dict[str, Any]
    "status": 'PENDING_AUTHORIZATION' | 'PENDING_SETUP' | 'TESTING_LIMITS' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ERROR'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "annotations": list[horcrux.aible.annotations.Annotation]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<id:int>/sync (mjolnir.account.update_remote_stack)[POST] -> Account | CloudFormationAccountUpdated

update_remote_stack

Toggle a sync to make sure the remote account is running the up-to-date aible stack
dependencies.


Return-only definitions: Account | CloudFormationAccountUpdated

/v1/account/<id:int>/usage (mjolnir.account.usage)[POST] -> UsageEvent

usage

With NewUsage defined as 

{
    "supplier": 'openai'
    "data": dict[str, Any] | OpenAIDataUsage
}

Return-only definitions: UsageEvent

With UsageEvent defined as 

{
    "user_id": int
    "tenant_id": int
    "account_id": int
    "service": Service
    "usages": Tuple[horcrux.aible.usage.Usage, ...]
    "id": int | NextValue
    "created_date": NextValue | EpochDateTime
}

Where Service is defined by 

{
    "id": int | NextValue
    "supplier_name": str
    "service_name": str
    "created_date": NextValue | EpochDateTime
    "updated_date": NextValue | EpochDateTime
}

Where Usage is defined by 

{
    "unit_of_measure": 'completion_tokens' | 'prompt_tokens'
    "quantity": int
}

/v1/aws/on_subscription_change (mjolnir.aws.handle_aws_purchase_change)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
handle_aws_purchase_change


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/aws/provision (mjolnir.aws.handle_new_aws_purchase)[GET] -> Annotated[ForwardRef('JSON'), Inferred]

handle_new_aws_purchase

With NewProvisionRequest defined as 

{
    "marketplace_token": str
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/aws/flex/<customer_id:str>/<product_code:str>/process (mjolnir.aws.process_provision_flex_credits)[GET] -> Annotated[ForwardRef('JSON'), Inferred]

process_provision_flex_credits

With FlexCreditsCustomerInfo defined as 

{
    "fullname": str
    "company_name": str
    "phone": str
    "email": Address
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/aws/flex/<customer_id:str>/<product_code:str>/add (mjolnir.aws.provision_flex_credits)[GET]
```
provision_flex_credits
```
/v1/azure/provision (mjolnir.azure.provision_azure_html)[GET]
```
provision_azure_html
```

/v1/azure/provision (mjolnir.azure.provision_azure_post)[POST] -> Tenant

provision_azure_post

With ProvisionRequest defined as 

{
    "token": str
    "root_fullname": str
    "tenant_name": Optional[str]
}

Return-only definitions: Tenant

With Tenant defined as 

{
    "id": int
    "fullname": SafeString
    "shortname": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "foreign_info": ForeignInfo
    "invite": Optional[Invite]
    "tokens": tuple[horcrux.authentication.token.AccessToken, ...]
    "num_licenses": int
    "user_limit": int | float
    "limits": TenantLimits
    "license_types": Optional[frozenset[horcrux.authentication.types.LicenseType]]
    "share_behavior": 'PUBLIC' | 'PRIVATE'
    "linked_domains": tuple[str, ...]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where ForeignInfo is defined by 

{
    "provider": Optional['AZURE' | 'AWS_MARKETPLACE']
    "id": Optional[str]
}

Where TenantLimits is defined by 

{
    "training_upload_limit": Optional[int]
    "model_training_limit": Optional[int]
    "score_limit": Optional[int]
    "deployment_limit": Optional[int]
    "account_limit": Optional[int]
    "allow_aible_resource_usage": bool
    "training_upload_size_bytes_limit": Optional[int]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/azure/update (mjolnir.azure.update_azure_subscription)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
update_azure_subscription


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/blueprints (mjolnir.blueprint.create)[POST] -> GuidedBlueprint

create

With BlueprintCreate defined as 

{
    "folder_id": int
    "outcome": Optional[BlueprintOutcomeCreate]
    "name": Optional[str]
    "wizard": Optional[dict]
    "suggested_fields": Optional[List[dict]]
}

Where BlueprintOutcomeCreate is defined by 

{
    "behavior": 'MAXIMIZE' | 'MINIMIZE'
}

Return-only definitions: GuidedBlueprint

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/blueprint/<blueprint_id:int> (mjolnir.blueprint.delete)[DELETE] -> GuidedBlueprint

delete


Return-only definitions: GuidedBlueprint

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/blueprint/<blueprint_id:int> (mjolnir.blueprint.get)[GET] -> GuidedBlueprint

get


Return-only definitions: GuidedBlueprint

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/blueprints (mjolnir.blueprint.list_all)[GET] -> List[horcrux.aible.blueprint.GuidedBlueprint]

list_all


Return-only definitions: List[horcrux.aible.blueprint.GuidedBlueprint]

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/blueprints/by/<tag_name:string> (mjolnir.blueprint.list_by_tag)[GET] -> List[horcrux.aible.blueprint.GuidedBlueprint]

list_by_tag


Return-only definitions: List[horcrux.aible.blueprint.GuidedBlueprint]

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/blueprint/<blueprint_id:int> (mjolnir.blueprint.update)[PATCH] -> GuidedBlueprint

update

With BlueprintUpdate defined as 

{
    "folder_id": Optional[int]
    "name": Optional[str]
    "wizard": Optional[dict]
    "suggested_fields": Optional[List[mjolnir.models.blueprint.SuggestedKey]]
}

Where SuggestedKey is defined by 

{
    "name": str
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": str
}

Return-only definitions: GuidedBlueprint

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/chat_tones/<tone_id:int>/comments (mjolnir.chat_tone.add_tone_comment)[POST] -> Comment

add_tone_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: Comment

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/chat_tones/<tone_id:int>/ratings (mjolnir.chat_tone.add_tones_rating)[POST] -> Rating

add_tones_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: Rating

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/chat_tones (mjolnir.chat_tone.create)[POST] -> ChatTone

create

With ChatToneCreate defined as 

{
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: ChatTone

With ChatTone defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "folder_id": int
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/chat_tones/<tone_id:int> (mjolnir.chat_tone.delete)[DELETE] -> ChatTone

delete


Return-only definitions: ChatTone

With ChatTone defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "folder_id": int
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/chat_tones/<tone_id:int> (mjolnir.chat_tone.get)[GET] -> ChatTone

get


Return-only definitions: ChatTone

With ChatTone defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "folder_id": int
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/chat_tones/<tone_id:int>/ratings (mjolnir.chat_tone.get_tones_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_tones_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/chat_tones/<tone_id:int>/comments (mjolnir.chat_tone.get_training_data_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_training_data_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/chat_tones (mjolnir.chat_tone.list_all)[GET] -> List[horcrux.aible.chat_tone.ChatTone]

list_all


Return-only definitions: List[horcrux.aible.chat_tone.ChatTone]

With ChatTone defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "folder_id": int
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/chat_tones/<tone_id:int> (mjolnir.chat_tone.update)[PATCH] -> ChatTone

update

With ChatToneUpdate defined as 

{
    "folder_id": Optional[int]
    "name": Optional[str]
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: ChatTone

With ChatTone defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "folder_id": int
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/comments/<comment_id:int>/comments (mjolnir.comment.add_comment_comment)[POST] -> List[horcrux.aible.rating.Rating]

add_comment_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int>/ratings (mjolnir.comment.add_comment_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_comment_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int> (mjolnir.comment.delete_comment)[DELETE] -> Comment

delete_comment


Return-only definitions: Comment

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int> (mjolnir.comment.get_comment)[GET] -> Comment

get_comment


Return-only definitions: Comment

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int>/comments (mjolnir.comment.get_comment_comments)[GET] -> List[horcrux.aible.rating.Rating]

get_comment_comments


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int>/ratings (mjolnir.comment.get_comment_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_comment_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/comments/<comment_id:int> (mjolnir.comment.update_comment)[PATCH] -> Comment

update_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: Comment

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment/<deployment_id:int>/cancel (mjolnir.deployment.abort)[POST] -> Deployment

abort


Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment (mjolnir.deployment.create)[POST] -> Deployment

create

With NewModelDeployment defined as 

{
    "model_name": str
    "job_id": int
    "end_date": Optional[AwareDateTime]
}

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deploy (mjolnir.deployment.create)[POST] -> Deployment

create

With NewModelDeployment defined as 

{
    "model_name": str
    "job_id": int
    "end_date": Optional[AwareDateTime]
}

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/job/<job_id:int>/deployment (mjolnir.deployment.create)[POST] -> Deployment

create

With NewModelDeployment defined as 

{
    "model_name": str
    "job_id": int
    "end_date": Optional[AwareDateTime]
}

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/job/<job_id:int>/deploy (mjolnir.deployment.create)[POST] -> Deployment

create

With NewModelDeployment defined as 

{
    "model_name": str
    "job_id": int
    "end_date": Optional[AwareDateTime]
}

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment/<deployment_id:int> (mjolnir.deployment.delete)[DELETE] -> Deployment

delete


Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/deploy (mjolnir.deployment.deploy_project)[POST] -> Deployment

deploy_project

With NewProjectDeployment defined as 

{
    "end_date": Optional[AwareDateTime]
}

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment/<deployment_id:int> (mjolnir.deployment.get)[GET] -> Deployment

get


Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployments (mjolnir.deployment.list_all)[GET] -> Tuple[horcrux.aible.deployment.Deployment, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.deployment.Deployment, ...]

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment/<deployment_id:int>/invocations (mjolnir.deployment.list_deployment_invocations)[GET] -> Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

list_deployment_invocations


Return-only definitions: Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

With DeploymentInvokation defined as 

{
    "tenant_id": int
    "id": int
    "deployment_id": Optional[int]
    "project_id": Optional[int]
    "duration_ms": int
    "number_rows": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "raw_score_path": URL
    "out_score_path": URL
    "created_date": EpochDateTime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

/v1/deployment/<deployment_id:int>/redeploy (mjolnir.deployment.redeploy)[POST] -> Deployment

redeploy


Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/deployment/<deployment_id:int> (mjolnir.deployment.update)[PATCH] -> Deployment

update

With DeploymentUpdate defined as 

{
    "status": Optional['NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR']
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
    "endpoint_url": Optional[URL]
    "endpoint_headers": Optional[Dict[str, str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Return-only definitions: Deployment

With Deployment defined as 

{
    "tenant_id": int
    "id": int
    "account_id": int
    "annotations": List[horcrux.aible.annotations.Annotation]
    "stack_id": str
    "endpoint_url": Optional[URL]
    "endpoint_headers": Dict[str, str]
    "end_date": Optional[AwareDateTime]
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "job_id": Optional[int]
    "model_name": Optional[str]
    "project_id": Optional[int]
    "created_by": Author
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/invocations (mjolnir.deployment_invokation.create_invocation)[POST] -> DeploymentInvokation | Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

create_invocation

    You may either post a singular object or array of objects.

With NewInvokation defined as 

{
    "created_date": Optional[EpochDateTime]
    "duration": int
    "number_rows": int
    "action": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "raw_score_path": URL
    "out_score_path": URL
    "deployment_id": Optional[int]
    "project_id": Optional[int]
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Return-only definitions: DeploymentInvokation | Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

With DeploymentInvokation defined as 

{
    "tenant_id": int
    "id": int
    "deployment_id": Optional[int]
    "project_id": Optional[int]
    "duration_ms": int
    "number_rows": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "raw_score_path": URL
    "out_score_path": URL
    "created_date": EpochDateTime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

/v1/folders/<folder_id:int> (mjolnir.folder.add_content_to_folder)[POST] -> Folder

add_content_to_folder


Return-only definitions: Folder

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folders (mjolnir.folder.create_folder)[POST] -> Folder

create_folder


Return-only definitions: Folder

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folders/<folder_id:int>/roles (mjolnir.folder.create_folder_role)[POST] -> FolderRole

create_folder_role


Return-only definitions: FolderRole

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/folders/<folder_id:int> (mjolnir.folder.delete_folder)[DELETE] -> Folder

delete_folder


Return-only definitions: Folder

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folder_roles/<role_id:int> (mjolnir.folder.delete_folder_role)[DELETE] -> FolderRole

delete_folder_role


Return-only definitions: FolderRole

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/folders/<folder_id:int> (mjolnir.folder.get_folder)[GET] -> Folder

get_folder


Return-only definitions: Folder

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folders/<folder_id:int>/blueprints (mjolnir.folder.get_folder_blueprints)[GET] -> List[horcrux.aible.project.Project]

get_folder_blueprints


Return-only definitions: List[horcrux.aible.project.Project]

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/folders/<folder_id:int>/projects (mjolnir.folder.get_folder_projects)[GET] -> List[horcrux.aible.blueprint.GuidedBlueprint]

get_folder_projects


Return-only definitions: List[horcrux.aible.blueprint.GuidedBlueprint]

With GuidedBlueprint defined as 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folder_roles/<role_id:int> (mjolnir.folder.get_folder_role)[GET] -> FolderRole

get_folder_role


Return-only definitions: FolderRole

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/folder_roles (mjolnir.folder.get_folder_roles)[GET] -> List[horcrux.aible.folder_role.FolderRole]

get_folder_roles


Return-only definitions: List[horcrux.aible.folder_role.FolderRole]

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/folders/<folder_id:int>/roles (mjolnir.folder.get_folder_roles)[GET] -> List[horcrux.aible.folder_role.FolderRole]

get_folder_roles


Return-only definitions: List[horcrux.aible.folder_role.FolderRole]

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/folders/<folder_id:int>/source_summaries (mjolnir.folder.get_folder_source_summaries)[GET] -> List[horcrux.aible.data_source_summary.DataSourceSummary]

get_folder_source_summaries


Return-only definitions: List[horcrux.aible.data_source_summary.DataSourceSummary]

With DataSourceSummary defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "name": str
    "source_type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "row_count": Optional[MetricSummary]
    "column_count": Optional[MetricSummary]
    "top_factors": Optional[MetricSummary]
    "num_useful_variables": Optional[MetricSummary]
    "readiness_score": Optional[MetricSummary]
    "dataset_count": int
    "error_dataset_count": int
    "total_cols": int
    "empty_col_count": int
    "binary_col_count": int
    "date_col_count": int
    "numeric_col_count": int
    "text_col_count": int
    "missing_header_count": int
    "duplicate_header_count": int
    "empty_rows_count": int
    "missing_fixed_count": int
    "too_many_values_count": int
    "unique_values_count": int
    "outlier_count": int
}

Where MetricSummary is defined by 

{
    "mean": int | float
    "histogram": MetricHistogram
}

Where MetricHistogram is defined by 

{
    "bins": List[int]
    "counts": List[int]
}

/v1/folders/<folder_id:int>/training_data (mjolnir.folder.get_folder_training_data)[GET] -> List[horcrux.aible.training.Training]

get_folder_training_data


Return-only definitions: List[horcrux.aible.training.Training]

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folders (mjolnir.folder.get_folders)[GET] -> List[horcrux.aible.folder.Folder]

get_folders


Return-only definitions: List[horcrux.aible.folder.Folder]

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folders/<folder_id:int> (mjolnir.folder.update_folder)[PATCH] -> Folder

update_folder


Return-only definitions: Folder

With Folder defined as 

{
    "tenant_id": int
    "id": int
    "name": SafeString
    "description": SafeString
    "default_role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "roles": List[horcrux.aible.folder_role.FolderRole]
    "contents": FolderContents
    "permissions": Permissions
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where FolderRole is defined by 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where FolderContents is defined by 

{
    "blueprint_count": int
    "project_count": int
    "training_data_count": int
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/folder_roles/<role_id:int> (mjolnir.folder.update_folder_role)[PATCH] -> FolderRole

update_folder_role


Return-only definitions: FolderRole

With FolderRole defined as 

{
    "tenant_id": int
    "id": int
    "folder_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": IUser
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": IUser
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where IUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/job/<job_id:int>/cancel (mjolnir.jobs.abort)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
abort


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/jobs (mjolnir.jobs.create)[POST] -> ModelTrainingJob

create
Return a token representing a job.

    A job is:
        - Run a set of models M
        - Each model produces 1-1000 results (confusion matrices)
    consumes:
        training_data_id: int
        error_cost_ratio: float
        budget: float
        outcome_key: str
        outcome_value: any
    produces:
        token: str

With NewModelTrainingJob defined as 

{
    "budget": float | int
    "account_id": int
    "tags": FrozenSet[horcrux.aible.job.JobTags]
    "error_cost_ratio": float | int
    "value_matrix": ConfusionMatrix | ImpactMatrix
    "max_ideal_population": int
    "current_capacity": int
    "extra": Optional[dict]
    "name": Optional[str]
    "derived_columns": Optional[List[Union[dict, list]]]
    "model_names": Optional[List[str]]
    "column_type_overrides": Optional[Dict[str, horcrux.aible.types.ColumnType]]
    "training_data_id": int
    "outcome_key": str
    "outcome_value": str | float | int | List[int] | List[Union[int, float]] | List[float] | List[str]
    "drop_columns": Optional[List[str]]
    "model_type": Optional['CATEGORICAL' | 'REGRESSION' | 'ALL']
    "drop_rows": Optional[List[mjolnir.jobs.DropKeyRow]]
    "score_function": Optional[ScoreFunction]
    "parent_blueprint_id": Optional[int]
    "external_model_setup_url": Optional[str]
    "timeseries_key": Optional[str]
    "train_split_condition": Optional[Condition]
    "test_split_condition": Optional[Condition]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where DropKeyRow is defined by 

{
    "key": str
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "operation": Optional['INCLUDE' | 'EXCLUDE']
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": Optional[List[Optional[str]] | List[Union[int, NoneType, float]]]
    "conditions": Optional[List[str]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where Condition is defined by 

{
    ...
}

Return-only definitions: ModelTrainingJob

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job (mjolnir.jobs.create)[POST] -> ModelTrainingJob

create
Return a token representing a job.

    A job is:
        - Run a set of models M
        - Each model produces 1-1000 results (confusion matrices)
    consumes:
        training_data_id: int
        error_cost_ratio: float
        budget: float
        outcome_key: str
        outcome_value: any
    produces:
        token: str

With NewModelTrainingJob defined as 

{
    "budget": float | int
    "account_id": int
    "tags": FrozenSet[horcrux.aible.job.JobTags]
    "error_cost_ratio": float | int
    "value_matrix": ConfusionMatrix | ImpactMatrix
    "max_ideal_population": int
    "current_capacity": int
    "extra": Optional[dict]
    "name": Optional[str]
    "derived_columns": Optional[List[Union[dict, list]]]
    "model_names": Optional[List[str]]
    "column_type_overrides": Optional[Dict[str, horcrux.aible.types.ColumnType]]
    "training_data_id": int
    "outcome_key": str
    "outcome_value": str | float | int | List[int] | List[Union[int, float]] | List[float] | List[str]
    "drop_columns": Optional[List[str]]
    "model_type": Optional['CATEGORICAL' | 'REGRESSION' | 'ALL']
    "drop_rows": Optional[List[mjolnir.jobs.DropKeyRow]]
    "score_function": Optional[ScoreFunction]
    "parent_blueprint_id": Optional[int]
    "external_model_setup_url": Optional[str]
    "timeseries_key": Optional[str]
    "train_split_condition": Optional[Condition]
    "test_split_condition": Optional[Condition]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where DropKeyRow is defined by 

{
    "key": str
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "operation": Optional['INCLUDE' | 'EXCLUDE']
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": Optional[List[Optional[str]] | List[Union[int, NoneType, float]]]
    "conditions": Optional[List[str]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where Condition is defined by 

{
    ...
}

Return-only definitions: ModelTrainingJob

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int>/debug (mjolnir.jobs.debug)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
debug


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/job/<job_id:int> (mjolnir.jobs.delete)[DELETE] -> ModelTrainingJob

delete


Return-only definitions: ModelTrainingJob

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int> (mjolnir.jobs.get)[GET] -> Annotated[ForwardRef('JSON'), Inferred]

get
With a given job id, return the status (chunked)
until done.

Upon a first time connection, dump the current status (for instant draw) and
then stream progress as it happens.

If complete, then there is no progress so close.

States:
    'not_started' (not implemented)
    'running'
    'done'

Deltas are:
    models:


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/jobs (mjolnir.jobs.list_all)[GET] -> Tuple[horcrux.aible.job.ModelTrainingJob, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.job.ModelTrainingJob, ...]

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job (mjolnir.jobs.list_all)[GET] -> Tuple[horcrux.aible.job.ModelTrainingJob, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.job.ModelTrainingJob, ...]

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/accounts/<account_id:int>/jobs (mjolnir.jobs.list_all)[GET] -> Tuple[horcrux.aible.job.ModelTrainingJob, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.job.ModelTrainingJob, ...]

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/jobs/by/<tag_name:string> (mjolnir.jobs.list_by_tag)[GET] -> Tuple[horcrux.aible.job.ModelTrainingJob, ...]

list_by_tag


Return-only definitions: Tuple[horcrux.aible.job.ModelTrainingJob, ...]

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int>/models (mjolnir.jobs.list_runs_by_job)[GET] -> Tuple[horcrux.aible.job.TrainedModel, ...]

list_runs_by_job


Return-only definitions: Tuple[horcrux.aible.job.TrainedModel, ...]

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int>/runs (mjolnir.jobs.list_runs_by_job)[GET] -> Tuple[horcrux.aible.job.TrainedModel, ...]

list_runs_by_job


Return-only definitions: Tuple[horcrux.aible.job.TrainedModel, ...]

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int> (mjolnir.jobs.update)[PATCH] -> ModelTrainingJob

update
Handle a protected post, lookup a job and add to it.

With NewModelData defined as 

{
    "action": Optional['NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR']
    "data": Optional[List[mjolnir.jobs.NewRunData]]
    "name": Optional[str]
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
    "models_to_run": Optional[List[str]]
}

Where NewRunData is defined by 

{
    "confusion_matrices": Optional[List[List[int]]]
    "metrics": Optional[dict]
    "feature_importance": Optional[dict]
    "metadata": Optional[dict]
    "plots": Optional[Plots]
    "name": str
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Return-only definitions: ModelTrainingJob

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/language_model_artifacts/<artifact_id:int>/comments (mjolnir.language_model_artifact.add_artifact_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_artifact_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/language_model_artifacts/<artifact_id:int>/ratings (mjolnir.language_model_artifact.add_artifacts_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_artifacts_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/language_model_artifacts/<artifact_id:int>/uploads (mjolnir.language_model_artifact.add_artifacts_upload)[POST] -> PresignedURL

add_artifacts_upload

With LanguageModelArtifactUpload defined as 

{
    "filename": str
}

Return-only definitions: PresignedURL

With PresignedURL defined as 

{
    "data_url": str
    "presigned_url": str | dict
}

/v1/account/<account_id:int>/artifacts (mjolnir.language_model_artifact.create)[POST] -> LanguageModelArtifact

create

With LanguageModelArtifactCreate defined as 

{
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: LanguageModelArtifact

With LanguageModelArtifact defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "account_id": int
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/language_model_artifacts/<artifact_id:int> (mjolnir.language_model_artifact.delete)[DELETE] -> LanguageModelArtifact

delete


Return-only definitions: LanguageModelArtifact

With LanguageModelArtifact defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "account_id": int
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/language_model_artifacts/<artifact_id:int> (mjolnir.language_model_artifact.get)[GET] -> LanguageModelArtifact

get


Return-only definitions: LanguageModelArtifact

With LanguageModelArtifact defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "account_id": int
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/language_model_artifacts/<artifact_id:int>/ratings (mjolnir.language_model_artifact.get_artifacts_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_artifacts_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/language_model_artifacts/<artifact_id:int>/comments (mjolnir.language_model_artifact.get_training_data_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_training_data_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/language_model_artifacts (mjolnir.language_model_artifact.list_all)[GET] -> List[horcrux.aible.language_model_artifact.LanguageModelArtifact]

list_all


Return-only definitions: List[horcrux.aible.language_model_artifact.LanguageModelArtifact]

With LanguageModelArtifact defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "account_id": int
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/language_model_artifacts/<artifact_id:int> (mjolnir.language_model_artifact.update)[PATCH] -> LanguageModelArtifact

update

With LanguageModelArtifactUpdate defined as 

{
    "folder_id": Optional[int]
    "name": Optional[str]
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: LanguageModelArtifact

With LanguageModelArtifact defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "account_id": int
    "folder_id": int
    "type": 'CORPUS' | 'FINE_TUNED_MODEL' | 'FINE_TUNING_DATA'
    "name": str
    "description": str
    "metadata": dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/licensing (mjolnir.licensing.create)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
create


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/licensing (mjolnir.licensing.list_all)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
list_all


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/login/password (mjolnir.login.check_password)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

check_password

With LoginRequest defined as 

{
    "token": str
    "password": str
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/login/create_bulk (mjolnir.login.create_bulk_users)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

create_bulk_users

With NewUserInTenant defined as 

{
    "email": Address
    "fullname": str
    "invite_tokens": List[str]
    "password": Optional[str | RandomPassword]
    "aliases": List[Union[mjolnir.login.NewUserAlias, str]]
}

Where NewUserAlias is defined by 

{
    "namespace": str
    "external_id": str
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/lookup-token (mjolnir.login.create_lookup_token)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

create_lookup_token

Generates a random lookup token and associates it with the tenant's API token.
This lookup token will then be passed to the customer's API gateway to be
validated against the /lookup-token/validate route to ensure the end-user
has rights run the lambda function.


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/login/reset (mjolnir.login.create_reset_user_request)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
create_reset_user_request


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/login/create (mjolnir.login.create_user)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

create_user

With NewUser defined as 

{
    "email": Address
    "fullname": str
    "password": str | RandomPassword
    "invite_tokens": List[str]
    "tenant": Optional[NewTenant]
    "accepts_terms_of_service": bool
}

Where NewTenant is defined by 

{
    "fullname": str
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/ssoRedirect (mjolnir.login.get_sso_redirect)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
get_sso_redirect


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/login/<token:str>/activate (mjolnir.login.handle_activate_user)[GET, HEAD] -> Annotated[ForwardRef('JSON'), Inferred]
```
handle_activate_user


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/login/<token:str>/deactivate (mjolnir.login.handle_deactivate_user)[GET, HEAD] -> Annotated[ForwardRef('JSON'), Inferred]
```
handle_deactivate_user


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/login (mjolnir.login.login_user)[POST] -> ProvisionalLoginRequest | ProvisionalLoginWithExternalRequest

login_user

With EmailLogin defined as 

{
    "email": str
}

Return-only definitions: ProvisionalLoginRequest | ProvisionalLoginWithExternalRequest

With ProvisionalLoginRequest defined as 

{
    "token": str
    "gravatar_uri": str
    "token_expires_at": int | float
}

Where ProvisionalLoginWithExternalRequest is defined by 

{
    "token": str
    "gravatar_uri": str
    "token_expires_at": int | float
    "external_authorization_url": str
}

/v1/logout (mjolnir.login.logout)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
logout


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/login/azure/authorized (mjolnir.login.on_azure_authorized_get)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
on_azure_authorized_get


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/login/azure/authorized (mjolnir.login.on_azure_authorized_post)[POST]

on_azure_authorized_post

With AzureAuthorized defined as 

{
    "state": str
    "code": Optional[str]
}

/v1/renew/login (mjolnir.login.renew_user_token)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
renew_user_token


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/login/<token:str>/reset (mjolnir.login.reset_user)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
reset_user


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/logout/saml-reply (mjolnir.login.saml_logout)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

saml_logout

Use the NameID in the session to initiate a saml log out.

TODO:
    - Graft NameID into the session
    - mark a session as SAML mediated
    - mark a session with the ForeignTenantAuthentication id!


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/login/saml-reply (mjolnir.login.saml_reply)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
saml_reply

Handle a SAML ACS reply


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/login/by/<tenant_id:int>/via/<key:str> (mjolnir.login.service_provider_initiated_login)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
service_provider_initiated_login


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/lookup-token/validate (mjolnir.login.validate_lookup_token)[POST] -> Annotated[ForwardRef('JSON'), Inferred]

validate_lookup_token

    Returns true if the lookup token and auth token parameters match
    the key/value pair stored in cache. This method is used to determine
    if a lambda or azure function-app is authorized to run when accessed
    via an API gateway.

With AuthLookupTokenPair defined as 

{
    "lookup_token": str
    "auth_token": str
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/offer/<offer_id:int> (mjolnir.marketplace.archive_offer)[DELETE] -> Offer

archive_offer

Used to fix up an offer


Return-only definitions: Offer

With Offer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplaces (mjolnir.marketplace.create)[POST] -> Marketplace

create

With NewMarketplace defined as 

{
    "title": str
    "description": str
    "public": Optional[bool]
}

Return-only definitions: Marketplace

With Marketplace defined as 

{
    "tenant_id": int
    "id": int
    "flags": 'PUBLISHED_INTERNAL' | 'PUBLISHED_EXTERNAL' | 'REQUIRES_APPROVAL'
    "title": SafeString
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "created_by": Author
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplace/<marketplace_id:int>/offers (mjolnir.marketplace.create_new_offer)[POST] -> Offer

create_new_offer

With PublishNewOffer defined as 

{
    "type": 'BLUEPRINT'
    "name": str
    "description": str
    "blueprint_id": int
    "status": Optional['DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED']
}

Return-only definitions: Offer

With Offer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplace/<marketplace_id:int> (mjolnir.marketplace.get)[GET] -> Marketplace

get


Return-only definitions: Marketplace

With Marketplace defined as 

{
    "tenant_id": int
    "id": int
    "flags": 'PUBLISHED_INTERNAL' | 'PUBLISHED_EXTERNAL' | 'REQUIRES_APPROVAL'
    "title": SafeString
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "created_by": Author
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/purchased/<purchase_id:int> (mjolnir.marketplace.get_purchase)[GET] -> PurchasedOffer

get_purchase

Used for looking up what offer a purchase_id (as in on a blueprint, model, etc) came from.


Return-only definitions: PurchasedOffer

With PurchasedOffer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchased_by": Author
    "purchase_date": EpochDateTime
    "offer_id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplaces (mjolnir.marketplace.list_all)[GET] -> Tuple[horcrux.aible.marketplace.Marketplace, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.marketplace.Marketplace, ...]

With Marketplace defined as 

{
    "tenant_id": int
    "id": int
    "flags": 'PUBLISHED_INTERNAL' | 'PUBLISHED_EXTERNAL' | 'REQUIRES_APPROVAL'
    "title": SafeString
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "created_by": Author
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplace/<marketplace_id:int>/offers (mjolnir.marketplace.list_offers)[GET] -> Tuple[horcrux.aible.marketplace.Offer, ...]

list_offers

Use this to list the available items for sale in this marketplace!

If you call this on your own marketplace, you will see (mostly) EVERYTHING (draft, published)

But everyone else will only see published on an external published market.


Return-only definitions: Tuple[horcrux.aible.marketplace.Offer, ...]

With Offer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/marketplace/<marketplace_id:int>/purchased (mjolnir.marketplace.list_purchased_by_marketplace)[GET] -> Tuple[horcrux.aible.marketplace.PurchasedOffer, ...]

list_purchased_by_marketplace


Return-only definitions: Tuple[horcrux.aible.marketplace.PurchasedOffer, ...]

With PurchasedOffer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchased_by": Author
    "purchase_date": EpochDateTime
    "offer_id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/offer/<offer_id:int>/buy (mjolnir.marketplace.purchase_offer)[POST] -> Offer | PurchasedOffer

purchase_offer


Return-only definitions: Offer | PurchasedOffer

With Offer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where PurchasedOffer is defined by 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchased_by": Author
    "purchase_date": EpochDateTime
    "offer_id": int
}

/v1/marketplace/<marketplace_id:int> (mjolnir.marketplace.update)[PATCH] -> Marketplace

update

With UpdateMarketplace defined as 

{
    "flags": Optional['PUBLISHED_INTERNAL' | 'PUBLISHED_EXTERNAL' | 'REQUIRES_APPROVAL']
    "title": Optional[str]
    "description": Optional[str]
}

Return-only definitions: Marketplace

With Marketplace defined as 

{
    "tenant_id": int
    "id": int
    "flags": 'PUBLISHED_INTERNAL' | 'PUBLISHED_EXTERNAL' | 'REQUIRES_APPROVAL'
    "title": SafeString
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "created_by": Author
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/offer/<offer_id:int> (mjolnir.marketplace.update_offer)[PATCH] -> Offer

update_offer

    Used to fix up an offer

With UpdateOffer defined as 

{
    "status": Optional['DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED']
    "name": Optional[str]
    "description": Optional[str]
    "blueprint_id": Optional[int]
}

Return-only definitions: Offer

With Offer defined as 

{
    "tenant_id": int
    "id": int
    "marketplace_id": int
    "entity_id": int
    "status": 'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'PURCHASED'
    "type": 'BLUEPRINT'
    "name": SafeString
    "created_by": Author
    "description": SafeString
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/models (mjolnir.model.create)[POST] -> NewModel | Tuple[mjolnir.model.NewModel, ...]

create

With NewModel defined as 

{
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Optional[Dict[str, Any]]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
}

Return-only definitions: NewModel | Tuple[mjolnir.model.NewModel, ...]

With NewModel defined as 

{
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Optional[Dict[str, Any]]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
}

/v1/model/<model_id:int> (mjolnir.model.delete)[DELETE] -> Model

delete


Return-only definitions: Model

With Model defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Dict[str, Any]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/models (mjolnir.model.list_all)[GET] -> Tuple[horcrux.aible.model.Model, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.model.Model, ...]

With Model defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Dict[str, Any]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/model (mjolnir.model.list_all)[GET] -> Tuple[horcrux.aible.model.Model, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.model.Model, ...]

With Model defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Dict[str, Any]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/models (mjolnir.model.mass_update)[PATCH] -> Tuple[horcrux.aible.model.Model, ...]

mass_update

With UpdateMultiModel defined as 

{
    "display_name": Optional[str]
    "options": Optional[Tuple[horcrux.aible.model.ModelOption, ...]]
    "metadata": Optional[Dict[str, Any]]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
    "name": str
}

Return-only definitions: Tuple[horcrux.aible.model.Model, ...]

With Model defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Dict[str, Any]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/model/<model_id:int> (mjolnir.model.update)[PATCH] -> Model

update

With UpdateModel defined as 

{
    "display_name": Optional[str]
    "options": Optional[Tuple[horcrux.aible.model.ModelOption, ...]]
    "metadata": Optional[Dict[str, Any]]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
}

Return-only definitions: Model

With Model defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "name": str
    "display_name": str
    "type": 'CLASSIFICATION' | 'REGRESSION' | 'TIME_SERIES'
    "options": Tuple[horcrux.aible.model.ModelOption, ...]
    "metadata": Dict[str, Any]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/generate_presigned_url (mjolnir.presign.presign_api_request)[GET, POST, PATCH, DELETE] -> str

presign_api_request

    Create a URL that upon executing http ``method`` on it (defaults to the method of
    this presign request unless ``method_override`` is provided) with given ``params``.

    You may omit ``expires_in`` (defaults to 5 minutes). Alternatively, you can pass
    in a string representing a duration (i.e. "5 days") for ``expires_in``.

    In addition, you may specify ``-1`` for ``expires_in``, which will default
    to the maximum presigned lifetime configured for this instance.

    Presigned URLs are designed for executing authorized actions upon the Aible
    backend within reason.

    Example:

    Assume that you want to call ``training_data.get_training_data`` for data id 123 without
    needing to login. You can create a URL that will allow a ``GET`` using the following
    ``POST``:

        {
            "method_override": "GET",
            "action": "training_data.get_training_data",
            "params": {"training_data_id": 123}
        }

With PresignedRequest defined as 

{
    "action": str
    "params": Dict[str, Any]
    "expires_in": int | float
    "method_override": Optional['GET' | 'PATCH' | 'POST' | 'DELETE']
}

Return-only definitions: str

/v1/project_scenarios/<project_scenario_id:int>/comments (mjolnir.project.add_project_scenario_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_project_scenario_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<project_scenario_id:int>/ratings (mjolnir.project.add_project_scenario_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_project_scenario_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenario/<scenario_id:int>/segments/<project_segment_id:int>/assumptions/<assumption_id:int> (mjolnir.project.add_project_scenario_segment_assumption)[POST] -> ProjectSegment

add_project_scenario_segment_assumption


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int>/comments (mjolnir.project.add_project_segment_assumption_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_project_segment_assumption_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int>/ratings (mjolnir.project.add_project_segment_assumption_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_project_segment_assumption_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/tasks/<task_id:int> (mjolnir.project.add_project_segment_task)[POST] -> ProjectSegment

add_project_segment_task


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_tasks/<project_task_id:int>/comments (mjolnir.project.add_project_task_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_project_task_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_tasks/<project_task_id:int>/ratings (mjolnir.project.add_project_task_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_project_task_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects (mjolnir.project.create_project)[POST] -> Project

create_project


Return-only definitions: Project

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/projects/<project_id:int>/monitors (mjolnir.project.create_project_monitor)[POST] -> ProjectMonitor

create_project_monitor


Return-only definitions: ProjectMonitor

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/monitor_snapshots (mjolnir.project.create_project_monitor_snapshots)[POST] -> ProjectScenario

create_project_monitor_snapshots


Return-only definitions: ProjectScenario

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/roles (mjolnir.project.create_project_role)[POST] -> ProjectRole

create_project_role


Return-only definitions: ProjectRole

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<scenario_id:int>/segments (mjolnir.project.create_project_scenario_segment)[POST] -> ProjectSegment

create_project_scenario_segment


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_scenario/<scenario_id:int>/segments/<project_segment_id:int>/assumptions (mjolnir.project.create_project_scenario_segment_assumption)[POST] -> ProjectSegment

create_project_scenario_segment_assumption


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/projects/<project_id:int>/scenarios (mjolnir.project.create_project_scenarios)[POST] -> ProjectScenario

create_project_scenarios


Return-only definitions: ProjectScenario

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/segments (mjolnir.project.create_project_segment)[POST] -> ProjectSegment

create_project_segment


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segments/<project_segment_id:int>/assumptions (mjolnir.project.create_project_segment_assumption)[POST] -> ProjectSegmentAssumption

create_project_segment_assumption


Return-only definitions: ProjectSegmentAssumption

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/jobs (mjolnir.project.create_project_segment_job)[POST] -> ProjectSegmentJob

create_project_segment_job


Return-only definitions: ProjectSegmentJob

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segments/<project_segment_id:int>/monitors (mjolnir.project.create_project_segment_monitor)[POST] -> ProjectSegmentMonitor

create_project_segment_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/roles (mjolnir.project.create_project_segment_role)[POST] -> List[horcrux.aible.project_segment_role.ProjectSegmentRole]

create_project_segment_role


Return-only definitions: List[horcrux.aible.project_segment_role.ProjectSegmentRole]

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_segments/<project_segment_id:int>/tasks (mjolnir.project.create_project_segment_task)[POST] -> ProjectSegment

create_project_segment_task


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segments/<project_segment_id:int>/users/<user_id:int>/monitors (mjolnir.project.create_project_segment_user_monitor)[POST] -> ProjectSegmentMonitor

create_project_segment_user_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_tasks (mjolnir.project.create_project_task)[POST] -> ProjectTask

create_project_task


Return-only definitions: ProjectTask

With ProjectTask defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_tasks/<task_id:int>/versions (mjolnir.project.create_project_task_version)[POST] -> ProjectTask

create_project_task_version


Return-only definitions: ProjectTask

With ProjectTask defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/segments (mjolnir.project.create_segment)[POST] -> List[horcrux.aible.segment.Segment]

create_segment


Return-only definitions: List[horcrux.aible.segment.Segment]

With Segment defined as 

{
    "tenant_id": int
    "id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int> (mjolnir.project.delete_project)[DELETE] -> Project

delete_project


Return-only definitions: Project

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/project_monitors/<monitor_id:int> (mjolnir.project.delete_project_monitor)[DELETE] -> ProjectMonitor

delete_project_monitor


Return-only definitions: ProjectMonitor

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_roles/<role_id:int> (mjolnir.project.delete_project_role)[DELETE] -> ProjectRole

delete_project_role


Return-only definitions: ProjectRole

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<scenario_id:int> (mjolnir.project.delete_project_scenario)[DELETE] -> ProjectScenario

delete_project_scenario


Return-only definitions: ProjectScenario

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int> (mjolnir.project.delete_project_segment)[DELETE] -> ProjectSegment

delete_project_segment


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int> (mjolnir.project.delete_project_segment_assumption)[DELETE] -> ProjectSegmentAssumption

delete_project_segment_assumption


Return-only definitions: ProjectSegmentAssumption

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_jobs/<project_segment_job_id:int> (mjolnir.project.delete_project_segment_job)[DELETE] -> ProjectSegmentJob

delete_project_segment_job


Return-only definitions: ProjectSegmentJob

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segment_monitors/<project_segment_monitor_id:int> (mjolnir.project.delete_project_segment_monitor)[DELETE] -> ProjectSegmentMonitor

delete_project_segment_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_roles/<project_segment_role_id:int> (mjolnir.project.delete_project_segment_role)[DELETE] -> ProjectSegmentRole

delete_project_segment_role


Return-only definitions: ProjectSegmentRole

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_segment_user_monitors/<project_segment_user_monitor_id:int> (mjolnir.project.delete_project_segment_user_monitor)[DELETE] -> ProjectSegmentMonitor

delete_project_segment_user_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/segments/<segment_id:int> (mjolnir.project.delete_segment)[DELETE] -> Segment

delete_segment


Return-only definitions: Segment

With Segment defined as 

{
    "tenant_id": int
    "id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int> (mjolnir.project.get_project)[GET] -> Project

get_project


Return-only definitions: Project

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/projects/<project_id:int>/frontier (mjolnir.project.get_project_frontier)[GET] -> ProjectFrontier

get_project_frontier


Return-only definitions: ProjectFrontier

With ProjectFrontier defined as 

{
    "head": Optional[ProjectSegmentFrontier]
    "models": List[mjolnir.models.project_frontier.ProjectSegmentFrontier]
    "blueprint": Optional[GuidedBlueprint]
}

Where ProjectSegmentFrontier is defined by 

{
    "project_segment_id": int
    "project_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "job_id": int
    "model_name": Optional[str]
    "assumption_data": Optional[dict]
}

Where Condition is defined by 

{
    ...
}

Where GuidedBlueprint is defined by 

{
    "tenant_id": int
    "folder_id": Optional[int]
    "id": int
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "name": Optional[SafeString]
    "suggested_fields": List[horcrux.aible.blueprint.SuggestedKey]
    "wizard": dict
    "version": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "purchase_id": Optional[int]
    "permissions": Permissions
}

Where SuggestedKey is defined by 

{
    "name": SafeString
    "aliases": List[str]
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "description": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/project_monitors/<monitor_id:int> (mjolnir.project.get_project_monitor)[GET] -> ProjectMonitor

get_project_monitor


Return-only definitions: ProjectMonitor

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_monitor_snapshots (mjolnir.project.get_project_monitor_snapshots)[GET] -> List[horcrux.aible.project_scenario.ProjectScenario]

get_project_monitor_snapshots


Return-only definitions: List[horcrux.aible.project_scenario.ProjectScenario]

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/monitor_snapshots (mjolnir.project.get_project_monitor_snapshots)[GET] -> List[horcrux.aible.project_scenario.ProjectScenario]

get_project_monitor_snapshots


Return-only definitions: List[horcrux.aible.project_scenario.ProjectScenario]

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_monitors (mjolnir.project.get_project_monitors)[GET] -> List[horcrux.aible.project_monitor.ProjectMonitor]

get_project_monitors


Return-only definitions: List[horcrux.aible.project_monitor.ProjectMonitor]

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/monitors (mjolnir.project.get_project_monitors)[GET] -> List[horcrux.aible.project_monitor.ProjectMonitor]

get_project_monitors


Return-only definitions: List[horcrux.aible.project_monitor.ProjectMonitor]

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_roles/<role_id:int> (mjolnir.project.get_project_role)[GET] -> ProjectRole

get_project_role


Return-only definitions: ProjectRole

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_roles (mjolnir.project.get_project_roles)[GET] -> List[horcrux.aible.project_role.ProjectRole]

get_project_roles


Return-only definitions: List[horcrux.aible.project_role.ProjectRole]

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/roles (mjolnir.project.get_project_roles)[GET] -> List[horcrux.aible.project_role.ProjectRole]

get_project_roles


Return-only definitions: List[horcrux.aible.project_role.ProjectRole]

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<scenario_id:int> (mjolnir.project.get_project_scenario)[GET] -> ProjectScenario

get_project_scenario


Return-only definitions: ProjectScenario

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<project_scenario_id:int>/comments (mjolnir.project.get_project_scenario_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_project_scenario_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<project_scenario_id:int>/ratings (mjolnir.project.get_project_scenario_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_project_scenario_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios (mjolnir.project.get_project_scenarios)[GET] -> List[horcrux.aible.project_scenario.ProjectScenario]

get_project_scenarios


Return-only definitions: List[horcrux.aible.project_scenario.ProjectScenario]

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/scenarios (mjolnir.project.get_project_scenarios)[GET] -> List[horcrux.aible.project_scenario.ProjectScenario]

get_project_scenarios


Return-only definitions: List[horcrux.aible.project_scenario.ProjectScenario]

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int> (mjolnir.project.get_project_segment)[GET] -> ProjectSegment

get_project_segment


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int> (mjolnir.project.get_project_segment_assumption)[GET] -> ProjectSegmentAssumption

get_project_segment_assumption


Return-only definitions: ProjectSegmentAssumption

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int>/comments (mjolnir.project.get_project_segment_assumption_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_project_segment_assumption_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_assumptions/<project_segment_assumption_id:int>/ratings (mjolnir.project.get_project_segment_assumption_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_project_segment_assumption_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_assumptions (mjolnir.project.get_project_segment_assumptions)[GET] -> List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]

get_project_segment_assumptions


Return-only definitions: List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/assumptions (mjolnir.project.get_project_segment_assumptions)[GET] -> List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]

get_project_segment_assumptions


Return-only definitions: List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_jobs/<project_segment_job_id:int> (mjolnir.project.get_project_segment_job)[GET] -> ProjectSegmentJob

get_project_segment_job


Return-only definitions: ProjectSegmentJob

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segment_jobs (mjolnir.project.get_project_segment_jobs)[GET] -> List[horcrux.aible.project_segment_job.ProjectSegmentJob]

get_project_segment_jobs


Return-only definitions: List[horcrux.aible.project_segment_job.ProjectSegmentJob]

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segments/<project_segment_id:int>/jobs (mjolnir.project.get_project_segment_jobs)[GET] -> List[horcrux.aible.project_segment_job.ProjectSegmentJob]

get_project_segment_jobs


Return-only definitions: List[horcrux.aible.project_segment_job.ProjectSegmentJob]

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segment_monitors/<project_segment_monitor_id:int> (mjolnir.project.get_project_segment_monitor)[GET] -> ProjectSegmentMonitor

get_project_segment_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_monitors (mjolnir.project.get_project_segment_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/segment_monitors (mjolnir.project.get_project_segment_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/monitors (mjolnir.project.get_project_segment_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_roles/<project_segment_role_id:int> (mjolnir.project.get_project_segment_role)[GET] -> ProjectSegmentRole

get_project_segment_role


Return-only definitions: ProjectSegmentRole

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_segment_roles (mjolnir.project.get_project_segment_roles)[GET] -> List[horcrux.aible.project_segment_role.ProjectSegmentRole]

get_project_segment_roles


Return-only definitions: List[horcrux.aible.project_segment_role.ProjectSegmentRole]

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_segments/<project_segment_id:int>/roles (mjolnir.project.get_project_segment_roles)[GET] -> List[horcrux.aible.project_segment_role.ProjectSegmentRole]

get_project_segment_roles


Return-only definitions: List[horcrux.aible.project_segment_role.ProjectSegmentRole]

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_segment_user_monitors/<project_segment_user_monitor_id:int> (mjolnir.project.get_project_segment_user_monitor)[GET] -> ProjectSegmentMonitor

get_project_segment_user_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_user_monitors (mjolnir.project.get_project_segment_user_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_user_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int>/users/<user_id:int>/monitors (mjolnir.project.get_project_segment_user_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_user_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/segment_user_monitors (mjolnir.project.get_project_segment_user_monitors)[GET] -> List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

get_project_segment_user_monitors


Return-only definitions: List[horcrux.aible.project_segment_monitor.ProjectSegmentMonitor]

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments (mjolnir.project.get_project_segments)[GET] -> List[horcrux.aible.project_segment.ProjectSegment]

get_project_segments


Return-only definitions: List[horcrux.aible.project_segment.ProjectSegment]

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/projects/<project_id:int>/segments (mjolnir.project.get_project_segments)[GET] -> List[horcrux.aible.project_segment.ProjectSegment]

get_project_segments


Return-only definitions: List[horcrux.aible.project_segment.ProjectSegment]

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_tasks/<project_task_id:int>/comments (mjolnir.project.get_project_task_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_project_task_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_tasks/<project_task_id:int>/ratings (mjolnir.project.get_project_task_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_project_task_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_tasks (mjolnir.project.get_project_tasks)[GET] -> ProjectTask

get_project_tasks


Return-only definitions: ProjectTask

With ProjectTask defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/projects (mjolnir.project.get_projects)[GET] -> List[horcrux.aible.project.Project]

get_projects


Return-only definitions: List[horcrux.aible.project.Project]

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/segments/<segment_id:int> (mjolnir.project.get_segment)[GET] -> Segment

get_segment


Return-only definitions: Segment

With Segment defined as 

{
    "tenant_id": int
    "id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/segments (mjolnir.project.get_segments)[GET] -> List[horcrux.aible.segment.Segment]

get_segments


Return-only definitions: List[horcrux.aible.segment.Segment]

With Segment defined as 

{
    "tenant_id": int
    "id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/projects/<project_id:int>/invocations (mjolnir.project.list_project_invocations)[GET] -> Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

list_project_invocations


Return-only definitions: Tuple[horcrux.aible.deployment.DeploymentInvokation, ...]

With DeploymentInvokation defined as 

{
    "tenant_id": int
    "id": int
    "deployment_id": Optional[int]
    "project_id": Optional[int]
    "duration_ms": int
    "number_rows": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "raw_score_path": URL
    "out_score_path": URL
    "created_date": EpochDateTime
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

/v1/project_segment_assumptions/<project_segment_assumption_id:int> (mjolnir.project.patch_project_segment_assumption)[PATCH] -> ProjectSegmentAssumption

patch_project_segment_assumption


Return-only definitions: ProjectSegmentAssumption

With ProjectSegmentAssumption defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_jobs/<project_segment_job_id:int> (mjolnir.project.patch_project_segment_job)[PATCH] -> ProjectSegmentJob

patch_project_segment_job


Return-only definitions: ProjectSegmentJob

With ProjectSegmentJob defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/project_segment_monitors/<project_segment_monitor_id:int> (mjolnir.project.patch_project_segment_monitor)[PATCH] -> ProjectSegmentMonitor

patch_project_segment_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_user_monitors/<project_segment_user_monitor_id:int> (mjolnir.project.patch_project_segment_user_monitor)[PATCH] -> ProjectSegmentMonitor

patch_project_segment_user_monitor


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenario/<scenario_id:int>/segments/<project_segment_id:int>/assumptions/<assumption_id:int> (mjolnir.project.remove_project_scenario_segment_assumption)[DELETE] -> ProjectSegment

remove_project_scenario_segment_assumption


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segments/<project_segment_id:int>/tasks/<task_id:int> (mjolnir.project.remove_project_segment_task)[DELETE] -> ProjectSegment

remove_project_segment_task


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/projects/<project_id:int> (mjolnir.project.update_project)[PATCH] -> Project

update_project


Return-only definitions: Project

With Project defined as 

{
    "tenant_id": int
    "account_id": int
    "folder_id": Optional[int]
    "id": int
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "monitors": List[horcrux.aible.project_monitor.ProjectMonitor]
    "segment_count": Optional[int]
    "segments": Optional[List[horcrux.aible.project_segment.ProjectSegment]]
    "scenarios": Optional[List[horcrux.aible.project_scenario.ProjectScenario]]
    "roles": Optional[List[horcrux.aible.project_role.ProjectRole]]
    "permissions": Optional[Permissions]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectMonitor is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where ProjectSegment is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

Where ProjectScenario is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

/v1/project_monitors/<monitor_id:int> (mjolnir.project.update_project_monitor)[PATCH] -> ProjectMonitor

update_project_monitor


Return-only definitions: ProjectMonitor

With ProjectMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "unique_id_name": Optional[str]
    "business_prediction_name": Optional[str]
    "terminal_conditions": List[horcrux.aible.segment.Condition]
    "activity_conditions": List[horcrux.aible.segment.Condition]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_roles/<role_id:int> (mjolnir.project.update_project_role)[PATCH] -> ProjectRole

update_project_role


Return-only definitions: ProjectRole

With ProjectRole defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_scenarios/<scenario_id:int> (mjolnir.project.update_project_scenario)[PATCH] -> ProjectScenario

update_project_scenario


Return-only definitions: ProjectScenario

With ProjectScenario defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_id": int
    "elements": List[horcrux.aible.project_scenario.ProjectScenarioElement]
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "name": SafeString
    "description": SafeString
    "segments": List[horcrux.aible.project_scenario.ProjectScenarioSegment]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioElement is defined by 

{
    "assumption_id": Optional[int]
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segments/<project_segment_id:int> (mjolnir.project.update_project_segment)[PATCH] -> ProjectSegment

update_project_segment


Return-only definitions: ProjectSegment

With ProjectSegment defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "segment_id": int
    "conditions": List[horcrux.aible.segment.Condition]
    "name": SafeString
    "description": SafeString
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "assumption": Optional[ProjectSegmentAssumption | ProjectScenarioSegment]
    "job": Optional[ProjectSegmentJob]
    "history": Optional[ProjectSegmentHistory]
    "roles": Optional[List[horcrux.aible.project_segment_role.ProjectSegmentRole]]
    "permissions": Optional[Permissions]
    "tasks": List[horcrux.aible.project_task.ProjectTask]
}

Where Condition is defined by 

{
    ...
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentAssumption is defined by 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectScenarioSegment is defined by 

{
    "id": int
    "data": dict
    "assumptions": List[horcrux.aible.project_assumption.ProjectAssumption]
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where ProjectSegmentJob is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "job_id": int
    "job": Optional[ModelTrainingJob]
    "data": dict
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ModelTrainingJob is defined by 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

Where ProjectSegmentHistory is defined by 

{
    "jobs": List[horcrux.aible.project_segment_job.ProjectSegmentJob]
    "assumptions": List[horcrux.aible.project_segment_assumption.ProjectSegmentAssumption]
}

Where ProjectSegmentRole is defined by 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_draft": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where ProjectTask is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segments/<project_segment_id:int>/feedback (mjolnir.project.update_project_segment_feedback)[POST] -> ProjectSegmentMonitor

update_project_segment_feedback


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/project_segment_roles/<project_segment_role_id:int> (mjolnir.project.update_project_segment_role)[PATCH] -> ProjectSegmentRole

update_project_segment_role


Return-only definitions: ProjectSegmentRole

With ProjectSegmentRole defined as 

{
    "tenant_id": int
    "id": int
    "project_segment_id": int
    "role_type": 'OWNER' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER' | 'NONE'
    "role_user": Author
    "preferences": ProjectSegmentUserPreferences
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectSegmentUserPreferences is defined by 

{
    "percent_processed": Optional[int | float]
    "feedback": Optional[dict]
}

/v1/project_tasks/<task_id:int> (mjolnir.project.update_project_task)[PATCH] -> ProjectTask

update_project_task


Return-only definitions: ProjectTask

With ProjectTask defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "assigned_to": Author
    "name": str
    "description": Optional[str]
    "type": str
    "status": 'ACCEPTED' | 'REJECTED' | 'DRAFT' | 'PENDING'
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "versions": List[horcrux.aible.project_assumption.ProjectAssumption]
    "projects": List[horcrux.aible.project_task.TaskProject]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ProjectAssumption is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "data": dict
    "type": str
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where TaskProject is defined by 

{
    "id": int
    "segments": List[horcrux.aible.project_task.TaskProjectSegment]
}

Where TaskProjectSegment is defined by 

{
    "id": int
}

/v1/project_segments/<project_segment_id:int>/users/<user_id:int>/feedback (mjolnir.project.update_user_project_segment_feedback)[POST] -> ProjectSegmentMonitor

update_user_project_segment_feedback


Return-only definitions: ProjectSegmentMonitor

With ProjectSegmentMonitor defined as 

{
    "tenant_id": int
    "id": int
    "project_id": int
    "project_segment_id": int
    "data": dict
    "start_date": EpochDateTime
    "end_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/charts (mjolnir.report.add_report_chart)[POST] -> List[horcrux.aible.rating.Rating]

add_report_chart

With ReportChartCreate defined as 

{
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/report_charts/<report_chart_id:int>/comments (mjolnir.report.add_report_chart_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_report_chart_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/report_charts/<report_chart_id:int>/ratings (mjolnir.report.add_report_chart_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_report_chart_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/comments (mjolnir.report.add_report_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_report_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/ratings (mjolnir.report.add_report_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_report_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports (mjolnir.report.create_report)[POST] -> Report

create_report

With ReportCreate defined as 

{
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/reports/<report_id:int> (mjolnir.report.delete_report)[DELETE] -> Report

delete_report


Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/report_charts/<report_chart_id:int> (mjolnir.report.delete_report_chart)[DELETE] -> Report

delete_report_chart


Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/reports/<report_id:int> (mjolnir.report.get_report)[GET] -> Report

get_report


Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/report_charts/<report_chart_id:int>/comments (mjolnir.report.get_report_chart_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_report_chart_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/report_charts/<report_chart_id:int>/ratings (mjolnir.report.get_report_chart_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_report_chart_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/report_charts (mjolnir.report.get_report_charts)[GET] -> List[horcrux.aible.rating.Rating]

get_report_charts


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/charts (mjolnir.report.get_report_charts)[GET] -> List[horcrux.aible.rating.Rating]

get_report_charts


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/comments (mjolnir.report.get_report_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_report_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports/<report_id:int>/ratings (mjolnir.report.get_report_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_report_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/reports (mjolnir.report.get_reports)[GET] -> List[horcrux.aible.report.Report]

get_reports


Return-only definitions: List[horcrux.aible.report.Report]

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/reports/<report_id:int> (mjolnir.report.update_report)[PATCH] -> Report

update_report

With ReportUpdate defined as 

{
    "folder_id": Optional[int]
    "name": Optional[str]
    "description": Optional[str]
    "metadata": Optional[dict]
}

Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/report_charts/<report_chart_id:int> (mjolnir.report.update_report_chart)[PATCH] -> Report

update_report_chart

With ReportChartUpdate defined as 

{
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
}

Return-only definitions: Report

With Report defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "folder_id": int
    "name": str
    "description": Optional[str]
    "metadata": Optional[Dict[str, Any]]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "charts": List[horcrux.aible.report_chart.ReportChart]
    "permissions": Permissions
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where ReportChart is defined by 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "comment_count": int
    "report_id": int
    "training_data_id": int
    "name": str
    "description": Optional[str]
    "data": Optional[dict]
    "options": Optional[dict]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "permissions": Permissions
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/job/<job_id:int>/<model_name:string> (mjolnir.run.get)[GET] -> TrainedModel

get


Return-only definitions: TrainedModel

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/runs (mjolnir.run.list_all)[GET] -> Tuple[horcrux.aible.job.TrainedModel, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.job.TrainedModel, ...]

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/run/<run_id:int>/job (mjolnir.run.list_by_run)[GET] -> ModelTrainingJob

list_by_run


Return-only definitions: ModelTrainingJob

With ModelTrainingJob defined as 

{
    "tenant_id": int
    "id": int
    "blueprint_id": Optional[int]
    "account_id": int
    "name": SafeString
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "start_date": Optional[AwareDateTime]
    "end_date": Optional[AwareDateTime]
    "stack_id": Optional[str]
    "matrix_type": 'CONFUSION' | 'IMPACT'
    "value_matrix": ConfusionMatrix | ImpactMatrix | UnparsedMatrix
    "current_capacity": int
    "max_ideal_population": int
    "model_optimization_ratio": float | int
    "column_type_overrides": Dict[str, horcrux.aible.types.ColumnType]
    "tags": 'HUMAN_UNDERSTANDABLE' | 'AUDITABLE' | 'REALTIME_RESULTS'
    "outcome_behavior": 'MAXIMIZE' | 'MINIMIZE'
    "outcome_key": str
    "outcome_value": OutcomeValue
    "score_function": ScoreFunction
    "mappings": List[horcrux.aible.blueprint.KeyMapping]
    "training_data_ids": FrozenSet[int]
    "column_labels": List[str]
    "drop_rows": List[Union[horcrux.aible.blueprint.DropRowByRange, horcrux.aible.blueprint.DropRowByValue]]
    "drop_columns": List[int]
    "attributes": Dict[str, Any]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "expected_models": Tuple[str, ...]
    "models": Tuple[horcrux.aible.job.TrainedModel, ...]
}

Where ConfusionMatrix is defined by 

{
    "true_positive": int | float
    "false_positive": int | float
    "true_negative": int | float
    "false_negative": int | float
}

Where ImpactMatrix is defined by 

{
    "range": AcceptableImpactRange
    "penalties": ImpactPenalties
}

Where AcceptableImpactRange is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where ImpactPenalties is defined by 

{
    "lower": int | float
    "upper": int | float
    "type": 'BY_PERCENT' | 'BY_VALUE'
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where ScoreFunction is defined by 

{
    "type": 'OUTCOME_KEY' | 'COLUMN' | 'PROGRAM'
    "key": Optional[str]
    "body": Optional[bytes]
}

Where KeyMapping is defined by 

{
    "from_index": int
    "to_index": int
    "training_data_id": int
}

Where DropRowByRange is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": List[List[Union[int, float]]]
    "labels": Optional[List[Union[str, int, float]]]
    "conditions": Optional[List[str]]
}

Where DropRowByValue is defined by 

{
    "type": 'BY_VALUE' | 'BY_RANGE' | 'BY_CONDITIONAL'
    "index": int
    "operation": 'INCLUDE' | 'EXCLUDE'
    "ranges": Optional[List[List[Union[int, float]]]]
    "labels": List[Optional[str]] | List[Union[int, NoneType, float]]
    "conditions": Optional[List[str]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where TrainedModel is defined by 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/runs/by/<tag_name:string> (mjolnir.run.list_by_tag)[GET] -> Tuple[horcrux.aible.job.TrainedModel, ...]

list_by_tag


Return-only definitions: Tuple[horcrux.aible.job.TrainedModel, ...]

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/job/<job_id:int>/<model_name:string> (mjolnir.run.update)[POST] -> TrainedModel

update

With NewRunData defined as 

{
    "confusion_matrices": Optional[List[List[int]]]
    "metrics": Optional[dict]
    "feature_importance": Optional[dict]
    "metadata": Optional[dict]
    "plots": Optional[Plots]
}

Return-only definitions: TrainedModel

With TrainedModel defined as 

{
    "tenant_id": int
    "id": int
    "job_id": int
    "model_name": str
    "model_display_name": Optional[str]
    "model_metadata": dict
    "matrices": Tuple[Tuple[int, int, int, int], ...]
    "metadata": dict
    "feature_importance": dict
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "plots": List[Dict[str, Any]]
    "impact_metrics": ImpactMetrics
}

Where ImpactMetrics is defined by 

{
    "sum_over_predict": Optional[int | float]
    "sum_under_predict": Optional[int | float]
    "count_over_predict": Optional[int]
    "count_under_predict": Optional[int]
    "mean_absolute_error": Optional[int | float]
}

/v1/schema_monitors (mjolnir.schema_monitor.create)[POST] -> SchemaMonitor

create
Create a schema monitor binding

With NewSchemaMonitor defined as 

{
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": Optional[SnapshotBase]
    "url": Optional[URL]
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
}

Where SnapshotBase is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Return-only definitions: SchemaMonitor

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<account_id:int>/schema_monitors (mjolnir.schema_monitor.create)[POST] -> SchemaMonitor

create
Create a schema monitor binding

With NewSchemaMonitor defined as 

{
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": Optional[SnapshotBase]
    "url": Optional[URL]
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
}

Where SnapshotBase is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Return-only definitions: SchemaMonitor

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/schema_monitor/<schema_monitor_id:int> (mjolnir.schema_monitor.delete)[DELETE] -> SchemaMonitor

delete
Show or Update a Score


Return-only definitions: SchemaMonitor

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/schema_monitor/<schema_monitor_id:int> (mjolnir.schema_monitor.get)[GET] -> SchemaMonitor

get
Show a schema monitor as-is


Return-only definitions: SchemaMonitor

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/schema_monitors (mjolnir.schema_monitor.list_all)[GET] -> Tuple[horcrux.aible.schema_monitor.SchemaMonitor, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.schema_monitor.SchemaMonitor, ...]

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/account/<account_id:int>/schema_monitors (mjolnir.schema_monitor.list_all)[GET] -> Tuple[horcrux.aible.schema_monitor.SchemaMonitor, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.schema_monitor.SchemaMonitor, ...]

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/schema_monitor/<id:int>/presigned_url (mjolnir.schema_monitor.presigned_url_for_schema_monitoring)[POST] -> Dict[str, Union[str, Dict[str, str]]]

presigned_url_for_schema_monitoring

Given an account_id and a file name, should generate a presigned url to upload the
training data to


Return-only definitions: Dict[str, Union[str, Dict[str, str]]]

/v1/schema_monitor/<schema_monitor_id:int> (mjolnir.schema_monitor.update)[PATCH] -> SchemaMonitor

update
add a new revision of the schema

With UpdateSchema defined as 

{
    "folder_id": Optional[int]
    "name": Optional[str]
    "schema": Optional[SnapshotBase]
    "url": Optional[URL]
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
    "status": Optional['update_credentials' | 'UPDATE_CREDENTIALS' | 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE']
}

Where SnapshotBase is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Return-only definitions: SchemaMonitor

With SchemaMonitor defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "account_id": int
    "folder_id": Optional[int]
    "name": str
    "type": 'REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS'
    "schema": SchemaMonitorSnapshot | EmptySchema
    "snapshots": Tuple[horcrux.aible.schema_monitor.SchemaMonitorSnapshot, ...]
    "version": int
    "url": URL
    "status": 'MISSING_CREDENTIALS_URL' | 'WAITING_FOR_SCHEMA' | 'MONITORING_SCHEMA' | 'AUTHENTICATION_FAILURE'
    "annotations": List[horcrux.aible.annotations.Annotation]
    "permissions": Permissions
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where SchemaMonitorSnapshot is defined by 

{
    "tables": Tuple[horcrux.aible.schema_monitor.TableSchemas, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.TableDelta, ...]
    "created_date": EpochDateTime | Default
}

Where TableSchemas is defined by 

{
    "name": str
    "columns": Tuple[horcrux.aible.schema_monitor.ColumnMetadata, ...]
    "deltas": Tuple[horcrux.aible.schema_monitor.ColumnDelta, ...]
}

Where ColumnMetadata is defined by 

{
    "name": str
    "type": str
}

Where ColumnDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'TYPE_RENAME' | 'DELETION'
    "type": str
}

Where TableDelta is defined by 

{
    "name": str
    "delta": 'ADDITION' | 'DELETION'
}

Where EmptySchema is defined by 

{
    ...
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/response/<action:str> (mjolnir.slack.on_response)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
on_response


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tags (mjolnir.tag.create)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
create


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/tags (mjolnir.tag.delete)[DELETE] -> Tag

delete


Return-only definitions: Tag

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tag/<tag_name:string> (mjolnir.tag.delete)[DELETE] -> Tag

delete


Return-only definitions: Tag

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tag/<tag_name:string> (mjolnir.tag.get)[GET] -> Tag

get


Return-only definitions: Tag

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tags (mjolnir.tag.list_all)[GET] -> Tuple[horcrux.aible.tag.Tag, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.tag.Tag, ...]

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tags/by/<entity_type:string>/<entity_id:int> (mjolnir.tag.list_tags_by_entity)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
list_tags_by_entity


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tags/by/<entity_type:string> (mjolnir.tag.list_tags_by_entity)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
list_tags_by_entity


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tags (mjolnir.tag.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]
```
update


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tag/<tag_name:string> (mjolnir.tag.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]
```
update


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/tagged (mjolnir.tagged.create)[POST] -> Tagged

create


Return-only definitions: Tagged

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string>/<tag_type:string>/<tagged_id:int> (mjolnir.tagged.create)[POST] -> Tagged

create


Return-only definitions: Tagged

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string> (mjolnir.tagged.create)[POST] -> Tagged

create


Return-only definitions: Tagged

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string>/<tag_type:string>/<tagged_id:int> (mjolnir.tagged.delete)[DELETE] -> Tag

delete


Return-only definitions: Tag

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string> (mjolnir.tagged.delete)[DELETE] -> Tag

delete


Return-only definitions: Tag

With Tag defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string>/<tag_type:string>/<tagged_id:int> (mjolnir.tagged.get)[GET] -> Tagged

get


Return-only definitions: Tagged

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged (mjolnir.tagged.list_all)[GET] -> Tuple[horcrux.aible.tag.Tagged, ...]

list_all


Return-only definitions: Tuple[horcrux.aible.tag.Tagged, ...]

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged/<tag_name:string> (mjolnir.tagged.list_by_tag_name)[GET] -> Tuple[horcrux.aible.tag.Tagged, ...]

list_by_tag_name


Return-only definitions: Tuple[horcrux.aible.tag.Tagged, ...]

With Tagged defined as 

{
    "tenant_id": int
    "name": SafeString
    "value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ACCOUNT' | 'JOB' | 'SCORE' | 'TRAINING' | 'GUIDED_BLUEPRINT' | 'DEPLOYMENT' | 'MODEL_RUN'
    "entity_id": int
    "priority": int
    "entity_value": Optional[Dict[str, Union[str, int, float, List[Any], Dict[str, Any]]] | List[Union[str, int, float, List[Any], Dict[str, Any]]]]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tagged (mjolnir.tagged.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]
```
update


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tagged/<tag_name:string>/<tag_type:string>/<tagged_id:int> (mjolnir.tagged.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]
```
update


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```
/v1/tagged/<tag_name:string> (mjolnir.tagged.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]
```
update


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/tenant/<tenant_id:int>/users (mjolnir.tenant.change_tenant_users)[PATCH] -> PublicPendingUser | PublicUser | Tuple[Union[mjolnir.tenant.PublicPendingUser, mjolnir.tenant.PublicUser], ...]

change_tenant_users

    Adjust another user's association with this tenant.

    To remove yourself from a tenant, delete your invite.

With TenantUserChange defined as 

{
    "action": 'remove'
    "user": TenantUser
}

Where TenantUser is defined by 

{
    "email": SafeString
}

Return-only definitions: PublicPendingUser | PublicUser | Tuple[Union[mjolnir.tenant.PublicPendingUser, mjolnir.tenant.PublicUser], ...]

With PublicPendingUser defined as 

{
    "email": str
    "invites": tuple[instruct.PendingUserInviteWithoutActionsAndToken, ...]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where PublicUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
    "email": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "tags": 'PASSWORD_RESET_REQUIRED' | 'OAUTH_ONLY' | 'ACTIVATION_EMAIL_SENT' | 'SLACK_ACTIVATION_REQUESTED' | 'NEW_ACCOUNT_EMAIL_REQUIRED' | 'DESIRES_TABLEAU' | 'USER_LOCKED_TO_TENANT' | 'NEW_TENANT_CREATION_DISALLOWED' | 'EMAIL_NOT_VERIFIED' | 'EMAIL_BOUNCES_OR_REJECTS' | 'NOT_AN_EMAIL'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "invites": Tuple[mjolnir.tenant.PublicTenantInvite, ...]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where PublicTenantInvite is defined by 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

/v1/tenants (mjolnir.tenant.create)[POST] -> Tenant

create

With NewTenant defined as 

{
    "fullname": str
}

Return-only definitions: Tenant

With Tenant defined as 

{
    "id": int
    "fullname": SafeString
    "shortname": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "foreign_info": ForeignInfo
    "invite": Optional[Invite]
    "tokens": tuple[horcrux.authentication.token.AccessToken, ...]
    "num_licenses": int
    "user_limit": int | float
    "limits": TenantLimits
    "license_types": Optional[frozenset[horcrux.authentication.types.LicenseType]]
    "share_behavior": 'PUBLIC' | 'PRIVATE'
    "linked_domains": tuple[str, ...]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where ForeignInfo is defined by 

{
    "provider": Optional['AZURE' | 'AWS_MARKETPLACE']
    "id": Optional[str]
}

Where TenantLimits is defined by 

{
    "training_upload_limit": Optional[int]
    "model_training_limit": Optional[int]
    "score_limit": Optional[int]
    "deployment_limit": Optional[int]
    "account_limit": Optional[int]
    "allow_aible_resource_usage": bool
    "training_upload_size_bytes_limit": Optional[int]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/foreign-authentications (mjolnir.tenant.create_foreign_authentication)[POST] -> ForeignTenantAuthentication

create_foreign_authentication

With CreateNewForeignTenantAuthentication defined as 

{
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "config": SAMLConfig | OAuth2Config | dict
    "key": Optional[str]
    "status": Optional['NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED']
}

Return-only definitions: ForeignTenantAuthentication

With ForeignTenantAuthentication defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "status": <Status.ACTIVE: 'active'> | <Status.INACTIVE: 'inactive'>
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "key": UUID
    "config": SAMLConfig | OAuth2Config | dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/invites (mjolnir.tenant.create_invite)[POST] -> NewPublicInvite | Tuple[mjolnir.invite.NewPublicInvite, ...]

create_invite

    Invite a person by email to a tenant, sending an invite email and creating a pending
    user if necessary.

With NewInvite defined as 

{
    "email": str
    "tenant_id": int
}

Return-only definitions: NewPublicInvite | Tuple[mjolnir.invite.NewPublicInvite, ...]

With NewPublicInvite defined as 

{
    "tenant_id": int
    "token": UUID
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user": UserWithoutTerms_and_conditions_acceptanceAndIdAndStatusAndPassword_changed_dateAndUpdated_dateAndCustom_app_domainAndPassword_hashAndTagsAndCreated_byAndCreated_dateAndAliases
}

Where UserWithoutTerms_and_conditions_acceptanceAndIdAndStatusAndPassword_changed_dateAndUpdated_dateAndCustom_app_domainAndPassword_hashAndTagsAndCreated_byAndCreated_dateAndAliases is defined by 

{
    "fullname": SafeString
    "email": SafeString
}

/v1/tenant/<tenant_id:int>/sts (mjolnir.tenant.create_sts_token)[POST] -> STSResponse

create_sts_token

    Allocate a short lived session token restricted to routes.

With STSRequest defined as 

{
    "actions": Tuple[str, ...]
    "expires_in": int | float
}

Return-only definitions: STSResponse

With STSResponse defined as 

{
    "token": str
    "expires_on": EpochDateTime
    "on_behalf_of": Author
    "issued_at": EpochDateTime
    "expires_on_epoch": int | float
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_aliases (mjolnir.tenant.create_user_aliases)[POST] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

create_user_aliases

With CreateUserAlias defined as 

{
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
}

Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/foreign-authentication/<key_or_id:str> (mjolnir.tenant.delete_foreign_authentication)[DELETE] -> ForeignTenantAuthentication

delete_foreign_authentication


Return-only definitions: ForeignTenantAuthentication

With ForeignTenantAuthentication defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "status": <Status.ACTIVE: 'active'> | <Status.INACTIVE: 'inactive'>
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "key": UUID
    "config": SAMLConfig | OAuth2Config | dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_aliases (mjolnir.tenant.delete_multi_alias)[DELETE] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

delete_multi_alias

With DeleteUserAlias defined as 

{
    "id": int
}

Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_alias/<alias_id:int> (mjolnir.tenant.delete_user_alias)[DELETE] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

delete_user_alias


Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tenant/<tenant_id:int> (mjolnir.tenant.get)[GET] -> Tenant

get


Return-only definitions: Tenant

With Tenant defined as 

{
    "id": int
    "fullname": SafeString
    "shortname": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "foreign_info": ForeignInfo
    "invite": Optional[Invite]
    "tokens": tuple[horcrux.authentication.token.AccessToken, ...]
    "num_licenses": int
    "user_limit": int | float
    "limits": TenantLimits
    "license_types": Optional[frozenset[horcrux.authentication.types.LicenseType]]
    "share_behavior": 'PUBLIC' | 'PRIVATE'
    "linked_domains": tuple[str, ...]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where ForeignInfo is defined by 

{
    "provider": Optional['AZURE' | 'AWS_MARKETPLACE']
    "id": Optional[str]
}

Where TenantLimits is defined by 

{
    "training_upload_limit": Optional[int]
    "model_training_limit": Optional[int]
    "score_limit": Optional[int]
    "deployment_limit": Optional[int]
    "account_limit": Optional[int]
    "allow_aible_resource_usage": bool
    "training_upload_size_bytes_limit": Optional[int]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/foreign-authentication/<key_or_id:str> (mjolnir.tenant.get_foreign_authentication)[GET] -> ForeignTenantAuthentication

get_foreign_authentication


Return-only definitions: ForeignTenantAuthentication

With ForeignTenantAuthentication defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "status": <Status.ACTIVE: 'active'> | <Status.INACTIVE: 'inactive'>
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "key": UUID
    "config": SAMLConfig | OAuth2Config | dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_alias/<alias_id:int> (mjolnir.tenant.get_user_alias)[GET] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

get_user_alias


Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tenants (mjolnir.tenant.list_all)[GET] -> Tuple[horcrux.authentication.tenant.Tenant, ...]

list_all


Return-only definitions: Tuple[horcrux.authentication.tenant.Tenant, ...]

With Tenant defined as 

{
    "id": int
    "fullname": SafeString
    "shortname": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "foreign_info": ForeignInfo
    "invite": Optional[Invite]
    "tokens": tuple[horcrux.authentication.token.AccessToken, ...]
    "num_licenses": int
    "user_limit": int | float
    "limits": TenantLimits
    "license_types": Optional[frozenset[horcrux.authentication.types.LicenseType]]
    "share_behavior": 'PUBLIC' | 'PRIVATE'
    "linked_domains": tuple[str, ...]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where ForeignInfo is defined by 

{
    "provider": Optional['AZURE' | 'AWS_MARKETPLACE']
    "id": Optional[str]
}

Where TenantLimits is defined by 

{
    "training_upload_limit": Optional[int]
    "model_training_limit": Optional[int]
    "score_limit": Optional[int]
    "deployment_limit": Optional[int]
    "account_limit": Optional[int]
    "allow_aible_resource_usage": bool
    "training_upload_size_bytes_limit": Optional[int]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_aliases/by/<external_id:path> (mjolnir.tenant.list_by_external_id)[GET] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

list_by_external_id


Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/foreign-authentications (mjolnir.tenant.list_foreign_authentications)[GET] -> Tuple[horcrux.authentication.tenant.ForeignTenantAuthentication, ...]

list_foreign_authentications

List the foreign tenant authentications on this tenant.

A Foreign Tenant Authentication allows SAML and OAuth2 logins via
a given ``entity_id``.

OAuth2 mediated logins can bounce to the ``entity_id`` (ARJ: Warning, OAuth2 is not ready yet)

SAML mediated logins can do an IDP initated one via using the ``entity_id`` as ``Identifier (Entity ID)``

And setting the reply URL (Assertion Consumer Service URL) to $API_DOMAIN/v1/login/saml-reply



Return-only definitions: Tuple[horcrux.authentication.tenant.ForeignTenantAuthentication, ...]

With ForeignTenantAuthentication defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "status": <Status.ACTIVE: 'active'> | <Status.INACTIVE: 'inactive'>
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "key": UUID
    "config": SAMLConfig | OAuth2Config | dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_aliases/in/<namespace:path> (mjolnir.tenant.list_in_namespace)[GET] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

list_in_namespace


Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_aliases (mjolnir.tenant.list_tenant_user_aliases)[GET] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

list_tenant_user_aliases


Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/renew/tenant (mjolnir.tenant.renew_token)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
renew_token


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/tenant/<tenant_id:int>/users (mjolnir.tenant.show_tenant_users)[GET] -> PublicPendingUser | PublicUser | Tuple[Union[mjolnir.tenant.PublicPendingUser, mjolnir.tenant.PublicUser], ...]

show_tenant_users


Return-only definitions: PublicPendingUser | PublicUser | Tuple[Union[mjolnir.tenant.PublicPendingUser, mjolnir.tenant.PublicUser], ...]

With PublicPendingUser defined as 

{
    "email": str
    "invites": tuple[instruct.PendingUserInviteWithoutActionsAndToken, ...]
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
}

Where PublicUser is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
    "email": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "tags": 'PASSWORD_RESET_REQUIRED' | 'OAUTH_ONLY' | 'ACTIVATION_EMAIL_SENT' | 'SLACK_ACTIVATION_REQUESTED' | 'NEW_ACCOUNT_EMAIL_REQUIRED' | 'DESIRES_TABLEAU' | 'USER_LOCKED_TO_TENANT' | 'NEW_TENANT_CREATION_DISALLOWED' | 'EMAIL_NOT_VERIFIED' | 'EMAIL_BOUNCES_OR_REJECTS' | 'NOT_AN_EMAIL'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "invites": Tuple[mjolnir.tenant.PublicTenantInvite, ...]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where PublicTenantInvite is defined by 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

/v1/user_aliases/namespaces (mjolnir.tenant.show_user_alias_namespaces)[GET] -> FrozenSet[str]
```
show_user_alias_namespaces


Return-only definitions: FrozenSet[str]
```

/v1/tenant/<tenant_id:int> (mjolnir.tenant.update)[PATCH] -> Tenant

update


Return-only definitions: Tenant

With Tenant defined as 

{
    "id": int
    "fullname": SafeString
    "shortname": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "foreign_info": ForeignInfo
    "invite": Optional[Invite]
    "tokens": tuple[horcrux.authentication.token.AccessToken, ...]
    "num_licenses": int
    "user_limit": int | float
    "limits": TenantLimits
    "license_types": Optional[frozenset[horcrux.authentication.types.LicenseType]]
    "share_behavior": 'PUBLIC' | 'PRIVATE'
    "linked_domains": tuple[str, ...]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where ForeignInfo is defined by 

{
    "provider": Optional['AZURE' | 'AWS_MARKETPLACE']
    "id": Optional[str]
}

Where TenantLimits is defined by 

{
    "training_upload_limit": Optional[int]
    "model_training_limit": Optional[int]
    "score_limit": Optional[int]
    "deployment_limit": Optional[int]
    "account_limit": Optional[int]
    "allow_aible_resource_usage": bool
    "training_upload_size_bytes_limit": Optional[int]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/tenants/sync (mjolnir.tenant.update_all_remote_stacks)[POST] -> Annotated[ForwardRef('JSON'), Inferred]
```
update_all_remote_stacks


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/foreign-authentication/<key_or_id:str> (mjolnir.tenant.update_foreign_authentication)[PATCH] -> ForeignTenantAuthentication

update_foreign_authentication

With UpdateForeignAuthentication defined as 

{
    "status": Optional[str]
    "name": Optional[str]
    "type": Optional[str]
    "config": Optional[Dict[str, str]]
}

Return-only definitions: ForeignTenantAuthentication

With ForeignTenantAuthentication defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "status": <Status.ACTIVE: 'active'> | <Status.INACTIVE: 'inactive'>
    "name": SafeString
    "type": 'GENERIC_SAML' | 'GENERIC_OAUTH2'
    "key": UUID
    "config": SAMLConfig | OAuth2Config | dict
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/user_alias/<alias_id:int> (mjolnir.tenant.update_user_alias)[PATCH] -> Tuple[horcrux.aible.user_alias.UserAlias, ...]

update_user_alias

With UpdateUserAlias defined as 

{
    "namespace": Optional[str]
    "external_id": Optional[str]
    "email": Optional[str]
    "fullname": Optional[str]
}

Return-only definitions: Tuple[horcrux.aible.user_alias.UserAlias, ...]

With UserAlias defined as 

{
    "tenant_id": int
    "id": int | NextValue
    "namespace": str
    "external_id": str
    "email": str
    "fullname": str
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "user_match": Optional[Author]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data (mjolnir.training.create)[POST] -> Training

create

on POST:

You can either upload a file (which I require the name of the file) or
send a JSON block in the body:

    {
        "file_uri": "s3://input/path/[item.txt]",
    }


Return-only definitions: Training

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/data/<training_data_id:int>/rulefits (mjolnir.training.create_rulefit)[POST] -> RulefitMappings

create_rulefit

    Begin a rulefit job on this data using a given `outcome_value`

With RulefitJobCommission defined as 

{
    "outcome_value": Tuple[int, ...] | Tuple[float, ...] | Tuple[Union[int, float], ...] | Tuple[str, ...]
}

Return-only definitions: RulefitMappings

/v1/data/<training_data_id:int>/debug (mjolnir.training.debug_url)[GET] -> Annotated[ForwardRef('JSON'), Inferred]
```
debug_url


Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]
```

/v1/data/<training_data_id:int>/rulefit (mjolnir.training.delete_rulefit)[DELETE] -> RulefitMappings

delete_rulefit

Cancel and/or clear out the rulefit matched by the submitted `outcome_value`.


Return-only definitions: RulefitMappings

/v1/data/by/<tag_name:string> (mjolnir.training.list_by_tag)[GET] -> Tuple[horcrux.aible.training.Training, ...]

list_by_tag

List the available Training Datas to work on


Return-only definitions: Tuple[horcrux.aible.training.Training, ...]

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/data/<training_data_id:int>/rulefits (mjolnir.training.list_rulefits)[GET] -> RulefitMappings
```
list_rulefits


Return-only definitions: RulefitMappings
```

/v1/data/<training_data_id:int>/reindex (mjolnir.training.reindex)[POST] -> Training

reindex

Clear the training data, then re-run validate headers and chain
if possible to index training data assuming header and target stability.


Return-only definitions: Training

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/data/<training_data_id:int> (mjolnir.training.update)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]

update

With TrainingUpdate defined as 

{
    "rulefit_definitions": Optional[Dict[Union[Tuple[int, ...], Tuple[float, ...], Tuple[Union[int, float], ...], Tuple[str, ...]], Union[List[horcrux.aible.training.RuleFitDefinition], mjolnir.training.PendingRuleFitUpdate]]]
    "headers": Optional[List[str]]
    "number_of_rows": Optional[int]
    "action": Optional['NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR']
    "features": Optional[List[mjolnir.training.Feature]]
    "metadata": Optional[TrainingMetadata]
    "transformations": Optional[TrainingTransformations]
    "options": Optional[TrainingOptions]
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
    "target": Optional[str]
    "target_value": Optional[OutcomeValue]
    "new_target": Optional[str]
    "deleted": Optional['NOT_DELETED' | 'DELETED' | 'ARCHIVE']
    "cascade": Optional[bool]
    "file_size": Optional[int]
    "name": Optional[str]
    "reindex": Optional[bool]
}

Where RuleFitDefinition is defined by 

{
    "rule": str
    "coefficient": float | int
    "support": float | int
    "count": Optional[int]
    "extra": Optional[dict]
}

Where PendingRuleFitUpdate is defined by 

{
    "action": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where Feature is defined by 

{
    "name": str
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[Tuple[str, Union[int, str]]] | List[Tuple[int, Union[int, str]]] | List[Tuple[float, Union[int, str]]] | List[Tuple[bool, Union[int, str]]] | List[Union[int, float, str]] | List[Tuple[Union[str, int, float, bool], Union[int, str]]]
    "metadata": Optional[dict]
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/data/<training_data_id:int>/descriptions (mjolnir.training.update_descriptions)[PATCH] -> Annotated[ForwardRef('JSON'), Inferred]

update_descriptions

With TrainingDescriptionsUpdate defined as 

{
    "columns": List[mjolnir.training.TrainingColumnDescription]
}

Where TrainingColumnDescription is defined by 

{
    "label": str
    "description": SafeString
}

Return-only definitions: Annotated[ForwardRef('JSON'), Inferred]

/v1/data/<training_data_id:int>/rulefit (mjolnir.training.update_rulefit)[PATCH] -> RulefitMappings

update_rulefit

With RuleFitUpdate defined as 

{
    "rulefit_definitions": Optional[Dict[Union[Tuple[int, ...], Tuple[float, ...], Tuple[Union[int, float], ...], Tuple[str, ...]], Union[List[horcrux.aible.training.RuleFitDefinition], mjolnir.training.PendingRuleFitUpdate]]]
}

Where RuleFitDefinition is defined by 

{
    "rule": str
    "coefficient": float | int
    "support": float | int
    "count": Optional[int]
    "extra": Optional[dict]
}

Where PendingRuleFitUpdate is defined by 

{
    "action": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "annotations": Optional[List[horcrux.aible.annotations.Annotation]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Return-only definitions: RulefitMappings

/v1/data/<training_data_id:int>/comments (mjolnir.training_data.add_training_data_comment)[POST] -> List[horcrux.aible.comment.Comment]

add_training_data_comment

With CommentUpdate defined as 

{
    "message": str
}

Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data/<training_data_id:int>/ratings (mjolnir.training_data.add_training_data_rating)[POST] -> List[horcrux.aible.rating.Rating]

add_training_data_rating

With RatingUpdate defined as 

{
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
}

Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data/<training_data_id:int>/details (mjolnir.training_data.create_upload_detail)[POST] -> TrainingDataDetailsUpload

create_upload_detail

With TrainingDataDetailCreate defined as 

{
    "target": Optional[str]
}

Return-only definitions: TrainingDataDetailsUpload

With TrainingDataDetailsUpload defined as 

{
    "key": str
    "data_url": str
    "presigned_url": dict
}

/v1/data/<training_data_id:int>/upload (mjolnir.training_data.create_upload_url)[POST] -> TrainingDataUpload

create_upload_url

With TrainingDataUploadCreate defined as 

{
    "description": Optional[str]
    "expires_in": Optional[int]
}

Return-only definitions: TrainingDataUpload

With TrainingDataUpload defined as 

{
    "id": str
    "name": str
    "description": Optional[str]
    "tenant": NamedEntity
    "account": NamedEntity
    "folder": NamedEntity
    "created_date": EpochDateTime
    "expiration_date": EpochDateTime
    "created_by": Author
    "presigned_url": Optional[dict]
}

Where NamedEntity is defined by 

{
    "id": int
    "name": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data/<training_data_id:int> (mjolnir.training_data.delete_training_data)[DELETE] -> Training

delete_training_data


Return-only definitions: Training

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/data_upload/<upload_id:string> (mjolnir.training_data.delete_upload_url)[DELETE] -> TrainingDataUpload

delete_upload_url


Return-only definitions: TrainingDataUpload

With TrainingDataUpload defined as 

{
    "id": str
    "name": str
    "description": Optional[str]
    "tenant": NamedEntity
    "account": NamedEntity
    "folder": NamedEntity
    "created_date": EpochDateTime
    "expiration_date": EpochDateTime
    "created_by": Author
    "presigned_url": Optional[dict]
}

Where NamedEntity is defined by 

{
    "id": int
    "name": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data/<training_data_id:int>/external_model_presigned_url (mjolnir.training_data.get_external_model_presigned_url)[GET] -> PresignedURL

get_external_model_presigned_url


Return-only definitions: PresignedURL

With PresignedURL defined as 

{
    "data_url": str
    "presigned_url": str | dict
}

/v1/data/<training_data_id:int> (mjolnir.training_data.get_training_data)[GET] -> Training

get_training_data


Return-only definitions: Training

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/data/<training_data_id:int>/comments (mjolnir.training_data.get_training_data_comments)[GET] -> List[horcrux.aible.comment.Comment]

get_training_data_comments


Return-only definitions: List[horcrux.aible.comment.Comment]

With Comment defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'COMMENT' | 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "message": str
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data/<training_data_id:int>/ratings (mjolnir.training_data.get_training_data_ratings)[GET] -> List[horcrux.aible.rating.Rating]

get_training_data_ratings


Return-only definitions: List[horcrux.aible.rating.Rating]

With Rating defined as 

{
    "tenant_id": int
    "id": int | NextValue | Default
    "entity_id": int
    "entity_type": 'PROJECT_ASSUMPTION' | 'PROJECT_SCENARIO' | 'PROJECT_SEGMENT_ASSUMPTION' | 'PROJECT_TASK' | 'TRAINING' | 'COMMENT' | 'REPORT' | 'REPORT_CHART' | 'LANGUAGE_MODEL_ARTIFACT' | 'CHAT_TONE'
    "score": 'LIKE' | 'DISLIKE' | 'NONE'
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data_upload/<upload_id:string> (mjolnir.training_data.get_upload_url)[GET] -> TrainingDataUpload

get_upload_url


Return-only definitions: TrainingDataUpload

With TrainingDataUpload defined as 

{
    "id": str
    "name": str
    "description": Optional[str]
    "tenant": NamedEntity
    "account": NamedEntity
    "folder": NamedEntity
    "created_date": EpochDateTime
    "expiration_date": EpochDateTime
    "created_by": Author
    "presigned_url": Optional[dict]
}

Where NamedEntity is defined by 

{
    "id": int
    "name": SafeString
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/data (mjolnir.training_data.list_all_training_data)[GET] -> List[horcrux.aible.training.Training]

list_all_training_data


Return-only definitions: List[horcrux.aible.training.Training]

With Training defined as 

{
    "comment_count": int
    "feedback": 'LIKE' | 'DISLIKE' | 'NONE'
    "like_count": int
    "dislike_count": int
    "tenant_id": int
    "folder_id": Optional[int]
    "schema_monitor_id": Optional[int]
    "id": int
    "name": Optional[SafeString]
    "target_index": Optional[int]
    "target_value": Optional[OutcomeValue]
    "recipe_id": Optional[int]
    "source": SourceURL
    "number_of_rows": int
    "file_size": int
    "status": 'NOT_STARTED' | 'RUNNING' | 'DONE' | 'ERROR'
    "categorical_counts": List[horcrux.aible.training.CategoricalCount]
    "annotations": List[horcrux.aible.annotations.Annotation]
    "rulefit_definitions": RulefitMappings
    "mappings": List[horcrux.aible.training.ColumnMapping]
    "labels": List[str]
    "descriptions": List[horcrux.types.SafeString]
    "metadata": TrainingMetadata
    "transformations": TrainingTransformations
    "options": TrainingOptions
    "account_id": int
    "stack_id": Optional[str]
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "created_by": Author
    "created_date": EpochDateTime
    "updated_date": EpochDateTime
    "permissions": Permissions
}

Where OutcomeValue is defined by 

{
    "value": str | int | float | List[str] | List[int] | List[float] | List[Union[int, float]]
}

Where SourceURL is defined by 

{
    "type": Source
    "url": Optional[URL]
    "content": SourceContent
}

Where Source is defined by 

{
    "id": int
    "provider_name": str
    "service_name": str
    "pattern": str
    "status": 'PAUSED' | 'DELETED' | 'ACTIVE'
}

Where URL is defined by URL["schema://domain/path#fragment?query=value"]

Where SourceContent is defined by 

{
    "type": 'RAW_DATA' | 'CONNECTION_METADATA'
    "provider": Optional['REDSHIFT' | 'SNOWFLAKE' | 'TERADATA' | 'ORACLE' | 'SALESFORCE' | 'BOOMI' | 'SIMBASPARK' | 'DATABRICKS' | 'S3' | 'AZUREBLOBSTORE' | 'BIGQUERY' | 'GCS']
    "options": Optional[DataSourceReadOptions]
    "table": Optional[str]
    "schema_monitor_id": Optional[int]
    "schema": Optional[List[horcrux.aible.training.SourceContextSchemaItem]]
}

Where DataSourceReadOptions is defined by 

{
    "delimiter": Optional[str]
    "encoding": Optional[str]
    "date_formats": List[str]
    "null_values": List[str]
}

Where SourceContextSchemaItem is defined by 

{
    "name": str
    "type": str
}

Where CategoricalCount is defined by 

{
    "index": int
    "term_counts": Dict[Union[int, str, float], Union[int, Literal['NaN'], Literal['Infinity'], Literal['-Infinity']]]
}

Where Annotation is defined by 

{
    "type": 'INFO' | 'WARNING' | 'ERROR' | 'DEBUG'
    "code": Optional[SafeString]
    "message": SafeString
    "scope": SafeString
    "metadata": Optional[dict]
    "created_date": datetime
}

Where ColumnMapping is defined by 

{
    "tenant_id": int
    "id": int
    "training_data_id": int
    "index": int
    "deleted": 'NOT_DELETED' | 'DELETED' | 'ARCHIVE'
    "type": 'ENUM' | 'RANGE' | 'BOTH'
    "value": List[str] | List[int] | List[float] | List[Union[int, float, str, bool]]
    "metadata": dict
    "created_date": datetime
    "updated_date": datetime
}

Where TrainingMetadata is defined by 

{
    "univariate_summaries": Optional[Dict[str, dict]]
    "upload_url": Optional[str]
}

Where TrainingTransformations is defined by 

{
    "row_filters": Optional[List[horcrux.aible.segment.Condition]]
    "unique_id_columns": Optional[List[str]]
    "projections": Optional[List[Union[dict, str]]]
    "query": Optional[dict]
    "plan": Optional[dict]
    "exclude_columns": Optional[List[str]]
}

Where Condition is defined by 

{
    ...
}

Where TrainingOptions is defined by 

{
    "target_steps": List[horcrux.aible.training.TargetAnalysisStep]
    "target_model_params": Optional[dict]
    "timestamp_column": Optional[str]
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Where Permissions is defined by 

{
    "can_view": bool
    "can_give_feedback": bool
    "can_edit": bool
    "can_delete": bool
    "can_manage_permissions": bool
}

/v1/invites (mjolnir.user.accept_or_reject_invites)[PATCH] -> PublicInvite | NewlyAcceptedInvite

accept_or_reject_invites

With UpdateInvite defined as 

{
    "tenant_id": int
    "action": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
}

Return-only definitions: PublicInvite | NewlyAcceptedInvite

With PublicInvite defined as 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where NewlyAcceptedInvite is defined by 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
    "tenant": Dict[str, Any]
}

/v1/config (mjolnir.user.get_config)[GET] -> ServerConfig

get_config


Return-only definitions: ServerConfig

With ServerConfig defined as 

{
    "env": str
    "api_endpoint": str
    "product_name": str
    "cloud_types_enabled": AllSets | FrozenSet[horcrux.aible.account.Type]
}

/v1/invite/<tenant_id:int> (mjolnir.user.leave_tenant)[DELETE] -> PublicInvite

leave_tenant


Return-only definitions: PublicInvite

With PublicInvite defined as 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

/v1/invites (mjolnir.user.leave_tenants)[DELETE] -> PublicInvite

leave_tenants

With UpdateInvite defined as 

{
    "tenant_id": int
    "action": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
}

Return-only definitions: PublicInvite

With PublicInvite defined as 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

/v1/invites (mjolnir.user.list_my_invites)[GET] -> Tuple[mjolnir.invite.PublicInvite, ...]

list_my_invites

List the invites for the current user.

URL query arguments:
    - status (the status to filter on)


Return-only definitions: Tuple[mjolnir.invite.PublicInvite, ...]

With PublicInvite defined as 

{
    "tenant_id": int
    "status": 'REQUESTED' | 'DENIED' | 'ACCEPTED' | 'DELETED'
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

/v1/me (mjolnir.user.show_my_info)[GET] -> UserWithoutPassword_hashAndAliases

show_my_info


Return-only definitions: UserWithoutPassword_hashAndAliases

With UserWithoutPassword_hashAndAliases defined as 

{
    "id": int | NextValue
    "fullname": SafeString
    "email": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "tags": 'PASSWORD_RESET_REQUIRED' | 'OAUTH_ONLY' | 'ACTIVATION_EMAIL_SENT' | 'SLACK_ACTIVATION_REQUESTED' | 'NEW_ACCOUNT_EMAIL_REQUIRED' | 'DESIRES_TABLEAU' | 'USER_LOCKED_TO_TENANT' | 'NEW_TENANT_CREATION_DISALLOWED' | 'EMAIL_NOT_VERIFIED' | 'EMAIL_BOUNCES_OR_REJECTS' | 'NOT_AN_EMAIL'
    "password_changed_date": EpochDateTime
    "terms_and_conditions_acceptance": AwareDateTime | 'HasNotAcceptedTermsAndConditions'
    "custom_app_domain": Optional[str]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/me/session (mjolnir.user.show_session)[GET] -> UserSessionInfo | TenantSessionInfo

show_session

Show information about this authenticated session.


Return-only definitions: UserSessionInfo | TenantSessionInfo

With UserSessionInfo defined as 

{
    "scope": 'user' | 'tenant'
    "type": str
    "expires_at": Optional[int | float]
    "expires_at_utc": Optional[str]
    "user": UserTokenWithoutPassword_hash
}

Where UserTokenWithoutPassword_hash is defined by 

{
    "id": int
    "email": str
    "fullname": str
    "password_changed_date": str
    "expires_at": float
    "exp": EpochDateTime
}

Where TenantSessionInfo is defined by 

{
    "scope": 'user' | 'tenant'
    "type": str
    "expires_at": Optional[int | float]
    "expires_at_utc": Optional[str]
    "tenant": SessionTenant
    "user": Author
}

Where SessionTenant is defined by 

{
    "id": int
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

/v1/me (mjolnir.user.update_my_info)[PATCH] -> UserWithoutPassword_hashAndAliases

update_my_info

    Hi, I am user. Let me update my record.

With UpdateMyInfo defined as 

{
    "fullname": Optional[str]
}

Return-only definitions: UserWithoutPassword_hashAndAliases

With UserWithoutPassword_hashAndAliases defined as 

{
    "id": int | NextValue
    "fullname": SafeString
    "email": SafeString
    "status": 'NOT_ACTIVATED' | 'ACTIVE' | 'INACTIVE' | 'DELETED'
    "tags": 'PASSWORD_RESET_REQUIRED' | 'OAUTH_ONLY' | 'ACTIVATION_EMAIL_SENT' | 'SLACK_ACTIVATION_REQUESTED' | 'NEW_ACCOUNT_EMAIL_REQUIRED' | 'DESIRES_TABLEAU' | 'USER_LOCKED_TO_TENANT' | 'NEW_TENANT_CREATION_DISALLOWED' | 'EMAIL_NOT_VERIFIED' | 'EMAIL_BOUNCES_OR_REJECTS' | 'NOT_AN_EMAIL'
    "password_changed_date": EpochDateTime
    "terms_and_conditions_acceptance": AwareDateTime | 'HasNotAcceptedTermsAndConditions'
    "custom_app_domain": Optional[str]
    "created_by": Author
    "created_date": EpochDateTime | Default
    "updated_date": EpochDateTime | Default
}

Where Author is defined by 

{
    "id": int | NextValue
    "fullname": SafeString
}

Aible API

Prefix: favicon.ico

Prefix: v1