primus.dashboard.api package

Subpackages

• primus.dashboard.api.models package
  • Account
    • Account.__init__()
    • Account.description
    • Account.fields()
    • Account.from_dict()
    • Account.get_by_id()
    • Account.get_by_key()
    • Account.key
    • Account.list_by_key()
    • Account.name
    • Account.settings
    • Account.update()
  • BatchJob
    • BatchJob.__init__()
    • BatchJob.accountId
    • BatchJob.batchId
    • BatchJob.completedAt
    • BatchJob.completedRequests
    • BatchJob.create()
    • BatchJob.errorDetails
    • BatchJob.errorMessage
    • BatchJob.estimatedEndAt
    • BatchJob.failedRequests
    • BatchJob.fields()
    • BatchJob.from_dict()
    • BatchJob.get_by_id()
    • BatchJob.modelName
    • BatchJob.modelProvider
    • BatchJob.scoreId
    • BatchJob.scorecardId
    • BatchJob.scoringJobCountCache
    • BatchJob.startedAt
    • BatchJob.status
    • BatchJob.totalRequests
    • BatchJob.type
    • BatchJob.update()
  • DataSet
    • DataSet.buildContext
    • DataSet.createdAt
    • DataSet.dataSource
    • DataSet.dataSourceId
    • DataSet.errorMessage
    • DataSet.filePath
    • DataSet.id
    • DataSet.name
    • DataSet.provenance
    • DataSet.source
    • DataSet.status
    • DataSet.updatedAt
  • DataSource
    • DataSource.__init__()
    • DataSource.fields()
    • DataSource.from_dict()
    • DataSource.get()
    • DataSource.get_by_name()
    • DataSource.list()
    • DataSource.list_by_key()
    • DataSource.list_by_name()
  • Evaluation
    • Evaluation.__init__()
    • Evaluation.accountId
    • Evaluation.accuracy
    • Evaluation.confusionMatrix
    • Evaluation.cost
    • Evaluation.costDetails
    • Evaluation.create()
    • Evaluation.createdAt
    • Evaluation.createdByUserId
    • Evaluation.datasetClassDistribution
    • Evaluation.elapsedSeconds
    • Evaluation.errorDetails
    • Evaluation.errorMessage
    • Evaluation.estimatedRemainingSeconds
    • Evaluation.fields()
    • Evaluation.from_dict()
    • Evaluation.get_by_id()
    • Evaluation.inferences
    • Evaluation.isDatasetClassDistributionBalanced
    • Evaluation.isPredictedClassDistributionBalanced
    • Evaluation.metadata
    • Evaluation.metrics
    • Evaluation.parameters
    • Evaluation.predictedClassDistribution
    • Evaluation.processedItems
    • Evaluation.scoreGoal
    • Evaluation.scoreId
    • Evaluation.scoreVersionId
    • Evaluation.scorecardId
    • Evaluation.startedAt
    • Evaluation.status
    • Evaluation.taskId
    • Evaluation.totalItems
    • Evaluation.type
    • Evaluation.update()
    • Evaluation.updatedAt
  • FeedbackChangeDetail
    • FeedbackChangeDetail.GRAPHQL_BASE_FIELDS
    • FeedbackChangeDetail.__init__()
    • FeedbackChangeDetail.changeType
    • FeedbackChangeDetail.changedAt
    • FeedbackChangeDetail.changedBy
    • FeedbackChangeDetail.count_by_account_id()
    • FeedbackChangeDetail.create()
    • FeedbackChangeDetail.createdAt
    • FeedbackChangeDetail.delete_all_by_account_id()
    • FeedbackChangeDetail.editCommentValue
    • FeedbackChangeDetail.externalId
    • FeedbackChangeDetail.feedbackItem
    • FeedbackChangeDetail.feedbackItemId
    • FeedbackChangeDetail.finalAnswerValue
    • FeedbackChangeDetail.finalCommentValue
    • FeedbackChangeDetail.from_dict()
    • FeedbackChangeDetail.get()
    • FeedbackChangeDetail.id
    • FeedbackChangeDetail.initialAnswerValue
    • FeedbackChangeDetail.initialCommentValue
    • FeedbackChangeDetail.list()
    • FeedbackChangeDetail.updatedAt
  • FeedbackItem
    • FeedbackItem.GRAPHQL_BASE_FIELDS
    • FeedbackItem.GRAPHQL_ITEM_FIELDS
    • FeedbackItem.GRAPHQL_RELATIONSHIP_FIELDS
    • FeedbackItem.__init__()
    • FeedbackItem.account
    • FeedbackItem.accountId
    • FeedbackItem.cacheKey
    • FeedbackItem.count_by_account_id()
    • FeedbackItem.create()
    • FeedbackItem.createdAt
    • FeedbackItem.delete_all_by_account_id()
    • FeedbackItem.editCommentValue
    • FeedbackItem.editedAt
    • FeedbackItem.editorName
    • FeedbackItem.finalAnswerValue
    • FeedbackItem.finalCommentValue
    • FeedbackItem.from_dict()
    • FeedbackItem.generate_cache_key()
    • FeedbackItem.get()
    • FeedbackItem.get_by_composite_key()
    • FeedbackItem.id
    • FeedbackItem.initialAnswerValue
    • FeedbackItem.initialCommentValue
    • FeedbackItem.invalidate()
    • FeedbackItem.isAgreement
    • FeedbackItem.isInvalid
    • FeedbackItem.item
    • FeedbackItem.itemId
    • FeedbackItem.list()
    • FeedbackItem.load_change_details()
    • FeedbackItem.metadata
    • FeedbackItem.reinstate()
    • FeedbackItem.score
    • FeedbackItem.scoreId
    • FeedbackItem.scoreResults
    • FeedbackItem.scorecard
    • FeedbackItem.scorecardId
    • FeedbackItem.set_invalidity()
    • FeedbackItem.updatedAt
    • FeedbackItem.upsert_by_cache_key()
  • Identifier
    • Identifier.__init__()
    • Identifier.accountId
    • Identifier.batch_create_for_item()
    • Identifier.batch_find_by_values()
    • Identifier.create()
    • Identifier.createdAt
    • Identifier.delete()
    • Identifier.fields()
    • Identifier.find_by_name_and_value()
    • Identifier.find_by_value()
    • Identifier.from_dict()
    • Identifier.itemId
    • Identifier.list_by_item_id()
    • Identifier.name
    • Identifier.position
    • Identifier.update()
    • Identifier.updatedAt
    • Identifier.url
    • Identifier.value
  • Item
    • Item.__init__()
    • Item.accountId
    • Item.attachedFiles
    • Item.create()
    • Item.createdAt
    • Item.createdByType
    • Item.description
    • Item.evaluationId
    • Item.externalId
    • Item.fields()
    • Item.find_by_identifier()
    • Item.from_dict()
    • Item.get_by_id()
    • Item.identifiers
    • Item.isEvaluation
    • Item.list()
    • Item.metadata
    • Item.scoreId
    • Item.text
    • Item.to_score_input()
    • Item.update()
    • Item.updatedAt
    • Item.upsert_by_identifiers()
  • Report
    • Report.__init__()
    • Report.accountId
    • Report.create()
    • Report.createdAt
    • Report.createdByUserId
    • Report.delete()
    • Report.delete_by_id()
    • Report.delete_multiple()
    • Report.fields()
    • Report.from_dict()
    • Report.get_by_name()
    • Report.list_by_account_id()
    • Report.name
    • Report.output
    • Report.parameters
    • Report.reportConfigurationId
    • Report.taskId
    • Report.update()
    • Report.updatedAt
  • ReportBlock
    • ReportBlock.__init__()
    • ReportBlock.attachedFiles
    • ReportBlock.create()
    • ReportBlock.createdAt
    • ReportBlock.dataSetId
    • ReportBlock.fields()
    • ReportBlock.from_dict()
    • ReportBlock.get_by_id()
    • ReportBlock.list_by_report_id()
    • ReportBlock.log
    • ReportBlock.name
    • ReportBlock.output
    • ReportBlock.position
    • ReportBlock.reportId
    • ReportBlock.type
    • ReportBlock.update()
    • ReportBlock.updatedAt
  • ReportConfiguration
    • ReportConfiguration.__init__()
    • ReportConfiguration.accountId
    • ReportConfiguration.configuration
    • ReportConfiguration.create()
    • ReportConfiguration.createdAt
    • ReportConfiguration.description
    • ReportConfiguration.fields()
    • ReportConfiguration.from_dict()
    • ReportConfiguration.get_by_name()
    • ReportConfiguration.list_by_account_and_name()
    • ReportConfiguration.list_by_account_id()
    • ReportConfiguration.name
    • ReportConfiguration.update()
    • ReportConfiguration.updatedAt
  • Score
    • Score.__init__()
    • Score.accuracy
    • Score.aiModel
    • Score.aiProvider
    • Score.create_version_from_code()
    • Score.create_version_from_yaml()
    • Score.externalId
    • Score.fields()
    • Score.from_dict()
    • Score.get_by_external_id()
    • Score.get_by_id()
    • Score.get_by_key()
    • Score.get_by_name()
    • Score.get_by_scorecard_and_external_id()
    • Score.get_champion_code_yaml()
    • Score.get_champion_configuration_yaml()
    • Score.get_code()
    • Score.get_local_code_path()
    • Score.get_local_configuration_path()
    • Score.get_local_guidelines_path()
    • Score.get_valid_classes()
    • Score.get_valid_classes_count()
    • Score.key
    • Score.list_by_section_id()
    • Score.name
    • Score.order
    • Score.pull_code_and_guidelines()
    • Score.pull_configuration()
    • Score.push_code_and_guidelines()
    • Score.push_configuration()
    • Score.sectionId
    • Score.type
    • Score.version
  • ScoreResult
    • ScoreResult.__init__()
    • ScoreResult.accountId
    • ScoreResult.attachments
    • ScoreResult.batch_create()
    • ScoreResult.code
    • ScoreResult.confidence
    • ScoreResult.correct
    • ScoreResult.cost
    • ScoreResult.create()
    • ScoreResult.createdAt
    • ScoreResult.end_time_seconds
    • ScoreResult.evaluationId
    • ScoreResult.explanation
    • ScoreResult.feedbackItemId
    • ScoreResult.fields()
    • ScoreResult.find_by_cache_key()
    • ScoreResult.from_dict()
    • ScoreResult.get_by_id()
    • ScoreResult.itemId
    • ScoreResult.metadata
    • ScoreResult.numeric_value
    • ScoreResult.score
    • ScoreResult.scoreId
    • ScoreResult.scoreName
    • ScoreResult.scoreVersionId
    • ScoreResult.scorecardId
    • ScoreResult.scoringJobId
    • ScoreResult.start_time_seconds
    • ScoreResult.status
    • ScoreResult.trace
    • ScoreResult.type
    • ScoreResult.update()
    • ScoreResult.updatedAt
    • ScoreResult.value
  • Scorecard
    • Scorecard.__init__()
    • Scorecard.accountId
    • Scorecard.create()
    • Scorecard.description
    • Scorecard.externalId
    • Scorecard.fields()
    • Scorecard.from_dict()
    • Scorecard.get_by_account_and_external_id()
    • Scorecard.get_by_external_id()
    • Scorecard.get_by_id()
    • Scorecard.get_by_key()
    • Scorecard.get_by_name()
    • Scorecard.key
    • Scorecard.list_by_external_id()
    • Scorecard.list_by_key()
    • Scorecard.list_by_name()
    • Scorecard.name
  • ScoringJob
    • ScoringJob.__init__()
    • ScoringJob.accountId
    • ScoringJob.batchId
    • ScoringJob.completedAt
    • ScoringJob.create()
    • ScoringJob.createdAt
    • ScoringJob.errorDetails
    • ScoringJob.errorMessage
    • ScoringJob.evaluationId
    • ScoringJob.fields()
    • ScoringJob.find_by_item_id()
    • ScoringJob.find_existing_job()
    • ScoringJob.from_dict()
    • ScoringJob.get_batch_job()
    • ScoringJob.get_by_id()
    • ScoringJob.itemId
    • ScoringJob.metadata
    • ScoringJob.scoreId
    • ScoringJob.scorecardId
    • ScoringJob.startedAt
    • ScoringJob.status
    • ScoringJob.update()
    • ScoringJob.updatedAt
  • Task
    • Task.__init__()
    • Task.accountId
    • Task.acquire_lock()
    • Task.advance_stage()
    • Task.attachedFiles
    • Task.cancellationRequestedAt
    • Task.command
    • Task.commandPayload
    • Task.commandResult
    • Task.complete_processing()
    • Task.completedAt
    • Task.create()
    • Task.create_stage()
    • Task.create_stages_batch()
    • Task.create_with_stages()
    • Task.createdAt
    • Task.currentStageId
    • Task.description
    • Task.digestAlgorithm
    • Task.digestCanonicalizationVersion
    • Task.dispatchStatus
    • Task.error
    • Task.errorDetails
    • Task.errorMessage
    • Task.estimatedCompletionAt
    • Task.fail_current_stage()
    • Task.fail_processing()
    • Task.fencingToken
    • Task.fields()
    • Task.from_dict()
    • Task.get_by_id()
    • Task.get_stages()
    • Task.idempotencyDigest
    • Task.idempotencyKey
    • Task.idempotencyNamespace
    • Task.leaseExpiresAt
    • Task.leaseOwner
    • Task.lifecycleStatus
    • Task.list_tasks()
    • Task.lock_expires
    • Task.lock_token
    • Task.metadata
    • Task.output
    • Task.progressDetails
    • Task.progressFraction
    • Task.progressMessage
    • Task.release_lock()
    • Task.scoreId
    • Task.scorecardId
    • Task.start_processing()
    • Task.startedAt
    • Task.status
    • Task.stderr
    • Task.stdout
    • Task.submittedBy
    • Task.target
    • Task.tenantId
    • Task.type
    • Task.update()
    • Task.update_progress()
    • Task.updatedAt
    • Task.workerNodeId
  • TaskStage
    • TaskStage.__init__()
    • TaskStage.complete_processing()
    • TaskStage.completedAt
    • TaskStage.create()
    • TaskStage.estimatedCompletionAt
    • TaskStage.fail_processing()
    • TaskStage.fields()
    • TaskStage.from_dict()
    • TaskStage.get_by_id()
    • TaskStage.name
    • TaskStage.order
    • TaskStage.processedItems
    • TaskStage.start_processing()
    • TaskStage.startedAt
    • TaskStage.status
    • TaskStage.statusMessage
    • TaskStage.taskId
    • TaskStage.totalItems
    • TaskStage.update()
  • Submodules
    • primus.dashboard.api.models.account module
      • Account
    • primus.dashboard.api.models.aggregated_metrics module
      • AggregatedMetrics
    • primus.dashboard.api.models.base module
      • BaseModel
    • primus.dashboard.api.models.batch_job module
      • BatchJob
    • primus.dashboard.api.models.data_set module
      • DataSet
    • primus.dashboard.api.models.data_source module
      • DataSource
    • primus.dashboard.api.models.evaluation module
      • Evaluation
    • primus.dashboard.api.models.experiment_template module
      • ExperimentTemplate
    • primus.dashboard.api.models.feedback_change_detail module
      • FeedbackChangeDetail
    • primus.dashboard.api.models.feedback_item module
      • FeedbackItem
    • primus.dashboard.api.models.identifier module
      • Identifier
    • primus.dashboard.api.models.item module
      • Item
    • primus.dashboard.api.models.procedure module
      • Procedure
    • primus.dashboard.api.models.procedure_template module
      • ProcedureTemplate
    • primus.dashboard.api.models.report module
      • Report
    • primus.dashboard.api.models.report_block module
      • ReportBlock
    • primus.dashboard.api.models.report_configuration module
      • ReportConfiguration
    • primus.dashboard.api.models.score module
      • Score
    • primus.dashboard.api.models.score_result module
      • Score
      • ScoreResult
    • primus.dashboard.api.models.scorecard module
      • Scorecard
    • primus.dashboard.api.models.scoring_job module
      • ScoringJob
    • primus.dashboard.api.models.task module
      • Task
    • primus.dashboard.api.models.task_stage module
      • TaskStage
    • primus.dashboard.api.models.test_score module
      • MockAPIClient
      • TestScoreConfiguration
      • TestScoreVersionCreation

