assessments

codioIDE.guides. Namespace

assessments

Description:
  • Guides assessments API methods
Source:

Interfaces

AssessmentResult

Members

(static, readonly) ASSESSMENT_TYPES :string

Source:
Properties:
Name Type Description
ADVANCED_CODE_TEST string
FILL_IN_THE_BLANKS string
MULTIPLE_CHOICE string
FREE_TEXT string
FREE_TEXT_AUTO string
STANDARD_CODE_TEST string
PARSONS_PUZZLE string
LLM_BASED_RUBRIC string
SPLICE string
GRADE_BOOK string
Type:
  • string

(static, readonly) GENERATE_ALLOWED_TYPES :string

Source:
Properties:
Name Type Description
FILL_IN_THE_BLANKS string
MULTIPLE_CHOICE string
FREE_TEXT string
STANDARD_CODE_TEST string
PARSONS_PUZZLE string
Type:
  • string

Methods

(async, static) generate(data) → {Promise.<codioIDE.guides.assessments.GenerateResult>}

Description:
  • Generate assessment
Source:
Parameters:
Name Type Description
data codioIDE.guides.assessments.GenerateRequest generate request data
Throws:
  • Will throw an error if the project is not found or data is not valid.
  • Will throw an error if the assessment type is not supported.
Returns:
Type
Promise.<codioIDE.guides.assessments.GenerateResult>

(async, static) list()

Description:
  • Returns guides assessments
Source:

(async, static) save(assessment, filesopt) → {Promise.<void>}

Description:
  • Save assessment
Source:
Parameters:
Name Type Attributes Description
assessment object assessment object
files Array.<codioIDE.guides.assessments.FileInfo> <optional>
 list of files to include in the assessment
Throws:
  • Will throw an error if the project is not found
  • Will throw an error if there is an error during file saving.
Returns:
Type
Promise.<void>

Type Definitions

AssessmentExecuteCallback(assessmentId)

Description:
  • Assessment execute callback
Source:
Parameters:
Name Type Description
assessmentId string assessment id

AssessmentResultCallback(assessmentId, result)

Description:
  • Assessment result callback
Source:
Parameters:
Name Type Description
assessmentId string assessment id
result string execution result

FileInfo

Source:
Properties:
Name Type Description
path string file path
content string file content
Type:
  • Object

GenerateRequest

Source:
Properties:
Name Type Description
assessmentType codioIDE.guides.assessments.GENERATE_ALLOWED_TYPES assessment type
guidesContent string guides content
filesList Array.<codioIDE.guides.assessments.FileInfo> list of files to include in the assessment
userIntro string assessment introduction text
Type:
  • Object

GenerateResult

Source:
Properties:
Name Type Description
assessment object assessment json
files Array.<codioIDE.guides.assessments.FileInfo> list of files to include in the assessment
Type:
  • Object