Aible API

Welcome to the Aible API server

Version: 2.0.0+git.b6459be46a3291284e643150d5991830ea1d5b64

Nearly all API operations are protected and require a header (Authorization) set to a string beginning with Bearer ... where ... is your authenticated session token.

All authenticated session tokens expire eventually. Before that happens, you can use that token to access the token renewal route and be provided with a new token to use in place of the old one. If your token was a user token, you use it as the authenticated session token and POST /v1/renew/login If your token was a tenant token, you set that as the authenticated session token and POST /v1/renew/tenant

There are 395 routes defined.

Modules

• default
• account
• admin
• aws
• blueprint
• chat_tone
• comment
• content_generation
• deployment
• deployment_invokation
• folder
• jobs
• language_model_artifact
• licensing
• login
• marketplace
• model
• presign
• project
• report
• run
• schema_monitor
• slack
• tag
• tagged
• tenant
• training
• training_data
• user

• / ( mjolnir.default.index ) [ HEAD ] ⭢ `HTML`

  
  

  index
  
  Return-only definitions: `HTML`
  
  

Prefix: favicon.ico

• /favicon.ico ( mjolnir.default.show_favicon ) [ HEAD , GET ] ⭢ `FavIcon`

  
  

  show_favicon
  
  Return-only definitions: `FavIcon`
  
  

Prefix: v1

• /v1/account/<id:int>/communicate/<path:path> ( mjolnir.account.communicate ) [ PUT , HEAD , GET , POST , DELETE , PATCH ]

  
  

  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
  
  

• /v1/account/<id:int>/communicate ( mjolnir.account.communicate_index ) [ PUT , HEAD , GET , POST , DELETE , PATCH ]

  
  

  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
  
  

