evaluation-function-api

OpenAPI Specification and Validation Schemas for the Evaluation Function API

https://github.com/lambda-feedback/evaluation-function-api

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (9.3%) to scientific vocabulary

Keywords

evaluation-function-api openapi swagger

Last synced: 6 months ago · JSON representation ·

Repository

OpenAPI Specification and Validation Schemas for the Evaluation Function API

Basic Info

Host: GitHub
Owner: lambda-feedback
Default Branch: main
Homepage: https://lambda-feedback.github.io/evaluation-function-api/
Size: 23.4 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

evaluation-function-api openapi swagger

Created over 1 year ago · Last pushed over 1 year ago

Metadata Files

Readme Citation

Evaluation Function API

This Repository contains the specification and validation schemas for the Lambda Feedback Evaluation Function API. The API is expected to be implemented by evaluation functions that are used in the Lambda Feedback platform.

Overview

The Evaluation Function API uses an RPC-like approach via HTTP, handling commands in the command HTTP header. It evaluates student responses with the eval command. For more complex cases, the optional preview command allows to perform lightweight checks without full evaluation.

Command Header

The command header specifies the action to be performed by the evaluation function. The API currently supports two commands: eval and preview.

Historically, some evaluation functions may also support the two legacy commands healthcheck and docs, which are used for health checks and documentation retrieval, respectively. However, these commands are considered deprecated.

Documentation

The full documentation is available here.

Owner

Name: lambda-feedback
Login: lambda-feedback
Kind: organization
Location: United Kingdom

Repositories: 12
Profile: https://github.com/lambda-feedback

Citation (CITATION.cff)

cff-version: 1.2.0
title: Evaluation Function API
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Louis
    family-names: Manestar
    email: louis.manestar18@imperial.ac.uk
    affiliation: Imperial College London
  - given-names: Andreas
    family-names: Pfurtscheller
    email: andreas.pfurtscheller23@imperial.ac.uk
    affiliation: Imperial College London
repository-code: 'https://github.com/lambda-feedback/shimmy'
abstract: >-
  The Evaluation Function API defines a standardised interface
  for evaluation functions in the context of Lambda Feedback.
keywords:
  - api
  - openapi
  - swagger
  - evaluation function
  - lambda feedback
  - education
  - lms

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science