Submodules

• primus.dashboard.api.client module
  • ClientContext
    • ClientContext.__init__()
    • ClientContext.account_id
    • ClientContext.account_key
    • ClientContext.actor_key
    • ClientContext.actor_source
    • ClientContext.actor_type
    • ClientContext.actor_user_id
    • ClientContext.score_id
    • ClientContext.score_name
    • ClientContext.scorecard_id
    • ClientContext.scorecard_key
  • GraphQLRetryPolicy
    • GraphQLRetryPolicy.__init__()
    • GraphQLRetryPolicy.backoff_multiplier
    • GraphQLRetryPolicy.initial_delay_seconds
    • GraphQLRetryPolicy.jitter_ratio
    • GraphQLRetryPolicy.max_attempts
    • GraphQLRetryPolicy.max_delay_seconds
    • GraphQLRetryPolicy.max_elapsed_seconds
    • GraphQLRetryPolicy.name
  • PrimusDashboardClient
    • PrimusDashboardClient.__init__()
    • PrimusDashboardClient.create_chat_message()
    • PrimusDashboardClient.create_chat_session()
    • PrimusDashboardClient.for_account()
    • PrimusDashboardClient.for_scorecard()
    • PrimusDashboardClient.get_chat_session()
    • PrimusDashboardClient.list_chat_messages()
    • PrimusDashboardClient.list_chat_sessions()
    • PrimusDashboardClient.update_chat_session()
• primus.dashboard.api.display_utils module
  • dict_to_table()
  • format_datetime()
  • model_to_panel()
  • truncate_text()
• primus.dashboard.api.namespaces module
  • AccountNamespace
    • AccountNamespace.__init__()
    • AccountNamespace.get_by_id()
    • AccountNamespace.get_by_key()
  • ScoreResultNamespace
    • ScoreResultNamespace.__init__()
    • ScoreResultNamespace.batch_create()
    • ScoreResultNamespace.create()
  • ScorecardNamespace
    • ScorecardNamespace.__init__()
    • ScorecardNamespace.get_by_id()
    • ScorecardNamespace.get_by_key()
• primus.dashboard.api.scoring_client module