Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LSC24 #166

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from
Draft

LSC24 #166

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
[![GitHub release](https://img.shields.io/github/release/vitrivr/vitrivr-ng?include_prereleases=&sort=semver&color=2ea44f)](https://github.com/vitrivr/vitrivr-ng/releases/)
[![License](https://img.shields.io/badge/License-MIT-blueviolet)](#license)

> [!CAUTION]
> This is extrodinary experimental and should not be used with anything but the `lsc24` branch of [vitrivr-engine](https://github.com/vitrivr/vitrivr-engine)

This directory contains the source code distribution of Vitrivr NG (stands for either 'Angular' or 'Next Generation'). It was created using [Angular](https://angular.io/)

Vitrivr NG is a web-based user interface developed to be used with the latest version if [Cineast](https://github.com/vitrivr/cineast). It allows the user to browse in and retrieve from mixed multimedia collections.
Expand Down
1 change: 1 addition & 0 deletions openapi/cineast/model/mediaSegmentDescriptor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
export interface MediaSegmentDescriptor {
segmentId?: string;
objectId?: string;
itemName?: string;
start?: number;
end?: number;
startabs?: number;
Expand Down
84 changes: 77 additions & 7 deletions openapi/dres/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
.gitignore
.openapi-generator-ignore
README.md
api.module.ts
api/api.ts
api/clientRunInfo.service.ts
api/download.service.ts
api/evaluation.service.ts
api/evaluationClient.service.ts
api/log.service.ts
api/status.service.ts
api/submission.service.ts
Expand All @@ -12,20 +13,89 @@ configuration.ts
encoder.ts
git_push.sh
index.ts
model/clientRunInfo.ts
model/clientRunInfoList.ts
model/clientTaskInfo.ts
model/apiAnswer.ts
model/apiAnswerSet.ts
model/apiAnswerType.ts
model/apiClientAnswer.ts
model/apiClientAnswerSet.ts
model/apiClientEvaluationInfo.ts
model/apiClientSubmission.ts
model/apiClientTaskTemplateInfo.ts
model/apiContentElement.ts
model/apiContentType.ts
model/apiCreateEvaluation.ts
model/apiEvaluation.ts
model/apiEvaluationInfo.ts
model/apiEvaluationOverview.ts
model/apiEvaluationStartMessage.ts
model/apiEvaluationState.ts
model/apiEvaluationStatus.ts
model/apiEvaluationTemplate.ts
model/apiEvaluationTemplateOverview.ts
model/apiEvaluationType.ts
model/apiHint.ts
model/apiHintContent.ts
model/apiHintOption.ts
model/apiHintType.ts
model/apiJudgement.ts
model/apiJudgementRequest.ts
model/apiJudgementValidatorStatus.ts
model/apiMediaCollection.ts
model/apiMediaItem.ts
model/apiMediaItemMetaDataEntry.ts
model/apiMediaType.ts
model/apiOverrideAnswerSetVerdictDto.ts
model/apiPopulatedMediaCollection.ts
model/apiRole.ts
model/apiRunProperties.ts
model/apiScore.ts
model/apiScoreOption.ts
model/apiScoreOverview.ts
model/apiScoreSeries.ts
model/apiScoreSeriesPoint.ts
model/apiSubmission.ts
model/apiSubmissionInfo.ts
model/apiSubmissionOption.ts
model/apiTarget.ts
model/apiTargetContent.ts
model/apiTargetOption.ts
model/apiTargetType.ts
model/apiTask.ts
model/apiTaskGroup.ts
model/apiTaskOption.ts
model/apiTaskOverview.ts
model/apiTaskStatus.ts
model/apiTaskTemplate.ts
model/apiTaskTemplateInfo.ts
model/apiTaskType.ts
model/apiTeam.ts
model/apiTeamAggregatorType.ts
model/apiTeamGroup.ts
model/apiTeamGroupValue.ts
model/apiTeamInfo.ts
model/apiTeamTaskOverview.ts
model/apiTemporalPoint.ts
model/apiTemporalRange.ts
model/apiTemporalUnit.ts
model/apiUser.ts
model/apiUserRequest.ts
model/apiVerdictStatus.ts
model/apiViewerInfo.ts
model/apiVote.ts
model/currentTime.ts
model/dresInfo.ts
model/errorStatus.ts
model/loginRequest.ts
model/models.ts
model/queryEvent.ts
model/queryEventCategory.ts
model/queryEventLog.ts
model/queryResult.ts
model/queryResultLog.ts
model/rankedAnswer.ts
model/runManagerStatus.ts
model/successStatus.ts
model/successfulSubmissionsStatus.ts
model/userDetails.ts
model/temporalRange.ts
ng-package.json
package.json
tsconfig.json
Expand Down
4 changes: 2 additions & 2 deletions openapi/dres/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## @dres-client-openapi/api@1.0
## @dres-client-openapi/api@2.0.3

### Building

Expand All @@ -19,7 +19,7 @@ Navigate to the folder of your consuming project and run one of next commands.
_published:_

```
npm install @dres-client-openapi/api@1.0 --save
npm install @dres-client-openapi/api@2.0.3 --save
```

_without publishing (not recommended):_
Expand Down
4 changes: 2 additions & 2 deletions openapi/dres/api.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core
import { Configuration } from './configuration';
import { HttpClient } from '@angular/common/http';

import { ClientRunInfoService } from './api/clientRunInfo.service';
import { DownloadService } from './api/download.service';
import { EvaluationService } from './api/evaluation.service';
import { EvaluationClientService } from './api/evaluationClient.service';
import { LogService } from './api/log.service';
import { StatusService } from './api/status.service';
import { SubmissionService } from './api/submission.service';
Expand Down
10 changes: 5 additions & 5 deletions openapi/dres/api/api.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export * from './clientRunInfo.service';
import { ClientRunInfoService } from './clientRunInfo.service';
export * from './download.service';
import { DownloadService } from './download.service';
export * from './evaluation.service';
import { EvaluationService } from './evaluation.service';
export * from './evaluationClient.service';
import { EvaluationClientService } from './evaluationClient.service';
export * from './log.service';
import { LogService } from './log.service';
export * from './status.service';
Expand All @@ -10,4 +10,4 @@ export * from './submission.service';
import { SubmissionService } from './submission.service';
export * from './user.service';
import { UserService } from './user.service';
export const APIS = [ClientRunInfoService, DownloadService, LogService, StatusService, SubmissionService, UserService];
export const APIS = [EvaluationService, EvaluationClientService, LogService, StatusService, SubmissionService, UserService];
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* DRES API
* API for DRES (Distributed Retrieval Evaluation Server), Version 1.0
* DRES Client API
* Client API for DRES (Distributed Retrieval Evaluation Server), Version 2.0.3
*
* The version of the OpenAPI document: 1.0
* The version of the OpenAPI document: 2.0.3
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand All @@ -18,6 +18,10 @@ import { HttpClient, HttpHeaders, HttpParams,
import { CustomHttpParameterCodec } from '../encoder';
import { Observable } from 'rxjs';

// @ts-ignore
import { ApiEvaluationInfo } from '../model/apiEvaluationInfo';
// @ts-ignore
import { ApiEvaluationState } from '../model/apiEvaluationState';
// @ts-ignore
import { ErrorStatus } from '../model/errorStatus';

Expand All @@ -30,7 +34,7 @@ import { Configuration } from '../configurat
@Injectable({
providedIn: 'root'
})
export class DownloadService {
export class EvaluationService {

protected basePath = 'http://localhost';
public defaultHeaders = new HttpHeaders();
Expand Down Expand Up @@ -88,17 +92,17 @@ export class DownloadService {
}

/**
* Provides a JSON download of the entire competition description structure.
* @param competitionId Competition ID
* Returns basic information about a specific evaluation.
* @param evaluationId The evaluation ID.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
public getApiV1DownloadCompetitionWithCompetitionid(competitionId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<string>;
public getApiV1DownloadCompetitionWithCompetitionid(competitionId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<string>>;
public getApiV1DownloadCompetitionWithCompetitionid(competitionId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<string>>;
public getApiV1DownloadCompetitionWithCompetitionid(competitionId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {
if (competitionId === null || competitionId === undefined) {
throw new Error('Required parameter competitionId was null or undefined when calling getApiV1DownloadCompetitionWithCompetitionid.');
public getApiV2EvaluationByEvaluationIdInfo(evaluationId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<ApiEvaluationInfo>;
public getApiV2EvaluationByEvaluationIdInfo(evaluationId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<ApiEvaluationInfo>>;
public getApiV2EvaluationByEvaluationIdInfo(evaluationId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<ApiEvaluationInfo>>;
public getApiV2EvaluationByEvaluationIdInfo(evaluationId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {
if (evaluationId === null || evaluationId === undefined) {
throw new Error('Required parameter evaluationId was null or undefined when calling getApiV2EvaluationByEvaluationIdInfo.');
}

let localVarHeaders = this.defaultHeaders;
Expand Down Expand Up @@ -132,7 +136,7 @@ export class DownloadService {
}
}

return this.httpClient.get<string>(`${this.configuration.basePath}/api/v1/download/competition/${encodeURIComponent(String(competitionId))}`,
return this.httpClient.get<ApiEvaluationInfo>(`${this.configuration.basePath}/api/v2/evaluation/${encodeURIComponent(String(evaluationId))}/info`,
{
context: localVarHttpContext,
responseType: <any>responseType_,
Expand All @@ -145,17 +149,17 @@ export class DownloadService {
}

/**
* Provides a JSON download of the entire competition run structure.
* @param runId Competition run ID
* Returns the state of a specific evaluation.
* @param evaluationId The evaluation ID.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
public getApiV1DownloadRunWithRunid(runId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<string>;
public getApiV1DownloadRunWithRunid(runId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<string>>;
public getApiV1DownloadRunWithRunid(runId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<string>>;
public getApiV1DownloadRunWithRunid(runId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {
if (runId === null || runId === undefined) {
throw new Error('Required parameter runId was null or undefined when calling getApiV1DownloadRunWithRunid.');
public getApiV2EvaluationByEvaluationIdState(evaluationId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<ApiEvaluationState>;
public getApiV2EvaluationByEvaluationIdState(evaluationId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<ApiEvaluationState>>;
public getApiV2EvaluationByEvaluationIdState(evaluationId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<ApiEvaluationState>>;
public getApiV2EvaluationByEvaluationIdState(evaluationId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {
if (evaluationId === null || evaluationId === undefined) {
throw new Error('Required parameter evaluationId was null or undefined when calling getApiV2EvaluationByEvaluationIdState.');
}

let localVarHeaders = this.defaultHeaders;
Expand Down Expand Up @@ -189,7 +193,7 @@ export class DownloadService {
}
}

return this.httpClient.get<string>(`${this.configuration.basePath}/api/v1/download/run/${encodeURIComponent(String(runId))}`,
return this.httpClient.get<ApiEvaluationState>(`${this.configuration.basePath}/api/v2/evaluation/${encodeURIComponent(String(evaluationId))}/state`,
{
context: localVarHttpContext,
responseType: <any>responseType_,
Expand All @@ -202,26 +206,74 @@ export class DownloadService {
}

/**
* Provides a CSV download with the scores for a given competition run.
* @param runId Competition run ID
* Lists an overview of all evaluations visible to the current user.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
public getApiV1DownloadRunWithRunidScores(runId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'text/csv' | 'application/json', context?: HttpContext}): Observable<string>;
public getApiV1DownloadRunWithRunidScores(runId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'text/csv' | 'application/json', context?: HttpContext}): Observable<HttpResponse<string>>;
public getApiV1DownloadRunWithRunidScores(runId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'text/csv' | 'application/json', context?: HttpContext}): Observable<HttpEvent<string>>;
public getApiV1DownloadRunWithRunidScores(runId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'text/csv' | 'application/json', context?: HttpContext}): Observable<any> {
if (runId === null || runId === undefined) {
throw new Error('Required parameter runId was null or undefined when calling getApiV1DownloadRunWithRunidScores.');
public getApiV2EvaluationInfoList(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<Array<ApiEvaluationInfo>>;
public getApiV2EvaluationInfoList(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<Array<ApiEvaluationInfo>>>;
public getApiV2EvaluationInfoList(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<Array<ApiEvaluationInfo>>>;
public getApiV2EvaluationInfoList(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {

let localVarHeaders = this.defaultHeaders;

let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
if (localVarHttpHeaderAcceptSelected === undefined) {
// to determine the Accept header
const httpHeaderAccepts: string[] = [
'application/json'
];
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
}
if (localVarHttpHeaderAcceptSelected !== undefined) {
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
}

let localVarHttpContext: HttpContext | undefined = options && options.context;
if (localVarHttpContext === undefined) {
localVarHttpContext = new HttpContext();
}


let responseType_: 'text' | 'json' | 'blob' = 'json';
if (localVarHttpHeaderAcceptSelected) {
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
responseType_ = 'text';
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
responseType_ = 'json';
} else {
responseType_ = 'blob';
}
}

return this.httpClient.get<Array<ApiEvaluationInfo>>(`${this.configuration.basePath}/api/v2/evaluation/info/list`,
{
context: localVarHttpContext,
responseType: <any>responseType_,
withCredentials: this.configuration.withCredentials,
headers: localVarHeaders,
observe: observe,
reportProgress: reportProgress
}
);
}

/**
* Lists an overview of all evaluation visible to the current user.
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
* @param reportProgress flag to report request and response progress.
*/
public getApiV2EvaluationStateList(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<Array<ApiEvaluationState>>;
public getApiV2EvaluationStateList(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpResponse<Array<ApiEvaluationState>>>;
public getApiV2EvaluationStateList(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<HttpEvent<Array<ApiEvaluationState>>>;
public getApiV2EvaluationStateList(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable<any> {

let localVarHeaders = this.defaultHeaders;

let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
if (localVarHttpHeaderAcceptSelected === undefined) {
// to determine the Accept header
const httpHeaderAccepts: string[] = [
'text/csv',
'application/json'
];
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
Expand All @@ -247,7 +299,7 @@ export class DownloadService {
}
}

return this.httpClient.get<string>(`${this.configuration.basePath}/api/v1/download/run/${encodeURIComponent(String(runId))}/scores`,
return this.httpClient.get<Array<ApiEvaluationState>>(`${this.configuration.basePath}/api/v2/evaluation/state/list`,
{
context: localVarHttpContext,
responseType: <any>responseType_,
Expand Down
Loading