ErrorResponse
timestampTimestamp when the error occurred
statusHTTP status code
errorHTTP status reason phrase
messageDetailed error message
FrameworkResponseDTO
idUnique identifier of the framework
nameName of the framework
codeNameCode name of the framework
descriptionDescription of the framework
List of criteria associated with the framework
CriterionRequestDTO
nameThe full name of the criterion
codeNameThe code name of the criterion
descriptionThe description of the criterion
AssessmentRequestConfiguration
expertIdThe ID of the expert who carries out the assessment
frameworkCodeNameThe code name of the framework to which the criterion belongs
criteriaCodeNamesThe code names of the criteria on which the assessment is based. If omitted, all criteria of the framework are assessed.
assessmentProcessIdThe ID of the assessment process, serves as to group assessment responses together. If omitted, a new UUID is generated.
llmCallTo be able to overwrite the LLM call flag
AssessmentsResponseDTO
assessmentProcessIdUnique identifier of the assessment process
statusCurrent status of the assessment process
completionCompletion percentage of the assessment process (0.0 to 1.0)
List of assessment responses (populated when status is COMPLETED)
AssessmentResponseDTO
idUnique identifier of the assessment result
assessmentProcessIdUnique identifier of the assessment process
inputTokensInput tokens used in the assessment
outputTokensOutput tokens generated by the assessment
processingTimeMsProcessing time in milliseconds
expertIdIdentifier of the expert who performed the assessment
fileNamesList of file names associated with the assessment
urlsList of URLs associated with the assessment
frameworkCodeNameCode name of the framework used in the assessment
criterionCodeNameCode name of the criterion used in the assessment
categoryCategory of the assessment result (e.g. SUFFICIENTLY REGULATED, NOT SUFFICIENTLY REGULATED, MISSING)
rationaleRationale behind the assessment result (markdown formatted)
List of citations supporting the assessment result
CitationDTO
fileNameName of the source file
contentQuoted text content of the citation
headingSection heading where the citation was found
startIndexStart character index of the citation in the extracted content
endIndexEnd character index of the citation in the extracted content
AssessmentFeedbackRequestDTO
expertIdThe ID of the expert who is rating the assessment
rationalFeedbackThe feedback on the rationale provided by the expert
assessmentResponseIdThe ID of the assessment response being rated
categoryFeedbackThe corrected category according to the expert
ContentProcessingResponseDTO
uuidUnique identifier of the content processing job
sourceTypeType of content source
sourceUrlOriginal URL (for URL sources)
fileNameName of the processed file
statusCurrent status of the content processing job
errorError message if the job failed
createdAtTimestamp when the job was created
completedAtTimestamp when the job completed
fetchedAtTimestamp when URL content was last fetched