Categorygithub.com/feeduvl/uvl-orchestration-concepts
modulepackage
0.0.0-20240918110848-18c9a5f01cf6
Repository: https://github.com/feeduvl/uvl-orchestration-concepts.git
Documentation: pkg.go.dev

# README

== uvl-orchestration-concepts image:https://img.shields.io/badge/License-EPL%202.0-blue.svg["EPL 2.0", link="https://www.eclipse.org/legal/epl-2.0/"]

This microservice is responsible for the coordination of all microservices dealing with datasets and detection tasks. The functions include processing of uploaded data and starting detection tasks/sending the detection results to the storage.

This microservice is based on link:https://github.com/feeduvl/ri-orchestration-twitter[ri-orchestration-twitter].

== REST API

See link:https://github.com/feeduvl/uvl-orchestration-concepts/blob/master/swagger.yaml[swagger.yaml] for details. The tool at https://editor.swagger.io/ can be used to render the swagger file.

== License Free use of this software is granted under the terms of the EPL version 2 (EPL2.0).

# Functions

RESTCalculateKappaFromAgreement returns kappas, error.
RESTCreateAnnotationFromAgreement returns error.
RESTGetDataset returns dataset, err.
RESTGetInfoFromAnnotations returns info from annotation, including docs, tokens, toreAlternatives, wordCodeAlternatives, relationshipAlternatives, err.
RESTPostStartNewDetection returns Result ,err.
No description provided by the author
No description provided by the author
RESTPostStoreAgreement returns err.
RESTPostStoreAnnotation returns err.
RESTPostStoreDataset returns err.
RESTPostStoreGroundTruth returns err.
RESTPostStoreResult returns ,err.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
POST
No description provided by the author
No description provided by the author

# Structs

Agreement model.
AgreementStatistics model, the initial and current kappas.
No description provided by the author
No description provided by the author
CodeAlternatives model, shows all code alternatives from all annotations, MergeStatus can be set to Pending, Accepted or Declined.
Dataset model.
Document model.
No description provided by the author
Only used inside this container, and for optimization.
ResponseMessage model.
Result model.
Run model.
No description provided by the author
No description provided by the author
TruthElement model.