• /v1/accounts ( mjolnir.account.create ) [ POST ] ⭢ Account

  
  

  create
  
  With NewAccount defined as 
  
  {
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "configuration": NewAWSAccount | NewGCPAccount | NewAzureAccount | dict
  }
  
  Where NewAWSAccount is defined by 
  
  {
      "release_version": str | None
      "cloud_base_url": URL | None
      "agent_base_url": URL | None
      "features": frozenset[str] | None
      "aws_account_id": str
      "lambda_rpc_arn": ARN | None
      "schema_arn": ARN | None
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where NewGCPAccount is defined by 
  
  {
      "release_version": str | None
      "cloud_base_url": URL | None
      "agent_base_url": URL | None
      "features": frozenset[str] | None
      "cloud_api_authentication_type": "GCP_SERVICE_ACCOUNT" | "AIBLE_STS_ONLY" | None
      "service_credentials": GCPServiceCredentials | "APPLICATION_DEFAULT_CREDENTIALS" | None
      "cloud_audience_url": URL | Default | None
      "agent_audience_url": URL | Default | None
      "gcp_project_id": str
      "gcp_region": str
      "bucket": str | None
      "looker_export_url": URL | None
  }
  
  Where GCPServiceCredentials is defined by 
  
  {
      "type": str
      "project_id": str
      "private_key_id": str
      "private_key": str
      "client_email": str
      "client_id": str
      "auth_uri": URL
      "token_uri": URL
      "auth_provider_x509_cert_url": URL
      "client_x509_cert_url": URL
      "universe_domain": str | None
  }
  
  Where NewAzureAccount is defined by 
  
  {
      "release_version": str | None
      "cloud_base_url": URL | None
      "agent_base_url": URL | None
      "features": frozenset[str] | None
      "azure_subscription_id": str
      "region_name": str
      "group_id": str | None
  }
  
  Return-only definitions: Account
  
  With Account defined as 
  
  {
      "tenant_id": int
      "id": int
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  

• /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.
  
      You may set ttl/read_only via the URL query variables. All
      variables are transformed to their underscored counterpart, which
      allows you, the user, to do things like::
  
         GET /v1/account/id/foreign_sts?read-only=yes
         {"ttl": "6 hours"}
  
         GET /v1/account/id/foreign_sts?read-only=yes
         {"ttl": 21600}
  
         GET /v1/account/<id>/foreign_sts?read-only=yes&ttl=6+hours
  
      STS sessions default to 1 hour. They are meant to be ephemeral.
  
  With CreateForeignSTSToken defined as 
  
  {
      "ttl": float | int
      "read_only": bool
  }
  
  Return-only definitions: ForeignSTSSession
  
  With ForeignSTSSession defined as 
  
  {
      "expires_on": ISO8601[str]
      "on_behalf_of": Author
      "issued_at": ISO8601[str]
      "expires_on_epoch": int | float
      "headers": list[tuple[str, str]]
      "base_url": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  create_setup_script
  
  Return-only definitions: `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" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  

• /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" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  

• /v1/accounts ( mjolnir.account.list_all ) [ GET ] ⭢ tuple[Account, …]

  
  

  list_all
  
  Return-only definitions: tuple[Account, …]
  
  With Account defined as 
  
  {
      "tenant_id": int
      "id": int
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  

• /v1/account/<id:int>/resources ( mjolnir.account.list_resources_for_account ) [ GET ] ⭢ dict[str, tuple[URL, float | int]]

  
  

  list_resources_for_account
  
  returns a mapping of filenames to [URL, updated_date] to download
  for setting up a cloud account.
  
  Return-only definitions: dict[str, tuple[URL, float | int]]
  
  With URL defined as URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  

• /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": "PENDING_AUTHORIZATION" | "PENDING_SETUP" | "TESTING_LIMITS" | "PENDING" | "ACTIVE" | "PAUSED" | "ERROR" | None
      "name": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
      "configuration": UpdateAWSConfiguration | None
  }
  
  Where UpdateAzureAccount is defined by 
  
  {
      "status": "PENDING_AUTHORIZATION" | "PENDING_SETUP" | "TESTING_LIMITS" | "PENDING" | "ACTIVE" | "PAUSED" | "ERROR" | None
      "name": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
      "configuration": UpdateAzureConfiguration | None
  }
  
  Where UpdateAWSConfiguration is defined by 
  
  {
      "release_version": str | None
      "cloud_base_url": URL | None
      "agent_base_url": URL | None
      "features": frozenset[str] | None
      "aws_account_id": str | None
      "iam_role": ARN | None
      "arn_role": ARN | None
      "external_id": str | None
      "bucket": str | None
      "resource_limits": dict | None
      "stack_id": str | None
      "stack_arn": ARN | None
      "lambda_rpc_arn": ARN | None
      "schema_arn": ARN | None
      "lambda_api_endpoint": URL | None
  }
  
  Where UpdateAzureConfiguration is defined by 
  
  {
      "release_version": str | None
      "cloud_base_url": URL | None
      "agent_base_url": URL | None
      "features": frozenset[str] | None
      "azure_subscription_id": str | None
      "region_name": str | None
      "group_id": str | None
  }
  
  Return-only definitions: Account
  
  With Account defined as 
  
  {
      "tenant_id": int
      "id": int
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  

• /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
  
  With Account defined as 
  
  {
      "tenant_id": int
      "id": int
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where CloudFormationAccountUpdated is defined by 
  
  {
      "tenant_id": int
      "id": int
      "type": "AWS" | "GCP" | "AZURE" | "ON_PREMISE"
      "name": str
      "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[Annotation]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "stack_update": dict[str, Any] | tuple[str, str]
      "check_stack_setup_stack_id": str
  }
  

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

  
  

  usage
  
  With NewUsage defined as 
  
  {
      "supplier": "openai"
      "data": dict[str, Any] | OpenAIDataUsage
  }
  
  Where OpenAIDataUsage is defined by 
  
  {
      "choices": list[dict[str, Any]]
      "created": ISO8601[str]
      "id": str
      "model": str
      "object": str
      "usage": dict[str, int | float]
  }
  
  Return-only definitions: UsageEvent
  
  With UsageEvent defined as 
  
  {
      "user_id": int
      "tenant_id": int
      "account_id": int
      "service": Service
      "usages": tuple[Usage, …]
      "id": int | NextValue
      "created_date": NextValue | ISO8601[str]
  }
  
  Where Service is defined by 
  
  {
      "id": int | NextValue
      "supplier_name": str
      "service_name": str
      "created_date": NextValue | ISO8601[str]
      "updated_date": NextValue | ISO8601[str]
  }
  
  Where Usage is defined by 
  
  {
      "unit_of_measure": "completion_tokens" | "prompt_tokens"
      "quantity": int
  }
  

• /v1/admin/schema/diff ( mjolnir.admin.diff ) [ POST ] ⭢ str | dict[str, dict[str, str] | int]

  
  

  diff
  
  Return-only definitions: str | dict[str, dict[str, str] | int]
  
  

• /v1/aws/on_subscription_change ( mjolnir.aws.handle_aws_purchase_change ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  handle_aws_purchase_change
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/aws/provision ( mjolnir.aws.handle_new_aws_purchase ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  handle_new_aws_purchase
  
  With NewProvisionRequest defined as 
  
  {
      "marketplace_token": str
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/aws/flex/<customer_id:str>/<product_code:str>/process ( mjolnir.aws.process_provision_flex_credits ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  process_provision_flex_credits
  
  With FlexCreditsCustomerInfo defined as 
  
  {
      "fullname": str
      "company_name": str
      "phone": str
      "email": Address
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/aws/flex/<customer_id:str>/<product_code:str>/add ( mjolnir.aws.provision_flex_credits ) [ GET ]

  
  

  provision_flex_credits
  
  

• /v1/blueprints ( mjolnir.blueprint.create ) [ POST ] ⭢ GuidedBlueprint

  
  

  create
  
  With BlueprintCreate defined as 
  
  {
      "folder_id": int
      "outcome": BlueprintOutcomeCreate | None
      "name": str | None
      "wizard": dict | None
      "suggested_fields": list[dict] | None
  }
  
  Where BlueprintOutcomeCreate is defined by 
  
  {
      "behavior": "MAXIMIZE" | "MINIMIZE"
  }
  
  Return-only definitions: GuidedBlueprint
  
  With GuidedBlueprint defined as 
  
  {
      "tenant_id": int
      "folder_id": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[GuidedBlueprint]

  
  

  list_all
  
  Return-only definitions: list[GuidedBlueprint]
  
  With GuidedBlueprint defined as 
  
  {
      "tenant_id": int
      "folder_id": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[GuidedBlueprint]

  
  

  list_by_tag
  
  Return-only definitions: list[GuidedBlueprint]
  
  With GuidedBlueprint defined as 
  
  {
      "tenant_id": int
      "folder_id": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": int | None
      "name": str | None
      "wizard": dict | None
      "suggested_fields": list[SuggestedKey] | None
  }
  
  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": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/chat_tones ( mjolnir.chat_tone.create ) [ POST ] ⭢ ChatTone

  
  

  create
  
  With ChatToneCreate defined as 
  
  {
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: ChatTone
  
  With ChatTone defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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[Rating]

  
  

  get_tones_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/chat_tones/<tone_id:int>/comments ( mjolnir.chat_tone.get_training_data_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_training_data_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/chat_tones ( mjolnir.chat_tone.list_all ) [ GET ] ⭢ list[ChatTone]

  
  

  list_all
  
  Return-only definitions: list[ChatTone]
  
  With ChatTone defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": int | None
      "name": str | None
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: ChatTone
  
  With ChatTone defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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[Rating]

  
  

  add_comment_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/comments/<comment_id:int>/ratings ( mjolnir.comment.add_comment_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_comment_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/comments/<comment_id:int>/comments ( mjolnir.comment.get_comment_comments ) [ GET ] ⭢ list[Rating]

  
  

  get_comment_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/comments/<comment_id:int>/ratings ( mjolnir.comment.get_comment_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_comment_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_collections/<collection_id:int>/comments ( mjolnir.content_generation.add_collection_comment ) [ POST ] ⭢ Comment

  
  

  add_collection_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_collections/<collection_id:int>/ratings ( mjolnir.content_generation.add_collection_rating ) [ POST ] ⭢ Rating

  
  

  add_collection_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/content_generation_example_sets/<example_set_id:int>/results/<result_id:int> ( mjolnir.content_generation.add_example_set_result_link ) [ POST ] ⭢ ContentGenerationExampleSet

  
  

  add_example_set_result_link
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int>/comments ( mjolnir.content_generation.add_execution_comment ) [ POST ] ⭢ Comment

  
  

  add_execution_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_executions/<execution_id:int>/ratings ( mjolnir.content_generation.add_execution_rating ) [ POST ] ⭢ Rating

  
  

  add_execution_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/content_generation_results/<result_id:int>/comments ( mjolnir.content_generation.add_result_comment ) [ POST ] ⭢ Comment

  
  

  add_result_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_results/<result_id:int>/ratings ( mjolnir.content_generation.add_result_rating ) [ POST ] ⭢ Rating

  
  

  add_result_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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/content_generation_collections ( mjolnir.content_generation.create_collection ) [ POST ] ⭢ ContentGenerationCollection

  
  

  create_collection
  
  With ContentGenerationCollectionCreate defined as 
  
  {
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: ContentGenerationCollection
  
  With ContentGenerationCollection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "executions": list[ContentGenerationExecution]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationExecution is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_connections ( mjolnir.content_generation.create_connection ) [ POST ] ⭢ AiServiceConnection

  
  

  create_connection
  
  With AiServiceConnectionCreate defined as 
  
  {
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
  }
  
  Return-only definitions: AiServiceConnection
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/content_generation_example_sets ( mjolnir.content_generation.create_example_set ) [ POST ] ⭢ AiServiceConnection

  
  

  create_example_set
  
  With ContentGenerationExampleSetCreate defined as 
  
  {
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
  }
  
  Return-only definitions: AiServiceConnection
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/fine_tuning_executions ( mjolnir.content_generation.create_execution ) [ POST ] ⭢ FineTuningExecution

  
  

  create_execution
  
  With FineTuningExecutionCreate defined as 
  
  {
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "status": str
      "metadata": dict
      "execution_time": int | None
  }
  
  Return-only definitions: FineTuningExecution
  
  With FineTuningExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "metadata": dict
      "execution_time": int | None
      "status": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions ( mjolnir.content_generation.create_execution ) [ POST ] ⭢ ContentGenerationExecution

  
  

  create_execution
  
  Return-only definitions: ContentGenerationExecution
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_connections/<connection_id:int>/models ( mjolnir.content_generation.create_model ) [ POST ] ⭢ AiServiceModel

  
  

  create_model
  
  Return-only definitions: AiServiceModel
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int>/results ( mjolnir.content_generation.create_result ) [ POST ] ⭢ ContentGenerationResult

  
  

  create_result
  
  Return-only definitions: ContentGenerationResult
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_collections/<collection_id:int> ( mjolnir.content_generation.delete_collection ) [ DELETE ] ⭢ ContentGenerationCollection

  
  

  delete_collection
  
  Return-only definitions: ContentGenerationCollection
  
  With ContentGenerationCollection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "executions": list[ContentGenerationExecution]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationExecution is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_connections/<connection_id:int> ( mjolnir.content_generation.delete_connection ) [ DELETE ] ⭢ AiServiceConnection

  
  

  delete_connection
  
  Return-only definitions: AiServiceConnection
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/content_generation_example_sets/<example_set_id:int> ( mjolnir.content_generation.delete_example_set ) [ DELETE ] ⭢ ContentGenerationExampleSet

  
  

  delete_example_set
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int> ( mjolnir.content_generation.delete_execution ) [ DELETE ] ⭢ ContentGenerationExecution

  
  

  delete_execution
  
  Return-only definitions: ContentGenerationExecution
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/fine_tuning_executions/<execution_id:int> ( mjolnir.content_generation.delete_execution ) [ DELETE ] ⭢ FineTuningExecution

  
  

  delete_execution
  
  Return-only definitions: FineTuningExecution
  
  With FineTuningExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "metadata": dict
      "execution_time": int | None
      "status": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/ai_service_models/<model_id:int> ( mjolnir.content_generation.delete_model ) [ DELETE ] ⭢ AiServiceModel

  
  

  delete_model
  
  Return-only definitions: AiServiceModel
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_results/<result_id:int> ( mjolnir.content_generation.delete_result ) [ DELETE ] ⭢ ContentGenerationResult

  
  

  delete_result
  
  Return-only definitions: ContentGenerationResult
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_collections/<collection_id:int> ( mjolnir.content_generation.get_collection ) [ GET ] ⭢ ContentGenerationCollection

  
  

  get_collection
  
  Return-only definitions: ContentGenerationCollection
  
  With ContentGenerationCollection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "executions": list[ContentGenerationExecution]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationExecution is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/content_generation_collections/<collection_id:int>/comments ( mjolnir.content_generation.get_collection_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_collection_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_collections/<collection_id:int>/ratings ( mjolnir.content_generation.get_collection_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_collection_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/ai_service_connections/<connection_id:int> ( mjolnir.content_generation.get_connection ) [ GET ] ⭢ AiServiceConnection

  
  

  get_connection
  
  Return-only definitions: AiServiceConnection
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/content_generation_example_sets/<example_set_id:int> ( mjolnir.content_generation.get_example_set ) [ GET ] ⭢ ContentGenerationExampleSet

  
  

  get_example_set
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_example_sets/<example_set_id:int>/results ( mjolnir.content_generation.get_example_set_result_view ) [ GET ] ⭢ ContentGenerationExampleSetResultView

  
  

  get_example_set_result_view
  
  Return-only definitions: ContentGenerationExampleSetResultView
  
  With ContentGenerationExampleSetResultView defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "result_ids": list[int]
  }
  

• /v1/content_generation_executions/<execution_id:int> ( mjolnir.content_generation.get_execution ) [ GET ] ⭢ ContentGenerationExecution

  
  

  get_execution
  
  Return-only definitions: ContentGenerationExecution
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/fine_tuning_executions/<execution_id:int> ( mjolnir.content_generation.get_execution ) [ GET ] ⭢ FineTuningExecution

  
  

  get_execution
  
  Return-only definitions: FineTuningExecution
  
  With FineTuningExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "metadata": dict
      "execution_time": int | None
      "status": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int>/comments ( mjolnir.content_generation.get_execution_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_execution_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_executions/<execution_id:int>/ratings ( mjolnir.content_generation.get_execution_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_execution_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/ai_service_models/<model_id:int> ( mjolnir.content_generation.get_model ) [ GET ] ⭢ AiServiceModel

  
  

  get_model
  
  Return-only definitions: AiServiceModel
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_results/<result_id:int> ( mjolnir.content_generation.get_result ) [ GET ] ⭢ ContentGenerationResult

  
  

  get_result
  
  Return-only definitions: ContentGenerationResult
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_results/<result_id:int>/comments ( mjolnir.content_generation.get_result_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_result_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/content_generation_results/<result_id:int>/ratings ( mjolnir.content_generation.get_result_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_result_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/content_generation_collections ( mjolnir.content_generation.list_all_collections ) [ GET ] ⭢ list[ContentGenerationCollection]

  
  

  list_all_collections
  
  Return-only definitions: list[ContentGenerationCollection]
  
  With ContentGenerationCollection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "executions": list[ContentGenerationExecution]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationExecution is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_connections ( mjolnir.content_generation.list_all_connections ) [ GET ] ⭢ list[AiServiceConnection]

  
  

  list_all_connections
  
  Return-only definitions: list[AiServiceConnection]
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/content_generation_example_sets ( mjolnir.content_generation.list_all_example_sets ) [ GET ] ⭢ list[ContentGenerationExampleSet]

  
  

  list_all_example_sets
  
  Return-only definitions: list[ContentGenerationExampleSet]
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/fine_tuning_executions ( mjolnir.content_generation.list_all_executions ) [ GET ] ⭢ list[FineTuningExecution]

  
  

  list_all_executions
  
  Return-only definitions: list[FineTuningExecution]
  
  With FineTuningExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "metadata": dict
      "execution_time": int | None
      "status": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions ( mjolnir.content_generation.list_all_executions ) [ GET ] ⭢ list[ContentGenerationExecution]

  
  

  list_all_executions
  
  Return-only definitions: list[ContentGenerationExecution]
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/content_generation_collections/<collection_id:int>/executions ( mjolnir.content_generation.list_all_executions ) [ GET ] ⭢ list[ContentGenerationExecution]

  
  

  list_all_executions
  
  Return-only definitions: list[ContentGenerationExecution]
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_models ( mjolnir.content_generation.list_all_models ) [ GET ] ⭢ list[AiServiceModel]

  
  

  list_all_models
  
  Return-only definitions: list[AiServiceModel]
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/ai_service_connections/<connection_id:int>/models ( mjolnir.content_generation.list_all_models ) [ GET ] ⭢ list[AiServiceModel]

  
  

  list_all_models
  
  Return-only definitions: list[AiServiceModel]
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_results ( mjolnir.content_generation.list_all_results ) [ GET ] ⭢ list[ContentGenerationResult]

  
  

  list_all_results
  
  Return-only definitions: list[ContentGenerationResult]
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int>/results ( mjolnir.content_generation.list_all_results ) [ GET ] ⭢ list[ContentGenerationResult]

  
  

  list_all_results
  
  Return-only definitions: list[ContentGenerationResult]
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_example_sets/<example_set_id:int>/results/<result_id:int> ( mjolnir.content_generation.remove_example_set_result_link ) [ DELETE ] ⭢ ContentGenerationExampleSet

  
  

  remove_example_set_result_link
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_example_sets/<example_set_id:int>/results ( mjolnir.content_generation.remove_example_set_result_link_bulk ) [ POST ] ⭢ ContentGenerationExampleSet

  
  

  remove_example_set_result_link_bulk
  
  With ContentGenerationExampleSetResultBulkAction defined as 
  
  {
      "operation": "ADD" | "REMOVE"
      "result_ids": list[int]
  }
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_collections/<collection_id:int> ( mjolnir.content_generation.update_collection ) [ PATCH ] ⭢ ContentGenerationCollection

  
  

  update_collection
  
  With ContentGenerationCollectionUpdate defined as 
  
  {
      "folder_id": int | None
      "name": str | None
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: ContentGenerationCollection
  
  With ContentGenerationCollection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "executions": list[ContentGenerationExecution]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationExecution is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/ai_service_connections/<connection_id:int> ( mjolnir.content_generation.update_connection ) [ PATCH ] ⭢ AiServiceConnection

  
  

  update_connection
  
  With AiServiceConnectionUpdate defined as 
  
  {
      "name": str | None
      "status": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: AiServiceConnection
  
  With AiServiceConnection defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "account_id": int
      "folder_id": int | None
      "external_id": str | None
      "type": str
      "name": str
      "status": str
      "metadata": dict
      "models": list[AiServiceModel]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AiServiceModel is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "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/content_generation_example_sets/<example_set_id:int> ( mjolnir.content_generation.update_example_set ) [ PATCH ] ⭢ ContentGenerationExampleSet

  
  

  update_example_set
  
  With ContentGenerationExampleSetUpdate defined as 
  
  {
      "name": str | None
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: ContentGenerationExampleSet
  
  With ContentGenerationExampleSet defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "folder_id": int
      "name": str
      "description": str
      "metadata": dict
      "result_count": int
      "result_token_count": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_executions/<execution_id:int> ( mjolnir.content_generation.update_execution ) [ PATCH ] ⭢ ContentGenerationExecution

  
  

  update_execution
  
  With ContentGenerationExecutionUpdate defined as 
  
  {
      "status": str | None
  }
  
  Return-only definitions: ContentGenerationExecution
  
  With ContentGenerationExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "account_id": int
      "collection_id": int | None
      "folder_id": int | None
      "blueprint_id": int | None
      "external_id": str | None
      "use_case_name": str | None
      "cached_execution_id": int | None
      "status": str
      "results": list[ContentGenerationResult]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ContentGenerationResult is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "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/fine_tuning_executions/<execution_id:int> ( mjolnir.content_generation.update_execution ) [ PATCH ] ⭢ FineTuningExecution

  
  

  update_execution
  
  With FineTuningExecutionUpdate defined as 
  
  {
      "name": str | None
      "description": str | None
      "status": str | None
      "metadata": dict | None
      "execution_time": int | None
  }
  
  Return-only definitions: FineTuningExecution
  
  With FineTuningExecution defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "base_model_version_id": int
      "example_set_id": int
      "type": "TRAINING" | "EVALUATION" | "PROFILER"
      "name": str
      "description": str
      "metadata": dict
      "execution_time": int | None
      "status": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/ai_service_models/<model_id:int> ( mjolnir.content_generation.update_model ) [ PATCH ] ⭢ AiServiceModel

  
  

  update_model
  
  With AiServiceModelUpdate defined as 
  
  {
      "name": str | None
      "status": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: AiServiceModel
  
  With AiServiceModel defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "connection_id": int
      "version_id": int | None
      "external_id": str | None
      "fine_tuning_execution_id": int | None
      "type": str
      "name": str
      "status": str | None
      "metadata": dict | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /v1/content_generation_results/<result_id:int>/usage ( mjolnir.content_generation.update_usage_data ) [ POST ] ⭢ ContentGenerationResult

  
  

  update_usage_data
  
  Return-only definitions: ContentGenerationResult
  
  With ContentGenerationResult defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "execution_id": int
      "model_version_id": int | None
      "task_name": str | None
      "input_token_count": int
      "output_token_count": int
      "execution_time": int
      "estimated_cost": float
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where Permissions is defined by 
  
  {
      "can_view": bool
      "can_give_feedback": bool
      "can_edit": bool
      "can_delete": bool
      "can_manage_permissions": bool
  }
  

• /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[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/deployment ( mjolnir.deployment.create ) [ POST ] ⭢ Deployment

  
  

  create
  
  With NewModelDeployment defined as 
  
  {
      "model_name": str
      "job_id": int
      "end_date": ISO8601[str] | None
  }
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/deploy ( mjolnir.deployment.create ) [ POST ] ⭢ Deployment

  
  

  create
  
  With NewModelDeployment defined as 
  
  {
      "model_name": str
      "job_id": int
      "end_date": ISO8601[str] | None
  }
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  create
  
  With NewModelDeployment defined as 
  
  {
      "model_name": str
      "job_id": int
      "end_date": ISO8601[str] | None
  }
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  create
  
  With NewModelDeployment defined as 
  
  {
      "model_name": str
      "job_id": int
      "end_date": ISO8601[str] | None
  }
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  deploy_project
  
  With NewProjectDeployment defined as 
  
  {
      "end_date": ISO8601[str] | None
  }
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/deployments ( mjolnir.deployment.list_all ) [ GET ] ⭢ tuple[Deployment, …]

  
  

  list_all
  
  Return-only definitions: tuple[Deployment, …]
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/deployment/<deployment_id:int>/invocations ( mjolnir.deployment.list_deployment_invocations ) [ GET ] ⭢ tuple[DeploymentInvokation, …]

  
  

  list_deployment_invocations
  
  Return-only definitions: tuple[DeploymentInvokation, …]
  
  With DeploymentInvokation defined as 
  
  {
      "tenant_id": int
      "id": int
      "deployment_id": int | None
      "project_id": int | None
      "duration_ms": int
      "number_rows": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "raw_score_path": URL
      "out_score_path": URL
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  

• /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[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  update
  
  With DeploymentUpdate defined as 
  
  {
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR" | None
      "annotations": list[Annotation] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Return-only definitions: Deployment
  
  With Deployment defined as 
  
  {
      "tenant_id": int
      "id": int
      "account_id": int
      "annotations": list[Annotation]
      "stack_id": str
      "endpoint_url": URL | None
      "endpoint_headers": dict[str, str]
      "end_date": ISO8601[str] | None
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "job_id": int | None
      "model_name": str | None
      "project_id": int | None
      "created_by": Author
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/invocations ( mjolnir.deployment_invokation.create_invocation ) [ POST ] ⭢ DeploymentInvokation | tuple[DeploymentInvokation, …]

  
  

  create_invocation
  
      You may either post a singular object or array of objects.
  
  With NewInvokation defined as 
  
  {
      "created_date": ISO8601[str] | None
      "duration": int
      "number_rows": int
      "action": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "raw_score_path": URL
      "out_score_path": URL
      "deployment_id": int | None
      "project_id": int | None
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Return-only definitions: DeploymentInvokation | tuple[DeploymentInvokation, …]
  
  With DeploymentInvokation defined as 
  
  {
      "tenant_id": int
      "id": int
      "deployment_id": int | None
      "project_id": int | None
      "duration_ms": int
      "number_rows": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "raw_score_path": URL
      "out_score_path": URL
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  

• /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": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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[Project]

  
  

  get_folder_blueprints
  
  Return-only definitions: list[Project]
  
  With Project defined as 
  
  {
      "tenant_id": int
      "account_id": int
      "folder_id": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /v1/folders/<folder_id:int>/projects ( mjolnir.folder.get_folder_projects ) [ GET ] ⭢ list[GuidedBlueprint]

  
  

  get_folder_projects
  
  Return-only definitions: list[GuidedBlueprint]
  
  With GuidedBlueprint defined as 
  
  {
      "tenant_id": int
      "folder_id": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/folder_roles ( mjolnir.folder.get_folder_roles ) [ GET ] ⭢ list[FolderRole]

  
  

  get_folder_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/folders/<folder_id:int>/roles ( mjolnir.folder.get_folder_roles ) [ GET ] ⭢ list[FolderRole]

  
  

  get_folder_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/folders/<folder_id:int>/source_summaries ( mjolnir.folder.get_folder_source_summaries ) [ GET ] ⭢ list[DataSourceSummary]

  
  

  get_folder_source_summaries
  
  Return-only definitions: list[DataSourceSummary]
  
  With DataSourceSummary defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "name": str
      "source_type": "RAW_DATA" | "CONNECTION_METADATA"
      "row_count": MetricSummary | None
      "column_count": MetricSummary | None
      "top_factors": MetricSummary | None
      "num_useful_variables": MetricSummary | None
      "readiness_score": MetricSummary | None
      "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[Training]

  
  

  get_folder_training_data
  
  Return-only definitions: list[Training]
  
  With Training defined as 
  
  {
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "tenant_id": int
      "folder_id": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[Folder]

  
  

  get_folders
  
  Return-only definitions: list[Folder]
  
  With Folder defined as 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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": str
      "description": str
      "default_role_type": "OWNER" | "EDITOR" | "CONTRIBUTOR" | "VIEWER" | "NONE"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "roles": list[FolderRole]
      "contents": FolderContents
      "permissions": Permissions
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  abort
  
  Return-only definitions: Annotated[`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["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"]
      "error_cost_ratio": float | int
      "value_matrix": ConfusionMatrix | ImpactMatrix
      "max_ideal_population": int
      "current_capacity": int
      "extra": dict | None
      "name": str | None
      "derived_columns": list[dict | list] | None
      "model_names": list[str] | None
      "column_type_overrides": dict[str, "ENUM" | "RANGE" | "BOTH"] | None
      "training_data_id": int
      "outcome_key": str
      "outcome_value": str | float | int | list[int] | list[int | float] | list[float] | list[str]
      "drop_columns": list[str] | None
      "model_type": "CATEGORICAL" | "REGRESSION" | "ALL" | None
      "drop_rows": list[DropKeyRow] | None
      "score_function": ScoreFunction | None
      "parent_blueprint_id": int | None
      "external_model_setup_url": str | None
      "timeseries_key": str | None
      "train_split_condition": Condition | None
      "test_split_condition": Condition | None
  }
  
  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": "INCLUDE" | "EXCLUDE" | None
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None] | None
      "conditions": list[str] | None
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Return-only definitions: ModelTrainingJob
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"]
      "error_cost_ratio": float | int
      "value_matrix": ConfusionMatrix | ImpactMatrix
      "max_ideal_population": int
      "current_capacity": int
      "extra": dict | None
      "name": str | None
      "derived_columns": list[dict | list] | None
      "model_names": list[str] | None
      "column_type_overrides": dict[str, "ENUM" | "RANGE" | "BOTH"] | None
      "training_data_id": int
      "outcome_key": str
      "outcome_value": str | float | int | list[int] | list[int | float] | list[float] | list[str]
      "drop_columns": list[str] | None
      "model_type": "CATEGORICAL" | "REGRESSION" | "ALL" | None
      "drop_rows": list[DropKeyRow] | None
      "score_function": ScoreFunction | None
      "parent_blueprint_id": int | None
      "external_model_setup_url": str | None
      "timeseries_key": str | None
      "train_split_condition": Condition | None
      "test_split_condition": Condition | None
  }
  
  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": "INCLUDE" | "EXCLUDE" | None
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None] | None
      "conditions": list[str] | None
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Return-only definitions: ModelTrainingJob
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

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

  
  

  debug
  
  Return-only definitions: Annotated[`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": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job/<job_id:int> ( mjolnir.jobs.get ) [ GET ] ⭢ Annotated[`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[`JSON`, Inferred]
  
  

• /v1/jobs ( mjolnir.jobs.list_all ) [ GET ] ⭢ tuple[ModelTrainingJob, …]

  
  

  list_all
  
  Return-only definitions: tuple[ModelTrainingJob, …]
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job ( mjolnir.jobs.list_all ) [ GET ] ⭢ tuple[ModelTrainingJob, …]

  
  

  list_all
  
  Return-only definitions: tuple[ModelTrainingJob, …]
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/accounts/<account_id:int>/jobs ( mjolnir.jobs.list_all ) [ GET ] ⭢ tuple[ModelTrainingJob, …]

  
  

  list_all
  
  Return-only definitions: tuple[ModelTrainingJob, …]
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/jobs/by/<tag_name:string> ( mjolnir.jobs.list_by_tag ) [ GET ] ⭢ tuple[ModelTrainingJob, …]

  
  

  list_by_tag
  
  Return-only definitions: tuple[ModelTrainingJob, …]
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job/<job_id:int>/models ( mjolnir.jobs.list_runs_by_job ) [ GET ] ⭢ tuple[TrainedModel, …]

  
  

  list_runs_by_job
  
  Return-only definitions: tuple[TrainedModel, …]
  
  With TrainedModel defined as 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job/<job_id:int>/runs ( mjolnir.jobs.list_runs_by_job ) [ GET ] ⭢ tuple[TrainedModel, …]

  
  

  list_runs_by_job
  
  Return-only definitions: tuple[TrainedModel, …]
  
  With TrainedModel defined as 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job/<job_id:int> ( mjolnir.jobs.update ) [ POST ] ⭢ ModelTrainingJob

  
  

  update
  Handle a protected post, lookup a job and add to it.
  With NewModelData defined as 
  
  {
      "action": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR" | None
      "data": list[NewRunData] | None
      "name": str | None
      "annotations": list[Annotation] | None
      "models_to_run": list[str] | None
  }
  
  Where NewRunData is defined by 
  
  {
      "confusion_matrices": list[list[int]] | None
      "metrics": dict | None
      "feature_importance": dict | None
      "metadata": dict | None
      "plots": Plots | None
      "name": str
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Return-only definitions: ModelTrainingJob
  
  With ModelTrainingJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/language_model_artifacts/<artifact_id:int>/comments ( mjolnir.language_model_artifact.add_artifact_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_artifact_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/language_model_artifacts/<artifact_id:int>/ratings ( mjolnir.language_model_artifact.add_artifacts_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_artifacts_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: LanguageModelArtifact
  
  With LanguageModelArtifact defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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[Rating]

  
  

  get_artifacts_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/language_model_artifacts/<artifact_id:int>/comments ( mjolnir.language_model_artifact.get_training_data_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_training_data_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/language_model_artifacts ( mjolnir.language_model_artifact.list_all ) [ GET ] ⭢ list[LanguageModelArtifact]

  
  

  list_all
  
  Return-only definitions: list[LanguageModelArtifact]
  
  With LanguageModelArtifact defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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": int | None
      "name": str | None
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: LanguageModelArtifact
  
  With LanguageModelArtifact defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  
  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[`JSON`, Inferred]

  
  

  create
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/licensing ( mjolnir.licensing.list_all ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  list_all
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/password ( mjolnir.login.check_password ) [ POST ] ⭢ UserSession

  
  

  check_password
  
  With LoginRequest defined as 
  
  {
      "token": str
      "password": str
  }
  
  Return-only definitions: UserSession
  
  With UserSession defined as 
  
  {
      "fullname": str
      "id": int
      "user_token": `BearerToken`
      "user_token_expires_at": float
      "user_token_expires_ttl": float
      "tenants": NotRequired[tuple[TenantSession, …]]
      "iap": NotRequired[FakeIAPSession]
      "restricted_to_tenant": NotRequired[int]
  }
  
  Where TenantSession is defined by 
  
  {
      "id": int
      "fullname": str
      "invite": TenantSessionInvite
  }
  
  Where TenantSessionInvite is defined by 
  
  {
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "token": `BearerToken`
      "expires_at": float
      "expires_ttl": float
  }
  
  Where FakeIAPSession is defined by 
  
  {
      "token": str
      "audience": str
      "expires_at": float
  }
  

• /v1/login/create_bulk ( mjolnir.login.create_bulk_users ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  create_bulk_users
  
  With NewUserInTenant defined as 
  
  {
      "email": Address
      "fullname": str
      "invite_tokens": list[ProvisionalToken]
      "password": str | RandomPassword | None
      "aliases": list[NewUserAlias | str]
  }
  
  Where NewUserAlias is defined by 
  
  {
      "namespace": str
      "external_id": str
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/lookup-token ( mjolnir.login.create_lookup_token ) [ POST ] ⭢ Annotated[`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[`JSON`, Inferred]
  
  

• /v1/login/reset ( mjolnir.login.create_reset_user_request ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  create_reset_user_request
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/create ( mjolnir.login.create_user ) [ POST ] ⭢ NewlyCreatedUser

  
  

  create_user
  
  With NewUser defined as 
  
  {
      "email": Address
      "fullname": str
      "password": str | RandomPassword
      "invite_tokens": list[ProvisionalToken]
      "tenant": NewTenant | None
      "accepts_terms_of_service": bool
  }
  
  Where NewTenant is defined by 
  
  {
      "fullname": str
  }
  
  Return-only definitions: NewlyCreatedUser
  
  With NewlyCreatedUser defined as 
  
  {
      "email": str
      "fullname": str
      "status": "ACTIVE" | "NOT_ACTIVATED"
      "tenants": tuple[Tenant, …]
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "invite_errors": NotRequired[tuple[InviteErrorResponse, …]]
  }
  
  Where Tenant is defined by 
  
  {
      "id": int
      "fullname": str
      "shortname": str
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "foreign_info": ForeignInfo
      "invite": Invite | None
      "tokens": tuple[AccessToken, …]
      "num_licenses": int
      "user_limit": int | float
      "limits": TenantLimits
      "license_types": frozenset["SAMPLE" | "EVALUATION" | "USER" | "UNLICENSED" | "STUDENT" | "USE_AIBLE_RESOURCES"] | None
      "share_behavior": "PUBLIC" | "PRIVATE"
      "linked_domains": tuple[str, …]
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where ForeignInfo is defined by 
  
  {
      "provider": "AZURE" | "AWS_MARKETPLACE" | None
      "id": str | None
  }
  
  Where Invite is defined by 
  
  {
      "user_id": int
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AccessToken is defined by 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "type": "API" | "USER" | "BOTH"
      "token": UUID
      "status": "ACTIVE" | "DELETED" | "INACTIVE"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TenantLimits is defined by 
  
  {
      "training_upload_limit": int | None
      "model_training_limit": int | None
      "score_limit": int | None
      "deployment_limit": int | None
      "account_limit": int | None
      "allow_aible_resource_usage": bool
      "training_upload_size_bytes_limit": int | None
  }
  
  Where InviteErrorResponse is defined by 
  
  {
      "key": str
      "type": str
      "message": str
      "debugging_info": NotRequired[dict[str, Any]]
  }
  

• /v1/ssoRedirect ( mjolnir.login.get_sso_redirect ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  get_sso_redirect
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/<token:str>/activate ( mjolnir.login.handle_activate_user ) [ HEAD , GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  handle_activate_user
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/<token:str>/deactivate ( mjolnir.login.handle_deactivate_user ) [ HEAD , GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  handle_deactivate_user
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/iap ( mjolnir.login.iap_initiated ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  iap_initiated
  
  Return-only definitions: Annotated[`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[`JSON`, Inferred]

  
  

  logout
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/oauth2-reply ( mjolnir.login.oauth2_reply ) [ GET ] ⭢ `AuthorizedUIRedirect`

  
  

  oauth2_reply
  
  With OAuth2Reply defined as 
  
  {
      "code": str
      "state": str
  }
  
  Return-only definitions: `AuthorizedUIRedirect`
  
  

• /v1/login/azure/authorized ( mjolnir.login.on_azure_authorized_get ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  on_azure_authorized_get
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

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

  
  

  on_azure_authorized_post
  
  With AzureAuthorized defined as 
  
  {
      "state": str
      "code": str | None
  }
  
  

• /v1/renew/login ( mjolnir.login.renew_user_token ) [ POST ] ⭢ UserSession

  
  

  renew_user_token
  
  Return-only definitions: UserSession
  
  With UserSession defined as 
  
  {
      "fullname": str
      "id": int
      "user_token": `BearerToken`
      "user_token_expires_at": float
      "user_token_expires_ttl": float
      "tenants": NotRequired[tuple[TenantSession, …]]
      "iap": NotRequired[FakeIAPSession]
      "restricted_to_tenant": NotRequired[int]
  }
  
  Where TenantSession is defined by 
  
  {
      "id": int
      "fullname": str
      "invite": TenantSessionInvite
  }
  
  Where TenantSessionInvite is defined by 
  
  {
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "token": `BearerToken`
      "expires_at": float
      "expires_ttl": float
  }
  
  Where FakeIAPSession is defined by 
  
  {
      "token": str
      "audience": str
      "expires_at": float
  }
  

• /v1/login/<token:str>/reset ( mjolnir.login.reset_user ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  reset_user
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/login/saml-reply ( mjolnir.login.saml_reply ) [ POST ] ⭢ `AuthorizedUIRedirect`

  
  

  saml_reply
  
  Handle a SAML ACS reply
  
  This is where we examine the request data and determine if it passes to
  send the user to the UI with an one-time password (OTP) SSO short-token
  code which it uses to exchange on the
  
      /v1/login/password
   route for a
  UserSession.
  
  Return-only definitions: `AuthorizedUIRedirect`
  
  

• /v1/login/by/<tenant_id:int>/via/<key:str> ( mjolnir.login.service_provider_initiated_login ) [ POST ] ⭢ `AuthNRedirect` | `AuthNFormPost`

  
  

  service_provider_initiated_login
  
  Login to Aible via this tenant SSO association.
  
  Create a service-provider initiated login request.
  
  A successful call will end up with the SSO IDP returning the browser to
  /v1/login/saml-reply
  
  Return-only definitions: `AuthNRedirect` | `AuthNFormPost`
  
  

• /v1/logout/saml-reply ( mjolnir.login.service_provider_initiated_logout_reply ) [ POST ]

  
  

  service_provider_initiated_logout_reply
  
  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!
  
  

• /v1/lookup-token/validate ( mjolnir.login.validate_lookup_token ) [ POST ] ⭢ Annotated[`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[`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": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/marketplaces ( mjolnir.marketplace.create ) [ POST ] ⭢ Marketplace

  
  

  create
  
  With NewMarketplace defined as 
  
  {
      "title": str
      "description": str
      "public": bool | None
  }
  
  Return-only definitions: Marketplace
  
  With Marketplace defined as 
  
  {
      "tenant_id": int
      "id": int
      "flags": "PUBLISHED_INTERNAL" | "PUBLISHED_EXTERNAL" | "REQUIRES_APPROVAL"
      "title": str
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "created_by": Author
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": "DRAFT" | "PUBLISHED" | "ARCHIVED" | "PURCHASED" | None
  }
  
  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": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "created_by": Author
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchased_by": Author
      "purchase_date": ISO8601[str]
      "offer_id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/marketplaces ( mjolnir.marketplace.list_all ) [ GET ] ⭢ tuple[Marketplace, …]

  
  

  list_all
  
  Return-only definitions: tuple[Marketplace, …]
  
  With Marketplace defined as 
  
  {
      "tenant_id": int
      "id": int
      "flags": "PUBLISHED_INTERNAL" | "PUBLISHED_EXTERNAL" | "REQUIRES_APPROVAL"
      "title": str
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "created_by": Author
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/marketplace/<marketplace_id:int>/offers ( mjolnir.marketplace.list_offers ) [ GET ] ⭢ tuple[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[Offer, …]
  
  With Offer defined as 
  
  {
      "tenant_id": int
      "id": int
      "marketplace_id": int
      "entity_id": int
      "status": "DRAFT" | "PUBLISHED" | "ARCHIVED" | "PURCHASED"
      "type": "BLUEPRINT"
      "name": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/marketplace/<marketplace_id:int>/purchased ( mjolnir.marketplace.list_purchased_by_marketplace ) [ GET ] ⭢ tuple[PurchasedOffer, …]

  
  

  list_purchased_by_marketplace
  
  Return-only definitions: tuple[PurchasedOffer, …]
  
  With PurchasedOffer defined as 
  
  {
      "tenant_id": int
      "id": int
      "marketplace_id": int
      "entity_id": int
      "status": "DRAFT" | "PUBLISHED" | "ARCHIVED" | "PURCHASED"
      "type": "BLUEPRINT"
      "name": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchased_by": Author
      "purchase_date": ISO8601[str]
      "offer_id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where PurchasedOffer is defined by 
  
  {
      "tenant_id": int
      "id": int
      "marketplace_id": int
      "entity_id": int
      "status": "DRAFT" | "PUBLISHED" | "ARCHIVED" | "PURCHASED"
      "type": "BLUEPRINT"
      "name": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchased_by": Author
      "purchase_date": ISO8601[str]
      "offer_id": int
  }
  

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

  
  

  update
  
  With UpdateMarketplace defined as 
  
  {
      "flags": "PUBLISHED_INTERNAL" | "PUBLISHED_EXTERNAL" | "REQUIRES_APPROVAL" | None
      "title": str | None
      "description": str | None
  }
  
  Return-only definitions: Marketplace
  
  With Marketplace defined as 
  
  {
      "tenant_id": int
      "id": int
      "flags": "PUBLISHED_INTERNAL" | "PUBLISHED_EXTERNAL" | "REQUIRES_APPROVAL"
      "title": str
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "created_by": Author
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  update_offer
  
      Used to fix up an offer
  
  With UpdateOffer defined as 
  
  {
      "status": "DRAFT" | "PUBLISHED" | "ARCHIVED" | "PURCHASED" | None
      "name": str | None
      "description": str | None
      "blueprint_id": int | None
  }
  
  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": str
      "created_by": Author
      "description": str
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/models ( mjolnir.model.create ) [ POST ] ⭢ NewModel | tuple[NewModel, …]

  
  

  create
  
  With NewModel defined as 
  
  {
      "name": str
      "display_name": str
      "type": "CLASSIFICATION" | "REGRESSION" | "TIME_SERIES"
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
  }
  
  Return-only definitions: NewModel | tuple[NewModel, …]
  
  With NewModel defined as 
  
  {
      "name": str
      "display_name": str
      "type": "CLASSIFICATION" | "REGRESSION" | "TIME_SERIES"
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
  }
  

• /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["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/intern_models ( mjolnir.model.download_intern_models ) [ GET ] ⭢ dict[str, str] | dict[str, dict[str, str]]

  
  

  download_intern_models
  
  Return-only definitions: dict[str, str] | dict[str, dict[str, str]]
  
  

• /v1/intern_model/<model_name:[0-9a-zA-z][0-9a-zA-z\-\.\_]*\/?[0-9a-zA-z][0-9a-zA-z\-\.\_]+> ( mjolnir.model.download_intern_models ) [ GET ] ⭢ dict[str, str] | dict[str, dict[str, str]]

  
  

  download_intern_models
  
  Return-only definitions: dict[str, str] | dict[str, dict[str, str]]
  
  

• /v1/models ( mjolnir.model.list_all ) [ GET ] ⭢ tuple[Model, …]

  
  

  list_all
  
  Return-only definitions: tuple[Model, …]
  
  With Model defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "name": str
      "display_name": str
      "type": "CLASSIFICATION" | "REGRESSION" | "TIME_SERIES"
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/model ( mjolnir.model.list_all ) [ GET ] ⭢ tuple[Model, …]

  
  

  list_all
  
  Return-only definitions: tuple[Model, …]
  
  With Model defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "name": str
      "display_name": str
      "type": "CLASSIFICATION" | "REGRESSION" | "TIME_SERIES"
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/models ( mjolnir.model.mass_update ) [ PATCH ] ⭢ tuple[Model, …]

  
  

  mass_update
  
  With UpdateMultiModel defined as 
  
  {
      "display_name": str | None
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …] | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
      "name": str
  }
  
  Return-only definitions: tuple[Model, …]
  
  With Model defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "name": str
      "display_name": str
      "type": "CLASSIFICATION" | "REGRESSION" | "TIME_SERIES"
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

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

  
  

  update
  
  With UpdateModel defined as 
  
  {
      "display_name": str | None
      "options": tuple["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …] | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
  }
  
  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["HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS", …]
      "metadata": dict[str, Any]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/generate_presigned_url ( mjolnir.presign.presign_api_request ) [ PUT , GET , POST , DELETE , PATCH ] ⭢ 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": "GET" | "PATCH" | "POST" | "DELETE" | "PUT" | None
  }
  
  Return-only definitions: str
  
  

• /v1/project_scenarios/<project_scenario_id:int>/comments ( mjolnir.project.add_project_scenario_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_project_scenario_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_scenarios/<project_scenario_id:int>/ratings ( mjolnir.project.add_project_scenario_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_project_scenario_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[Comment]

  
  

  add_project_segment_assumption_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_segment_assumptions/<project_segment_assumption_id:int>/ratings ( mjolnir.project.add_project_segment_assumption_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_project_segment_assumption_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[TaskProjectSegment]
  }
  
  Where TaskProjectSegment is defined by 
  
  {
      "id": int
  }
  

• /v1/project_tasks/<project_task_id:int>/comments ( mjolnir.project.add_project_task_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_project_task_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_tasks/<project_task_id:int>/ratings ( mjolnir.project.add_project_task_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_project_task_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /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": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segments/<project_segment_id:int>/roles ( mjolnir.project.create_project_segment_role ) [ POST ] ⭢ list[ProjectSegmentRole]

  
  

  create_project_segment_role
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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[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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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[TaskProjectSegment]
  }
  
  Where TaskProjectSegment is defined by 
  
  {
      "id": int
  }
  

• /v1/segments ( mjolnir.project.create_segment ) [ POST ] ⭢ list[Segment]

  
  

  create_segment
  
  Return-only definitions: list[Segment]
  
  With Segment defined as 
  
  {
      "tenant_id": int
      "id": int
      "conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /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": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /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": ProjectSegmentFrontier | None
      "models": list[ProjectSegmentFrontier]
      "blueprint": GuidedBlueprint | None
  }
  
  Where ProjectSegmentFrontier is defined by 
  
  {
      "project_segment_id": int
      "project_id": int
      "conditions": list[Condition]
      "job_id": int
      "model_name": str | None
      "assumption_data": dict | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where GuidedBlueprint is defined by 
  
  {
      "tenant_id": int
      "folder_id": int | None
      "id": int
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "name": str | None
      "suggested_fields": list[SuggestedKey]
      "wizard": dict
      "version": int
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "purchase_id": int | None
      "permissions": Permissions
  }
  
  Where SuggestedKey is defined by 
  
  {
      "name": str
      "aliases": list[str]
      "type": "ENUM" | "RANGE" | "BOTH"
      "description": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_monitor_snapshots ( mjolnir.project.get_project_monitor_snapshots ) [ GET ] ⭢ list[ProjectScenario]

  
  

  get_project_monitor_snapshots
  
  Return-only definitions: list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/projects/<project_id:int>/monitor_snapshots ( mjolnir.project.get_project_monitor_snapshots ) [ GET ] ⭢ list[ProjectScenario]

  
  

  get_project_monitor_snapshots
  
  Return-only definitions: list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_monitors ( mjolnir.project.get_project_monitors ) [ GET ] ⭢ list[ProjectMonitor]

  
  

  get_project_monitors
  
  Return-only definitions: list[ProjectMonitor]
  
  With ProjectMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/projects/<project_id:int>/monitors ( mjolnir.project.get_project_monitors ) [ GET ] ⭢ list[ProjectMonitor]

  
  

  get_project_monitors
  
  Return-only definitions: list[ProjectMonitor]
  
  With ProjectMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_roles ( mjolnir.project.get_project_roles ) [ GET ] ⭢ list[ProjectRole]

  
  

  get_project_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/projects/<project_id:int>/roles ( mjolnir.project.get_project_roles ) [ GET ] ⭢ list[ProjectRole]

  
  

  get_project_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_scenarios/<project_scenario_id:int>/comments ( mjolnir.project.get_project_scenario_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_project_scenario_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_scenarios/<project_scenario_id:int>/ratings ( mjolnir.project.get_project_scenario_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_project_scenario_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_scenarios ( mjolnir.project.get_project_scenarios ) [ GET ] ⭢ list[ProjectScenario]

  
  

  get_project_scenarios
  
  Return-only definitions: list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/projects/<project_id:int>/scenarios ( mjolnir.project.get_project_scenarios ) [ GET ] ⭢ list[ProjectScenario]

  
  

  get_project_scenarios
  
  Return-only definitions: list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segment_assumptions/<project_segment_assumption_id:int>/comments ( mjolnir.project.get_project_segment_assumption_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_project_segment_assumption_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_segment_assumptions/<project_segment_assumption_id:int>/ratings ( mjolnir.project.get_project_segment_assumption_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_project_segment_assumption_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segment_assumptions ( mjolnir.project.get_project_segment_assumptions ) [ GET ] ⭢ list[ProjectSegmentAssumption]

  
  

  get_project_segment_assumptions
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segments/<project_segment_id:int>/assumptions ( mjolnir.project.get_project_segment_assumptions ) [ GET ] ⭢ list[ProjectSegmentAssumption]

  
  

  get_project_segment_assumptions
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/project_segment_jobs ( mjolnir.project.get_project_segment_jobs ) [ GET ] ⭢ list[ProjectSegmentJob]

  
  

  get_project_segment_jobs
  
  Return-only definitions: list[ProjectSegmentJob]
  
  With ProjectSegmentJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_segment_id": int
      "job_id": int
      "job": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/project_segments/<project_segment_id:int>/jobs ( mjolnir.project.get_project_segment_jobs ) [ GET ] ⭢ list[ProjectSegmentJob]

  
  

  get_project_segment_jobs
  
  Return-only definitions: list[ProjectSegmentJob]
  
  With ProjectSegmentJob defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_segment_id": int
      "job_id": int
      "job": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segment_monitors ( mjolnir.project.get_project_segment_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/projects/<project_id:int>/segment_monitors ( mjolnir.project.get_project_segment_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segments/<project_segment_id:int>/monitors ( mjolnir.project.get_project_segment_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /v1/project_segment_roles ( mjolnir.project.get_project_segment_roles ) [ GET ] ⭢ list[ProjectSegmentRole]

  
  

  get_project_segment_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /v1/project_segments/<project_segment_id:int>/roles ( mjolnir.project.get_project_segment_roles ) [ GET ] ⭢ list[ProjectSegmentRole]

  
  

  get_project_segment_roles
  
  Return-only definitions: list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segment_user_monitors ( mjolnir.project.get_project_segment_user_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_user_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/projects/<project_id:int>/segment_user_monitors ( mjolnir.project.get_project_segment_user_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_user_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segments/<project_segment_id:int>/users/<user_id:int>/monitors ( mjolnir.project.get_project_segment_user_monitors ) [ GET ] ⭢ list[ProjectSegmentMonitor]

  
  

  get_project_segment_user_monitors
  
  Return-only definitions: list[ProjectSegmentMonitor]
  
  With ProjectSegmentMonitor defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "project_segment_id": int
      "data": dict
      "start_date": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/project_segments ( mjolnir.project.get_project_segments ) [ GET ] ⭢ list[ProjectSegment]

  
  

  get_project_segments
  
  Return-only definitions: list[ProjectSegment]
  
  With ProjectSegment defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[TaskProjectSegment]
  }
  
  Where TaskProjectSegment is defined by 
  
  {
      "id": int
  }
  

• /v1/projects/<project_id:int>/segments ( mjolnir.project.get_project_segments ) [ GET ] ⭢ list[ProjectSegment]

  
  

  get_project_segments
  
  Return-only definitions: list[ProjectSegment]
  
  With ProjectSegment defined as 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[TaskProjectSegment]
  }
  
  Where TaskProjectSegment is defined by 
  
  {
      "id": int
  }
  

• /v1/project_tasks/<project_task_id:int>/comments ( mjolnir.project.get_project_task_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_project_task_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/project_tasks/<project_task_id:int>/ratings ( mjolnir.project.get_project_task_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_project_task_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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[TaskProjectSegment]
  }
  
  Where TaskProjectSegment is defined by 
  
  {
      "id": int
  }
  

• /v1/projects ( mjolnir.project.get_projects ) [ GET ] ⭢ list[Project]

  
  

  get_projects
  
  Return-only definitions: list[Project]
  
  With Project defined as 
  
  {
      "tenant_id": int
      "account_id": int
      "folder_id": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /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[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/segments ( mjolnir.project.get_segments ) [ GET ] ⭢ list[Segment]

  
  

  get_segments
  
  Return-only definitions: list[Segment]
  
  With Segment defined as 
  
  {
      "tenant_id": int
      "id": int
      "conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/projects/<project_id:int>/invocations ( mjolnir.project.list_project_invocations ) [ GET ] ⭢ tuple[DeploymentInvokation, …]

  
  

  list_project_invocations
  
  Return-only definitions: tuple[DeploymentInvokation, …]
  
  With DeploymentInvokation defined as 
  
  {
      "tenant_id": int
      "id": int
      "deployment_id": int | None
      "project_id": int | None
      "duration_ms": int
      "number_rows": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "raw_score_path": URL
      "out_score_path": URL
      "created_date": ISO8601[str]
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": int | None
      "id": int
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "monitors": list[ProjectMonitor]
      "segment_count": int | None
      "segments": list[ProjectSegment] | None
      "scenarios": list[ProjectScenario] | None
      "roles": list[ProjectRole] | None
      "permissions": Permissions | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectMonitor is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "unique_id_name": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where ProjectSegment is defined by 
  
  {
      "tenant_id": int
      "id": int
      "project_id": int
      "segment_id": int
      "conditions": list[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  

• /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": str | None
      "business_prediction_name": str | None
      "terminal_conditions": list[Condition]
      "activity_conditions": list[Condition]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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[ProjectScenarioElement]
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "name": str
      "description": str
      "segments": list[ProjectScenarioSegment]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioElement is defined by 
  
  {
      "assumption_id": int | None
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /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[Condition]
      "name": str
      "description": str
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "assumption": ProjectSegmentAssumption | ProjectScenarioSegment | None
      "job": ProjectSegmentJob | None
      "history": ProjectSegmentHistory | None
      "roles": list[ProjectSegmentRole] | None
      "permissions": Permissions | None
      "tasks": list[ProjectTask]
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectScenarioSegment is defined by 
  
  {
      "id": int
      "data": dict
      "assumptions": list[ProjectAssumption]
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": ModelTrainingJob | None
      "data": dict
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ModelTrainingJob is defined by 
  
  {
      "tenant_id": int
      "id": int
      "blueprint_id": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  
  Where ProjectSegmentHistory is defined by 
  
  {
      "jobs": list[ProjectSegmentJob]
      "assumptions": list[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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  
  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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where TaskProject is defined by 
  
  {
      "id": int
      "segments": list[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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectSegmentUserPreferences is defined by 
  
  {
      "percent_processed": float | int | None
      "feedback": dict | None
  }
  

• /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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "assigned_to": Author
      "name": str
      "description": str | None
      "type": str
      "status": "ACCEPTED" | "REJECTED" | "DRAFT" | "PENDING"
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "versions": list[ProjectAssumption]
      "projects": list[TaskProject]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ProjectAssumption is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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[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": ISO8601[str]
      "end_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports/<report_id:int>/charts ( mjolnir.report.add_report_chart ) [ POST ] ⭢ list[Rating]

  
  

  add_report_chart
  
  With ReportChartCreate defined as 
  
  {
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/report_charts/<report_chart_id:int>/comments ( mjolnir.report.add_report_chart_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_report_chart_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/report_charts/<report_chart_id:int>/ratings ( mjolnir.report.add_report_chart_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_report_chart_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports/<report_id:int>/comments ( mjolnir.report.add_report_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_report_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/reports/<report_id:int>/ratings ( mjolnir.report.add_report_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_report_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports ( mjolnir.report.create_report ) [ POST ] ⭢ Report

  
  

  create_report
  
  With ReportCreate defined as 
  
  {
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: Report
  
  With Report defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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[Comment]

  
  

  get_report_chart_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/report_charts/<report_chart_id:int>/ratings ( mjolnir.report.get_report_chart_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_report_chart_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/report_charts ( mjolnir.report.get_report_charts ) [ GET ] ⭢ list[Rating]

  
  

  get_report_charts
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports/<report_id:int>/charts ( mjolnir.report.get_report_charts ) [ GET ] ⭢ list[Rating]

  
  

  get_report_charts
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports/<report_id:int>/comments ( mjolnir.report.get_report_comments ) [ GET ] ⭢ list[Comment]

  
  

  get_report_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/reports/<report_id:int>/ratings ( mjolnir.report.get_report_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_report_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/reports ( mjolnir.report.get_reports ) [ GET ] ⭢ list[Report]

  
  

  get_reports
  
  Return-only definitions: list[Report]
  
  With Report defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": int | None
      "name": str | None
      "description": str | None
      "metadata": dict | None
  }
  
  Return-only definitions: Report
  
  With Report defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": str | None
      "data": dict | None
      "options": dict | None
  }
  
  Return-only definitions: Report
  
  With Report defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "folder_id": int
      "name": str
      "description": str | None
      "metadata": dict[str, Any] | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "charts": list[ReportChart]
      "permissions": Permissions
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where ReportChart is defined by 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "comment_count": int
      "report_id": int
      "training_data_id": int
      "name": str
      "description": str | None
      "data": dict | None
      "options": dict | None
      "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": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/runs ( mjolnir.run.list_all ) [ GET ] ⭢ tuple[TrainedModel, …]

  
  

  list_all
  
  Return-only definitions: tuple[TrainedModel, …]
  
  With TrainedModel defined as 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /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": int | None
      "account_id": int
      "name": str
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "start_date": ISO8601[str] | None
      "end_date": ISO8601[str] | None
      "stack_id": str | None
      "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, "ENUM" | "RANGE" | "BOTH"]
      "tags": "HUMAN_UNDERSTANDABLE" | "AUDITABLE" | "REALTIME_RESULTS"
      "outcome_behavior": "MAXIMIZE" | "MINIMIZE"
      "outcome_key": str
      "outcome_value": OutcomeValue
      "score_function": ScoreFunction
      "mappings": list[KeyMapping]
      "training_data_ids": frozenset[int]
      "column_labels": list[str]
      "drop_rows": list[DropRowByRange | DropRowByValue]
      "drop_columns": list[int]
      "attributes": dict[str, Any]
      "annotations": list[Annotation]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "expected_models": tuple[str, …]
      "models": tuple[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[float | int]
  }
  
  Where ScoreFunction is defined by 
  
  {
      "type": "OUTCOME_KEY" | "COLUMN" | "PROGRAM"
      "key": str | None
      "body": bytes | None
  }
  
  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[int | float]]
      "labels": list[str | int | float] | None
      "conditions": list[str] | None
  }
  
  Where DropRowByValue is defined by 
  
  {
      "type": "BY_VALUE" | "BY_RANGE" | "BY_CONDITIONAL"
      "index": int
      "operation": "INCLUDE" | "EXCLUDE"
      "ranges": list[list[int | float]] | None
      "labels": list[str | None] | list[int | float | None]
      "conditions": list[str] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where TrainedModel is defined by 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/runs/by/<tag_name:string> ( mjolnir.run.list_by_tag ) [ GET ] ⭢ tuple[TrainedModel, …]

  
  

  list_by_tag
  
  Return-only definitions: tuple[TrainedModel, …]
  
  With TrainedModel defined as 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/job/<job_id:int>/<model_name:string> ( mjolnir.run.update ) [ POST ] ⭢ TrainedModel

  
  

  update
  
  With NewRunData defined as 
  
  {
      "confusion_matrices": list[list[int]] | None
      "metrics": dict | None
      "feature_importance": dict | None
      "metadata": dict | None
      "plots": Plots | None
  }
  
  Return-only definitions: TrainedModel
  
  With TrainedModel defined as 
  
  {
      "tenant_id": int
      "id": int
      "job_id": int
      "model_name": str
      "model_display_name": str | None
      "model_metadata": dict
      "matrices": tuple[tuple[int, int, int, int], …]
      "metadata": dict
      "feature_importance": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "plots": list[dict[str, Any]]
      "impact_metrics": ImpactMetrics
  }
  
  Where ImpactMetrics is defined by 
  
  {
      "sum_over_predict": int | float | None
      "sum_under_predict": int | float | None
      "count_over_predict": int | None
      "count_under_predict": int | None
      "mean_absolute_error": int | float | None
  }
  

• /v1/schema_monitors ( mjolnir.schema_monitor.create ) [ POST ] ⭢ SchemaMonitor

  
  

  create
  Create a schema monitor binding
  With NewSchemaMonitor defined as 
  
  {
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SnapshotBase | None
      "url": URL | None
      "annotations": list[Annotation] | None
  }
  
  Where SnapshotBase is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Return-only definitions: SchemaMonitor
  
  With SchemaMonitor defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /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": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SnapshotBase | None
      "url": URL | None
      "annotations": list[Annotation] | None
  }
  
  Where SnapshotBase is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Return-only definitions: SchemaMonitor
  
  With SchemaMonitor defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /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": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /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": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /v1/schema_monitors ( mjolnir.schema_monitor.list_all ) [ GET ] ⭢ tuple[SchemaMonitor, …]

  
  

  list_all
  
  Return-only definitions: tuple[SchemaMonitor, …]
  
  With SchemaMonitor defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /v1/account/<account_id:int>/schema_monitors ( mjolnir.schema_monitor.list_all ) [ GET ] ⭢ tuple[SchemaMonitor, …]

  
  

  list_all
  
  Return-only definitions: tuple[SchemaMonitor, …]
  
  With SchemaMonitor defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /v1/schema_monitor/<id:int>/presigned_url ( mjolnir.schema_monitor.presigned_url_for_schema_monitoring ) [ POST ] ⭢ dict[str, 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, 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": int | None
      "name": str | None
      "schema": SnapshotBase | None
      "url": URL | None
      "annotations": list[Annotation] | None
      "status": "update_credentials" | "UPDATE_CREDENTIALS" | "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE" | None
  }
  
  Where SnapshotBase is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Return-only definitions: SchemaMonitor
  
  With SchemaMonitor defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue | Default
      "account_id": int
      "folder_id": int | None
      "name": str
      "type": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL"
      "schema": SchemaMonitorSnapshot | EmptySchema
      "snapshots": tuple[SchemaMonitorSnapshot, …]
      "version": int
      "url": URL
      "status": "MISSING_CREDENTIALS_URL" | "WAITING_FOR_SCHEMA" | "MONITORING_SCHEMA" | "AUTHENTICATION_FAILURE"
      "annotations": list[Annotation]
      "permissions": Permissions
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where SchemaMonitorSnapshot is defined by 
  
  {
      "tables": tuple[TableSchemas, …]
      "deltas": tuple[TableDelta, …]
      "created_date": ISO8601[str] | Default
  }
  
  Where TableSchemas is defined by 
  
  {
      "name": str
      "columns": tuple[ColumnMetadata, …]
      "deltas": tuple[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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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": str
  }
  

• /v1/response/<action:str> ( mjolnir.slack.on_response ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  on_response
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tags ( mjolnir.tag.create ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  create
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tags ( mjolnir.tag.delete ) [ DELETE ] ⭢ Tag

  
  

  delete
  
  Return-only definitions: Tag
  
  With Tag defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tag/<tag_name:str> ( mjolnir.tag.delete ) [ DELETE ] ⭢ Tag

  
  

  delete
  
  Return-only definitions: Tag
  
  With Tag defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tag/<tag_name:str> ( mjolnir.tag.get ) [ GET ] ⭢ Tag

  
  

  get
  
  Return-only definitions: Tag
  
  With Tag defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tags ( mjolnir.tag.list_all ) [ GET ] ⭢ tuple[Tag, …]

  
  

  list_all
  
  Return-only definitions: tuple[Tag, …]
  
  With Tag defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tags/by/<entity_type:str>/<entity_id:int> ( mjolnir.tag.list_tags_by_entity ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  list_tags_by_entity
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tags/by/<entity_type:str> ( mjolnir.tag.list_tags_by_entity ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  list_tags_by_entity
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tags ( mjolnir.tag.update ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tag/<tag_name:str> ( mjolnir.tag.update ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tagged ( mjolnir.tagged.create ) [ POST ] ⭢ Tagged

  
  

  create
  
  Return-only definitions: Tagged
  
  With Tagged defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tagged/<tag_name:string> ( mjolnir.tagged.create ) [ POST ] ⭢ Tagged

  
  

  create
  
  Return-only definitions: Tagged
  
  With Tagged defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tagged/<tag_name:string> ( mjolnir.tagged.delete ) [ DELETE ] ⭢ Tag

  
  

  delete
  
  Return-only definitions: Tag
  
  With Tag defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tagged ( mjolnir.tagged.list_all ) [ GET ] ⭢ tuple[Tagged, …]

  
  

  list_all
  
  Return-only definitions: tuple[Tagged, …]
  
  With Tagged defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tagged/<tag_name:string> ( mjolnir.tagged.list_by_tag_name ) [ GET ] ⭢ tuple[Tagged, …]

  
  

  list_by_tag_name
  
  Return-only definitions: tuple[Tagged, …]
  
  With Tagged defined as 
  
  {
      "tenant_id": int
      "name": str
      "value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "type": "ACCOUNT" | "JOB" | "SCORE" | "TRAINING" | "GUIDED_BLUEPRINT" | "DEPLOYMENT" | "MODEL_RUN"
      "entity_id": int
      "priority": int
      "entity_value": dict[str, str | int | float | list[Any] | dict[str, Any]] | list[str | int | float | list[Any] | dict[str, Any]] | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tagged ( mjolnir.tagged.update ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tagged/<tag_name:string> ( mjolnir.tagged.update ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tagged/<tag_name:string>/<tag_type:string>/<tagged_id:int> ( mjolnir.tagged.update ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/tenant/<tenant_id:int>/users ( mjolnir.tenant.change_tenant_users ) [ PATCH ] ⭢ PublicPendingUser | PublicUser | tuple[PublicPendingUser | 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": str
  }
  
  Return-only definitions: PublicPendingUser | PublicUser | tuple[PublicPendingUser | PublicUser, …]
  
  With PublicPendingUser defined as 
  
  {
      "email": str
      "invites": tuple[PendingUserInvite.PendingUserInviteWithoutActionsAndToken, …]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where PendingUserInvite.PendingUserInviteWithoutActionsAndToken is defined by 
  
  {
      "tenant_id": int
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where PublicUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
      "email": str
      "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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "invites": tuple[PublicTenantInvite, …]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where PublicTenantInvite is defined by 
  
  {
      "tenant_id": int
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
      "shortname": str
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "foreign_info": ForeignInfo
      "invite": Invite | None
      "tokens": tuple[AccessToken, …]
      "num_licenses": int
      "user_limit": int | float
      "limits": TenantLimits
      "license_types": frozenset["SAMPLE" | "EVALUATION" | "USER" | "UNLICENSED" | "STUDENT" | "USE_AIBLE_RESOURCES"] | None
      "share_behavior": "PUBLIC" | "PRIVATE"
      "linked_domains": tuple[str, …]
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where ForeignInfo is defined by 
  
  {
      "provider": "AZURE" | "AWS_MARKETPLACE" | None
      "id": str | None
  }
  
  Where Invite is defined by 
  
  {
      "user_id": int
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AccessToken is defined by 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "type": "API" | "USER" | "BOTH"
      "token": UUID
      "status": "ACTIVE" | "DELETED" | "INACTIVE"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TenantLimits is defined by 
  
  {
      "training_upload_limit": int | None
      "model_training_limit": int | None
      "score_limit": int | None
      "deployment_limit": int | None
      "account_limit": int | None
      "allow_aible_resource_usage": bool
      "training_upload_size_bytes_limit": int | None
  }
  

• /v1/foreign-authentications ( mjolnir.tenant.create_foreign_authentication ) [ POST ] ⭢ SAMLForeignTenantAuthentication | OAuth2ForeignTenantAuthentication

  
  

  create_foreign_authentication
  
      A foreign authentication allows an external IDP to verify that a given user email
      address is trusted for access to only that tenant
  
      Users that are created by an SSO-response are marked as "OAUTH_ONLY" -- this
      means that user can only be accessed via an IDP-verified SSO login.
  
      Aible supports SAML IDP-initiated and SP-initiated logins. To create a SAML IDP
      SSO association, set "type": "GENERIC_SAML" in request
      body. For all SAML SSO associations, the URL to start an SP-initiated login into Aible
      is the entity_id of a ForeignTenantAuthentication
      response.
  
  With CreateNewForeignTenantAuthentication defined as 
  
  {
      "name": str
      "type": "GENERIC_SAML" | "GENERIC_OAUTH2"
      "config": SAMLConfig | OAuth2Config | dict
      "key": str | None
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED" | None
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  
  Return-only definitions: SAMLForeignTenantAuthentication | OAuth2ForeignTenantAuthentication
  
  With SAMLForeignTenantAuthentication defined as 
  
  {
      "type": "GENERIC_SAML"
      "config": SAMLConfig
      "entity_id": URL
      "assertion_consumer_service_url": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where OAuth2ForeignTenantAuthentication is defined by 
  
  {
      "type": "GENERIC_OAUTH2"
      "config": OAuth2Config
      "entity_id": URL
      "redirect_uri": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  

• /v1/invites ( mjolnir.tenant.create_invite ) [ POST ] ⭢ NewPublicInvite | tuple[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[NewPublicInvite, …]
  
  With NewPublicInvite defined as 
  
  {
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user": User.UserWithoutCustom_app_domainAndCreated_byAndCreated_dateAndStatusAndPassword_changed_dateAndPassword_hashAndAliasesAndUpdated_dateAndIdAndTagsAndTerms_and_conditions_acceptance
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where User.UserWithoutCustom_app_domainAndCreated_byAndCreated_dateAndStatusAndPassword_changed_dateAndPassword_hashAndAliasesAndUpdated_dateAndIdAndTagsAndTerms_and_conditions_acceptance is defined by 
  
  {
      "fullname": str
      "email": str
  }
  

• /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": ISO8601[str]
      "on_behalf_of": Author
      "issued_at": ISO8601[str]
      "expires_on_epoch": int | float
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/user_aliases ( mjolnir.tenant.create_user_aliases ) [ POST ] ⭢ tuple[UserAlias, …]

  
  

  create_user_aliases
  
  With CreateUserAlias defined as 
  
  {
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
  }
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/foreign-authentication/<key_or_id:str> ( mjolnir.tenant.delete_foreign_authentication ) [ DELETE ] ⭢ OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication

  
  

  delete_foreign_authentication
  
  Return-only definitions: OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication
  
  With OAuth2ForeignTenantAuthentication defined as 
  
  {
      "type": "GENERIC_OAUTH2"
      "config": OAuth2Config
      "entity_id": URL
      "redirect_uri": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where SAMLForeignTenantAuthentication is defined by 
  
  {
      "type": "GENERIC_SAML"
      "config": SAMLConfig
      "entity_id": URL
      "assertion_consumer_service_url": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  

• /v1/user_aliases ( mjolnir.tenant.delete_multi_alias ) [ DELETE ] ⭢ tuple[UserAlias, …]

  
  

  delete_multi_alias
  
  With DeleteUserAlias defined as 
  
  {
      "id": int
  }
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/user_alias/<alias_id:int> ( mjolnir.tenant.delete_user_alias ) [ DELETE ] ⭢ tuple[UserAlias, …]

  
  

  delete_user_alias
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tenant/<tenant_id:int> ( mjolnir.tenant.get ) [ GET ] ⭢ Tenant

  
  

  get
  
  Return-only definitions: Tenant
  
  With Tenant defined as 
  
  {
      "id": int
      "fullname": str
      "shortname": str
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "foreign_info": ForeignInfo
      "invite": Invite | None
      "tokens": tuple[AccessToken, …]
      "num_licenses": int
      "user_limit": int | float
      "limits": TenantLimits
      "license_types": frozenset["SAMPLE" | "EVALUATION" | "USER" | "UNLICENSED" | "STUDENT" | "USE_AIBLE_RESOURCES"] | None
      "share_behavior": "PUBLIC" | "PRIVATE"
      "linked_domains": tuple[str, …]
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where ForeignInfo is defined by 
  
  {
      "provider": "AZURE" | "AWS_MARKETPLACE" | None
      "id": str | None
  }
  
  Where Invite is defined by 
  
  {
      "user_id": int
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AccessToken is defined by 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "type": "API" | "USER" | "BOTH"
      "token": UUID
      "status": "ACTIVE" | "DELETED" | "INACTIVE"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TenantLimits is defined by 
  
  {
      "training_upload_limit": int | None
      "model_training_limit": int | None
      "score_limit": int | None
      "deployment_limit": int | None
      "account_limit": int | None
      "allow_aible_resource_usage": bool
      "training_upload_size_bytes_limit": int | None
  }
  

• /v1/foreign-authentication/<key_or_id:str> ( mjolnir.tenant.get_foreign_authentication ) [ GET ] ⭢ OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication

  
  

  get_foreign_authentication
  
  Return-only definitions: OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication
  
  With OAuth2ForeignTenantAuthentication defined as 
  
  {
      "type": "GENERIC_OAUTH2"
      "config": OAuth2Config
      "entity_id": URL
      "redirect_uri": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where SAMLForeignTenantAuthentication is defined by 
  
  {
      "type": "GENERIC_SAML"
      "config": SAMLConfig
      "entity_id": URL
      "assertion_consumer_service_url": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  

• /v1/user_alias/<alias_id:int> ( mjolnir.tenant.get_user_alias ) [ GET ] ⭢ tuple[UserAlias, …]

  
  

  get_user_alias
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tenants ( mjolnir.tenant.list_all ) [ GET ] ⭢ tuple[Tenant, …]

  
  

  list_all
  
  Return-only definitions: tuple[Tenant, …]
  
  With Tenant defined as 
  
  {
      "id": int
      "fullname": str
      "shortname": str
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "foreign_info": ForeignInfo
      "invite": Invite | None
      "tokens": tuple[AccessToken, …]
      "num_licenses": int
      "user_limit": int | float
      "limits": TenantLimits
      "license_types": frozenset["SAMPLE" | "EVALUATION" | "USER" | "UNLICENSED" | "STUDENT" | "USE_AIBLE_RESOURCES"] | None
      "share_behavior": "PUBLIC" | "PRIVATE"
      "linked_domains": tuple[str, …]
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where ForeignInfo is defined by 
  
  {
      "provider": "AZURE" | "AWS_MARKETPLACE" | None
      "id": str | None
  }
  
  Where Invite is defined by 
  
  {
      "user_id": int
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AccessToken is defined by 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "type": "API" | "USER" | "BOTH"
      "token": UUID
      "status": "ACTIVE" | "DELETED" | "INACTIVE"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TenantLimits is defined by 
  
  {
      "training_upload_limit": int | None
      "model_training_limit": int | None
      "score_limit": int | None
      "deployment_limit": int | None
      "account_limit": int | None
      "allow_aible_resource_usage": bool
      "training_upload_size_bytes_limit": int | None
  }
  

• /v1/user_aliases/by/<external_id:path> ( mjolnir.tenant.list_by_external_id ) [ GET ] ⭢ tuple[UserAlias, …]

  
  

  list_by_external_id
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/foreign-authentications ( mjolnir.tenant.list_foreign_authentications ) [ GET ] ⭢ tuple[OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication, …]

  
  

  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[OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication, …]
  
  With OAuth2ForeignTenantAuthentication defined as 
  
  {
      "type": "GENERIC_OAUTH2"
      "config": OAuth2Config
      "entity_id": URL
      "redirect_uri": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where SAMLForeignTenantAuthentication is defined by 
  
  {
      "type": "GENERIC_SAML"
      "config": SAMLConfig
      "entity_id": URL
      "assertion_consumer_service_url": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  

• /v1/user_aliases/in/<namespace:path> ( mjolnir.tenant.list_in_namespace ) [ GET ] ⭢ tuple[UserAlias, …]

  
  

  list_in_namespace
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/user_aliases ( mjolnir.tenant.list_tenant_user_aliases ) [ GET ] ⭢ tuple[UserAlias, …]

  
  

  list_tenant_user_aliases
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/renew/tenant ( mjolnir.tenant.renew_token ) [ POST ] ⭢ TenantSession

  
  

  renew_token
  
  Return-only definitions: TenantSession
  
  With TenantSession defined as 
  
  {
      "id": int
      "fullname": str
      "invite": TenantSessionInvite
  }
  
  Where TenantSessionInvite is defined by 
  
  {
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "token": `BearerToken`
      "expires_at": float
      "expires_ttl": float
  }
  

• /v1/tenant/<tenant_id:int>/users ( mjolnir.tenant.show_tenant_users ) [ GET ] ⭢ PublicPendingUser | PublicUser | tuple[PublicPendingUser | PublicUser, …]

  
  

  show_tenant_users
  
  Return-only definitions: PublicPendingUser | PublicUser | tuple[PublicPendingUser | PublicUser, …]
  
  With PublicPendingUser defined as 
  
  {
      "email": str
      "invites": tuple[PendingUserInvite.PendingUserInviteWithoutActionsAndToken, …]
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where PendingUserInvite.PendingUserInviteWithoutActionsAndToken is defined by 
  
  {
      "tenant_id": int
      "created_by": IUser
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where IUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where PublicUser is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
      "email": str
      "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": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "invites": tuple[PublicTenantInvite, …]
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where PublicTenantInvite is defined by 
  
  {
      "tenant_id": int
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
      "shortname": str
      "status": "NOT_ACTIVATED" | "ACTIVE" | "INACTIVE" | "DELETED"
      "foreign_info": ForeignInfo
      "invite": Invite | None
      "tokens": tuple[AccessToken, …]
      "num_licenses": int
      "user_limit": int | float
      "limits": TenantLimits
      "license_types": frozenset["SAMPLE" | "EVALUATION" | "USER" | "UNLICENSED" | "STUDENT" | "USE_AIBLE_RESOURCES"] | None
      "share_behavior": "PUBLIC" | "PRIVATE"
      "linked_domains": tuple[str, …]
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where ForeignInfo is defined by 
  
  {
      "provider": "AZURE" | "AWS_MARKETPLACE" | None
      "id": str | None
  }
  
  Where Invite is defined by 
  
  {
      "user_id": int
      "tenant_id": int
      "token": UUID
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where AccessToken is defined by 
  
  {
      "tenant_id": int
      "id": int
      "name": str
      "type": "API" | "USER" | "BOTH"
      "token": UUID
      "status": "ACTIVE" | "DELETED" | "INACTIVE"
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TenantLimits is defined by 
  
  {
      "training_upload_limit": int | None
      "model_training_limit": int | None
      "score_limit": int | None
      "deployment_limit": int | None
      "account_limit": int | None
      "allow_aible_resource_usage": bool
      "training_upload_size_bytes_limit": int | None
  }
  

• /v1/tenants/sync ( mjolnir.tenant.update_all_remote_stacks ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update_all_remote_stacks
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/foreign-authentication/<key_or_id:str> ( mjolnir.tenant.update_foreign_authentication ) [ PATCH ] ⭢ OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication

  
  

  update_foreign_authentication
  
  With UpdateForeignAuthentication defined as 
  
  {
      "status": str | None
      "name": str | None
      "type": str | None
      "config": dict[str, str | None] | None
  }
  
  Return-only definitions: OAuth2ForeignTenantAuthentication | SAMLForeignTenantAuthentication
  
  With OAuth2ForeignTenantAuthentication defined as 
  
  {
      "type": "GENERIC_OAUTH2"
      "config": OAuth2Config
      "entity_id": URL
      "redirect_uri": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where OAuth2Config is defined by 
  
  {
      "landing_page": URL | None
      "app_id": str
      "app_secret": bytes
      "authorize_url": URL
      "token_url": URL
      "user_info_url": URL
  }
  
  Where URL is defined by URL["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where SAMLForeignTenantAuthentication is defined by 
  
  {
      "type": "GENERIC_SAML"
      "config": SAMLConfig
      "entity_id": URL
      "assertion_consumer_service_url": URL
      "tenant_id": int
      "id": int | NextValue | Default
      "status": "ACTIVE" | "INACTIVE"
      "name": str
      "key": UUID
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where SAMLConfig is defined by 
  
  {
      "landing_page": URL | None
      "issuer_url": URL
      "login_url": URL
      "logout_url": URL
      "certificate_thumbprint": str
      "certificate_thumbprint_type": "NONE" | "SHA1" | "SHA256" | "MD5" | "SHA512"
  }
  

• /v1/user_alias/<alias_id:int> ( mjolnir.tenant.update_user_alias ) [ PATCH ] ⭢ tuple[UserAlias, …]

  
  

  update_user_alias
  
  With UpdateUserAlias defined as 
  
  {
      "namespace": str | None
      "external_id": str | None
      "email": str | None
      "fullname": str | None
  }
  
  Return-only definitions: tuple[UserAlias, …]
  
  With UserAlias defined as 
  
  {
      "tenant_id": int
      "id": int | NextValue
      "namespace": str
      "external_id": str
      "email": str
      "fullname": str
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "user_match": Author | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/tenant/<tenant_id:int>/usage-report ( mjolnir.tenant.usage_report ) [ POST ] ⭢ Annotated[`JSON`, Inferred]

  
  

  usage_report
  
      Generate an usage report of all the agent interactions by each day.
  
      The following payloads are equivalent:
          * {}
          * {"start": "-3 months", "end": "now"}
          * {"start": "2025-07-01", "end": "2025-10-25"}
  
      start/end may be also:
          - a float / int representing a UTC epoch in seconds
          - "NOW" / "now" / null all correspond to the current utc timestamp
  
      Additional URL query variables:
          * `show-nulls` (boolean) - if any days are empty, show them regardless
  
      N.B. Submitted times are expected to be in UTC unless submitted with an
      explicit timezone (which will be converted to UTC).
  
  With UsageReport defined as 
  
  {
      "start": ISO8601[str]
      "end": ISO8601[str]
      "by_folders": tuple[int, …]
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /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": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[int | float, …] | tuple[str, …]
  }
  
  Return-only definitions: RulefitMappings
  
  

• /v1/data/<training_data_id:int>/debug ( mjolnir.training.debug_url ) [ GET ] ⭢ Annotated[`JSON`, Inferred]

  
  

  debug_url
  
  Return-only definitions: Annotated[`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[Training, …]

  
  

  list_by_tag
  
  List the available Training Datas to work on
  
  Return-only definitions: tuple[Training, …]
  
  With Training defined as 
  
  {
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "tenant_id": int
      "folder_id": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[`JSON`, Inferred]

  
  

  update
  
  With TrainingUpdate defined as 
  
  {
      "rulefit_definitions": dict[tuple[int, …] | tuple[float, …] | tuple[int | float, …] | tuple[str, …], list[RuleFitDefinition] | PendingRuleFitUpdate] | None
      "headers": list[str] | None
      "number_of_rows": int | None
      "action": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR" | None
      "features": list[Feature] | None
      "metadata": TrainingMetadata | None
      "transformations": TrainingTransformations | None
      "options": TrainingOptions | None
      "annotations": list[Annotation] | None
      "target": str | None
      "target_value": OutcomeValue | None
      "new_target": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE" | None
      "cascade": bool | None
      "file_size": int | None
      "name": str | None
      "reindex": bool | None
  }
  
  Where RuleFitDefinition is defined by 
  
  {
      "rule": str
      "coefficient": float | int
      "support": float | int
      "count": int | None
      "extra": dict | None
  }
  
  Where PendingRuleFitUpdate is defined by 
  
  {
      "action": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "annotations": list[Annotation] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Where Feature is defined by 
  
  {
      "name": str
      "type": "ENUM" | "RANGE" | "BOTH"
      "value": list[tuple[str, int | str]] | list[tuple[int, int | str]] | list[tuple[float, int | str]] | list[tuple[bool, int | str]] | list[int | float | str] | list[tuple[str | int | float | bool, int | str]]
      "metadata": dict | None
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/data/<training_data_id:int>/descriptions ( mjolnir.training.update_descriptions ) [ PATCH ] ⭢ Annotated[`JSON`, Inferred]

  
  

  update_descriptions
  
  With TrainingDescriptionsUpdate defined as 
  
  {
      "columns": list[TrainingColumnDescription]
  }
  
  Where TrainingColumnDescription is defined by 
  
  {
      "label": str
      "description": str
  }
  
  Return-only definitions: Annotated[`JSON`, Inferred]
  
  

• /v1/data/<training_data_id:int>/rulefit ( mjolnir.training.update_rulefit ) [ PATCH ] ⭢ RulefitMappings

  
  

  update_rulefit
  
  With RuleFitUpdate defined as 
  
  {
      "rulefit_definitions": dict[tuple[int, …] | tuple[float, …] | tuple[int | float, …] | tuple[str, …], list[RuleFitDefinition] | PendingRuleFitUpdate] | None
  }
  
  Where RuleFitDefinition is defined by 
  
  {
      "rule": str
      "coefficient": float | int
      "support": float | int
      "count": int | None
      "extra": dict | None
  }
  
  Where PendingRuleFitUpdate is defined by 
  
  {
      "action": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "annotations": list[Annotation] | None
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  Return-only definitions: RulefitMappings
  
  

• /v1/data/<training_data_id:int>/comments ( mjolnir.training_data.add_training_data_comment ) [ POST ] ⭢ list[Comment]

  
  

  add_training_data_comment
  
  With CommentUpdate defined as 
  
  {
      "message": str
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/data/<training_data_id:int>/ratings ( mjolnir.training_data.add_training_data_rating ) [ POST ] ⭢ list[Rating]

  
  

  add_training_data_rating
  
  With RatingUpdate defined as 
  
  {
      "feedback": "LIKE" | "DISLIKE" | "NONE"
  }
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/data/<training_data_id:int>/details ( mjolnir.training_data.create_upload_detail ) [ POST ] ⭢ TrainingDataDetailsUpload

  
  

  create_upload_detail
  
  With TrainingDataDetailCreate defined as 
  
  {
      "target": str | None
  }
  
  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": str | None
      "expires_in": int | None
  }
  
  Return-only definitions: TrainingDataUpload
  
  With TrainingDataUpload defined as 
  
  {
      "id": str
      "name": str
      "description": str | None
      "tenant": NamedEntity
      "account": NamedEntity
      "folder": NamedEntity
      "created_date": ISO8601[str]
      "expiration_date": ISO8601[str]
      "created_by": Author
      "presigned_url": dict | None
  }
  
  Where NamedEntity is defined by 
  
  {
      "id": int
      "name": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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": str | None
      "tenant": NamedEntity
      "account": NamedEntity
      "folder": NamedEntity
      "created_date": ISO8601[str]
      "expiration_date": ISO8601[str]
      "created_by": Author
      "presigned_url": dict | None
  }
  
  Where NamedEntity is defined by 
  
  {
      "id": int
      "name": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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[Comment]

  
  

  get_training_data_comments
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "message": str
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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": str
  }
  

• /v1/data/<training_data_id:int>/ratings ( mjolnir.training_data.get_training_data_ratings ) [ GET ] ⭢ list[Rating]

  
  

  get_training_data_ratings
  
  Return-only definitions: list[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" | "CONTENT_GENERATION_COLLECTION" | "CONTENT_GENERATION_EXECUTION" | "CONTENT_GENERATION_RESULT"
      "score": "LIKE" | "DISLIKE" | "NONE"
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": str | None
      "tenant": NamedEntity
      "account": NamedEntity
      "folder": NamedEntity
      "created_date": ISO8601[str]
      "expiration_date": ISO8601[str]
      "created_by": Author
      "presigned_url": dict | None
  }
  
  Where NamedEntity is defined by 
  
  {
      "id": int
      "name": str
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/data ( mjolnir.training_data.list_all_training_data ) [ GET ] ⭢ list[Training]

  
  

  list_all_training_data
  
  Return-only definitions: list[Training]
  
  With Training defined as 
  
  {
      "comment_count": int
      "feedback": "LIKE" | "DISLIKE" | "NONE"
      "like_count": int
      "dislike_count": int
      "tenant_id": int
      "folder_id": int | None
      "schema_monitor_id": int | None
      "id": int
      "name": str | None
      "target_index": int | None
      "target_value": OutcomeValue | None
      "recipe_id": int | None
      "source": SourceURL
      "number_of_rows": int
      "file_size": int
      "status": "NOT_STARTED" | "RUNNING" | "DONE" | "ERROR"
      "categorical_counts": list[CategoricalCount]
      "annotations": list[Annotation]
      "rulefit_definitions": RulefitMappings
      "mappings": list[ColumnMapping]
      "labels": list[str]
      "descriptions": list[str]
      "metadata": TrainingMetadata
      "transformations": TrainingTransformations
      "options": TrainingOptions
      "account_id": int
      "stack_id": str | None
      "deleted": "NOT_DELETED" | "DELETED" | "ARCHIVE"
      "created_by": Author
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
      "permissions": Permissions
  }
  
  Where OutcomeValue is defined by 
  
  {
      "value": str | int | float | list[str] | list[int] | list[float] | list[float | int]
  }
  
  Where SourceURL is defined by 
  
  {
      "type": Source
      "url": URL | URI | None
      "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["scheme://domain/path#fragment?query1=value1&query2=value2"]
  
  Where URI is defined by 
  
  {
      "value": str
      "parts": tuple[str, …]
  }
  
  Where SourceContent is defined by 
  
  {
      "type": "RAW_DATA" | "CONNECTION_METADATA"
      "provider": "REDSHIFT" | "SNOWFLAKE" | "TERADATA" | "ORACLE" | "SALESFORCE" | "BOOMI" | "SIMBASPARK" | "DATABRICKS" | "S3" | "AZUREBLOBSTORE" | "BIGQUERY" | "GCS" | "POSTGRESQL" | "MSSQL" | None
      "options": dict | None
      "table": str | None
      "schema_monitor_id": int | None
      "schema": list[SourceContextSchemaItem] | None
  }
  
  Where SourceContextSchemaItem is defined by 
  
  {
      "name": str
      "type": str
  }
  
  Where CategoricalCount is defined by 
  
  {
      "index": int
      "term_counts": dict[CategoricalTerm, CategoricalCountable]
  }
  
  Where Annotation is defined by 
  
  {
      "type": "INFO" | "WARNING" | "ERROR" | "DEBUG"
      "code": str | None
      "message": str
      "scope": str
      "metadata": dict | None
      "created_date": ISO8601[str]
  }
  
  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[int | float | str | bool]
      "metadata": dict
      "created_date": ISO8601[str]
      "updated_date": ISO8601[str]
  }
  
  Where TrainingMetadata is defined by 
  
  {
      "univariate_summaries": dict[str, dict] | None
      "upload_url": str | None
  }
  
  Where TrainingTransformations is defined by 
  
  {
      "row_filters": list[Condition] | None
      "unique_id_columns": list[str] | None
      "projections": list[dict | str] | None
      "query": dict | None
      "plan": dict | None
      "exclude_columns": list[str] | None
  }
  
  Where Condition is defined by 
  
  {
      ...
  }
  
  Where TrainingOptions is defined by 
  
  {
      "target_steps": list["SUGGEST_FEATURES" | "EXPLORE_INTERACTIONS" | "SHAP_EXPLORE" | "BIGQUERY_MODEL"]
      "target_model_params": dict | None
      "timestamp_column": str | None
      "kpi_analysis": dict | None
      "report_settings": dict | None
      "refresh_interval": TrainingRefreshInterval | None
  }
  
  Where TrainingRefreshInterval is defined by 
  
  {
      "cron_expr": str
      "timezone": str | None
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  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" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  
  Where NewlyAcceptedInvite is defined by 
  
  {
      "tenant_id": int
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | 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["AWS" | "GCP" | "AZURE" | "ON_PREMISE"]
  }
  

• /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" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/invites ( mjolnir.user.list_my_invites ) [ GET ] ⭢ tuple[PublicInvite, …]

  
  

  list_my_invites
  
  List the invites for the current user.
  
  URL query arguments:
      - status (the status to filter on)
  
  Return-only definitions: tuple[PublicInvite, …]
  
  With PublicInvite defined as 
  
  {
      "tenant_id": int
      "status": "REQUESTED" | "DENIED" | "ACCEPTED" | "DELETED" | Default
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/me ( mjolnir.user.show_my_info ) [ GET ] ⭢ User.UserWithoutAliasesAndPassword_hash

  
  

  show_my_info
  
  Return-only definitions: User.UserWithoutAliasesAndPassword_hash
  
  With User.UserWithoutAliasesAndPassword_hash defined as 
  
  {
      "id": int | NextValue
      "fullname": str
      "email": str
      "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": ISO8601[str]
      "terms_and_conditions_acceptance": ISO8601[str] | "HasNotAcceptedTermsAndConditions"
      "custom_app_domain": str | None
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /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": int | float | None
      "expires_at_utc": str | None
      "user": UserToken.UserTokenWithoutPassword_hash
  }
  
  Where UserToken.UserTokenWithoutPassword_hash is defined by 
  
  {
      "id": int
      "email": str
      "fullname": str
      "password_changed_date": str
      "expires_at": float
      "exp": ISO8601[str]
  }
  
  Where TenantSessionInfo is defined by 
  
  {
      "scope": "user" | "tenant"
      "type": str
      "expires_at": int | float | None
      "expires_at_utc": str | None
      "tenant": SessionTenant
      "user": Author
  }
  
  Where SessionTenant is defined by 
  
  {
      "id": int
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }
  

• /v1/me ( mjolnir.user.update_my_info ) [ PATCH ] ⭢ User.UserWithoutAliasesAndPassword_hash

  
  

  update_my_info
  
      Hi, I am user. Let me update my record.
  
  With UpdateMyInfo defined as 
  
  {
      "fullname": str | None
      "password": UpdateMyPassword | ForcePassword | None
  }
  
  Where UpdateMyPassword is defined by 
  
  {
      "current": str
      "new": str
  }
  
  Where ForcePassword is defined by 
  
  {
      "new": str
  }
  
  Return-only definitions: User.UserWithoutAliasesAndPassword_hash
  
  With User.UserWithoutAliasesAndPassword_hash defined as 
  
  {
      "id": int | NextValue
      "fullname": str
      "email": str
      "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": ISO8601[str]
      "terms_and_conditions_acceptance": ISO8601[str] | "HasNotAcceptedTermsAndConditions"
      "custom_app_domain": str | None
      "created_by": Author
      "created_date": ISO8601[str] | Default
      "updated_date": ISO8601[str] | Default
  }
  
  Where Author is defined by 
  
  {
      "id": int | NextValue
      "fullname": str
  }