{ "openapi": "3.1.0", "info": { "title": "Discourse Analysis Tool Suite API", "version": "1.10.1" }, "paths": { "/analysis/code_frequencies": { "post": { "tags": ["analysis"], "summary": "Returns all SourceDocument IDs that match the query parameters.", "operationId": "code_frequencies", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_analysis-code_frequencies" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeFrequency" }, "title": "Response Analysis-Code Frequencies" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analysis/code_occurrences": { "post": { "tags": ["analysis"], "summary": "Returns all SourceDocument IDs that match the query parameters.", "operationId": "code_occurrences", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "code_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Code Id" } }, { "name": "return_children", "in": "query", "required": true, "schema": { "type": "boolean", "title": "Return Children" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_analysis-code_occurrences" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeOccurrence" }, "title": "Response Analysis-Code Occurrences" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analysis/count_sdocs_with_date_metadata/{project_id}/metadata/{date_metadata_id}}": { "get": { "tags": ["analysis"], "summary": "Returns tuple[num_sdocs_with_date_metadata, num_total_sdocs].", "operationId": "count_sdocs_with_date_metadata", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "date_metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Date Metadata Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "prefixItems": [{ "type": "integer" }, { "type": "integer" }], "minItems": 2, "maxItems": 2, "title": "Response Analysis-Count Sdocs With Date Metadata" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/analysis/sample_sdocs_by_tags": { "post": { "tags": ["analysis"], "summary": "Sample & Aggregate Source Documents by tags.", "operationId": "sample_sdocs_by_tags", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "n", "in": "query", "required": true, "schema": { "type": "integer", "title": "N" } }, { "name": "frac", "in": "query", "required": true, "schema": { "type": "number", "title": "Frac" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } }, "title": "Tag Groups" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SampledSdocsResults" }, "title": "Response Analysis-Sample Sdocs By Tags" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/annoscaling/suggest": { "post": { "tags": ["annoscaling"], "summary": "Suggest annotations", "description": "Suggest annotations", "operationId": "suggest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnoscalingSuggest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AnnoscalingResult" }, "type": "array", "title": "Response Annoscaling-Suggest" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/annoscaling/confirm_suggestions": { "post": { "tags": ["annoscaling"], "summary": "Suggest annotations", "description": "Suggest annotations", "operationId": "confirm_suggestions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnoscalingConfirmSuggest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/authentication/register": { "post": { "tags": ["authentication"], "summary": "Registers a new User and returns it with the generated ID.", "operationId": "register", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/login": { "post": { "tags": ["authentication"], "summary": "Returns the JWT access token for the provided user login data if the login was successful. This is usually only called from an OAuth2 client!", "operationId": "login", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Body_authentication-login" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthorizationHeaderData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/logout": { "post": { "tags": ["authentication"], "summary": "Revokes the refresh token associated with the given session.", "operationId": "logout", "parameters": [ { "name": "refresh_token", "in": "query", "required": true, "schema": { "type": "string", "title": "Refresh Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/refresh_access": { "post": { "tags": ["authentication"], "summary": "Uses the given refresh token to obtain a new access token.", "operationId": "refresh_access_token", "parameters": [ { "name": "refresh_token", "in": "query", "required": true, "schema": { "type": "string", "title": "Refresh Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthorizationHeaderData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/content": { "get": { "tags": ["authentication"], "summary": "Returns success if the user can access the content", "operationId": "auth_content", "parameters": [ { "name": "x-original-uri", "in": "header", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "X-Original-Uri" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/oidc/login": { "get": { "tags": ["authentication"], "summary": "Oidc Login", "operationId": "oidc_login", "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "redirect_uri", "in": "query", "required": true, "schema": { "type": "string", "title": "Redirect Uri" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/oidc/callback": { "get": { "tags": ["authentication"], "summary": "Oidc Callback", "operationId": "oidc_callback", "parameters": [ { "name": "provider", "in": "query", "required": true, "schema": { "type": "string", "title": "Provider" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/authentication/sync-session": { "post": { "tags": ["authentication"], "summary": "Sync Session", "operationId": "sync_session", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/bbox": { "put": { "tags": ["bboxAnnotation"], "summary": "Creates a BBoxAnnotation", "operationId": "add_bbox_annotation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/bbox/{bbox_id}": { "get": { "tags": ["bboxAnnotation"], "summary": "Returns the BBoxAnnotation with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "bbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Bbox Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["bboxAnnotation"], "summary": "Updates the BBoxAnnotation with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "bbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Bbox Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["bboxAnnotation"], "summary": "Deletes the BBoxAnnotation with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "bbox_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Bbox Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bbox/sdoc/{sdoc_id}/user/{user_id}": { "get": { "tags": ["bboxAnnotation"], "summary": "Returns all BBoxAnnotations of the User for the SourceDocument", "operationId": "get_by_sdoc_and_user", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BBoxAnnotationRead" }, "title": "Response Bboxannotation-Get By Sdoc And User" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/bbox/bulk/update": { "patch": { "tags": ["bboxAnnotation"], "summary": "Updates BBoxAnnotation in Bulk", "operationId": "update_bbox_anno_annotations_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BBoxAnnotationUpdateBulk" }, "type": "array", "title": "Bbox Annos" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BBoxAnnotationRead" }, "type": "array", "title": "Response Bboxannotation-Update Bbox Anno Annotations Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/bbox/bulk/delete": { "delete": { "tags": ["bboxAnnotation"], "summary": "Deletes all BBoxAnnotations with the given IDs.", "operationId": "delete_bulk_by_id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array", "title": "Bbox Anno Ids" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BBoxAnnotationRead" }, "type": "array", "title": "Response Bboxannotation-Delete Bulk By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/bbox/code/{code_id}/user": { "get": { "tags": ["bboxAnnotation"], "summary": "Returns BBoxAnnotations with the given Code of the logged-in User", "operationId": "get_by_user_code", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BBoxAnnotationRead" }, "title": "Response Bboxannotation-Get By User Code" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/project/{proj_id}": { "get": { "tags": ["classifier"], "summary": "Returns all Classifiers of the Project with the given ID", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClassifierRead" }, "title": "Response Classifier-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/{classifier_id}": { "patch": { "tags": ["classifier"], "summary": "Updates the Classifier with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "classifier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Classifier Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["classifier"], "summary": "Deletes the Classifier with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "classifier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Classifier Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/project/{proj_id}/datasetstatistics": { "post": { "tags": ["classifier"], "summary": "Returns statistics of the dataset that would be created with these parameters", "operationId": "compute_dataset_statistics", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "model", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ClassifierModel" } }, { "name": "merge_children_into_parent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Merge Children Into Parent" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_classifier-compute_dataset_statistics" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClassifierData" }, "title": "Response Classifier-Compute Dataset Statistics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/project/{proj_id}/datasetstatistics2": { "post": { "tags": ["classifier"], "summary": "Returns statistics of the dataset that would be created with these parameters", "operationId": "compute_dataset_statistics2", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "model", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ClassifierModel" } }, { "name": "merge_children_into_parent", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Merge Children Into Parent" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_classifier-compute_dataset_statistics2" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClassifierData" }, "title": "Response Classifier-Compute Dataset Statistics2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/classifier": { "post": { "tags": ["classifier"], "summary": "Start Classifier job", "operationId": "start_classifier_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/classifier/classifier/{job_id}": { "get": { "tags": ["classifier"], "summary": "Get Classifier job", "operationId": "get_classifier_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifierJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/classifier/{job_id}/abort": { "post": { "tags": ["classifier"], "summary": "Abort Classifier job", "operationId": "abort_classifier_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Classifier-Abort Classifier Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/classifier/{job_id}/retry": { "post": { "tags": ["classifier"], "summary": "Retry Classifier job", "operationId": "retry_classifier_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Classifier-Retry Classifier Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/classifier/classifier/project/{project_id}": { "get": { "tags": ["classifier"], "summary": "Get all Classifier jobs by project", "operationId": "get_classifier_jobs_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClassifierJobRead" }, "title": "Response Classifier-Get Classifier Jobs By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/code": { "put": { "tags": ["code"], "summary": "Creates a new Code and returns it with the generated ID.", "operationId": "create_new_code", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/code/{code_id}": { "get": { "tags": ["code"], "summary": "Returns the Code with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["code"], "summary": "Updates the Code with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["code"], "summary": "Deletes the Code with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/code/project/{proj_id}": { "get": { "tags": ["code"], "summary": "Returns all Codes of the Project with the given ID", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CodeRead" }, "title": "Response Code-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota": { "put": { "tags": ["conceptOverTimeAnalysis"], "summary": "Creates an ConceptOverTimeAnalysis", "description": "Creates an ConceptOverTimeAnalysis", "operationId": "create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTACreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/cota/{cota_id}": { "get": { "tags": ["conceptOverTimeAnalysis"], "summary": "Returns the ConceptOverTimeAnalysis", "description": "Returns the ConceptOverTimeAnalysis with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["conceptOverTimeAnalysis"], "summary": "Updates the ConceptOverTimeAnalysis", "description": "Updates the ConceptOverTimeAnalysis with the given ID if it exists", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTAUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["conceptOverTimeAnalysis"], "summary": "Removes the ConceptOverTimeAnalysis", "description": "Removes the ConceptOverTimeAnalysis with the given ID if it exists", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/project/{project_id}": { "get": { "tags": ["conceptOverTimeAnalysis"], "summary": "Returns COTAs of the Project", "description": "Returns the COTA of the Project with the given ID if it exists", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/COTARead" }, "title": "Response Conceptovertimeanalysis-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/duplicate/{cota_id}": { "post": { "tags": ["conceptOverTimeAnalysis"], "summary": "Duplicates the ConceptOverTimeAnalysis with the given ID if it exists", "operationId": "duplicate_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/annotate/{cota_id}": { "post": { "tags": ["conceptOverTimeAnalysis"], "summary": "Annotate (multiple) COTASentences", "operationId": "annotate_cota_sentence", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } }, { "name": "concept_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Concept Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/COTASentenceID" }, "title": "Cota Sentence Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/remove/{cota_id}": { "post": { "tags": ["conceptOverTimeAnalysis"], "summary": "Remove (multiple) COTASentences from the search space", "operationId": "remove_cota_sentence", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/COTASentenceID" }, "title": "Cota Sentence Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/reset/{cota_id}": { "post": { "tags": ["conceptOverTimeAnalysis"], "summary": "Resets the ConceptOverTimeAnalysis", "description": "Resets the ConceptOverTimeAnalysis deleting model, embeddings, refinement jobs and resetting the search space", "operationId": "reset_cota", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cota Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cota/refine": { "post": { "tags": ["conceptOverTimeAnalysis"], "summary": "Refines the ConceptOverTimeAnalysis", "description": "Refines the ConceptOverTimeAnalysis with the given ID if it exists", "operationId": "refine_cota", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARefinementJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/cota/refine/{cota_job_id}": { "get": { "tags": ["conceptOverTimeAnalysis"], "summary": "Returns the COTA Refinement Job for the given ID", "description": "Returns the COTA Refinement Job for the given ID if it exists", "operationId": "get_cota_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cota_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Cota Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/COTARefinementJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/searchColumns/{doctype}": { "get": { "tags": ["docprocessing"], "summary": "Get all column names (the job names) for the given document type", "operationId": "get_search_columns_by_doctype", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "doctype", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/DocType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Response Docprocessing-Get Search Columns By Doctype" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/project/{proj_id}/search": { "post": { "tags": ["docprocessing"], "summary": "Get all SourceDocumentStatusDetailed for the Project with the given ID by status", "operationId": "search_sdoc_health", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "doctype", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/DocType" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page" } }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SdocHealthSort" }, "title": "Sorts" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SdocHealthResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/project/{proj_id}/status/{status}/simple": { "get": { "tags": ["docprocessing"], "summary": "Get all SourceDocumentStatusSimple for the Project with the given ID by status", "operationId": "get_simple_sdoc_status_by_project_and_status", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "status", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SDocStatus" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceDocumentStatusSimple" }, "title": "Response Docprocessing-Get Simple Sdoc Status By Project And Status" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/project/{proj_id}": { "put": { "tags": ["docprocessing"], "summary": "Uploads one or multiple files to the Project with the given ID if it exists", "operationId": "upload_files", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_docprocessing-upload_files" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Docprocessing-Upload Files" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/project/{proj_id}/retry": { "post": { "tags": ["docprocessing"], "summary": "Retries doc processing jobs for SourceDocuments in the given Project and document type", "operationId": "retry_failed_sdocs", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "doctype", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/DocType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Docprocessing-Retry Failed Sdocs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docprocessing/project/{proj_id}/recompute": { "post": { "tags": ["docprocessing"], "summary": "Recomputes the processing step for all SourceDocuments in the Project", "operationId": "recompute_processing_step", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "processing_step", "in": "query", "required": true, "schema": { "type": "string", "title": "Processing Step" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_docprocessing-recompute_processing_step" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Docprocessing-Recompute Processing Step" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/folder/{folder_id}": { "get": { "tags": ["folder"], "summary": "Get Folder By Id", "operationId": "get_folder_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": ["folder"], "summary": "Update Folder", "operationId": "update_folder", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["folder"], "summary": "Delete Folder", "operationId": "delete_folder", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/folder/sdocids/{folder_id}": { "get": { "tags": ["folder"], "summary": "Returns lists of source document ids per doctype in the specified sdoc folder", "operationId": "get_sdoc_ids_in_folder_by_doctype", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer" } }, "propertyNames": { "$ref": "#/components/schemas/DocType" }, "title": "Response Folder-Get Sdoc Ids In Folder By Doctype" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/folder/project/{project_id}/folder/{folder_type}": { "get": { "tags": ["folder"], "summary": "Returns the folders of the folder_type of the project with the given ID", "operationId": "get_folders_by_project_and_type", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "folder_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/FolderType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderRead" }, "title": "Response Folder-Get Folders By Project And Type" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/folder/": { "post": { "tags": ["folder"], "summary": "Create Folder", "operationId": "create_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/folder/move_folders": { "post": { "tags": ["folder"], "summary": "Move Folders", "operationId": "move_folders", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "target_folder_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Target Folder Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Folder Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderRead" }, "title": "Response Folder-Move Folders" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/import/{project_id}/type/{import_job_type}": { "post": { "tags": ["import"], "summary": "Starts an import job with the given parameters and file", "operationId": "start_import_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "import_job_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ImportJobType" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import-start_import_job" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/import/{import_job_id}": { "get": { "tags": ["import"], "summary": "Returns the ImportJob for the given ID if it exists", "operationId": "get_import_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "import_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Import Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/import/project/{project_id}": { "get": { "tags": ["import"], "summary": "Returns all ImportJobs for the given project ID if it exists", "operationId": "get_all_import_jobs", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportJobRead" }, "title": "Response Import-Get All Import Jobs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/heartbeat": { "get": { "tags": ["general"], "summary": "Heartbeat", "operationId": "heartbeat", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/info": { "get": { "tags": ["general"], "summary": "Info", "operationId": "info", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceInfo" } } } } } } }, "/": { "get": { "tags": ["general"], "summary": "Redirection to /docs", "operationId": "root_to_docs", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/job/crawler": { "post": { "tags": ["job"], "summary": "Start Crawler job", "operationId": "start_crawler_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/job/crawler/{job_id}": { "get": { "tags": ["job"], "summary": "Get Crawler job", "operationId": "get_crawler_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrawlerJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/crawler/{job_id}/abort": { "post": { "tags": ["job"], "summary": "Abort Crawler job", "operationId": "abort_crawler_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Job-Abort Crawler Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/crawler/{job_id}/retry": { "post": { "tags": ["job"], "summary": "Retry Crawler job", "operationId": "retry_crawler_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Job-Retry Crawler Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/crawler/project/{project_id}": { "get": { "tags": ["job"], "summary": "Get all Crawler jobs by project", "operationId": "get_crawler_jobs_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrawlerJobRead" }, "title": "Response Job-Get Crawler Jobs By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/ml": { "post": { "tags": ["job"], "summary": "Start Ml job", "operationId": "start_ml_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MLJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MlJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/job/ml/{job_id}": { "get": { "tags": ["job"], "summary": "Get Ml job", "operationId": "get_ml_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MlJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/ml/{job_id}/abort": { "post": { "tags": ["job"], "summary": "Abort Ml job", "operationId": "abort_ml_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Job-Abort Ml Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/ml/{job_id}/retry": { "post": { "tags": ["job"], "summary": "Retry Ml job", "operationId": "retry_ml_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Job-Retry Ml Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/ml/project/{project_id}": { "get": { "tags": ["job"], "summary": "Get all Ml jobs by project", "operationId": "get_ml_jobs_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MlJobRead" }, "title": "Response Job-Get Ml Jobs By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/duplicate_finder": { "post": { "tags": ["job"], "summary": "Start DuplicateFinder job", "operationId": "start_duplicate_finder_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateFinderInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateFinderJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/job/duplicate_finder/{job_id}": { "get": { "tags": ["job"], "summary": "Get DuplicateFinder job", "operationId": "get_duplicate_finder_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateFinderJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/job/export": { "post": { "tags": ["job"], "summary": "Start Export job", "operationId": "start_export_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/job/export/{job_id}": { "get": { "tags": ["job"], "summary": "Get Export job", "operationId": "get_export_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/create_prompt_templates": { "post": { "tags": ["llm"], "summary": "Returns the system and user prompt templates for the given llm task in all supported languages", "operationId": "create_prompt_templates", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "approach_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ApproachType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_llm-create_prompt_templates" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LLMPromptTemplates" }, "title": "Response Llm-Create Prompt Templates" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/determine_approach": { "post": { "tags": ["llm"], "summary": "Determines the appropriate approach based on the provided input", "operationId": "determine_approach", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMJobParameters" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproachRecommendation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/llm/count_existing_assistant_annotations": { "post": { "tags": ["llm"], "summary": "Based on the approach, count the number of existing assistant annotations", "operationId": "count_existing_assistant_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "task_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TaskType" } }, { "name": "approach_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ApproachType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_llm-count_existing_assistant_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Llm-Count Existing Assistant Annotations" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/llm_assistant": { "post": { "tags": ["llm"], "summary": "Start LlmAssistant job", "operationId": "start_llm_assistant_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMJobInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmAssistantJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/llm/llm_assistant/{job_id}": { "get": { "tags": ["llm"], "summary": "Get LlmAssistant job", "operationId": "get_llm_assistant_job_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmAssistantJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/llm_assistant/{job_id}/abort": { "post": { "tags": ["llm"], "summary": "Abort LlmAssistant job", "operationId": "abort_llm_assistant_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Llm-Abort Llm Assistant Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/llm_assistant/{job_id}/retry": { "post": { "tags": ["llm"], "summary": "Retry LlmAssistant job", "operationId": "retry_llm_assistant_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "boolean", "title": "Response Llm-Retry Llm Assistant Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/llm/llm_assistant/project/{project_id}": { "get": { "tags": ["llm"], "summary": "Get all LlmAssistant jobs by project", "operationId": "get_llm_assistant_jobs_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LlmAssistantJobRead" }, "title": "Response Llm-Get Llm Assistant Jobs By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/memo": { "put": { "tags": ["memo"], "summary": "Adds a Memo to the Attached Object with the given ID if it exists", "operationId": "add_memo", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "attached_object_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Attached Object Id" } }, { "name": "attached_object_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AttachedObjectType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/memo/{memo_id}": { "get": { "tags": ["memo"], "summary": "Returns the Memo with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "memo_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Memo Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["memo"], "summary": "Updates the Memo with the given ID if it exists", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "memo_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Memo Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["memo"], "summary": "Removes the Memo with the given ID if it exists", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "memo_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Memo Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/memo/attached_obj/{attached_obj_type}/to/{attached_obj_id}": { "get": { "tags": ["memo"], "summary": "Returns all Memos attached to the object if it exists", "operationId": "get_memos_by_attached_object_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "attached_obj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Attached Obj Id" } }, { "name": "attached_obj_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AttachedObjectType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemoRead" }, "title": "Response Memo-Get Memos By Attached Object Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/memo/attached_obj/{attached_obj_type}/to/{attached_obj_id}/user": { "get": { "tags": ["memo"], "summary": "Returns the logged-in User's Memo attached to the object if it exists", "operationId": "get_user_memo_by_attached_object_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "attached_obj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Attached Obj Id" } }, { "name": "attached_obj_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AttachedObjectType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/memo/generate_suggestion/{attached_obj_type}/{attached_obj_id}": { "get": { "tags": ["memo"], "summary": "Generates a 1–2 sentence memo suggestion using LLM based on the attached object", "operationId": "generate_memo_suggestion", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "attached_obj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Attached Obj Id" } }, { "name": "attached_obj_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AttachedObjectType" } }, { "name": "model", "in": "query", "required": true, "schema": { "type": "string", "title": "Model" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Memo-Generate Memo Suggestion" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/job/{aspect_id}": { "post": { "tags": ["perspectives"], "summary": "Starts the PerspectivesJob for the given Parameters. If a job is already running, this will raise an error.", "operationId": "start_perspectives_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AddMissingDocsToAspectParams" }, { "$ref": "#/components/schemas/CreateClusterWithNameParams" }, { "$ref": "#/components/schemas/CreateClusterWithSdocsParams" }, { "$ref": "#/components/schemas/RemoveClusterParams" }, { "$ref": "#/components/schemas/MergeClustersParams" }, { "$ref": "#/components/schemas/SplitClusterParams" }, { "$ref": "#/components/schemas/ChangeClusterParams" }, { "$ref": "#/components/schemas/RefineModelParams" }, { "$ref": "#/components/schemas/ResetModelParams" }, { "$ref": "#/components/schemas/RecomputeClusterTitleAndDescriptionParams" } ], "title": "Perspectives Job Params" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerspectivesJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/job/{perspectives_job_id}": { "get": { "tags": ["perspectives"], "summary": "Returns the PerspectivesJob for the given ID if it exists", "operationId": "get_perspectives_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "perspectives_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Perspectives Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerspectivesJobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/aspect": { "put": { "tags": ["perspectives"], "summary": "Creates a new Aspect", "operationId": "create_aspect", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/perspectives/project/{proj_id}/aspects": { "get": { "tags": ["perspectives"], "summary": "Returns all Aspects of the Project with the given ID if it exists", "operationId": "get_all_aspects", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AspectRead" }, "title": "Response Perspectives-Get All Aspects" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/aspect/{aspect_id}": { "get": { "tags": ["perspectives"], "summary": "Returns the Aspect with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["perspectives"], "summary": "Updates the Aspect with the given ID.", "operationId": "update_aspect_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["perspectives"], "summary": "Removes the Aspect with the given ID.", "operationId": "remove_aspect_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/aspect/{aspect_id}/sdoc/{sdoc_id}": { "get": { "tags": ["perspectives"], "summary": "Returns the Document Aspect Content for the given IDs.", "operationId": "get_docaspect_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } }, { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Perspectives-Get Docaspect By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/label_accept/{aspect_id}": { "post": { "tags": ["perspectives"], "summary": "Accept the label of the provided SourceDocuments (by ID).", "operationId": "accept_label", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Perspectives-Accept Label" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/label_revert/{aspect_id}": { "post": { "tags": ["perspectives"], "summary": "Reverts the label of the provided SourceDocuments (by ID).", "operationId": "revert_label", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Perspectives-Revert Label" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/visualize_documents/{aspect_id}": { "post": { "tags": ["perspectives"], "summary": "Returns data for visualizing the documents of the given aspect.", "operationId": "visualize_documents", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } }, { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "title": "Search Query" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_perspectives-visualize_documents" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerspectivesVisualization" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/cluster_similarities/{aspect_id}": { "get": { "tags": ["perspectives"], "summary": "Returns data for visualizing the cluster similarities of the given aspect.", "operationId": "get_cluster_similarities", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerspectivesClusterSimilarities" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/visualize_clusters/{aspect_id}": { "get": { "tags": ["perspectives"], "summary": "Returns data for visualizing the clusters of the given aspect.", "operationId": "visualize_clusters", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AspectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/clusters/{aspect_id}/sdoc/{sdoc_id}": { "get": { "tags": ["perspectives"], "summary": "Returns the clusters for the given SourceDocument (sdoc_id) in the specified Aspect (aspect_id).", "operationId": "get_clusters_for_sdoc", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "aspect_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Aspect Id" } }, { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterRead" }, "title": "Response Perspectives-Get Clusters For Sdoc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/perspectives/cluster/{cluster_id}/details": { "patch": { "tags": ["perspectives"], "summary": "Updates the Cluster's name and description.", "operationId": "update_cluster_details", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "cluster_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cluster Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/project": { "put": { "tags": ["project"], "summary": "Creates a new Project", "operationId": "create_new_project", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/project/{proj_id}": { "get": { "tags": ["project"], "summary": "Returns the Project with the given ID if it exists", "operationId": "read_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["project"], "summary": "Updates the Project with the given ID.", "operationId": "update_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["project"], "summary": "Removes the Project with the given ID.", "operationId": "delete_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/project/{proj_id}/resolve_filename/{filename}": { "get": { "tags": ["project"], "summary": "Returns the Id of the SourceDocument identified by project_id and filename if it exists", "operationId": "resolve_filename", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "filename", "in": "path", "required": true, "schema": { "type": "string", "title": "Filename" } }, { "name": "only_finished", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Only Finished" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Project-Resolve Filename" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/project/user/projects": { "get": { "tags": ["project"], "summary": "Returns all Projects of the logged-in User", "operationId": "get_user_projects", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProjectRead" }, "type": "array", "title": "Response Project-Get User Projects" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/project{project_id}/sdoc/status/{status}": { "get": { "tags": ["project"], "summary": "Returns all Projects of the logged-in User", "operationId": "count_sdocs_with_status", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "status", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SDocStatus" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Project-Count Sdocs With Status" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projmeta": { "put": { "tags": ["projectMetadata"], "summary": "Creates a new Metadata and returns it with the generated ID.", "operationId": "create_new_metadata", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/projmeta/{metadata_id}": { "get": { "tags": ["projectMetadata"], "summary": "Returns the Metadata with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["projectMetadata"], "summary": "Updates the Metadata with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["projectMetadata"], "summary": "Deletes the Metadata with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/projmeta/project/{proj_id}": { "get": { "tags": ["projectMetadata"], "summary": "Returns all ProjectMetadata of the Project with the given ID if it exists", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectMetadataRead" }, "title": "Response Projectmetadata-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/rag/rag_session": { "post": { "tags": ["rag"], "summary": "Answer a query using Retrieval-Augmented Generation (RAG)", "operationId": "rag_session", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "top_k", "in": "query", "required": true, "schema": { "type": "integer", "title": "Top K" } }, { "name": "threshold", "in": "query", "required": true, "schema": { "type": "number", "title": "Threshold" } }, { "name": "model", "in": "query", "required": true, "schema": { "type": "string", "title": "Model" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Session Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_rag-rag_session" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/rag/chat_session": { "get": { "tags": ["rag"], "summary": "Initiate or continue a chat session with the LLM using a prompt", "operationId": "chat_session", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "model", "in": "query", "required": true, "schema": { "type": "string", "title": "Model" } }, { "name": "prompt", "in": "query", "required": true, "schema": { "type": "string", "title": "Prompt" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatSessionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/rag/models": { "get": { "tags": ["rag"], "summary": "Get all available LLM models from the LLM Provider", "operationId": "get_available_models", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Response Rag-Get Available Models" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/search_annotate/auto_annotate": { "post": { "tags": ["search_annotate"], "summary": "Returns the character & token-level positions needed for creating SpanAnnotations.", "operationId": "auto_annotate", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "title": "Query" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSpanAnnotationHits" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/sdoc_info": { "post": { "tags": ["search"], "summary": "Returns Search Info.", "operationId": "search_sdoc_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_SdocColumns_" }, "title": "Response Search-Search Sdoc Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/sdoc": { "post": { "tags": ["search"], "summary": "Returns all SourceDocument Ids and their scores and (optional) hightlights that match the query parameters.", "operationId": "search_sdocs", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "title": "Search Query" } }, { "name": "expert_mode", "in": "query", "required": true, "schema": { "type": "boolean", "title": "Expert Mode" } }, { "name": "highlight", "in": "query", "required": true, "schema": { "type": "boolean", "title": "Highlight" } }, { "name": "folder_id", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Folder Id" } }, { "name": "page_number", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page Number" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page Size" } }, { "name": "show_folders", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Show Folders" } }, { "name": "show_child_folders", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Child Folders" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search-search_sdocs" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSDocHits" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/memo_info": { "post": { "tags": ["search"], "summary": "Returns Memo Table Info.", "operationId": "search_memo_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_MemoColumns_" }, "title": "Response Search-Search Memo Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/memo": { "post": { "tags": ["search"], "summary": "Returns all Memo Ids that match the query parameters.", "operationId": "search_memos", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "title": "Search Query" } }, { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "search_content", "in": "query", "required": true, "schema": { "type": "boolean", "title": "Search Content" } }, { "name": "page_number", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page Number" } }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search-search_memos" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedElasticSearchHits" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/span_annotation_info": { "post": { "tags": ["search"], "summary": "Returns SpanAnnotationSearch Info.", "operationId": "search_span_annotation_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_SpanColumns_" }, "title": "Response Search-Search Span Annotation Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/span_annotation": { "post": { "tags": ["search"], "summary": "Returns SpanAnnotationSearch.", "operationId": "search_span_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search-search_span_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationSearchResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/sentence_annotation_info": { "post": { "tags": ["search"], "summary": "Returns SentenceAnnotationSearch Info.", "operationId": "search_sentence_annotation_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_SentAnnoColumns_" }, "title": "Response Search-Search Sentence Annotation Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/sentence_annotation": { "post": { "tags": ["search"], "summary": "Returns Sentence Annotations.", "operationId": "search_sentence_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search-search_sentence_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationSearchResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/bbox_annotation_info": { "post": { "tags": ["search"], "summary": "Returns BBoxAnnotationSearch Info.", "operationId": "search_bbox_annotation_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_BBoxColumns_" }, "title": "Response Search-Search Bbox Annotation Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/search/bbox_annotation": { "post": { "tags": ["search"], "summary": "Returns BBoxAnnotationSearchResult.", "operationId": "search_bbox_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search-search_bbox_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BBoxAnnotationSearchResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sentence": { "put": { "tags": ["sentenceAnnotation"], "summary": "Creates a SentenceAnnotation", "operationId": "add_sentence_annotation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/sentence/bulk/create": { "put": { "tags": ["sentenceAnnotation"], "summary": "Creates SentenceAnnotations in Bulk", "operationId": "add_sentence_annotations_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SentenceAnnotationCreate" }, "type": "array", "title": "Sentence Annotations" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array", "title": "Response Sentenceannotation-Add Sentence Annotations Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/sentence/{sentence_anno_id}": { "get": { "tags": ["sentenceAnnotation"], "summary": "Returns the SentenceAnnotation with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sentence_anno_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sentence Anno Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["sentenceAnnotation"], "summary": "Updates the SentenceAnnotation with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sentence_anno_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sentence Anno Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["sentenceAnnotation"], "summary": "Deletes the SentenceAnnotation with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sentence_anno_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sentence Anno Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sentence/sdoc/{sdoc_id}/user/{user_id}": { "get": { "tags": ["sentenceAnnotation"], "summary": "Returns all SentenceAnnotations of the User for the SourceDocument", "operationId": "get_by_sdoc_and_user", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentenceAnnotatorResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sentence/bulk/update": { "patch": { "tags": ["sentenceAnnotation"], "summary": "Updates SentenceAnnotation in Bulk", "operationId": "update_sent_anno_annotations_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SentenceAnnotationUpdateBulk" }, "type": "array", "title": "Sent Annos" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array", "title": "Response Sentenceannotation-Update Sent Anno Annotations Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/sentence/bulk/delete": { "delete": { "tags": ["sentenceAnnotation"], "summary": "Deletes all SentenceAnnotations with the given IDs.", "operationId": "delete_bulk_by_id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array", "title": "Sentence Anno Ids" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array", "title": "Response Sentenceannotation-Delete Bulk By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/sentence/code/{code_id}/user": { "get": { "tags": ["sentenceAnnotation"], "summary": "Returns SentenceAnnotations with the given Code of the logged-in User", "operationId": "get_by_user_code", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "title": "Response Sentenceannotation-Get By User Code" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sentence/count_annotations/{user_id}": { "post": { "tags": ["sentenceAnnotation"], "summary": "Counts the SentenceAnnotations of the User (by user_id) per Codes (by class_ids) in Documents (by sdoc_ids)", "operationId": "count_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_sentenceAnnotation-count_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Sentenceannotation-Count Annotations" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/simsearch/sentences": { "post": { "tags": ["simsearch"], "summary": "Returns similar sentences according to a textual or visual query.", "operationId": "find_similar_sentences", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "top_k", "in": "query", "required": true, "schema": { "type": "integer", "title": "Top K" } }, { "name": "threshold", "in": "query", "required": true, "schema": { "type": "number", "title": "Threshold" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_simsearch-find_similar_sentences" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimSearchSentenceHit" }, "title": "Response Simsearch-Find Similar Sentences" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/simsearch/images": { "post": { "tags": ["simsearch"], "summary": "Returns similar images according to a textual or visual query.", "operationId": "find_similar_images", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "top_k", "in": "query", "required": true, "schema": { "type": "integer", "title": "Top K" } }, { "name": "threshold", "in": "query", "required": true, "schema": { "type": "number", "title": "Threshold" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_simsearch-find_similar_images" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimSearchImageHit" }, "title": "Response Simsearch-Find Similar Images" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdoc/{sdoc_id}": { "get": { "tags": ["sourceDocument"], "summary": "Returns the SourceDocument with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "only_if_finished", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Only If Finished" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["sourceDocument"], "summary": "Removes the SourceDocument with the given ID if it exists", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["sourceDocument"], "summary": "Updates the SourceDocument with the given ID.", "operationId": "update_sdoc", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdoc/data/{sdoc_id}": { "get": { "tags": ["sourceDocument"], "summary": "Returns the SourceDocumentData with the given ID if it exists", "operationId": "get_by_id_with_data", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "only_if_finished", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Only If Finished" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentDataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdoc/{sdoc_id}/same_folder": { "get": { "tags": ["sourceDocument"], "summary": "Returns the ids of SourceDocuments in the same folder as the SourceDocument with the given id.", "operationId": "get_same_folder_sdocs", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Response Sourcedocument-Get Same Folder Sdocs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdoc/{sdoc_id}/url": { "get": { "tags": ["sourceDocument"], "summary": "Returns the URL to the original file of the SourceDocument with the given ID if it exists.", "operationId": "get_file_url", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "relative", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Relative" } }, { "name": "webp", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Webp" } }, { "name": "thumbnail", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Thumbnail" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Sourcedocument-Get File Url" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdoc/{sdoc_id}/annotators": { "get": { "tags": ["sourceDocument"], "summary": "Returns IDs of users that annotated that SourceDocument.", "operationId": "get_annotators", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Response Sourcedocument-Get Annotators" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdocmeta/{metadata_id}": { "get": { "tags": ["sdocMetadata"], "summary": "Returns the Metadata with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["sdocMetadata"], "summary": "Updates the Metadata with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentMetadataUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["sdocMetadata"], "summary": "Deletes the Metadata with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "metadata_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Metadata Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdocmeta/sdoc/{sdoc_id}": { "get": { "tags": ["sdocMetadata"], "summary": "Returns all SourceDocumentMetadata of the SourceDocument with the given ID if it exists", "operationId": "get_by_sdoc", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" }, "title": "Response Sdocmetadata-Get By Sdoc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdocmeta/sdoc/{sdoc_id}/metadata/{metadata_key}": { "get": { "tags": ["sdocMetadata"], "summary": "Returns the SourceDocumentMetadata with the given Key if it exists.", "operationId": "get_by_sdoc_and_key", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "metadata_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Metadata Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sdocmeta/bulk/update": { "patch": { "tags": ["sdocMetadata"], "summary": "Updates multiple metadata objects at once.", "operationId": "update_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SourceDocumentMetadataBulkUpdate" }, "type": "array", "title": "Metadatas" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SourceDocumentMetadataRead" }, "type": "array", "title": "Response Sdocmetadata-Update Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/span": { "put": { "tags": ["spanAnnotation"], "summary": "Creates a SpanAnnotation", "operationId": "add_span_annotation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/span/bulk/create": { "put": { "tags": ["spanAnnotation"], "summary": "Creates SpanAnnotations in Bulk", "operationId": "add_span_annotations_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpanAnnotationCreate" }, "type": "array", "title": "Spans" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "type": "array", "title": "Response Spanannotation-Add Span Annotations Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/span/{span_id}": { "get": { "tags": ["spanAnnotation"], "summary": "Returns the SpanAnnotation with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["spanAnnotation"], "summary": "Updates the SpanAnnotation with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["spanAnnotation"], "summary": "Deletes the SpanAnnotation with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationDeleted" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/span/sdoc/{sdoc_id}/user/{user_id}": { "get": { "tags": ["spanAnnotation"], "summary": "Returns all SpanAnnotations of the User for the SourceDocument", "operationId": "get_by_sdoc_and_user", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "title": "Response Spanannotation-Get By Sdoc And User" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/span/bulk/update": { "patch": { "tags": ["spanAnnotation"], "summary": "Updates SpanAnnotations in Bulk", "operationId": "update_span_annotations_bulk", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpanAnnotationUpdateBulk" }, "type": "array", "title": "Spans" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "type": "array", "title": "Response Spanannotation-Update Span Annotations Bulk" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/span/bulk/delete": { "delete": { "tags": ["spanAnnotation"], "summary": "Deletes all SpanAnnotations with the given IDs.", "operationId": "delete_bulk_by_id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array", "title": "Span Anno Ids" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SpanAnnotationDeleted" }, "type": "array", "title": "Response Spanannotation-Delete Bulk By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/span/{span_id}/groups": { "get": { "tags": ["spanAnnotation"], "summary": "Returns all SpanGroups that contain the the SpanAnnotation.", "operationId": "get_all_groups", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanGroupRead" }, "title": "Response Spanannotation-Get All Groups" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["spanAnnotation"], "summary": "Removes the SpanAnnotation from all SpanGroups", "operationId": "remove_from_all_groups", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationDeleted" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/span/{span_id}/group/{group_id}": { "patch": { "tags": ["spanAnnotation"], "summary": "Adds the SpanAnnotation to the SpanGroup", "operationId": "add_to_group", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } }, { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["spanAnnotation"], "summary": "Removes the SpanAnnotation from the SpanGroup", "operationId": "remove_from_group", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Id" } }, { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanAnnotationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/span/code/{code_id}/user": { "get": { "tags": ["spanAnnotation"], "summary": "Returns SpanAnnotations with the given Code of the logged-in User", "operationId": "get_by_user_code", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Code Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "title": "Response Spanannotation-Get By User Code" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/span/count_annotations/{user_id}": { "post": { "tags": ["spanAnnotation"], "summary": "Counts the SpanAnnotations of the User (by user_id) per Codes (by class_ids) in Documents (by sdoc_ids)", "operationId": "count_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_spanAnnotation-count_annotations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Spanannotation-Count Annotations" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/spangroup": { "put": { "tags": ["spanGroup"], "summary": "Creates a new SpanGroup and returns it with the generated ID.", "operationId": "create_new_span_group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanGroupCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/SpanGroupRead" }, { "type": "null" }], "title": "Response Spangroup-Create New Span Group" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/spangroup/{span_group_id}": { "get": { "tags": ["spanGroup"], "summary": "Returns the SpanGroup with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/SpanGroupRead" }, { "type": "null" }], "title": "Response Spangroup-Get By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["spanGroup"], "summary": "Updates the SpanGroup with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpanGroupUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/SpanGroupRead" }, { "type": "null" }], "title": "Response Spangroup-Update By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["spanGroup"], "summary": "Deletes the SpanGroup with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/SpanGroupRead" }, { "type": "null" }], "title": "Response Spangroup-Delete By Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/spangroup/{span_group_id}/span_annotations": { "get": { "tags": ["spanGroup"], "summary": "Returns all SpanAnnotations in the SpanGroup with the given ID if it exists", "operationId": "get_annotations", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "span_group_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Span Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "title": "Response Spangroup-Get Annotations" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/spangroup/sdoc/{sdoc_id}": { "get": { "tags": ["spanGroup"], "summary": "Returns all SpanGroups of the logged-in User if it exists", "operationId": "get_by_sdoc", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } }, { "name": "skip", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer", "maximum": 10000000, "minimum": 0 }, { "type": "null" }], "title": "Skip", "description": "The number of elements to skip (offset)" }, "description": "The number of elements to skip (offset)" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer", "maximum": 1000, "minimum": 1 }, { "type": "null" }], "title": "Limit", "description": "The maximum number of returned elements" }, "description": "The maximum number of returned elements" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanGroupRead" }, "title": "Response Spangroup-Get By Sdoc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/spangroup/sdoc/{sdoc}/user/{user_id}": { "get": { "tags": ["spanGroup"], "summary": "Returns all SpanGroupWithAnnotations of the User in the sDoc", "operationId": "get_by_sdoc_and_user", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } }, { "name": "sdoc_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanGroupWithAnnotationsRead" }, "title": "Response Spangroup-Get By Sdoc And User" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/statistics/code": { "post": { "tags": ["statistics"], "summary": "Returns SpanEntityStats for the given SourceDocuments.", "operationId": "filter_code_stats", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "code_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Code Id" } }, { "name": "sort_by_global", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Sort By Global" } }, { "name": "top_k", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Top K" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpanEntityStat" }, "title": "Response Statistics-Filter Code Stats" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/statistics/keyword": { "post": { "tags": ["statistics"], "summary": "Returns KeywordStats for the given SourceDocuments.", "operationId": "filter_keyword_stats", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "sort_by_global", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Sort By Global" } }, { "name": "top_k", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Top K" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordStat" }, "title": "Response Statistics-Filter Keyword Stats" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/statistics/tag": { "post": { "tags": ["statistics"], "summary": "Returns Stat for the given SourceDocuments.", "operationId": "filter_tag_stats", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sort_by_global", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Sort By Global" } }, { "name": "top_k", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Top K" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagStat" }, "title": "Response Statistics-Filter Tag Stats" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag": { "put": { "tags": ["tag"], "summary": "Creates a new Tag and returns it with the generated ID.", "operationId": "create_new_doc_tag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/tag/bulk/link": { "patch": { "tags": ["tag"], "summary": "Links multiple Tags with the SourceDocuments and returns the number of new Links", "operationId": "link_multiple_tags", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentTagMultiLink" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Tag-Link Multiple Tags" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/tag/bulk/unlink": { "delete": { "tags": ["tag"], "summary": "Unlinks all Tags with the SourceDocuments and returns the number of removed Links.", "operationId": "unlink_multiple_tags", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceDocumentTagMultiLink" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Tag-Unlink Multiple Tags" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/tag/bulk/set": { "patch": { "tags": ["tag"], "summary": "Sets SourceDocuments' tags to the provided tags", "operationId": "set_tags_batch", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SourceDocumentTagLinks" }, "type": "array", "title": "Links" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Tag-Set Tags Batch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/tag/bulk/update": { "patch": { "tags": ["tag"], "summary": "Updates SourceDocuments' tags", "operationId": "update_tags_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_tag-update_tags_batch" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Tag-Update Tags Batch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/tag/{tag_id}": { "get": { "tags": ["tag"], "summary": "Returns the Tag with the given ID.", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tag Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["tag"], "summary": "Updates the Tag with the given ID.", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tag Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["tag"], "summary": "Deletes the Tag with the given ID.", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tag Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag/project/{proj_id}": { "get": { "tags": ["tag"], "summary": "Returns all Tags of the Project with the given ID", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRead" }, "title": "Response Tag-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag/sdoc/{sdoc_id}": { "get": { "tags": ["tag"], "summary": "Returns all TagIDs linked with the SourceDocument.", "operationId": "get_by_sdoc", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Response Tag-Get By Sdoc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag/{tag_id}/sdocs": { "get": { "tags": ["tag"], "summary": "Returns all SourceDocument IDs attached to the Tag with the given ID if it exists.", "operationId": "get_sdoc_ids_by_tag_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tag Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Response Tag-Get Sdoc Ids By Tag Id" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag/sdoc_counts/{project_id}": { "post": { "tags": ["tag"], "summary": "Returns a dict of all tag ids with their count of assigned source documents, counting only source documents in the given id list", "operationId": "get_sdoc_counts", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Sdoc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Tag-Get Sdoc Counts" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tag/count_tags/{user_id}": { "post": { "tags": ["tag"], "summary": "Counts the Tags of the User (by user_id) per Tags (by class_ids) in Documents (by sdoc_ids)", "operationId": "count_tags", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_tag-count_tags" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Tag-Count Tags" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tagrecommendation/{project_id}": { "get": { "tags": ["TagRecommendation"], "summary": "Retrieve all finished tag recommendation MLJobs.", "operationId": "get_all_tagrecommendation_jobs", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer" }, "title": "Response Tagrecommendation-Get All Tagrecommendation Jobs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tagrecommendation/job/{ml_job_id}": { "get": { "tags": ["TagRecommendation"], "summary": "Retrieve all (non-reviewed) document tag recommendations for the given ml job ID.", "operationId": "get_all_tagrecommendations_from_job", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "ml_job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ml Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRecommendationResult" }, "title": "Response Tagrecommendation-Get All Tagrecommendations From Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tagrecommendation/review_recommendations": { "patch": { "tags": ["TagRecommendation"], "summary": "The endpoint receives IDs of wrongly and correctly tagged document recommendations and sets `is_accepted` to `true` or `false`, while setting the corresponding document tags if `true`.", "operationId": "update_recommendations", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "integer" }, "type": "array", "title": "Reviewd Recommendation Ids" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TagRecommendationLinkRead" }, "type": "array", "title": "Response Tagrecommendation-Update Recommendations" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/timelineAnalysis": { "put": { "tags": ["timelineAnalysis"], "summary": "Creates an TimelineAnalysis", "operationId": "create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/timelineAnalysis/{timeline_analysis_id}": { "get": { "tags": ["timelineAnalysis"], "summary": "Returns the TimelineAnalysis with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "timeline_analysis_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Timeline Analysis Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["timelineAnalysis"], "summary": "Updates the TimelineAnalysis with the given ID if it exists", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "timeline_analysis_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Timeline Analysis Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["timelineAnalysis"], "summary": "Removes the TimelineAnalysis with the given ID if it exists", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "timeline_analysis_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Timeline Analysis Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/timelineAnalysis/project/{project_id}": { "get": { "tags": ["timelineAnalysis"], "summary": "Returns the TimelineAnalysis of the Project with the given ID if it exists", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineAnalysisRead" }, "title": "Response Timelineanalysis-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/timelineAnalysis/recompute/{timeline_analysis_id}": { "post": { "tags": ["timelineAnalysis"], "summary": "Recomputes the TimelineAnalysis with the given ID if it exists", "operationId": "recompute_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "timeline_analysis_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Timeline Analysis Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/timelineAnalysis/duplicate/{timeline_analysis_id}": { "post": { "tags": ["timelineAnalysis"], "summary": "Duplicates the TimelineAnalysis with the given ID if it exists", "operationId": "duplicate_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "timeline_analysis_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Timeline Analysis Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineAnalysisRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/me": { "get": { "tags": ["user"], "summary": "Returns the current (logged in) user", "operationId": "get_me", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/user/by_id/{user_id}": { "get": { "tags": ["user"], "summary": "Returns the User with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUserRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/{proj_id}/user": { "get": { "tags": ["user"], "summary": "Returns all Users of the Project with the given ID", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRead" }, "title": "Response User-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["user"], "summary": "Associates an existing User to the Project with the given ID if it exists", "operationId": "associate_user_to_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAddUser" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/all": { "get": { "tags": ["user"], "summary": "Returns all Users that exist in the system", "operationId": "get_all", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "skip", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer", "maximum": 10000000, "minimum": 0 }, { "type": "null" }], "title": "Skip", "description": "The number of elements to skip (offset)" }, "description": "The number of elements to skip (offset)" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [{ "type": "integer", "maximum": 1000, "minimum": 1 }, { "type": "null" }], "title": "Limit", "description": "The maximum number of returned elements" }, "description": "The maximum number of returned elements" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUserRead" }, "title": "Response User-Get All" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user/": { "delete": { "tags": ["user"], "summary": "Removes the logged-in User", "operationId": "delete_me", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] }, "patch": { "tags": ["user"], "summary": "Updates the logged-in User", "operationId": "update_me", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/user/{proj_id}/user/{user_id}": { "delete": { "tags": ["user"], "summary": "Dissociates the Users with the Project with the given ID if it exists", "operationId": "dissociate_user_from_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "proj_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Proj Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/whiteboard": { "put": { "tags": ["whiteboard"], "summary": "Creates an Whiteboard", "operationId": "create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [{ "OAuth2PasswordBearer": [] }] } }, "/whiteboard/{whiteboard_id}": { "get": { "tags": ["whiteboard"], "summary": "Returns the Whiteboard with the given ID if it exists", "operationId": "get_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "whiteboard_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Whiteboard Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["whiteboard"], "summary": "Updates the Whiteboard with the given ID if it exists", "operationId": "update_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "whiteboard_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Whiteboard Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["whiteboard"], "summary": "Removes the Whiteboard with the given ID if it exists", "operationId": "delete_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "whiteboard_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Whiteboard Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/whiteboard/data/{whiteboard_id}": { "get": { "tags": ["whiteboard"], "summary": "Returns the Whiteboard with the given ID if it exists", "operationId": "get_data_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "whiteboard_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Whiteboard Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/whiteboard/project/{project_id}": { "get": { "tags": ["whiteboard"], "summary": "Returns the Whiteboards of the Project with the given ID", "operationId": "get_by_project", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WhiteboardRead" }, "title": "Response Whiteboard-Get By Project" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/whiteboard/duplicate/{whiteboard_id}": { "post": { "tags": ["whiteboard"], "summary": "Duplicates the Whiteboard with the given ID if it exists", "operationId": "duplicate_by_id", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "whiteboard_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Whiteboard Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhiteboardRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/word_frequency/info/{project_id}": { "get": { "tags": ["word_frequency"], "summary": "Returns WordFrequency Info.", "operationId": "word_frequency_analysis_info", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInfo_WordFrequencyColumns_" }, "title": "Response Word Frequency-Word Frequency Analysis Info" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/word_frequency/analysis": { "post": { "tags": ["word_frequency"], "summary": "Perform word frequency analysis.", "operationId": "word_frequency_analysis", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page" } }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "title": "Page Size" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_word_frequency-word_frequency_analysis" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordFrequencyResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/word_frequency/export": { "post": { "tags": ["word_frequency"], "summary": "Export the word frequency analysis.", "operationId": "word_frequency_analysis_export", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Project Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_word_frequency-word_frequency_analysis_export" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Word Frequency-Word Frequency Analysis Export" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/word_frequency/sdoc/{sdoc_id}": { "get": { "tags": ["word_frequency"], "summary": "Returns the SourceDocument's word frequencies with the given ID if it exists", "operationId": "get_word_frequencies", "security": [{ "OAuth2PasswordBearer": [] }], "parameters": [ { "name": "sdoc_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Sdoc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WordFrequencyRead" }, "title": "Response Word Frequency-Get Word Frequencies" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AddMissingDocsToAspectParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "add_missing_docs_to_aspect", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "add_missing_docs_to_aspect" } }, "type": "object", "title": "AddMissingDocsToAspectParams" }, "AnnoscalingConfirmSuggest": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project to apply suggestions" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code to apply on accepted spans" }, "reject_code_id": { "type": "integer", "title": "Reject Code Id", "description": "Code to apply on rejected spans" }, "accept": { "items": { "$ref": "#/components/schemas/SdocSentencePair" }, "type": "array", "title": "Accept", "description": "Suggested annotations to accept" }, "reject": { "items": { "$ref": "#/components/schemas/SdocSentencePair" }, "type": "array", "title": "Reject", "description": "Suggested annotations to reject" } }, "type": "object", "required": ["project_id", "code_id", "reject_code_id", "accept", "reject"], "title": "AnnoscalingConfirmSuggest" }, "AnnoscalingResult": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "sentence_id": { "type": "integer", "title": "Sentence Id", "description": "ID of the sentence within the document" }, "text": { "type": "string", "title": "Text", "description": "Sentence text" } }, "type": "object", "required": ["sdoc_id", "sentence_id", "text"], "title": "AnnoscalingResult" }, "AnnoscalingSuggest": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project to retrieve suggestions" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code to provide suggestions for" }, "reject_cide_id": { "type": "integer", "title": "Reject Cide Id", "description": "Code to use as opposing code" }, "top_k": { "type": "integer", "title": "Top K", "description": "Number of suggestions to provide" } }, "type": "object", "required": ["project_id", "code_id", "reject_cide_id", "top_k"], "title": "AnnoscalingSuggest" }, "AnnotationLLMJobResult": { "properties": { "llm_job_type": { "type": "string", "const": "ANNOTATION", "title": "Llm Job Type" }, "results": { "items": { "$ref": "#/components/schemas/AnnotationResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": ["llm_job_type", "results"], "title": "AnnotationLLMJobResult" }, "AnnotationParams": { "properties": { "llm_job_type": { "type": "string", "const": "ANNOTATION", "title": "Llm Job Type" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "IDs of the source documents to analyse" }, "code_ids": { "items": { "type": "integer" }, "type": "array", "title": "Code Ids", "description": "IDs of the codes to use for the annotation" }, "delete_existing_annotations": { "type": "boolean", "title": "Delete Existing Annotations", "description": "Delete existing annotations before creating new ones", "default": false } }, "type": "object", "required": ["llm_job_type", "sdoc_ids", "code_ids"], "title": "AnnotationParams" }, "AnnotationResult": { "properties": { "status": { "type": "string", "enum": ["error", "finished"], "title": "Status", "description": "Status of the Result" }, "status_message": { "type": "string", "title": "Status Message", "description": "Status message of the result" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "suggested_annotations": { "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "type": "array", "title": "Suggested Annotations", "description": "Suggested annotations" } }, "type": "object", "required": ["status", "status_message", "sdoc_id", "suggested_annotations"], "title": "AnnotationResult" }, "ApproachRecommendation": { "properties": { "recommended_approach": { "$ref": "#/components/schemas/ApproachType", "description": "Recommended approach" }, "reasoning": { "type": "string", "title": "Reasoning", "description": "Reasoning for the recommendation" }, "available_approaches": { "additionalProperties": { "type": "boolean" }, "propertyNames": { "$ref": "#/components/schemas/ApproachType" }, "type": "object", "title": "Available Approaches", "description": "Available approaches" } }, "type": "object", "required": ["recommended_approach", "reasoning", "available_approaches"], "title": "ApproachRecommendation" }, "ApproachType": { "type": "string", "enum": ["LLM_ZERO_SHOT", "LLM_FEW_SHOT"], "title": "ApproachType" }, "AspectCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the aspect" }, "doc_embedding_prompt": { "type": "string", "title": "Doc Embedding Prompt", "description": "Prompt for document embedding" }, "doc_modification_prompt": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Doc Modification Prompt", "description": "Prompt for document modification" }, "is_hierarchical": { "type": "boolean", "title": "Is Hierarchical", "description": "Whether the aspect is hierarchical" }, "modality": { "$ref": "#/components/schemas/DocType", "description": "Modality of the documents of this aspect" }, "pipeline_settings": { "$ref": "#/components/schemas/PipelineSettings", "description": "Pipeline settings for this aspect" }, "tag_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Tag Id", "description": "ID of the tag associated with this aspect." }, "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the project this aspect belongs to" } }, "type": "object", "required": ["name", "doc_embedding_prompt", "is_hierarchical", "modality", "pipeline_settings", "project_id"], "title": "AspectCreate" }, "AspectRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the aspect" }, "doc_embedding_prompt": { "type": "string", "title": "Doc Embedding Prompt", "description": "Prompt for document embedding" }, "doc_modification_prompt": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Doc Modification Prompt", "description": "Prompt for document modification" }, "is_hierarchical": { "type": "boolean", "title": "Is Hierarchical", "description": "Whether the aspect is hierarchical" }, "modality": { "$ref": "#/components/schemas/DocType", "description": "Modality of the documents of this aspect" }, "pipeline_settings": { "$ref": "#/components/schemas/PipelineSettings", "description": "Pipeline settings for this aspect" }, "tag_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Tag Id", "description": "ID of the tag associated with this aspect." }, "id": { "type": "integer", "title": "Id", "description": "ID of the aspect" }, "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the project this aspect belongs to" }, "most_recent_job_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Most Recent Job Id", "description": "ID of the most recent job associated with the aspect" } }, "type": "object", "required": [ "name", "doc_embedding_prompt", "is_hierarchical", "modality", "pipeline_settings", "id", "project_id" ], "title": "AspectRead" }, "AspectUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "New name of the aspect" } }, "type": "object", "title": "AspectUpdate" }, "AttachedObjectType": { "type": "string", "enum": [ "source_document", "code", "sentence_annotation", "span_annotation", "span_group", "bbox_annotation", "project", "tag" ], "title": "AttachedObjectType" }, "BBoxAnnoTimelineAnalysisFilter-Input": { "properties": { "timeline_analysis_type": { "type": "string", "const": "bbox_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_BBoxColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "BBoxAnnoTimelineAnalysisFilter" }, "BBoxAnnoTimelineAnalysisFilter-Output": { "properties": { "timeline_analysis_type": { "type": "string", "const": "bbox_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_BBoxColumns_-Output", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "BBoxAnnoTimelineAnalysisFilter" }, "BBoxAnnotationCreate": { "properties": { "x_min": { "type": "integer", "title": "X Min", "description": "Absolute x_min coordinate of the BBoxAnnotation" }, "x_max": { "type": "integer", "title": "X Max", "description": "Absolute x_max coordinate of the BBoxAnnotation" }, "y_min": { "type": "integer", "title": "Y Min", "description": "Absolute y_min coordinate of the BBoxAnnotation" }, "y_max": { "type": "integer", "title": "Y Max", "description": "Absolute y_max coordinate of the BBoxAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the BBoxAnnotation refers to" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the BBoxAnnotation refers to" } }, "type": "object", "required": ["x_min", "x_max", "y_min", "y_max", "code_id", "sdoc_id"], "title": "BBoxAnnotationCreate" }, "BBoxAnnotationNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "bboxAnnotation", "title": "Type" }, "bboxAnnotationId": { "type": "integer", "title": "Bboxannotationid", "description": "ID of the bbox annotation" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "bboxAnnotationId"], "title": "BBoxAnnotationNodeData" }, "BBoxAnnotationRead": { "properties": { "x_min": { "type": "integer", "title": "X Min", "description": "Absolute x_min coordinate of the BBoxAnnotation" }, "x_max": { "type": "integer", "title": "X Max", "description": "Absolute x_max coordinate of the BBoxAnnotation" }, "y_min": { "type": "integer", "title": "Y Min", "description": "Absolute y_min coordinate of the BBoxAnnotation" }, "y_max": { "type": "integer", "title": "Y Max", "description": "Absolute y_max coordinate of the BBoxAnnotation" }, "id": { "type": "integer", "title": "Id", "description": "ID of the BBoxAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the BBoxAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User that created the BBoxAnnotation" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the BBoxAnnotation refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the BBoxAnnotation" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the BBoxAnnotation" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "Memo IDs attached to the BBoxAnnotation" } }, "type": "object", "required": [ "x_min", "x_max", "y_min", "y_max", "id", "code_id", "user_id", "sdoc_id", "created", "updated", "memo_ids" ], "title": "BBoxAnnotationRead" }, "BBoxAnnotationRow": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the BBoxAnnotation" }, "x": { "type": "integer", "title": "X", "description": "The x-coordinate of the BBoxAnnotation." }, "y": { "type": "integer", "title": "Y", "description": "The y-coordinate of the BBoxAnnotation." }, "width": { "type": "integer", "title": "Width", "description": "The width of the BBoxAnnotation." }, "height": { "type": "integer", "title": "Height", "description": "The height of the BBoxAnnotation." }, "url": { "type": "string", "title": "Url", "description": "The url to the Image of the BBoxAnnotation." }, "code": { "$ref": "#/components/schemas/CodeRead", "description": "Code the BBoxAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the BBoxAnnotation belongs to" }, "sdoc": { "$ref": "#/components/schemas/SourceDocumentRead", "description": "SourceDocument the BBoxAnnotation refers to" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "The TagIDs of the SourceDocument." }, "memo": { "anyOf": [{ "$ref": "#/components/schemas/MemoRead" }, { "type": "null" }], "description": "The Memo of the Annotation." } }, "type": "object", "required": ["id", "x", "y", "width", "height", "url", "code", "user_id", "sdoc", "tag_ids", "memo"], "title": "BBoxAnnotationRow" }, "BBoxAnnotationSearchResult": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of bbox_annotation_ids. Used for pagination." }, "data": { "items": { "$ref": "#/components/schemas/BBoxAnnotationRow" }, "type": "array", "title": "Data", "description": "The Annotations." } }, "type": "object", "required": ["total_results", "data"], "title": "BBoxAnnotationSearchResult" }, "BBoxAnnotationUpdate": { "properties": { "code_id": { "type": "integer", "title": "Code Id", "description": "Code the BBoxAnnotation refers to" } }, "type": "object", "required": ["code_id"], "title": "BBoxAnnotationUpdate" }, "BBoxAnnotationUpdateBulk": { "properties": { "bbox_annotation_id": { "type": "integer", "title": "Bbox Annotation Id", "description": "ID of the BBoxAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the BBoxAnnotation refers to" } }, "type": "object", "required": ["bbox_annotation_id", "code_id"], "title": "BBoxAnnotationUpdateBulk" }, "BBoxColumns": { "type": "string", "enum": [ "BB_CODE_ID", "BB_MEMO_CONTENT", "BB_SOURCE_SOURCE_DOCUMENT_NAME", "BB_TAG_ID_LIST_RECURSIVE", "BB_FOLDER_ID_LIST_RECURSIVE" ], "title": "BBoxColumns" }, "Body_analysis-code_frequencies": { "properties": { "code_ids": { "items": { "type": "integer" }, "type": "array", "title": "Code Ids" }, "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids" }, "doctypes": { "items": { "$ref": "#/components/schemas/DocType" }, "type": "array", "title": "Doctypes" } }, "type": "object", "required": ["code_ids", "user_ids", "doctypes"], "title": "Body_analysis-code_frequencies" }, "Body_analysis-code_occurrences": { "properties": { "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids" }, "doctypes": { "items": { "$ref": "#/components/schemas/DocType" }, "type": "array", "title": "Doctypes" } }, "type": "object", "required": ["user_ids", "doctypes"], "title": "Body_analysis-code_occurrences" }, "Body_authentication-login": { "properties": { "grant_type": { "anyOf": [{ "type": "string", "pattern": "^password$" }, { "type": "null" }], "title": "Grant Type" }, "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "format": "password", "title": "Password" }, "scope": { "type": "string", "title": "Scope", "default": "" }, "client_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Client Id" }, "client_secret": { "anyOf": [{ "type": "string" }, { "type": "null" }], "format": "password", "title": "Client Secret" } }, "type": "object", "required": ["username", "password"], "title": "Body_authentication-login" }, "Body_classifier-compute_dataset_statistics": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids" } }, "type": "object", "required": ["sdoc_ids", "user_ids", "class_ids"], "title": "Body_classifier-compute_dataset_statistics" }, "Body_classifier-compute_dataset_statistics2": { "properties": { "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids" }, "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids" } }, "type": "object", "required": ["tag_ids", "user_ids", "class_ids"], "title": "Body_classifier-compute_dataset_statistics2" }, "Body_docprocessing-recompute_processing_step": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "settings": { "$ref": "#/components/schemas/ProcessingSettings" } }, "type": "object", "required": ["sdoc_ids", "settings"], "title": "Body_docprocessing-recompute_processing_step" }, "Body_docprocessing-upload_files": { "properties": { "settings": { "type": "string", "title": "Settings", "description": "ProcessingSettings as JSON string" }, "uploaded_files": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Uploaded Files", "description": "File(s) that get uploaded and represented by the SourceDocument(s)" } }, "type": "object", "required": ["settings", "uploaded_files"], "title": "Body_docprocessing-upload_files" }, "Body_import-start_import_job": { "properties": { "uploaded_file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Uploaded File" } }, "type": "object", "required": ["uploaded_file"], "title": "Body_import-start_import_job" }, "Body_llm-count_existing_assistant_annotations": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "code_ids": { "items": { "type": "integer" }, "type": "array", "title": "Code Ids" } }, "type": "object", "required": ["sdoc_ids", "code_ids"], "title": "Body_llm-count_existing_assistant_annotations" }, "Body_llm-create_prompt_templates": { "properties": { "llm_job_params": { "$ref": "#/components/schemas/LLMJobParameters" }, "example_ids": { "anyOf": [{ "items": { "type": "integer" }, "type": "array" }, { "type": "null" }], "title": "Example Ids" } }, "type": "object", "required": ["llm_job_params"], "title": "Body_llm-create_prompt_templates" }, "Body_perspectives-visualize_documents": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Input", "description": "The filter of the Concept" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_SdocColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_perspectives-visualize_documents" }, "Body_rag-rag_session": { "properties": { "query": { "anyOf": [{ "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "integer" }], "title": "Query" }, "sdoc_ids": { "anyOf": [{ "items": { "type": "integer" }, "type": "array" }, { "type": "null" }], "title": "Sdoc Ids" } }, "type": "object", "required": ["query", "sdoc_ids"], "title": "Body_rag-rag_session" }, "Body_search-search_bbox_annotations": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_BBoxColumns_-Input", "description": "The filter of the Concept" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_BBoxColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_search-search_bbox_annotations" }, "Body_search-search_memos": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_MemoColumns_" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_MemoColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_search-search_memos" }, "Body_search-search_sdocs": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Input", "description": "The filter of the Concept" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_SdocColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_search-search_sdocs" }, "Body_search-search_sentence_annotations": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_SentAnnoColumns_-Input", "description": "The filter of the Concept" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_SentAnnoColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_search-search_sentence_annotations" }, "Body_search-search_span_annotations": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_SpanColumns_-Input", "description": "The filter of the Concept" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_SpanColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_search-search_span_annotations" }, "Body_sentenceAnnotation-count_annotations": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids" } }, "type": "object", "required": ["sdoc_ids", "class_ids"], "title": "Body_sentenceAnnotation-count_annotations" }, "Body_simsearch-find_similar_images": { "properties": { "query": { "anyOf": [{ "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "integer" }], "title": "Query" }, "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["query", "filter"], "title": "Body_simsearch-find_similar_images" }, "Body_simsearch-find_similar_sentences": { "properties": { "query": { "anyOf": [{ "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "integer" }], "title": "Query" }, "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["query", "filter"], "title": "Body_simsearch-find_similar_sentences" }, "Body_spanAnnotation-count_annotations": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids" } }, "type": "object", "required": ["sdoc_ids", "class_ids"], "title": "Body_spanAnnotation-count_annotations" }, "Body_tag-count_tags": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids" } }, "type": "object", "required": ["sdoc_ids", "class_ids"], "title": "Body_tag-count_tags" }, "Body_tag-update_tags_batch": { "properties": { "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids" }, "unlink_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Unlink Tag Ids" }, "link_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Link Tag Ids" } }, "type": "object", "required": ["sdoc_ids", "unlink_tag_ids", "link_tag_ids"], "title": "Body_tag-update_tags_batch" }, "Body_word_frequency-word_frequency_analysis": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_WordFrequencyColumns_" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_WordFrequencyColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_word_frequency-word_frequency_analysis" }, "Body_word_frequency-word_frequency_analysis_export": { "properties": { "filter": { "$ref": "#/components/schemas/Filter_WordFrequencyColumns_" }, "sorts": { "items": { "$ref": "#/components/schemas/Sort_WordFrequencyColumns_" }, "type": "array", "title": "Sorts" } }, "type": "object", "required": ["filter", "sorts"], "title": "Body_word_frequency-word_frequency_analysis_export" }, "BooleanOperator": { "type": "string", "enum": ["BOOLEAN_EQUALS", "BOOLEAN_NOT_EQUALS"], "title": "BooleanOperator" }, "BorderNodeData": { "properties": { "borderColor": { "type": "string", "title": "Bordercolor", "description": "Color of the border" }, "borderRadius": { "type": "string", "title": "Borderradius", "description": "Radius of the border" }, "borderWidth": { "type": "integer", "title": "Borderwidth", "description": "Width of the border" }, "borderStyle": { "$ref": "#/components/schemas/BorderStyle", "description": "Style of the border" }, "text": { "type": "string", "title": "Text", "description": "Text of the text" }, "color": { "type": "string", "title": "Color", "description": "Text color of the text" }, "horizontalAlign": { "$ref": "#/components/schemas/HorizontalAlign", "description": "Horizontal alignment of the text" }, "verticalAlign": { "$ref": "#/components/schemas/VerticalAlign", "description": "Vertical alignment of the text" }, "bold": { "type": "boolean", "title": "Bold", "description": "Boldness of the text" }, "italic": { "type": "boolean", "title": "Italic", "description": "Italicness of the text" }, "underline": { "type": "boolean", "title": "Underline", "description": "Underlinedness of the text" }, "strikethrough": { "type": "boolean", "title": "Strikethrough", "description": "Strikethroughness of the text" }, "fontSize": { "type": "integer", "title": "Fontsize", "description": "Font size of the text" }, "fontFamily": { "type": "string", "title": "Fontfamily", "description": "Font family of the text" }, "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "border", "title": "Type" } }, "type": "object", "required": [ "borderColor", "borderRadius", "borderWidth", "borderStyle", "text", "color", "horizontalAlign", "verticalAlign", "bold", "italic", "underline", "strikethrough", "fontSize", "fontFamily", "bgcolor", "bgalpha", "type" ], "title": "BorderNodeData" }, "BorderStyle": { "type": "string", "enum": ["solid", "dashed", "dotted"], "title": "BorderStyle" }, "COTAConcept": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the Concept" }, "name": { "type": "string", "title": "Name", "description": "Name of the Concept" }, "description": { "type": "string", "title": "Description", "description": "Description of the Concept" }, "color": { "type": "string", "title": "Color", "description": "Color of the Concept" }, "visible": { "type": "boolean", "title": "Visible", "description": "Visibility of the Concept" } }, "type": "object", "required": ["id", "name", "description", "color", "visible"], "title": "COTAConcept" }, "COTACreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the ConceptOverTimeAnalysis" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the ConceptOverTimeAnalysis belongs to" } }, "type": "object", "required": ["name", "project_id"], "title": "COTACreate" }, "COTARead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the ConceptOverTimeAnalysis" }, "id": { "type": "integer", "title": "Id", "description": "ID of the ConceptOverTimeAnalysis" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the ConceptOverTimeAnalysis belongs to" }, "last_refinement_job_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Last Refinement Job Id", "description": "ID of the last refinement job for the ConceptOverTimeAnalysis" }, "timeline_settings": { "$ref": "#/components/schemas/COTATimelineSettings", "description": "Timeline Analysis Settings of the ConceptOverTimeAnalysis." }, "training_settings": { "$ref": "#/components/schemas/COTATrainingSettings", "description": "Timeline Training Settings of the ConceptOverTimeAnalysis." }, "concepts": { "items": { "$ref": "#/components/schemas/COTAConcept" }, "type": "array", "title": "Concepts", "description": "List of Concepts that are part of the ConceptOverTimeAnalysis" }, "search_space": { "items": { "$ref": "#/components/schemas/COTASentence" }, "type": "array", "title": "Search Space", "description": "List of Sentences that form the search space of the ConceptOverTimeAnalysis" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the ConceptOverTimeAnalysis" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the ConceptOverTimeAnalysis" } }, "type": "object", "required": [ "name", "id", "project_id", "last_refinement_job_id", "timeline_settings", "training_settings", "concepts", "search_space", "created", "updated" ], "title": "COTARead" }, "COTARefinementHyperparameters": { "properties": { "cem_training_epochs": { "type": "integer", "title": "Cem Training Epochs", "description": "Number of epochs to train the Concept Embedding Model", "default": 10 }, "cem_dimensions": { "type": "integer", "title": "Cem Dimensions", "description": "Number of dimensions of the Concept Embedding Model", "default": 64 } }, "type": "object", "title": "COTARefinementHyperparameters" }, "COTARefinementJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "cota_id": { "type": "integer", "title": "Cota Id", "description": "ID of the COTA that is used in the COTARefinementJob" }, "hyperparams": { "$ref": "#/components/schemas/COTARefinementHyperparameters", "description": "Hyperparameters of the COTARefinementJob", "default": { "cem_training_epochs": 10, "cem_dimensions": 64 } } }, "type": "object", "required": ["project_id", "cota_id"], "title": "COTARefinementJobInput" }, "COTARefinementJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/COTARefinementJobInput", "description": "Input for the job" }, "output": { "type": "null", "title": "Output", "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "COTARefinementJobRead" }, "COTASentence": { "properties": { "sentence_id": { "type": "integer", "title": "Sentence Id", "description": "ID of the Sentence in the SDoc" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the Sentence Document that contains the Sentence" }, "concept_similarities": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Concept Similarities", "description": "Dictionary of Concept IDs and their similarity score" }, "concept_probabilities": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Concept Probabilities", "description": "Dictionary of Concept IDs and their probability score" }, "concept_annotation": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Concept Annotation", "description": "Concept ID this sentence belongs to" }, "x": { "type": "number", "title": "X", "description": "X coordinate of the Sentence in the search space" }, "y": { "type": "number", "title": "Y", "description": "Y coordinate of the Sentence in the search space" }, "date": { "type": "string", "format": "date-time", "title": "Date", "description": "date of the sdoc" }, "text": { "type": "string", "title": "Text", "description": "text of the sentence" } }, "type": "object", "required": [ "sentence_id", "sdoc_id", "concept_similarities", "concept_probabilities", "concept_annotation", "x", "y", "date", "text" ], "title": "COTASentence" }, "COTASentenceID": { "properties": { "sentence_id": { "type": "integer", "title": "Sentence Id", "description": "ID of the Sentence in the SDoc" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the Sentence Document that contains the Sentence" } }, "type": "object", "required": ["sentence_id", "sdoc_id"], "title": "COTASentenceID" }, "COTATimelineSettings": { "properties": { "group_by": { "$ref": "#/components/schemas/DateGroupBy", "description": "Group by date", "default": "YEAR" }, "date_metadata_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Date Metadata Id", "description": "ID of the Project Date Metadata that is used for the ConceptOverTimeAnalysis" }, "threshold": { "type": "number", "title": "Threshold", "description": "Threshold of the ConceptOverTimeAnalysis", "default": 0.9 } }, "type": "object", "title": "COTATimelineSettings" }, "COTATrainingSettings": { "properties": { "search_space_topk": { "type": "integer", "title": "Search Space Topk", "description": "Number of sentences to use as search space per concept.", "default": 1000 }, "search_space_threshold": { "type": "number", "title": "Search Space Threshold", "description": "Threshold to filter sentences from the search space.", "default": 0.8 }, "min_required_annotations_per_concept": { "type": "integer", "title": "Min Required Annotations Per Concept", "description": "Minimum number of annotations per concept required to train the CEM.", "default": 5 }, "dimensionality_reduction_algorithm": { "$ref": "#/components/schemas/DimensionalityReductionAlgorithm", "description": "Dimensionality Reduction Algorithm used for the ConceptOverTimeAnalysis", "default": "umap" }, "layers": { "type": "integer", "title": "Layers", "description": "Number of layers of the CEM.", "default": 5 }, "dimensions": { "type": "integer", "title": "Dimensions", "description": "Number of dimensions of the CEM.", "default": 64 }, "epochs": { "type": "integer", "title": "Epochs", "description": "Number of epochs to train", "default": 5 } }, "type": "object", "title": "COTATrainingSettings" }, "COTAUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name of the ConceptOverTimeAnalysis" }, "timeline_settings": { "anyOf": [{ "$ref": "#/components/schemas/COTATimelineSettings" }, { "type": "null" }], "description": "Timeline Settings of the ConceptOverTimeAnalysis." }, "training_settings": { "anyOf": [{ "$ref": "#/components/schemas/COTATrainingSettings" }, { "type": "null" }], "description": "Training Settings of the ConceptOverTimeAnalysis." }, "concepts": { "anyOf": [{ "items": { "$ref": "#/components/schemas/COTAConcept" }, "type": "array" }, { "type": "null" }], "title": "Concepts", "description": "List of Concepts that are part of the ConceptOverTimeAnalysis" } }, "type": "object", "title": "COTAUpdate" }, "ChangeClusterParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "change_cluster", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "change_cluster" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "List of source document IDs to change the cluster for." }, "cluster_id": { "type": "integer", "title": "Cluster Id", "description": "ID of the cluster to change to. (-1 will be treated as 'removing' the documents / marking them as outliers)" } }, "type": "object", "required": ["sdoc_ids", "cluster_id"], "title": "ChangeClusterParams" }, "ChatSessionResponse": { "properties": { "response": { "type": "string", "title": "Response", "description": "The response of the model" }, "session_id": { "type": "string", "title": "Session Id", "description": "The session ID of the chat" } }, "type": "object", "required": ["response", "session_id"], "title": "ChatSessionResponse" }, "ClassifierData": { "properties": { "class_id": { "type": "integer", "title": "Class Id", "description": "ID of the class (tag or code)" }, "num_examples": { "type": "integer", "title": "Num Examples", "description": "Number of examples for the class (tag or code)" } }, "type": "object", "required": ["class_id", "num_examples"], "title": "ClassifierData" }, "ClassifierEvaluationOutput": { "properties": { "task_type": { "type": "string", "const": "evaluation", "title": "Task Type" }, "evaluation": { "$ref": "#/components/schemas/ClassifierEvaluationRead", "description": "The Classifier Evaluation" } }, "type": "object", "required": ["task_type", "evaluation"], "title": "ClassifierEvaluationOutput" }, "ClassifierEvaluationParams": { "properties": { "task_type": { "type": "string", "const": "evaluation", "title": "Task Type" }, "classifier_id": { "type": "integer", "title": "Classifier Id", "description": "ID of the model to evaluate" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "List of Tag IDs to evaluate on" }, "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids", "description": "User IDs whose annotations serve as gold labels" } }, "type": "object", "required": ["task_type", "classifier_id", "tag_ids", "user_ids"], "title": "ClassifierEvaluationParams" }, "ClassifierEvaluationRead": { "properties": { "classifier_id": { "type": "integer", "title": "Classifier Id", "description": "ID of the Classifier" }, "f1": { "type": "number", "title": "F1", "description": "F1 score" }, "precision": { "type": "number", "title": "Precision", "description": "Precision score" }, "recall": { "type": "number", "title": "Recall", "description": "Recall score" }, "accuracy": { "type": "number", "title": "Accuracy", "description": "Accuracy score" }, "eval_data_stats": { "items": { "$ref": "#/components/schemas/ClassifierData" }, "type": "array", "title": "Eval Data Stats", "description": "Evaluation data statistics" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Classifier Evaluation" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Creation timestamp of the classifier" } }, "type": "object", "required": ["classifier_id", "f1", "precision", "recall", "accuracy", "eval_data_stats", "id", "created"], "title": "ClassifierEvaluationRead" }, "ClassifierInferenceOutput": { "properties": { "task_type": { "type": "string", "const": "inference", "title": "Task Type" }, "result_statistics": { "items": { "$ref": "#/components/schemas/ClassifierData" }, "type": "array", "title": "Result Statistics", "description": "Statistics of the inference results" }, "total_affected_docs": { "type": "integer", "title": "Total Affected Docs", "description": "Number of SourceDocuments successfully affected by the classifier" } }, "type": "object", "required": ["task_type", "result_statistics", "total_affected_docs"], "title": "ClassifierInferenceOutput" }, "ClassifierInferenceParams": { "properties": { "task_type": { "type": "string", "const": "inference", "title": "Task Type" }, "classifier_id": { "type": "integer", "title": "Classifier Id", "description": "ID of the model to use for inference" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "List of SourceDocument IDs to apply the classifier on" }, "delete_existing_work": { "type": "boolean", "title": "Delete Existing Work", "description": "Delete existing span/sent annotations or tags before creating new ones" } }, "type": "object", "required": ["task_type", "classifier_id", "sdoc_ids", "delete_existing_work"], "title": "ClassifierInferenceParams" }, "ClassifierJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "task_type": { "$ref": "#/components/schemas/ClassifierTask", "description": "The type of the Classifier Task" }, "model_type": { "$ref": "#/components/schemas/ClassifierModel", "description": "The type of the Classifier Model" }, "task_parameters": { "oneOf": [ { "$ref": "#/components/schemas/ClassifierTrainingParams" }, { "$ref": "#/components/schemas/ClassifierEvaluationParams" }, { "$ref": "#/components/schemas/ClassifierInferenceParams" } ], "title": "Task Parameters", "description": "Specific parameters for the ClassifierJob w.r.t it's type", "discriminator": { "propertyName": "task_type", "mapping": { "evaluation": "#/components/schemas/ClassifierEvaluationParams", "inference": "#/components/schemas/ClassifierInferenceParams", "training": "#/components/schemas/ClassifierTrainingParams" } } } }, "type": "object", "required": ["project_id", "task_type", "model_type", "task_parameters"], "title": "ClassifierJobInput" }, "ClassifierJobOutput": { "properties": { "task_type": { "$ref": "#/components/schemas/ClassifierTask", "description": "The type of the ClassifierJob" }, "task_output": { "oneOf": [ { "$ref": "#/components/schemas/ClassifierTrainingOutput" }, { "$ref": "#/components/schemas/ClassifierEvaluationOutput" }, { "$ref": "#/components/schemas/ClassifierInferenceOutput" } ], "title": "Task Output", "description": "Specific outputs for the ClassifierJob w.r.t it's type", "discriminator": { "propertyName": "task_type", "mapping": { "evaluation": "#/components/schemas/ClassifierEvaluationOutput", "inference": "#/components/schemas/ClassifierInferenceOutput", "training": "#/components/schemas/ClassifierTrainingOutput" } } } }, "type": "object", "required": ["task_type", "task_output"], "title": "ClassifierJobOutput" }, "ClassifierJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/ClassifierJobInput", "description": "Input for the job" }, "output": { "anyOf": [{ "$ref": "#/components/schemas/ClassifierJobOutput" }, { "type": "null" }], "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "ClassifierJobRead" }, "ClassifierLoss": { "properties": { "step": { "type": "integer", "title": "Step", "description": "Training step" }, "value": { "type": "number", "title": "Value", "description": "Loss value" } }, "type": "object", "required": ["step", "value"], "title": "ClassifierLoss" }, "ClassifierModel": { "type": "string", "enum": ["document", "sentence", "span"], "title": "ClassifierModel" }, "ClassifierRead": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the project this classifier belongs to" }, "name": { "type": "string", "title": "Name", "description": "Name of the classifier" }, "base_model": { "type": "string", "title": "Base Model", "description": "Name of the base model" }, "type": { "$ref": "#/components/schemas/ClassifierModel", "description": "Type of the classifier" }, "path": { "type": "string", "title": "Path", "description": "Name of the classifier" }, "labelid2classid": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Labelid2Classid", "description": "Mapping from internal model label id to code/tag id, depending on ClassifierModel." }, "train_params": { "additionalProperties": true, "type": "object", "title": "Train Params", "description": "Training parameters" }, "train_loss": { "items": { "$ref": "#/components/schemas/ClassifierLoss" }, "type": "array", "title": "Train Loss", "description": "Training loss per step" }, "train_data_stats": { "items": { "$ref": "#/components/schemas/ClassifierData" }, "type": "array", "title": "Train Data Stats", "description": "Training data stats" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Classifier" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Creation timestamp of the classifier" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Update timestamp of the classifier" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids", "description": "List of class IDs the classifier was trained with (tag or code)" }, "evaluations": { "items": { "$ref": "#/components/schemas/ClassifierEvaluationRead" }, "type": "array", "title": "Evaluations", "description": "List of evaluations for the classifier" } }, "type": "object", "required": [ "project_id", "name", "base_model", "type", "path", "labelid2classid", "train_params", "train_loss", "train_data_stats", "id", "created", "updated", "class_ids", "evaluations" ], "title": "ClassifierRead" }, "ClassifierTask": { "type": "string", "enum": ["training", "evaluation", "inference"], "title": "ClassifierTask" }, "ClassifierTrainingOutput": { "properties": { "task_type": { "type": "string", "const": "training", "title": "Task Type" }, "classifier": { "$ref": "#/components/schemas/ClassifierRead", "description": "The trained Classifier" } }, "type": "object", "required": ["task_type", "classifier"], "title": "ClassifierTrainingOutput" }, "ClassifierTrainingParams": { "properties": { "task_type": { "type": "string", "const": "training", "title": "Task Type" }, "classifier_name": { "type": "string", "title": "Classifier Name", "description": "Name of the model to train" }, "base_name": { "type": "string", "title": "Base Name", "description": "Name of the base model" }, "adapter_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Adapter Name", "description": "Name of the adapter to use (if any)" }, "class_ids": { "items": { "type": "integer" }, "type": "array", "title": "Class Ids", "description": "List of class IDs to train on (tag or code)" }, "user_ids": { "items": { "type": "integer" }, "type": "array", "title": "User Ids", "description": "List of user IDs to train on" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "List of Tag IDs to train on" }, "merge_children_into_parent": { "type": "boolean", "title": "Merge Children Into Parent", "description": "Merge child codes in parent code?" }, "epochs": { "type": "integer", "title": "Epochs", "description": "Number of epochs to train for" }, "batch_size": { "type": "integer", "title": "Batch Size", "description": "Batch size to use for training" }, "early_stopping": { "type": "boolean", "title": "Early Stopping", "description": "Whether to use early stopping" }, "learning_rate": { "type": "number", "title": "Learning Rate", "description": "Learning rate to use for training" }, "weight_decay": { "type": "number", "title": "Weight Decay", "description": "Weight decay to use for training" }, "dropout": { "type": "number", "title": "Dropout", "description": "Dropout rate to use in the model" }, "chunk_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Chunk Size", "description": "Slice long documents into chunks of size x" }, "precision": { "anyOf": [ { "type": "integer", "enum": [64, 32, 16] }, { "type": "string", "enum": [ "transformer-engine", "transformer-engine-float16", "16-true", "16-mixed", "bf16-true", "bf16-mixed", "32-true", "64-true" ] }, { "type": "string", "enum": ["64", "32", "16", "bf16"] }, { "type": "null" } ], "title": "Precision", "description": "Precision, e.g. 32-true, 16-mixed, 16-true, bf16-true, bf16-mixed" }, "is_bio": { "type": "boolean", "title": "Is Bio", "description": "Whether to use BIO or IO tagging" } }, "type": "object", "required": [ "task_type", "classifier_name", "base_name", "adapter_name", "class_ids", "user_ids", "tag_ids", "merge_children_into_parent", "epochs", "batch_size", "early_stopping", "learning_rate", "weight_decay", "dropout", "chunk_size", "precision", "is_bio" ], "title": "ClassifierTrainingParams" }, "ClassifierUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Updated name of the classifier" } }, "type": "object", "title": "ClassifierUpdate" }, "ClusterCreate": { "properties": { "parent_cluster_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Cluster Id", "description": "ID of the parent cluster, if any" }, "aspect_id": { "type": "integer", "title": "Aspect Id", "description": "ID of the aspect this cluster belongs to" }, "level": { "type": "integer", "title": "Level", "description": "Hierarchical level of the cluster" }, "name": { "type": "string", "title": "Name", "description": "Name of the cluster" }, "description": { "type": "string", "title": "Description", "description": "Description of the cluster" } }, "type": "object", "required": ["aspect_id", "level", "name", "description"], "title": "ClusterCreate" }, "ClusterRead": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the cluster" }, "aspect_id": { "type": "integer", "title": "Aspect Id", "description": "ID of the aspect this cluster belongs to" }, "parent_cluster_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Cluster Id", "description": "ID of the parent cluster, if any" }, "is_outlier": { "type": "boolean", "title": "Is Outlier", "description": "Whether the cluster is an outlier" }, "name": { "type": "string", "title": "Name", "description": "Name of the cluster" }, "description": { "type": "string", "title": "Description", "description": "Description of the cluster" }, "level": { "type": "integer", "title": "Level", "description": "Hierarchical level of the cluster" }, "x": { "type": "number", "title": "X", "description": "X coordinate for visualization" }, "y": { "type": "number", "title": "Y", "description": "Y coordinate for visualization" }, "top_words": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Top Words", "description": "Top words associated with the cluster" }, "top_word_scores": { "anyOf": [{ "items": { "type": "number" }, "type": "array" }, { "type": "null" }], "title": "Top Word Scores", "description": "Scores of the top words" }, "top_docs": { "anyOf": [{ "items": { "type": "integer" }, "type": "array" }, { "type": "null" }], "title": "Top Docs", "description": "IDs of top documents for the cluster" } }, "type": "object", "required": [ "id", "aspect_id", "parent_cluster_id", "is_outlier", "name", "description", "level", "x", "y", "top_words", "top_word_scores", "top_docs" ], "title": "ClusterRead" }, "ClusterUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "New name of the cluster" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "New description of the cluster" } }, "type": "object", "title": "ClusterUpdate" }, "CodeCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the Code" }, "color": { "type": "string", "title": "Color", "description": "Color of the Code" }, "description": { "type": "string", "title": "Description", "description": "Description of the Code", "default": "" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Code" }, "enabled": { "type": "boolean", "title": "Enabled", "description": "While false, the code is neither created in pre-processing nor shown in the UI (except in settings to enable it again)", "default": true }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Code belongs to" }, "is_system": { "type": "boolean", "title": "Is System", "description": "Is the Code a system code" } }, "type": "object", "required": ["name", "project_id", "is_system"], "title": "CodeCreate" }, "CodeFrequency": { "properties": { "code_id": { "type": "integer", "title": "Code Id", "description": "The id of the code." }, "count": { "type": "integer", "title": "Count", "description": "The number of occurrences of the code." }, "child_count": { "type": "integer", "title": "Child Count", "description": "The number of occurrences of all child codes of the code." }, "total_count": { "type": "integer", "title": "Total Count", "description": "The total number of occurrences of the code and all its child codes." } }, "type": "object", "required": ["code_id", "count", "child_count", "total_count"], "title": "CodeFrequency" }, "CodeNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "code", "title": "Type" }, "codeId": { "type": "integer", "title": "Codeid", "description": "ID of the code" }, "parentCodeId": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parentcodeid", "description": "ID of the parent code" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "codeId"], "title": "CodeNodeData" }, "CodeOccurrence": { "properties": { "sdoc": { "$ref": "#/components/schemas/SourceDocumentRead", "description": "The SourceDocument where the Code occurs." }, "code": { "$ref": "#/components/schemas/CodeRead", "description": "The occuring Code." }, "text": { "type": "string", "title": "Text", "description": "A text span of the SourceDocument annotated with the Code." }, "count": { "type": "integer", "title": "Count", "description": "The number of occurrences of the text span annotated with the Code in the SourceDocument." } }, "type": "object", "required": ["sdoc", "code", "text", "count"], "title": "CodeOccurrence" }, "CodeRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the Code" }, "color": { "type": "string", "title": "Color", "description": "Color of the Code" }, "description": { "type": "string", "title": "Description", "description": "Description of the Code", "default": "" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Code" }, "enabled": { "type": "boolean", "title": "Enabled", "description": "While false, the code is neither created in pre-processing nor shown in the UI (except in settings to enable it again)", "default": true }, "id": { "type": "integer", "title": "Id", "description": "ID of the Code" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Code belongs to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the Code" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the Code" }, "is_system": { "type": "boolean", "title": "Is System", "description": "Is the Code a system code" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "Memo IDs attached to the Code" } }, "type": "object", "required": ["name", "color", "id", "project_id", "created", "updated", "is_system", "memo_ids"], "title": "CodeRead" }, "CodeUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name of the Code" }, "color": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Color", "description": "Color of the Code" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the Code" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Code" }, "enabled": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Enabled", "description": "While false, the code is neither created in pre-processing nor shown in the UI (except in settings to enable it again)" } }, "type": "object", "title": "CodeUpdate" }, "ColumnInfo_BBoxColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/BBoxColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[BBoxColumns]" }, "ColumnInfo_MemoColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/MemoColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[MemoColumns]" }, "ColumnInfo_SdocColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SdocColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[SdocColumns]" }, "ColumnInfo_SentAnnoColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SentAnnoColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[SentAnnoColumns]" }, "ColumnInfo_SpanColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SpanColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[SpanColumns]" }, "ColumnInfo_WordFrequencyColumns_": { "properties": { "label": { "type": "string", "title": "Label" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/WordFrequencyColumns" }, { "type": "integer" }], "title": "Column" }, "sortable": { "type": "boolean", "title": "Sortable" }, "operator": { "$ref": "#/components/schemas/FilterOperator" }, "value": { "$ref": "#/components/schemas/FilterValueType" } }, "type": "object", "required": ["label", "column", "sortable", "operator", "value"], "title": "ColumnInfo[WordFrequencyColumns]" }, "CoreferenceResolutionParams": { "properties": { "ml_job_type": { "type": "string", "const": "COREFERENCE_RESOLUTION", "title": "Ml Job Type" }, "recompute": { "type": "boolean", "title": "Recompute", "description": "Whether to recompute already processed documents", "default": false } }, "type": "object", "required": ["ml_job_type"], "title": "CoreferenceResolutionParams" }, "CrawlerJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "The ID of the Project to import the crawled data." }, "settings": { "$ref": "#/components/schemas/ProcessingSettings", "description": "Processing settings" }, "urls": { "items": { "type": "string" }, "type": "array", "title": "Urls", "description": "List of URLs to crawl." } }, "type": "object", "required": ["project_id", "settings", "urls"], "title": "CrawlerJobInput" }, "CrawlerJobOutput": { "properties": { "crawled_data_zip": { "type": "string", "format": "path", "title": "Crawled Data Zip" } }, "type": "object", "required": ["crawled_data_zip"], "title": "CrawlerJobOutput" }, "CrawlerJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/CrawlerJobInput", "description": "Input for the job" }, "output": { "anyOf": [{ "$ref": "#/components/schemas/CrawlerJobOutput" }, { "type": "null" }], "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "CrawlerJobRead" }, "CreateAspectParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "create_aspect", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "create_aspect" } }, "type": "object", "title": "CreateAspectParams" }, "CreateClusterWithNameParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "create_cluster_with_name", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "create_cluster_with_name" }, "create_dto": { "$ref": "#/components/schemas/ClusterCreate", "description": "DTO for creating a new cluster." } }, "type": "object", "required": ["create_dto"], "title": "CreateClusterWithNameParams" }, "CreateClusterWithSdocsParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "create_cluster_with_sdocs", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "create_cluster_with_sdocs" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "List of source document IDs to include in the cluster." } }, "type": "object", "required": ["sdoc_ids"], "title": "CreateClusterWithSdocsParams" }, "DateGroupBy": { "type": "string", "enum": ["YEAR", "MONTH", "DAY"], "title": "DateGroupBy" }, "DateOperator": { "type": "string", "enum": ["DATE_EQUALS", "DATE_GT", "DATE_LT", "DATE_GTE", "DATE_LTE"], "title": "DateOperator" }, "DimensionalityReductionAlgorithm": { "type": "string", "enum": ["umap", "pca", "tsne"], "title": "DimensionalityReductionAlgorithm" }, "DocTagRecommendationParams": { "properties": { "ml_job_type": { "type": "string", "const": "TAG_RECOMMENDATION", "title": "Ml Job Type" }, "multi_class": { "type": "boolean", "title": "Multi Class", "description": "Tags are mutually exclusive if `False`", "default": false }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "Tags to consider. If empty, all tags applied to any document are considered.", "default": [] }, "method": { "$ref": "#/components/schemas/TagRecommendationMethod", "description": "Method to use for suggestions", "default": "KNN" } }, "type": "object", "required": ["ml_job_type"], "title": "DocTagRecommendationParams" }, "DocType": { "type": "string", "enum": ["text", "image", "video", "audio"], "title": "DocType" }, "DocumentEmbeddingParams": { "properties": { "ml_job_type": { "type": "string", "const": "DOCUMENT_EMBEDDING", "title": "Ml Job Type" }, "recompute": { "type": "boolean", "title": "Recompute", "description": "Whether to recompute already processed documents", "default": false } }, "type": "object", "required": ["ml_job_type"], "title": "DocumentEmbeddingParams" }, "DuplicateFinderInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "max_different_words": { "type": "integer", "title": "Max Different Words", "description": "Number of different words allowed between duplicates" }, "tag_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Tag Id", "description": "Tag id to filter source documents. If not provided, all source documents are considered." } }, "type": "object", "required": ["project_id", "max_different_words", "tag_id"], "title": "DuplicateFinderInput" }, "DuplicateFinderJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/DuplicateFinderInput", "description": "Input for the job" }, "output": { "anyOf": [{ "$ref": "#/components/schemas/DuplicateFinderOutput" }, { "type": "null" }], "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "DuplicateFinderJobRead" }, "DuplicateFinderOutput": { "properties": { "duplicates": { "items": { "items": { "type": "integer" }, "type": "array" }, "type": "array", "title": "Duplicates", "description": "List of found duplicate clusters" } }, "type": "object", "required": ["duplicates"], "title": "DuplicateFinderOutput" }, "ElasticSearchHit": { "properties": { "id": { "type": "integer", "title": "Id", "description": "The ID of the Document" }, "score": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Score", "description": "The score of the Document that was found by a ES Query" }, "highlights": { "items": { "type": "string" }, "type": "array", "title": "Highlights", "description": "The highlights found within the document.", "default": [] } }, "type": "object", "required": ["id"], "title": "ElasticSearchHit" }, "ExportJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "export_job_type": { "$ref": "#/components/schemas/ExportJobType", "description": "The type of the export job (what to export)" }, "specific_export_job_parameters": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/ExportSelectedSdocsParams" }, { "$ref": "#/components/schemas/ExportSelectedSpanAnnotationsParams" }, { "$ref": "#/components/schemas/ExportSelectedSentenceAnnotationsParams" }, { "$ref": "#/components/schemas/ExportSelectedBboxAnnotationsParams" }, { "$ref": "#/components/schemas/ExportSelectedMemosParams" }, { "$ref": "#/components/schemas/ExportSelectedWhiteboardsParams" }, { "$ref": "#/components/schemas/ExportSelectedTimelineAnalysesParams" }, { "$ref": "#/components/schemas/ExportSelectedCotaParams" } ], "discriminator": { "propertyName": "export_job_type", "mapping": { "SELECTED_BBOX_ANNOTATIONS": "#/components/schemas/ExportSelectedBboxAnnotationsParams", "SELECTED_COTA": "#/components/schemas/ExportSelectedCotaParams", "SELECTED_MEMOS": "#/components/schemas/ExportSelectedMemosParams", "SELECTED_SDOCS": "#/components/schemas/ExportSelectedSdocsParams", "SELECTED_SENTENCE_ANNOTATIONS": "#/components/schemas/ExportSelectedSentenceAnnotationsParams", "SELECTED_SPAN_ANNOTATIONS": "#/components/schemas/ExportSelectedSpanAnnotationsParams", "SELECTED_TIMELINE_ANALYSES": "#/components/schemas/ExportSelectedTimelineAnalysesParams", "SELECTED_WHITEBOARDS": "#/components/schemas/ExportSelectedWhiteboardsParams" } } }, { "type": "null" } ], "title": "Specific Export Job Parameters", "description": "Specific parameters for the export job w.r.t it's type" } }, "type": "object", "required": ["project_id", "export_job_type", "specific_export_job_parameters"], "title": "ExportJobInput" }, "ExportJobOutput": { "properties": { "results_url": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Results Url", "description": "URL to download the results when done." } }, "type": "object", "title": "ExportJobOutput" }, "ExportJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/ExportJobInput", "description": "Input for the job" }, "output": { "anyOf": [{ "$ref": "#/components/schemas/ExportJobOutput" }, { "type": "null" }], "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "ExportJobRead" }, "ExportJobType": { "type": "string", "enum": [ "ALL_DATA", "ALL_USERS", "ALL_SDOCS", "ALL_CODES", "ALL_TAGS", "ALL_FOLDERS", "ALL_SPAN_ANNOTATIONS", "ALL_SENTENCE_ANNOTATIONS", "ALL_BBOX_ANNOTATIONS", "ALL_MEMOS", "ALL_PROJECT_METADATA", "ALL_WHITEBOARDS", "ALL_TIMELINE_ANALYSES", "ALL_COTA", "SELECTED_SDOCS", "SELECTED_SPAN_ANNOTATIONS", "SELECTED_SENTENCE_ANNOTATIONS", "SELECTED_BBOX_ANNOTATIONS", "SELECTED_MEMOS", "SELECTED_WHITEBOARDS", "SELECTED_TIMELINE_ANALYSES", "SELECTED_COTA" ], "title": "ExportJobType" }, "ExportSelectedBboxAnnotationsParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_BBOX_ANNOTATIONS", "title": "Export Job Type" }, "bbox_annotation_ids": { "items": { "type": "integer" }, "type": "array", "title": "Bbox Annotation Ids", "description": "IDs of the bbox annotations to export" } }, "type": "object", "required": ["export_job_type", "bbox_annotation_ids"], "title": "ExportSelectedBboxAnnotationsParams" }, "ExportSelectedCotaParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_COTA", "title": "Export Job Type" }, "cota_ids": { "items": { "type": "integer" }, "type": "array", "title": "Cota Ids", "description": "IDs of the cota to export" } }, "type": "object", "required": ["export_job_type", "cota_ids"], "title": "ExportSelectedCotaParams" }, "ExportSelectedMemosParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_MEMOS", "title": "Export Job Type" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "IDs of the memos to export" } }, "type": "object", "required": ["export_job_type", "memo_ids"], "title": "ExportSelectedMemosParams" }, "ExportSelectedSdocsParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_SDOCS", "title": "Export Job Type" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "IDs of the source documents to export" } }, "type": "object", "required": ["export_job_type", "sdoc_ids"], "title": "ExportSelectedSdocsParams" }, "ExportSelectedSentenceAnnotationsParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_SENTENCE_ANNOTATIONS", "title": "Export Job Type" }, "sentence_annotation_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sentence Annotation Ids", "description": "IDs of the sentence annotations to export" } }, "type": "object", "required": ["export_job_type", "sentence_annotation_ids"], "title": "ExportSelectedSentenceAnnotationsParams" }, "ExportSelectedSpanAnnotationsParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_SPAN_ANNOTATIONS", "title": "Export Job Type" }, "span_annotation_ids": { "items": { "type": "integer" }, "type": "array", "title": "Span Annotation Ids", "description": "IDs of the span annotations to export" } }, "type": "object", "required": ["export_job_type", "span_annotation_ids"], "title": "ExportSelectedSpanAnnotationsParams" }, "ExportSelectedTimelineAnalysesParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_TIMELINE_ANALYSES", "title": "Export Job Type" }, "timeline_analysis_ids": { "items": { "type": "integer" }, "type": "array", "title": "Timeline Analysis Ids", "description": "IDs of the timeline analyses to export" } }, "type": "object", "required": ["export_job_type", "timeline_analysis_ids"], "title": "ExportSelectedTimelineAnalysesParams" }, "ExportSelectedWhiteboardsParams": { "properties": { "export_job_type": { "type": "string", "const": "SELECTED_WHITEBOARDS", "title": "Export Job Type" }, "whiteboard_ids": { "items": { "type": "integer" }, "type": "array", "title": "Whiteboard Ids", "description": "IDs of the whiteboards to export" } }, "type": "object", "required": ["export_job_type", "whiteboard_ids"], "title": "ExportSelectedWhiteboardsParams" }, "FewShotParams": { "properties": { "llm_approach_type": { "type": "string", "const": "LLM_FEW_SHOT", "title": "Llm Approach Type" }, "prompts": { "items": { "$ref": "#/components/schemas/LLMPromptTemplates" }, "type": "array", "title": "Prompts", "description": "The prompt templates to use for the job" }, "model": { "type": "string", "title": "Model", "description": "Large Language Model to use for the job" } }, "type": "object", "required": ["llm_approach_type", "prompts", "model"], "title": "FewShotParams" }, "FilterExpression_BBoxColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/BBoxColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[BBoxColumns]" }, "FilterExpression_MemoColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/MemoColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[MemoColumns]" }, "FilterExpression_SdocColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SdocColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[SdocColumns]" }, "FilterExpression_SentAnnoColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SentAnnoColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[SentAnnoColumns]" }, "FilterExpression_SpanColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/SpanColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[SpanColumns]" }, "FilterExpression_WordFrequencyColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "column": { "anyOf": [{ "$ref": "#/components/schemas/WordFrequencyColumns" }, { "type": "integer" }], "title": "Column" }, "operator": { "anyOf": [ { "$ref": "#/components/schemas/IDOperator" }, { "$ref": "#/components/schemas/NumberOperator" }, { "$ref": "#/components/schemas/StringOperator" }, { "$ref": "#/components/schemas/IDListOperator" }, { "$ref": "#/components/schemas/IDListRecursiveOperator" }, { "$ref": "#/components/schemas/ListOperator" }, { "$ref": "#/components/schemas/DateOperator" }, { "$ref": "#/components/schemas/BooleanOperator" } ], "title": "Operator" }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "integer" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } ], "title": "Value" } }, "type": "object", "required": ["id", "column", "operator", "value"], "title": "FilterExpression[WordFrequencyColumns]" }, "FilterOperator": { "type": "string", "enum": ["BOOLEAN", "STRING", "ID", "NUMBER", "ID_LIST", "ID_LIST_RECURSIVE", "LIST", "DATE"], "title": "FilterOperator" }, "FilterValueType": { "type": "string", "enum": [ "SDOC_ID", "CODE_ID", "USER_ID", "TAG_ID", "FOLDER_ID", "SPAN_ANNOTATION", "DOC_TYPE", "INFER_FROM_OPERATOR" ], "title": "FilterValueType" }, "Filter_BBoxColumns_-Input": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_BBoxColumns_" }, { "$ref": "#/components/schemas/Filter_BBoxColumns_-Input" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[BBoxColumns]" }, "Filter_BBoxColumns_-Output": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_BBoxColumns_" }, { "$ref": "#/components/schemas/Filter_BBoxColumns_-Output" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[BBoxColumns]" }, "Filter_MemoColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_MemoColumns_" }, { "$ref": "#/components/schemas/Filter_MemoColumns_" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[MemoColumns]" }, "Filter_SdocColumns_-Input": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SdocColumns_" }, { "$ref": "#/components/schemas/Filter_SdocColumns_-Input" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SdocColumns]" }, "Filter_SdocColumns_-Output": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SdocColumns_" }, { "$ref": "#/components/schemas/Filter_SdocColumns_-Output" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SdocColumns]" }, "Filter_SentAnnoColumns_-Input": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SentAnnoColumns_" }, { "$ref": "#/components/schemas/Filter_SentAnnoColumns_-Input" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SentAnnoColumns]" }, "Filter_SentAnnoColumns_-Output": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SentAnnoColumns_" }, { "$ref": "#/components/schemas/Filter_SentAnnoColumns_-Output" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SentAnnoColumns]" }, "Filter_SpanColumns_-Input": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SpanColumns_" }, { "$ref": "#/components/schemas/Filter_SpanColumns_-Input" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SpanColumns]" }, "Filter_SpanColumns_-Output": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_SpanColumns_" }, { "$ref": "#/components/schemas/Filter_SpanColumns_-Output" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[SpanColumns]" }, "Filter_WordFrequencyColumns_": { "properties": { "id": { "type": "string", "title": "Id" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/FilterExpression_WordFrequencyColumns_" }, { "$ref": "#/components/schemas/Filter_WordFrequencyColumns_" } ] }, "type": "array", "title": "Items" }, "logic_operator": { "$ref": "#/components/schemas/LogicalOperator" } }, "type": "object", "required": ["id", "items", "logic_operator"], "title": "Filter[WordFrequencyColumns]" }, "FolderCreate": { "properties": { "name": { "type": "string", "maxLength": 231, "title": "Name", "description": "Name of the folder" }, "folder_type": { "$ref": "#/components/schemas/FolderType", "description": "Type of the folder (normal, sdoc_folder)" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "ID of the parent folder (nullable)" }, "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the project this folder belongs to (nullable)" } }, "type": "object", "required": ["name", "folder_type", "project_id"], "title": "FolderCreate" }, "FolderRead": { "properties": { "name": { "type": "string", "maxLength": 231, "title": "Name", "description": "Name of the folder" }, "folder_type": { "$ref": "#/components/schemas/FolderType", "description": "Type of the folder (normal, sdoc_folder)" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "ID of the parent folder (nullable)" }, "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the project this folder belongs to (nullable)" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Folder" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Creation timestamp of the folder" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Update timestamp of the folder" } }, "type": "object", "required": ["name", "folder_type", "project_id", "id", "created", "updated"], "title": "FolderRead" }, "FolderType": { "type": "string", "enum": ["normal", "sdoc_folder"], "title": "FolderType" }, "FolderUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Updated name of the folder" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Updated parent folder ID" } }, "type": "object", "title": "FolderUpdate" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HierarchicalElasticSearchHit": { "properties": { "id": { "type": "integer", "title": "Id", "description": "The ID of the Document" }, "score": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Score", "description": "The score of the Document that was found by a ES Query" }, "highlights": { "items": { "type": "string" }, "type": "array", "title": "Highlights", "description": "The highlights found within the document.", "default": [] }, "is_folder": { "type": "boolean", "title": "Is Folder", "description": "Indicates if the hit is a folder (True) or a document (False)." }, "sub_rows": { "items": { "$ref": "#/components/schemas/HierarchicalElasticSearchHit" }, "type": "array", "title": "Sub Rows", "description": "Sub-rows of the hit, if it is a folder." } }, "type": "object", "required": ["id", "is_folder", "sub_rows"], "title": "HierarchicalElasticSearchHit" }, "HorizontalAlign": { "type": "string", "enum": ["left", "center", "right"], "title": "HorizontalAlign" }, "IDListOperator": { "type": "string", "enum": ["ID_LIST_CONTAINS", "ID_LIST_NOT_CONTAINS"], "title": "IDListOperator" }, "IDListRecursiveOperator": { "type": "string", "enum": ["IDLR_CONTAINS", "IDLR_NOT_CONTAINS", "IDLR_CONTAINS_RECURSIVE"], "title": "IDListRecursiveOperator" }, "IDOperator": { "type": "string", "enum": ["ID_EQUALS", "ID_NOT_EQUALS"], "title": "IDOperator" }, "ImportJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "import_job_type": { "$ref": "#/components/schemas/ImportJobType", "description": "The type of the import job (what to import)" }, "user_id": { "type": "integer", "title": "User Id", "description": "ID of the User, who started the job." }, "file_name": { "type": "string", "title": "File Name", "description": "The name to the file that is used for the import job" } }, "type": "object", "required": ["project_id", "import_job_type", "user_id", "file_name"], "title": "ImportJobInput" }, "ImportJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/ImportJobInput", "description": "Input for the job" }, "output": { "type": "null", "title": "Output", "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "ImportJobRead" }, "ImportJobType": { "type": "string", "enum": [ "PROJECT", "CODES", "TAGS", "FOLDERS", "BBOX_ANNOTATIONS", "SPAN_ANNOTATIONS", "SENTENCE_ANNOTATIONS", "USERS", "PROJECT_METADATA", "WHITEBOARDS", "TIMELINE_ANALYSES", "COTA", "MEMOS", "DOCUMENTS" ], "title": "ImportJobType" }, "InstanceInfo": { "properties": { "is_oidc_enabled": { "type": "boolean", "title": "Is Oidc Enabled", "description": "Is OIDC enabled" }, "oidc_provider_names": { "items": { "type": "string" }, "type": "array", "title": "Oidc Provider Names", "description": "OIDC provider names" }, "is_stable": { "type": "boolean", "title": "Is Stable", "description": "Is stable" }, "glitchtip_dsn": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Glitchtip Dsn", "description": "Glitchtip DSN" } }, "type": "object", "required": ["is_oidc_enabled", "oidc_provider_names", "is_stable", "glitchtip_dsn"], "title": "InstanceInfo" }, "JobStatus": { "type": "string", "enum": ["queued", "finished", "failed", "started", "deferred", "scheduled", "stopped", "canceled"], "title": "JobStatus" }, "KeywordStat": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "The counted keyword." }, "filtered_count": { "type": "integer", "title": "Filtered Count", "description": "Number of occurrences of the keyword in the filtered collection" }, "global_count": { "type": "integer", "title": "Global Count", "description": "Number of occurrences of the keyword in the entire collection" } }, "type": "object", "required": ["keyword", "filtered_count", "global_count"], "title": "KeywordStat" }, "LLMJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "llm_job_type": { "$ref": "#/components/schemas/TaskType", "description": "The type of the LLMJob (what to llm)" }, "specific_task_parameters": { "oneOf": [ { "$ref": "#/components/schemas/TaggingParams" }, { "$ref": "#/components/schemas/MetadataExtractionParams" }, { "$ref": "#/components/schemas/AnnotationParams" }, { "$ref": "#/components/schemas/SentenceAnnotationParams" } ], "title": "Specific Task Parameters", "description": "Specific parameters for the LLMJob w.r.t it's type", "discriminator": { "propertyName": "llm_job_type", "mapping": { "ANNOTATION": "#/components/schemas/AnnotationParams", "METADATA_EXTRACTION": "#/components/schemas/MetadataExtractionParams", "SENTENCE_ANNOTATION": "#/components/schemas/SentenceAnnotationParams", "TAGGING": "#/components/schemas/TaggingParams" } } }, "llm_approach_type": { "$ref": "#/components/schemas/ApproachType", "description": "The approach to use for the LLMJob" }, "specific_approach_parameters": { "oneOf": [ { "$ref": "#/components/schemas/ZeroShotParams" }, { "$ref": "#/components/schemas/FewShotParams" } ], "title": "Specific Approach Parameters", "description": "Specific parameters for the approach w.r.t it's type", "discriminator": { "propertyName": "llm_approach_type", "mapping": { "LLM_FEW_SHOT": "#/components/schemas/FewShotParams", "LLM_ZERO_SHOT": "#/components/schemas/ZeroShotParams" } } } }, "type": "object", "required": [ "project_id", "llm_job_type", "specific_task_parameters", "llm_approach_type", "specific_approach_parameters" ], "title": "LLMJobInput" }, "LLMJobOutput": { "properties": { "llm_job_type": { "$ref": "#/components/schemas/TaskType", "description": "The type of the LLMJob (what to llm)" }, "specific_task_result": { "oneOf": [ { "$ref": "#/components/schemas/TaggingLLMJobResult" }, { "$ref": "#/components/schemas/MetadataExtractionLLMJobResult" }, { "$ref": "#/components/schemas/AnnotationLLMJobResult" }, { "$ref": "#/components/schemas/SentenceAnnotationLLMJobResult" } ], "title": "Specific Task Result", "description": "Specific result for the LLMJob w.r.t it's type", "discriminator": { "propertyName": "llm_job_type", "mapping": { "ANNOTATION": "#/components/schemas/AnnotationLLMJobResult", "METADATA_EXTRACTION": "#/components/schemas/MetadataExtractionLLMJobResult", "SENTENCE_ANNOTATION": "#/components/schemas/SentenceAnnotationLLMJobResult", "TAGGING": "#/components/schemas/TaggingLLMJobResult" } } } }, "type": "object", "required": ["llm_job_type", "specific_task_result"], "title": "LLMJobOutput" }, "LLMJobParameters": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "llm_job_type": { "$ref": "#/components/schemas/TaskType", "description": "The type of the LLMJob (what to llm)" }, "specific_task_parameters": { "oneOf": [ { "$ref": "#/components/schemas/TaggingParams" }, { "$ref": "#/components/schemas/MetadataExtractionParams" }, { "$ref": "#/components/schemas/AnnotationParams" }, { "$ref": "#/components/schemas/SentenceAnnotationParams" } ], "title": "Specific Task Parameters", "description": "Specific parameters for the LLMJob w.r.t it's type", "discriminator": { "propertyName": "llm_job_type", "mapping": { "ANNOTATION": "#/components/schemas/AnnotationParams", "METADATA_EXTRACTION": "#/components/schemas/MetadataExtractionParams", "SENTENCE_ANNOTATION": "#/components/schemas/SentenceAnnotationParams", "TAGGING": "#/components/schemas/TaggingParams" } } } }, "type": "object", "required": ["project_id", "llm_job_type", "specific_task_parameters"], "title": "LLMJobParameters" }, "LLMPromptTemplates": { "properties": { "language": { "type": "string", "title": "Language", "description": "The language of the prompt template" }, "system_prompt": { "type": "string", "title": "System Prompt", "description": "The system prompt to use for the job" }, "user_prompt": { "type": "string", "title": "User Prompt", "description": "The user prompt to use for the job" } }, "type": "object", "required": ["language", "system_prompt", "user_prompt"], "title": "LLMPromptTemplates" }, "Language": { "type": "string", "enum": ["auto", "de", "en", "it"], "title": "Language" }, "ListOperator": { "type": "string", "enum": ["LIST_CONTAINS", "LIST_NOT_CONTAINS"], "title": "ListOperator" }, "LlmAssistantJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/LLMJobInput", "description": "Input for the job" }, "output": { "anyOf": [{ "$ref": "#/components/schemas/LLMJobOutput" }, { "type": "null" }], "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "LlmAssistantJobRead" }, "LogicalOperator": { "type": "string", "enum": ["or", "and"], "title": "LogicalOperator", "description": "This tells our filter how to combine multiple column expressions." }, "MLJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "The ID of the Project to analyse" }, "ml_job_type": { "$ref": "#/components/schemas/MLJobType", "description": "The type of the MLJob" }, "specific_ml_job_parameters": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/QuotationAttributionParams" }, { "$ref": "#/components/schemas/DocTagRecommendationParams" }, { "$ref": "#/components/schemas/CoreferenceResolutionParams" }, { "$ref": "#/components/schemas/DocumentEmbeddingParams" }, { "$ref": "#/components/schemas/SentenceEmbeddingParams" } ], "discriminator": { "propertyName": "ml_job_type", "mapping": { "COREFERENCE_RESOLUTION": "#/components/schemas/CoreferenceResolutionParams", "DOCUMENT_EMBEDDING": "#/components/schemas/DocumentEmbeddingParams", "QUOTATION_ATTRIBUTION": "#/components/schemas/QuotationAttributionParams", "SENTENCE_EMBEDDING": "#/components/schemas/SentenceEmbeddingParams", "TAG_RECOMMENDATION": "#/components/schemas/DocTagRecommendationParams" } } }, { "type": "null" } ], "title": "Specific Ml Job Parameters", "description": "Specific parameters for the MLJob w.r.t it's type" } }, "type": "object", "required": ["project_id", "ml_job_type", "specific_ml_job_parameters"], "title": "MLJobInput" }, "MLJobType": { "type": "string", "enum": [ "QUOTATION_ATTRIBUTION", "TAG_RECOMMENDATION", "COREFERENCE_RESOLUTION", "DOCUMENT_EMBEDDING", "SENTENCE_EMBEDDING" ], "title": "MLJobType" }, "MemoColumns": { "type": "string", "enum": ["M_TITLE", "M_CONTENT", "M_STARRED", "M_USER_ID"], "title": "MemoColumns" }, "MemoCreate": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Memo" }, "content": { "type": "string", "title": "Content", "description": "Textual content of the Memo" }, "content_json": { "type": "string", "title": "Content Json", "description": "JSON content of the Memo" }, "starred": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Starred", "description": "Starred flag of the Memo", "default": false } }, "type": "object", "required": ["title", "content", "content_json"], "title": "MemoCreate" }, "MemoNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "memo", "title": "Type" }, "memoId": { "type": "integer", "title": "Memoid", "description": "ID of the memo" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "memoId"], "title": "MemoNodeData" }, "MemoRead": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Memo" }, "content": { "type": "string", "title": "Content", "description": "Textual content of the Memo" }, "content_json": { "type": "string", "title": "Content Json", "description": "JSON content of the Memo" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Memo" }, "starred": { "type": "boolean", "title": "Starred", "description": "Starred flag of the Memo" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the Memo belongs to" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Memo belongs to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the Memo" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the Memo" }, "attached_object_id": { "type": "integer", "title": "Attached Object Id", "description": "ID of the Object the Memo is attached to" }, "attached_object_type": { "$ref": "#/components/schemas/AttachedObjectType", "description": "Type of the Object the ID refers to" } }, "type": "object", "required": [ "title", "content", "content_json", "id", "starred", "user_id", "project_id", "created", "updated", "attached_object_id", "attached_object_type" ], "title": "MemoRead" }, "MemoUpdate": { "properties": { "title": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Title", "description": "Title of the Memo" }, "content": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Content", "description": "Textual content of the Memo" }, "content_json": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Content Json", "description": "JSON content of the Memo" }, "starred": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Starred", "description": "Starred flag of the Memo" } }, "type": "object", "title": "MemoUpdate" }, "MergeClustersParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "merge_clusters", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "merge_clusters" }, "cluster_to_keep": { "type": "integer", "title": "Cluster To Keep", "description": "ID of the cluster to keep after merging." }, "cluster_to_merge": { "type": "integer", "title": "Cluster To Merge", "description": "ID of the cluster to delete after merging." } }, "type": "object", "required": ["cluster_to_keep", "cluster_to_merge"], "title": "MergeClustersParams" }, "MetaType": { "type": "string", "enum": ["STRING", "NUMBER", "DATE", "BOOLEAN", "LIST"], "title": "MetaType" }, "MetadataExtractionLLMJobResult": { "properties": { "llm_job_type": { "type": "string", "const": "METADATA_EXTRACTION", "title": "Llm Job Type" }, "results": { "items": { "$ref": "#/components/schemas/MetadataExtractionResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": ["llm_job_type", "results"], "title": "MetadataExtractionLLMJobResult" }, "MetadataExtractionParams": { "properties": { "llm_job_type": { "type": "string", "const": "METADATA_EXTRACTION", "title": "Llm Job Type" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "IDs of the source documents to analyse" }, "project_metadata_ids": { "items": { "type": "integer" }, "type": "array", "title": "Project Metadata Ids", "description": "IDs of the project metadata to use for the metadata extraction" } }, "type": "object", "required": ["llm_job_type", "sdoc_ids", "project_metadata_ids"], "title": "MetadataExtractionParams" }, "MetadataExtractionResult": { "properties": { "status": { "type": "string", "enum": ["error", "finished"], "title": "Status", "description": "Status of the Result" }, "status_message": { "type": "string", "title": "Status Message", "description": "Status message of the result" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "current_metadata": { "items": { "$ref": "#/components/schemas/SourceDocumentMetadataReadResolved" }, "type": "array", "title": "Current Metadata", "description": "Current metadata" }, "suggested_metadata": { "items": { "$ref": "#/components/schemas/SourceDocumentMetadataReadResolved" }, "type": "array", "title": "Suggested Metadata", "description": "Suggested metadata" } }, "type": "object", "required": ["status", "status_message", "sdoc_id", "current_metadata", "suggested_metadata"], "title": "MetadataExtractionResult" }, "MlJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/MLJobInput", "description": "Input for the job" }, "output": { "type": "null", "title": "Output", "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "MlJobRead" }, "NoteNodeData": { "properties": { "text": { "type": "string", "title": "Text", "description": "Text of the text" }, "color": { "type": "string", "title": "Color", "description": "Text color of the text" }, "horizontalAlign": { "$ref": "#/components/schemas/HorizontalAlign", "description": "Horizontal alignment of the text" }, "verticalAlign": { "$ref": "#/components/schemas/VerticalAlign", "description": "Vertical alignment of the text" }, "bold": { "type": "boolean", "title": "Bold", "description": "Boldness of the text" }, "italic": { "type": "boolean", "title": "Italic", "description": "Italicness of the text" }, "underline": { "type": "boolean", "title": "Underline", "description": "Underlinedness of the text" }, "strikethrough": { "type": "boolean", "title": "Strikethrough", "description": "Strikethroughness of the text" }, "fontSize": { "type": "integer", "title": "Fontsize", "description": "Font size of the text" }, "fontFamily": { "type": "string", "title": "Fontfamily", "description": "Font family of the text" }, "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "note", "title": "Type" } }, "type": "object", "required": [ "text", "color", "horizontalAlign", "verticalAlign", "bold", "italic", "underline", "strikethrough", "fontSize", "fontFamily", "bgcolor", "bgalpha", "type" ], "title": "NoteNodeData" }, "NumberOperator": { "type": "string", "enum": ["NUMBER_EQUALS", "NUMBER_NOT_EQUALS", "NUMBER_GT", "NUMBER_LT", "NUMBER_GTE", "NUMBER_LTE"], "title": "NumberOperator" }, "PaginatedElasticSearchHits": { "properties": { "hits": { "items": { "$ref": "#/components/schemas/ElasticSearchHit" }, "type": "array", "title": "Hits", "description": "The IDs, scores and (optional) highlights of Document search results on the requested page." }, "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of hits. Used for pagination." } }, "type": "object", "required": ["hits", "total_results"], "title": "PaginatedElasticSearchHits" }, "PaginatedSDocHits": { "properties": { "hits": { "items": { "$ref": "#/components/schemas/HierarchicalElasticSearchHit" }, "type": "array", "title": "Hits", "description": "The IDs, scores and (optional) highlights of Document search results on the requested page." }, "sdocs": { "additionalProperties": { "$ref": "#/components/schemas/SourceDocumentRead" }, "type": "object", "title": "Sdocs", "description": "A dictionary of sdoc_id and SourceDocumentRead." }, "sdoc_folders": { "additionalProperties": { "$ref": "#/components/schemas/FolderRead" }, "type": "object", "title": "Sdoc Folders", "description": "A dictionary of folder_id and FolderRead." }, "annotators": { "additionalProperties": { "items": { "type": "integer" }, "type": "array" }, "type": "object", "title": "Annotators", "description": "A dictionary of sdoc_id and a list of annotator user IDs that annotated the document." }, "tags": { "additionalProperties": { "items": { "type": "integer" }, "type": "array" }, "type": "object", "title": "Tags", "description": "A dictionary of sdoc_id and a list of tag IDs that are associated with the document." }, "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of hits. Used for pagination." } }, "type": "object", "required": ["hits", "sdocs", "sdoc_folders", "annotators", "tags", "total_results"], "title": "PaginatedSDocHits" }, "PaginatedSpanAnnotationHits": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of SpanAnnotation hits. Used for pagination." }, "hits": { "items": { "$ref": "#/components/schemas/SpanAnnotationHit" }, "type": "array", "title": "Hits", "description": "The SpanAnnotation hits matching the search query." } }, "type": "object", "required": ["total_results", "hits"], "title": "PaginatedSpanAnnotationHits" }, "PerspectivesClusterSimilarities": { "properties": { "aspect_id": { "type": "integer", "title": "Aspect Id", "description": "ID of the aspect this visualization belongs to" }, "clusters": { "items": { "$ref": "#/components/schemas/ClusterRead" }, "type": "array", "title": "Clusters", "description": "List of clusters in the visualization" }, "similarities": { "items": { "items": { "type": "number" }, "type": "array" }, "type": "array", "title": "Similarities", "description": "Matrix of cluster similarities, where similarities[i][j] is the similarity between clusters[i] and clusters[j]" } }, "type": "object", "required": ["aspect_id", "clusters", "similarities"], "title": "PerspectivesClusterSimilarities" }, "PerspectivesDoc": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "cluster_id": { "type": "integer", "title": "Cluster Id", "description": "ID of the cluster this document belongs to" }, "x": { "type": "number", "title": "X", "description": "X coordinate of the document in the visualization" }, "y": { "type": "number", "title": "Y", "description": "Y coordinate of the document in the visualization" }, "is_accepted": { "type": "boolean", "title": "Is Accepted", "description": "Indicates whether the document<->cluster assignment is accepted by a user" }, "in_searchresult": { "type": "boolean", "title": "In Searchresult", "description": "Indicates whether the document is part of the search result" }, "is_outlier": { "type": "boolean", "title": "Is Outlier", "description": "Indicates whether the document is an outlier" } }, "type": "object", "required": ["sdoc_id", "cluster_id", "x", "y", "is_accepted", "in_searchresult", "is_outlier"], "title": "PerspectivesDoc" }, "PerspectivesJobInput": { "properties": { "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "aspect_id": { "type": "integer", "title": "Aspect Id", "description": "ID of the aspect associated with the PerspectivesJob. -1 if not applicable." }, "perspectives_job_type": { "$ref": "#/components/schemas/PerspectivesJobType", "description": "Type of the PerspectivesJob" }, "parameters": { "oneOf": [ { "$ref": "#/components/schemas/CreateAspectParams" }, { "$ref": "#/components/schemas/AddMissingDocsToAspectParams" }, { "$ref": "#/components/schemas/CreateClusterWithNameParams" }, { "$ref": "#/components/schemas/CreateClusterWithSdocsParams" }, { "$ref": "#/components/schemas/RemoveClusterParams" }, { "$ref": "#/components/schemas/MergeClustersParams" }, { "$ref": "#/components/schemas/SplitClusterParams" }, { "$ref": "#/components/schemas/ChangeClusterParams" }, { "$ref": "#/components/schemas/RefineModelParams" }, { "$ref": "#/components/schemas/ResetModelParams" }, { "$ref": "#/components/schemas/RecomputeClusterTitleAndDescriptionParams" } ], "title": "Parameters", "description": "Parameters for the PerspectivesJob. The type depends on the PerspectivesJobType.", "discriminator": { "propertyName": "perspectives_job_type", "mapping": { "add_missing_docs_to_aspect": "#/components/schemas/AddMissingDocsToAspectParams", "change_cluster": "#/components/schemas/ChangeClusterParams", "create_aspect": "#/components/schemas/CreateAspectParams", "create_cluster_with_name": "#/components/schemas/CreateClusterWithNameParams", "create_cluster_with_sdocs": "#/components/schemas/CreateClusterWithSdocsParams", "merge_clusters": "#/components/schemas/MergeClustersParams", "recompute_cluster_title_and_description": "#/components/schemas/RecomputeClusterTitleAndDescriptionParams", "refine_model": "#/components/schemas/RefineModelParams", "remove_cluster": "#/components/schemas/RemoveClusterParams", "reset_model": "#/components/schemas/ResetModelParams", "split_cluster": "#/components/schemas/SplitClusterParams" } } } }, "type": "object", "required": ["project_id", "aspect_id", "perspectives_job_type", "parameters"], "title": "PerspectivesJobInput" }, "PerspectivesJobRead": { "properties": { "job_id": { "type": "string", "title": "Job Id", "description": "RQ job ID" }, "job_type": { "type": "string", "title": "Job Type", "description": "Type of the job" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project ID associated with the job" }, "status": { "$ref": "#/components/schemas/JobStatus", "description": "Current status of the job" }, "status_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Message", "description": "Status message" }, "current_step": { "type": "integer", "title": "Current Step", "description": "Current step in the job process" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps", "description": "Total number of steps in the job process" }, "input": { "$ref": "#/components/schemas/PerspectivesJobInput", "description": "Input for the job" }, "output": { "type": "null", "title": "Output", "description": "Output for the job" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the job" }, "finished": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished", "description": "Finished timestamp of the job" } }, "type": "object", "required": ["job_id", "job_type", "project_id", "status", "current_step", "steps", "input", "created"], "title": "PerspectivesJobRead" }, "PerspectivesJobType": { "type": "string", "enum": [ "create_aspect", "add_missing_docs_to_aspect", "create_cluster_with_name", "create_cluster_with_sdocs", "remove_cluster", "merge_clusters", "split_cluster", "change_cluster", "refine_model", "reset_model", "recompute_cluster_title_and_description" ], "title": "PerspectivesJobType" }, "PerspectivesVisualization": { "properties": { "aspect_id": { "type": "integer", "title": "Aspect Id", "description": "ID of the aspect this visualization belongs to" }, "clusters": { "items": { "$ref": "#/components/schemas/ClusterRead" }, "type": "array", "title": "Clusters", "description": "List of clusters in the visualization" }, "docs": { "items": { "$ref": "#/components/schemas/PerspectivesDoc" }, "type": "array", "title": "Docs", "description": "List of documents in the visualization" } }, "type": "object", "required": ["aspect_id", "clusters", "docs"], "title": "PerspectivesVisualization" }, "PipelineSettings": { "properties": { "rewriting_model": { "type": "string", "title": "Rewriting Model", "description": "Large Language Model to use for the perspective creation pipeline" }, "umap_n_neighbors": { "type": "integer", "title": "Umap N Neighbors", "description": "Number of neighbors for UMAP dimensionality reduction", "default": 15 }, "umap_n_components": { "type": "integer", "title": "Umap N Components", "description": "Number of components for UMAP dimensionality reduction", "default": 10 }, "umap_min_dist": { "type": "number", "title": "Umap Min Dist", "description": "Minimum distance for UMAP dimensionality reduction", "default": 0.1 }, "umap_metric": { "type": "string", "title": "Umap Metric", "description": "Metric for UMAP dimensionality reduction", "default": "cosine" }, "hdbscan_min_cluster_size": { "type": "integer", "title": "Hdbscan Min Cluster Size", "description": "Minimum cluster size for HDBSCAN clustering", "default": 10 }, "hdbscan_metric": { "type": "string", "title": "Hdbscan Metric", "description": "Metric for HDBSCAN clustering", "default": "euclidean" }, "num_keywords": { "type": "integer", "title": "Num Keywords", "description": "Number of keywords to extract per cluster", "default": 50 }, "num_top_documents": { "type": "integer", "title": "Num Top Documents", "description": "Number of top documents to extract per cluster", "default": 5 } }, "type": "object", "required": ["rewriting_model"], "title": "PipelineSettings", "description": "Settings for the perspective creation pipeline.\nWhen updating these settings, make sure to also update the frontend default settings! (PerspectiveCreationDialog.tsx)" }, "ProcessingSettings": { "properties": { "extract_images": { "type": "boolean", "title": "Extract Images", "description": "Whether to extract images from the documents" }, "pages_per_chunk": { "type": "integer", "title": "Pages Per Chunk", "description": "Number of pages to chunk the documents into" }, "keyword_number": { "type": "integer", "title": "Keyword Number", "description": "Number of keywords to extract" }, "keyword_deduplication_threshold": { "type": "number", "title": "Keyword Deduplication Threshold", "description": "Threshold for keyword deduplication (0.0 - 1.0)" }, "keyword_max_ngram_size": { "type": "integer", "title": "Keyword Max Ngram Size", "description": "Maximum n-gram size for keyword extraction" }, "language": { "$ref": "#/components/schemas/Language", "description": "Language of the documents: 'de', 'en', ..." }, "model": { "type": "string", "title": "Model", "description": "Large Language Model to use for processing" } }, "type": "object", "required": [ "extract_images", "pages_per_chunk", "keyword_number", "keyword_deduplication_threshold", "keyword_max_ngram_size", "language", "model" ], "title": "ProcessingSettings" }, "ProjectAddUser": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "E-Mail of the User" } }, "type": "object", "required": ["email"], "title": "ProjectAddUser" }, "ProjectCreate": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Project" }, "description": { "type": "string", "title": "Description", "description": "Description of the Project" } }, "type": "object", "required": ["title", "description"], "title": "ProjectCreate" }, "ProjectMetadataCreate": { "properties": { "key": { "type": "string", "title": "Key", "description": "Key of the ProjectMetadata" }, "metatype": { "$ref": "#/components/schemas/MetaType", "description": "Type of the ProjectMetadata" }, "read_only": { "type": "boolean", "title": "Read Only", "description": "Flag that tells if the ProjectMetadata cannot be changed. Used for system generated metadata! Use False for user metadata.", "default": false }, "doctype": { "$ref": "#/components/schemas/DocType", "description": "DOCTYPE of the SourceDocument this metadata refers to" }, "description": { "type": "string", "title": "Description", "description": "Description of the ProjectMetadata" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the ProjectMetadata belongs to" } }, "type": "object", "required": ["key", "metatype", "doctype", "description", "project_id"], "title": "ProjectMetadataCreate" }, "ProjectMetadataRead": { "properties": { "key": { "type": "string", "title": "Key", "description": "Key of the ProjectMetadata" }, "metatype": { "$ref": "#/components/schemas/MetaType", "description": "Type of the ProjectMetadata" }, "read_only": { "type": "boolean", "title": "Read Only", "description": "Flag that tells if the ProjectMetadata cannot be changed. Used for system generated metadata! Use False for user metadata.", "default": false }, "doctype": { "$ref": "#/components/schemas/DocType", "description": "DOCTYPE of the SourceDocument this metadata refers to" }, "description": { "type": "string", "title": "Description", "description": "Description of the ProjectMetadata" }, "id": { "type": "integer", "title": "Id", "description": "ID of the ProjectMetadata" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the ProjectMetadata belongs to" } }, "type": "object", "required": ["key", "metatype", "doctype", "description", "id", "project_id"], "title": "ProjectMetadataRead" }, "ProjectMetadataUpdate": { "properties": { "key": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Key", "description": "Key of the ProjectMetadata" }, "metatype": { "anyOf": [{ "$ref": "#/components/schemas/MetaType" }, { "type": "null" }], "description": "Type of the ProjectMetadata" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the ProjectMetadata" } }, "type": "object", "title": "ProjectMetadataUpdate" }, "ProjectRead": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Project" }, "description": { "type": "string", "title": "Description", "description": "Description of the Project" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Project" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the Project" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the Project" } }, "type": "object", "required": ["title", "description", "id", "created", "updated"], "title": "ProjectRead" }, "ProjectUpdate": { "properties": { "title": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Title", "description": "Title of the Project" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the Project" } }, "type": "object", "title": "ProjectUpdate" }, "PublicUserRead": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the User" }, "first_name": { "type": "string", "title": "First Name", "description": "First name of the User" }, "last_name": { "type": "string", "title": "Last Name", "description": "Last name of the User" } }, "type": "object", "required": ["id", "first_name", "last_name"], "title": "PublicUserRead", "description": "A user object with information that everybody may see." }, "QuotationAttributionParams": { "properties": { "ml_job_type": { "type": "string", "const": "QUOTATION_ATTRIBUTION", "title": "Ml Job Type" }, "recompute": { "type": "boolean", "title": "Recompute", "description": "Whether to recompute already processed documents", "default": false } }, "type": "object", "required": ["ml_job_type"], "title": "QuotationAttributionParams" }, "RecomputeClusterTitleAndDescriptionParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "recompute_cluster_title_and_description", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "recompute_cluster_title_and_description" }, "cluster_id": { "type": "integer", "title": "Cluster Id", "description": "ID of the cluster to recompute title and description for." } }, "type": "object", "required": ["cluster_id"], "title": "RecomputeClusterTitleAndDescriptionParams" }, "RefineModelParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "refine_model", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "refine_model" } }, "type": "object", "title": "RefineModelParams" }, "RemoveClusterParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "remove_cluster", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "remove_cluster" }, "cluster_id": { "type": "integer", "title": "Cluster Id", "description": "ID of the cluster to remove." } }, "type": "object", "required": ["cluster_id"], "title": "RemoveClusterParams" }, "ResetModelParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "reset_model", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "reset_model" } }, "type": "object", "title": "ResetModelParams" }, "SDocStatus": { "type": "integer", "enum": [-100, 0, 1], "title": "SDocStatus" }, "SampledSdocsResults": { "properties": { "tags": { "items": { "type": "integer" }, "type": "array", "title": "Tags", "description": "The tags aggregated by." }, "sdocs": { "items": { "type": "integer" }, "type": "array", "title": "Sdocs", "description": "The grouped SourceDocument IDs." }, "sample_fixed": { "items": { "type": "integer" }, "type": "array", "title": "Sample Fixed", "description": "The fixed sample of SourceDocument IDs." }, "sample_relative": { "items": { "type": "integer" }, "type": "array", "title": "Sample Relative", "description": "The relative sample of SourceDocument IDs." } }, "type": "object", "required": ["tags", "sdocs", "sample_fixed", "sample_relative"], "title": "SampledSdocsResults" }, "SdocColumns": { "type": "string", "enum": [ "SD_SOURCE_DOCUMENT_TYPE", "SD_SOURCE_DOCUMENT_NAME", "SD_TAG_ID_LIST_RECURSIVE", "SD_CODE_ID_LIST_RECURSIVE", "SD_FOLDER_ID_LIST_RECURSIVE", "SD_USER_ID_LIST", "SD_SPAN_ANNOTATIONS" ], "title": "SdocColumns" }, "SdocHealthResult": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "Total number of sdocs in the project" }, "data": { "items": { "$ref": "#/components/schemas/SdocStatusRow" }, "type": "array", "title": "Data", "description": "List of SourceDocument status rows (one per sdoc in the project)" } }, "type": "object", "required": ["total_results", "data"], "title": "SdocHealthResult" }, "SdocHealthSort": { "properties": { "column": { "type": "string", "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "SdocHealthSort" }, "SdocNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "sdoc", "title": "Type" }, "sdocId": { "type": "integer", "title": "Sdocid", "description": "ID of the source document" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "sdocId"], "title": "SdocNodeData" }, "SdocSentencePair": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id" }, "sentence": { "type": "integer", "title": "Sentence" } }, "type": "object", "required": ["sdoc_id", "sentence"], "title": "SdocSentencePair" }, "SdocStatusRow": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the SourceDocument" }, "name": { "type": "string", "title": "Name", "description": "Name of the SourceDocument" }, "status": { "additionalProperties": { "$ref": "#/components/schemas/SDocStatus" }, "type": "object", "title": "Status", "description": "Processing status of the SourceDocument (the keys are the processing step/job and differ per doctype)" }, "failed_job_uuids": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Failed Job Uuids", "description": "UUIDs of the failed processing jobs (the keys are the processing step/job and differ per doctype)" }, "failed_job_status_msgs": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Failed Job Status Msgs", "description": "Status messages of the failed processing jobs (the keys are the processing step/job and differ per doctype)" } }, "type": "object", "required": ["sdoc_id", "name", "status", "failed_job_uuids", "failed_job_status_msgs"], "title": "SdocStatusRow" }, "SdocTimelineAnalysisFilter-Input": { "properties": { "timeline_analysis_type": { "type": "string", "const": "document", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SdocTimelineAnalysisFilter" }, "SdocTimelineAnalysisFilter-Output": { "properties": { "timeline_analysis_type": { "type": "string", "const": "document", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SdocColumns_-Output", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SdocTimelineAnalysisFilter" }, "SentAnnoColumns": { "type": "string", "enum": [ "SentAnno_CODE_ID", "SentAnno_USER_ID", "SentAnno_MEMO_CONTENT", "SentAnno_SOURCE_SOURCE_DOCUMENT_NAME", "SentAnno_TAG_ID_LIST_RECURSIVE", "SentAnno_FOLDER_ID_LIST_RECURSIVE" ], "title": "SentAnnoColumns" }, "SentAnnoTimelineAnalysisFilter-Input": { "properties": { "timeline_analysis_type": { "type": "string", "const": "sentence_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SentAnnoColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SentAnnoTimelineAnalysisFilter" }, "SentAnnoTimelineAnalysisFilter-Output": { "properties": { "timeline_analysis_type": { "type": "string", "const": "sentence_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SentAnnoColumns_-Output", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SentAnnoTimelineAnalysisFilter" }, "SentenceAnnotationCreate": { "properties": { "sentence_id_start": { "type": "integer", "title": "Sentence Id Start", "description": "Start sentence ID of the SentenceAnnotation" }, "sentence_id_end": { "type": "integer", "title": "Sentence Id End", "description": "End sentence ID of the SentenceAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SentenceAnnotation refers to" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SentenceAnnotation refers to" } }, "type": "object", "required": ["sentence_id_start", "sentence_id_end", "code_id", "sdoc_id"], "title": "SentenceAnnotationCreate" }, "SentenceAnnotationLLMJobResult": { "properties": { "llm_job_type": { "type": "string", "const": "SENTENCE_ANNOTATION", "title": "Llm Job Type" }, "results": { "items": { "$ref": "#/components/schemas/SentenceAnnotationResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": ["llm_job_type", "results"], "title": "SentenceAnnotationLLMJobResult" }, "SentenceAnnotationNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "sentenceAnnotation", "title": "Type" }, "sentenceAnnotationId": { "type": "integer", "title": "Sentenceannotationid", "description": "ID of the sentence annotation" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "sentenceAnnotationId"], "title": "SentenceAnnotationNodeData" }, "SentenceAnnotationParams": { "properties": { "llm_job_type": { "type": "string", "const": "SENTENCE_ANNOTATION", "title": "Llm Job Type" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "IDs of the source documents to analyse" }, "code_ids": { "items": { "type": "integer" }, "type": "array", "title": "Code Ids", "description": "IDs of the codes to use for the sentence annotation" }, "delete_existing_annotations": { "type": "boolean", "title": "Delete Existing Annotations", "description": "Delete existing annotations before creating new ones", "default": false } }, "type": "object", "required": ["llm_job_type", "sdoc_ids", "code_ids"], "title": "SentenceAnnotationParams" }, "SentenceAnnotationRead": { "properties": { "sentence_id_start": { "type": "integer", "title": "Sentence Id Start", "description": "Start sentence ID of the SentenceAnnotation" }, "sentence_id_end": { "type": "integer", "title": "Sentence Id End", "description": "End sentence ID of the SentenceAnnotation" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SentenceAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SentenceAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User that created the SentenceAnnotation" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SentenceAnnotation refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the SentenceAnnotation" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SentenceAnnotation" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "Memo IDs attached to the SentenceAnnotation" } }, "type": "object", "required": [ "sentence_id_start", "sentence_id_end", "id", "code_id", "user_id", "sdoc_id", "created", "updated", "memo_ids" ], "title": "SentenceAnnotationRead" }, "SentenceAnnotationResult": { "properties": { "status": { "type": "string", "enum": ["error", "finished"], "title": "Status", "description": "Status of the Result" }, "status_message": { "type": "string", "title": "Status Message", "description": "Status message of the result" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "suggested_annotations": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array", "title": "Suggested Annotations", "description": "Suggested annotations" } }, "type": "object", "required": ["status", "status_message", "sdoc_id", "suggested_annotations"], "title": "SentenceAnnotationResult" }, "SentenceAnnotationRow": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the SentenceAnnotation" }, "text": { "type": "string", "title": "Text", "description": "The Text the SentenceAnnotation spans." }, "code": { "$ref": "#/components/schemas/CodeRead", "description": "Code the SentenceAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the SentenceAnnotation belongs to" }, "sdoc": { "$ref": "#/components/schemas/SourceDocumentRead", "description": "SourceDocument the SentenceAnnotation refers to" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "The TagIDs of the SourceDocument." }, "memo": { "anyOf": [{ "$ref": "#/components/schemas/MemoRead" }, { "type": "null" }], "description": "The Memo of the Annotation." } }, "type": "object", "required": ["id", "text", "code", "user_id", "sdoc", "tag_ids", "memo"], "title": "SentenceAnnotationRow" }, "SentenceAnnotationSearchResult": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of sentence_annotation_ids. Used for pagination." }, "data": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRow" }, "type": "array", "title": "Data", "description": "The Annotations." } }, "type": "object", "required": ["total_results", "data"], "title": "SentenceAnnotationSearchResult" }, "SentenceAnnotationUpdate": { "properties": { "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SentenceAnnotation refers to" } }, "type": "object", "required": ["code_id"], "title": "SentenceAnnotationUpdate" }, "SentenceAnnotationUpdateBulk": { "properties": { "sent_annotation_id": { "type": "integer", "title": "Sent Annotation Id", "description": "ID of the SentenceAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SentenceAnnotation refers to" } }, "type": "object", "required": ["sent_annotation_id", "code_id"], "title": "SentenceAnnotationUpdateBulk" }, "SentenceAnnotatorResult": { "properties": { "sentence_annotations": { "additionalProperties": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array" }, "type": "object", "title": "Sentence Annotations", "description": "A mapping of sentence IDs to their annotations" } }, "type": "object", "required": ["sentence_annotations"], "title": "SentenceAnnotatorResult" }, "SentenceEmbeddingParams": { "properties": { "ml_job_type": { "type": "string", "const": "SENTENCE_EMBEDDING", "title": "Ml Job Type" }, "recompute": { "type": "boolean", "title": "Recompute", "description": "Whether to recompute already processed documents", "default": false } }, "type": "object", "required": ["ml_job_type"], "title": "SentenceEmbeddingParams" }, "SimSearchImageHit": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "The ID of the SourceDocument similar to the query." }, "score": { "type": "number", "title": "Score", "description": "The similarity score." } }, "type": "object", "required": ["sdoc_id", "score"], "title": "SimSearchImageHit" }, "SimSearchSentenceHit": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "The ID of the SourceDocument similar to the query." }, "score": { "type": "number", "title": "Score", "description": "The similarity score." }, "sentence_id": { "type": "integer", "title": "Sentence Id", "description": "The sentence id with respect to the SourceDocument" } }, "type": "object", "required": ["sdoc_id", "score", "sentence_id"], "title": "SimSearchSentenceHit" }, "SortDirection": { "type": "string", "enum": ["asc", "desc"], "title": "SortDirection" }, "Sort_BBoxColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/BBoxColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[BBoxColumns]" }, "Sort_MemoColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/MemoColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[MemoColumns]" }, "Sort_SdocColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/SdocColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[SdocColumns]" }, "Sort_SentAnnoColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/SentAnnoColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[SentAnnoColumns]" }, "Sort_SpanColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/SpanColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[SpanColumns]" }, "Sort_WordFrequencyColumns_": { "properties": { "column": { "anyOf": [{ "$ref": "#/components/schemas/WordFrequencyColumns" }, { "type": "integer" }], "title": "Column" }, "direction": { "$ref": "#/components/schemas/SortDirection" } }, "type": "object", "required": ["column", "direction"], "title": "Sort[WordFrequencyColumns]" }, "SourceDocumentDataRead": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocument" }, "project_id": { "type": "integer", "title": "Project Id", "description": "ID of the Project the SourceDocument belongs to" }, "repo_url": { "type": "string", "title": "Repo Url", "description": "Relative path to the SourceDocument in the repository" }, "html": { "type": "string", "title": "Html", "description": "Processed HTML of the SourceDocument" }, "tokens": { "items": { "type": "string" }, "type": "array", "title": "Tokens", "description": "List of tokens in the SourceDocument" }, "token_character_offsets": { "items": { "prefixItems": [{ "type": "integer" }, { "type": "integer" }], "type": "array", "maxItems": 2, "minItems": 2 }, "type": "array", "title": "Token Character Offsets", "description": "List of character offsets of each token" }, "sentences": { "items": { "type": "string" }, "type": "array", "title": "Sentences", "description": "List of sentences in the SourceDocument" }, "word_level_transcriptions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/WordLevelTranscription" }, "type": "array" }, { "type": "null" } ], "title": "Word Level Transcriptions", "description": "word level transcriptions, with tokens, start times and end times" } }, "type": "object", "required": [ "id", "project_id", "repo_url", "html", "tokens", "token_character_offsets", "sentences", "word_level_transcriptions" ], "title": "SourceDocumentDataRead" }, "SourceDocumentMetadataBulkUpdate": { "properties": { "int_value": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Int Value", "description": "Int Value of the SourceDocumentMetadata" }, "str_value": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Str Value", "description": "String Value of the SourceDocumentMetadata" }, "boolean_value": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Boolean Value", "description": "Boolean Value of the SourceDocumentMetadata" }, "date_value": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Date Value", "description": "Date Value of the SourceDocumentMetadata" }, "list_value": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "List Value", "description": "List Value of the SourceDocumentMetadata" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocumentMetadata" } }, "type": "object", "required": ["int_value", "str_value", "boolean_value", "date_value", "list_value", "id"], "title": "SourceDocumentMetadataBulkUpdate" }, "SourceDocumentMetadataRead": { "properties": { "int_value": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Int Value", "description": "Int Value of the SourceDocumentMetadata" }, "str_value": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Str Value", "description": "String Value of the SourceDocumentMetadata" }, "boolean_value": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Boolean Value", "description": "Boolean Value of the SourceDocumentMetadata" }, "date_value": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Date Value", "description": "Date Value of the SourceDocumentMetadata" }, "list_value": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "List Value", "description": "List Value of the SourceDocumentMetadata" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocumentMetadata" }, "project_metadata_id": { "type": "integer", "title": "Project Metadata Id", "description": "ID of the ProjectMetadata" }, "source_document_id": { "type": "integer", "title": "Source Document Id", "description": "SourceDocument the SourceDocumentMetadata belongs to" } }, "type": "object", "required": [ "int_value", "str_value", "boolean_value", "date_value", "list_value", "id", "project_metadata_id", "source_document_id" ], "title": "SourceDocumentMetadataRead" }, "SourceDocumentMetadataReadResolved": { "properties": { "int_value": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Int Value", "description": "Int Value of the SourceDocumentMetadata" }, "str_value": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Str Value", "description": "String Value of the SourceDocumentMetadata" }, "boolean_value": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Boolean Value", "description": "Boolean Value of the SourceDocumentMetadata" }, "date_value": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Date Value", "description": "Date Value of the SourceDocumentMetadata" }, "list_value": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "List Value", "description": "List Value of the SourceDocumentMetadata" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocumentMetadata" }, "source_document_id": { "type": "integer", "title": "Source Document Id", "description": "SourceDocument the SourceDocumentMetadata belongs to" }, "project_metadata": { "$ref": "#/components/schemas/ProjectMetadataRead", "description": "ProjectMetadata of the SourceDocumentMetadata" } }, "type": "object", "required": [ "int_value", "str_value", "boolean_value", "date_value", "list_value", "id", "source_document_id", "project_metadata" ], "title": "SourceDocumentMetadataReadResolved" }, "SourceDocumentMetadataUpdate": { "properties": { "int_value": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Int Value", "description": "Int Value of the SourceDocumentMetadata" }, "str_value": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Str Value", "description": "String Value of the SourceDocumentMetadata" }, "boolean_value": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Boolean Value", "description": "Boolean Value of the SourceDocumentMetadata" }, "date_value": { "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Date Value", "description": "Date Value of the SourceDocumentMetadata" }, "list_value": { "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "List Value", "description": "List Value of the SourceDocumentMetadata" } }, "type": "object", "required": ["int_value", "str_value", "boolean_value", "date_value", "list_value"], "title": "SourceDocumentMetadataUpdate" }, "SourceDocumentRead": { "properties": { "filename": { "type": "string", "maxLength": 230, "title": "Filename", "description": "Filename of the SourceDocument" }, "name": { "type": "string", "title": "Name", "description": "User-defined name of the document (default is the filename)" }, "doctype": { "$ref": "#/components/schemas/DocType", "description": "DOCTYPE of the SourceDocument" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the SourceDocument belongs to" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocument" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "The created timestamp of the SourceDocument" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SourceDocument" }, "folder_id": { "type": "integer", "title": "Folder Id", "description": "ID of the Folder this SourceDocument belongs to" } }, "type": "object", "required": ["filename", "name", "doctype", "project_id", "id", "created", "updated", "folder_id"], "title": "SourceDocumentRead" }, "SourceDocumentStatusSimple": { "properties": { "filename": { "type": "string", "maxLength": 230, "title": "Filename", "description": "Filename of the SourceDocument" }, "name": { "type": "string", "title": "Name", "description": "User-defined name of the document (default is the filename)" }, "doctype": { "$ref": "#/components/schemas/DocType", "description": "DOCTYPE of the SourceDocument" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the SourceDocument belongs to" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SourceDocument" }, "processed_jobs": { "type": "integer", "title": "Processed Jobs", "description": "Number of processed jobs (depending on the doctype)" }, "total_jobs": { "type": "integer", "title": "Total Jobs", "description": "Total number of jobs (depending on the doctype)" }, "processed_status": { "$ref": "#/components/schemas/SDocStatus", "description": "Overall processing status. Results from processed_jobs and total_jobs" } }, "type": "object", "required": [ "filename", "name", "doctype", "project_id", "id", "processed_jobs", "total_jobs", "processed_status" ], "title": "SourceDocumentStatusSimple" }, "SourceDocumentTagLinks": { "properties": { "source_document_id": { "type": "integer", "title": "Source Document Id", "description": "ID of SourceDocument" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "List of IDs of Tags" } }, "type": "object", "required": ["source_document_id", "tag_ids"], "title": "SourceDocumentTagLinks" }, "SourceDocumentTagMultiLink": { "properties": { "source_document_ids": { "items": { "type": "integer" }, "type": "array", "title": "Source Document Ids", "description": "List of IDs of SourceDocuments" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "List of IDs of Tags" } }, "type": "object", "required": ["source_document_ids", "tag_ids"], "title": "SourceDocumentTagMultiLink" }, "SourceDocumentUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "User-defined name of the document (default is the filename)" }, "folder_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Folder Id", "description": "ID of the Folder this SourceDocument belongs to" }, "extract_html": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Extract HTML done?" }, "text_extraction": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text Extraction done?" }, "text_language_detection": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text Language Detection done?" }, "text_spacy": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text Spacy done?" }, "text_es_index": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text ES Index done?" }, "text_sentence_embedding": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text Sentence Embedding done?" }, "text_html_mapping": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Text HTML Mapping done?" }, "image_caption": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Image Captioning done?" }, "image_embedding": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Image Embedding done?" }, "image_metadata_extraction": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Image Metadata Extraction done?" }, "image_thumbnail": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Image Thumbnail Generation done?" }, "image_object_detection": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Object Detection done?" }, "audio_metadata": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Audio Metadata Extraction done?" }, "audio_thumbnail": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Audio Thumbnail Generation done?" }, "audio_transcription": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Transcription done?" }, "video_metadata": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Video Metadata Extraction done?" }, "video_thumbnail": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Video Thumbnail Generation done?" }, "video_audio_extraction": { "anyOf": [{ "$ref": "#/components/schemas/SDocStatus" }, { "type": "null" }], "description": "Video Audio Extraction done?" } }, "type": "object", "title": "SourceDocumentUpdate" }, "SpanAnnoTimelineAnalysisFilter-Input": { "properties": { "timeline_analysis_type": { "type": "string", "const": "span_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SpanColumns_-Input", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SpanAnnoTimelineAnalysisFilter" }, "SpanAnnoTimelineAnalysisFilter-Output": { "properties": { "timeline_analysis_type": { "type": "string", "const": "span_annotation", "title": "Timeline Analysis Type" }, "filter": { "$ref": "#/components/schemas/Filter_SpanColumns_-Output", "description": "The filter of the Concept" } }, "type": "object", "required": ["timeline_analysis_type", "filter"], "title": "SpanAnnoTimelineAnalysisFilter" }, "SpanAnnotationCreate": { "properties": { "begin": { "type": "integer", "title": "Begin", "description": "Begin of the SpanAnnotation in characters" }, "end": { "type": "integer", "title": "End", "description": "End of the SpanAnnotation in characters" }, "begin_token": { "type": "integer", "title": "Begin Token", "description": "Begin of the SpanAnnotation in tokens" }, "end_token": { "type": "integer", "title": "End Token", "description": "End of the SpanAnnotation in tokens" }, "span_text": { "type": "string", "title": "Span Text", "description": "The SpanText the SpanAnnotation spans." }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SpanAnnotation refers to" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanAnnotation refers to" } }, "type": "object", "required": ["begin", "end", "begin_token", "end_token", "span_text", "code_id", "sdoc_id"], "title": "SpanAnnotationCreate" }, "SpanAnnotationDeleted": { "properties": { "begin": { "type": "integer", "title": "Begin", "description": "Begin of the SpanAnnotation in characters" }, "end": { "type": "integer", "title": "End", "description": "End of the SpanAnnotation in characters" }, "begin_token": { "type": "integer", "title": "Begin Token", "description": "Begin of the SpanAnnotation in tokens" }, "end_token": { "type": "integer", "title": "End Token", "description": "End of the SpanAnnotation in tokens" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SpanAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SpanAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the SpanAnnotation belongs to" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanAnnotation refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the SpanAnnotation" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SpanAnnotation" } }, "type": "object", "required": [ "begin", "end", "begin_token", "end_token", "id", "code_id", "user_id", "sdoc_id", "created", "updated" ], "title": "SpanAnnotationDeleted" }, "SpanAnnotationHit": { "properties": { "span_dto": { "$ref": "#/components/schemas/SpanAnnotationCreate", "description": "The DTO needed to create the SpanAnnotation." }, "before_context": { "type": "string", "title": "Before Context", "description": "The context before the span." }, "after_context": { "type": "string", "title": "After Context", "description": "The context after the span." } }, "type": "object", "required": ["span_dto", "before_context", "after_context"], "title": "SpanAnnotationHit" }, "SpanAnnotationNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "spanAnnotation", "title": "Type" }, "spanAnnotationId": { "type": "integer", "title": "Spanannotationid", "description": "ID of the span annotation" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "spanAnnotationId"], "title": "SpanAnnotationNodeData" }, "SpanAnnotationRead": { "properties": { "begin": { "type": "integer", "title": "Begin", "description": "Begin of the SpanAnnotation in characters" }, "end": { "type": "integer", "title": "End", "description": "End of the SpanAnnotation in characters" }, "begin_token": { "type": "integer", "title": "Begin Token", "description": "Begin of the SpanAnnotation in tokens" }, "end_token": { "type": "integer", "title": "End Token", "description": "End of the SpanAnnotation in tokens" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SpanAnnotation" }, "text": { "type": "string", "title": "Text", "description": "The SpanText the SpanAnnotation spans." }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SpanAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the SpanAnnotation belongs to" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanAnnotation refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the SpanAnnotation" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SpanAnnotation" }, "group_ids": { "items": { "type": "integer" }, "type": "array", "title": "Group Ids", "description": "The group ids this span annotations belongs to" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "Memo IDs attached to the SpanAnnotation" } }, "type": "object", "required": [ "begin", "end", "begin_token", "end_token", "id", "text", "code_id", "user_id", "sdoc_id", "created", "updated", "group_ids", "memo_ids" ], "title": "SpanAnnotationRead" }, "SpanAnnotationRow": { "properties": { "id": { "type": "integer", "title": "Id", "description": "ID of the SpanAnnotation" }, "span_text": { "type": "string", "title": "Span Text", "description": "The SpanText the SpanAnnotation spans." }, "code": { "$ref": "#/components/schemas/CodeRead", "description": "Code the SpanAnnotation refers to" }, "user_id": { "type": "integer", "title": "User Id", "description": "User the SpanAnnotation belongs to" }, "sdoc": { "$ref": "#/components/schemas/SourceDocumentRead", "description": "SourceDocument the SpanAnnotation refers to" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "The TagIDs of the SourceDocument." }, "memo": { "anyOf": [{ "$ref": "#/components/schemas/MemoRead" }, { "type": "null" }], "description": "The Memo of the Annotation." } }, "type": "object", "required": ["id", "span_text", "code", "user_id", "sdoc", "tag_ids", "memo"], "title": "SpanAnnotationRow" }, "SpanAnnotationSearchResult": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of span_annotation_ids. Used for pagination." }, "data": { "items": { "$ref": "#/components/schemas/SpanAnnotationRow" }, "type": "array", "title": "Data", "description": "The Annotations." } }, "type": "object", "required": ["total_results", "data"], "title": "SpanAnnotationSearchResult" }, "SpanAnnotationUpdate": { "properties": { "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SpanAnnotation refers to" } }, "type": "object", "required": ["code_id"], "title": "SpanAnnotationUpdate" }, "SpanAnnotationUpdateBulk": { "properties": { "span_annotation_id": { "type": "integer", "title": "Span Annotation Id", "description": "ID of the SpanAnnotation" }, "code_id": { "type": "integer", "title": "Code Id", "description": "Code the SpanAnnotation refers to" } }, "type": "object", "required": ["span_annotation_id", "code_id"], "title": "SpanAnnotationUpdateBulk" }, "SpanColumns": { "type": "string", "enum": [ "SP_SPAN_TEXT", "SP_CODE_ID", "SP_USER_ID", "SP_MEMO_CONTENT", "SP_SOURCE_SOURCE_DOCUMENT_NAME", "SP_TAG_ID_LIST_RECURSIVE", "SP_FOLDER_ID_LIST_RECURSIVE" ], "title": "SpanColumns" }, "SpanEntityStat": { "properties": { "code_id": { "type": "integer", "title": "Code Id", "description": "The ID of the Code related to the SpanAnnotation" }, "span_text": { "type": "string", "title": "Span Text", "description": "The SpanText the SpanAnnotation spans" }, "filtered_count": { "type": "integer", "title": "Filtered Count", "description": "Number of occurrences of the SpanEntity in a collection of SourceDocuments." }, "global_count": { "type": "integer", "title": "Global Count", "description": "Number of occurrences of the SpanEntity in a collection of SourceDocuments." } }, "type": "object", "required": ["code_id", "span_text", "filtered_count", "global_count"], "title": "SpanEntityStat" }, "SpanGroupCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the SpanGroup" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanGroup refers to" } }, "type": "object", "required": ["name", "sdoc_id"], "title": "SpanGroupCreate" }, "SpanGroupRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the SpanGroup" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SpanGroup" }, "user_id": { "type": "integer", "title": "User Id", "description": "User that created the SpanGroup" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanGroup refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the SpanGroup" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SpanGroup" } }, "type": "object", "required": ["name", "id", "user_id", "sdoc_id", "created", "updated"], "title": "SpanGroupRead" }, "SpanGroupUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name of the SpanGroup" } }, "type": "object", "title": "SpanGroupUpdate" }, "SpanGroupWithAnnotationsRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the SpanGroup" }, "id": { "type": "integer", "title": "Id", "description": "ID of the SpanGroup" }, "user_id": { "type": "integer", "title": "User Id", "description": "User that created the SpanGroup" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "SourceDocument the SpanGroup refers to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the SpanGroup" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the SpanGroup" }, "span_annotations": { "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "type": "array", "title": "Span Annotations", "description": "Annotations of the SpanGroup" } }, "type": "object", "required": ["name", "id", "user_id", "sdoc_id", "created", "updated", "span_annotations"], "title": "SpanGroupWithAnnotationsRead" }, "SplitClusterParams": { "properties": { "perspectives_job_type": { "type": "string", "const": "split_cluster", "title": "Perspectives Job Type", "description": "Type of the PerspectivesJob", "default": "split_cluster" }, "cluster_id": { "type": "integer", "title": "Cluster Id", "description": "ID of the cluster to split." }, "split_into": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Split Into", "description": "Number of clusters to split the cluster into. Must be greater than 1. If not set, the cluster will be split automatically." } }, "type": "object", "required": ["cluster_id", "split_into"], "title": "SplitClusterParams" }, "StringOperator": { "type": "string", "enum": ["STRING_CONTAINS", "STRING_EQUALS", "STRING_NOT_EQUALS", "STRING_STARTS_WITH", "STRING_ENDS_WITH"], "title": "StringOperator" }, "TAAnnotationAggregationType": { "type": "string", "enum": ["unit", "annotation", "document"], "title": "TAAnnotationAggregationType" }, "TagCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Title of the Tag" }, "color": { "type": "string", "title": "Color", "description": "Color of the Code" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the Tag" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Tag" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Tag belongs to" } }, "type": "object", "required": ["name", "project_id"], "title": "TagCreate" }, "TagNodeData": { "properties": { "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" }, "type": { "type": "string", "const": "tag", "title": "Type" }, "tagId": { "type": "integer", "title": "Tagid", "description": "ID of the tag" } }, "type": "object", "required": ["bgcolor", "bgalpha", "type", "tagId"], "title": "TagNodeData" }, "TagRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Title of the Tag" }, "color": { "type": "string", "title": "Color", "description": "Color of the Tag" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the Tag" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Tag" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Tag" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Tag belongs to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the Tag" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the Tag" }, "memo_ids": { "items": { "type": "integer" }, "type": "array", "title": "Memo Ids", "description": "Memo IDs attached to the Tag" } }, "type": "object", "required": ["name", "color", "id", "project_id", "created", "updated", "memo_ids"], "title": "TagRead" }, "TagRecommendationLinkRead": { "properties": { "ml_job_id": { "type": "string", "title": "Ml Job Id", "description": "Identifier of the corresponding ML Job." }, "source_document_id": { "type": "integer", "title": "Source Document Id", "description": "ID of the source document" }, "predicted_tag_id": { "type": "integer", "title": "Predicted Tag Id", "description": "ID of the predicted tag" }, "prediction_score": { "type": "number", "title": "Prediction Score", "description": "Prediction score of the tag" }, "is_reviewed": { "type": "boolean", "title": "Is Reviewed", "description": "Reviewed status of the recommendation", "default": false } }, "type": "object", "required": ["ml_job_id", "source_document_id", "predicted_tag_id", "prediction_score"], "title": "TagRecommendationLinkRead" }, "TagRecommendationMethod": { "type": "string", "enum": ["SIMPLE", "KNN", "EXCLUSIVE"], "title": "TagRecommendationMethod" }, "TagRecommendationResult": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "recommendation_ids": { "items": { "type": "integer" }, "type": "array", "title": "Recommendation Ids", "description": "List of the corresponding TagRecommendationLinks" }, "current_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Current Tag Ids", "description": "List of current tag IDs for the source document" }, "suggested_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Suggested Tag Ids", "description": "List of suggested tag IDs for the source document" }, "scores": { "items": { "type": "number" }, "type": "array", "title": "Scores", "description": "List of the scores of the suggested tags" } }, "type": "object", "required": ["sdoc_id", "recommendation_ids", "current_tag_ids", "suggested_tag_ids", "scores"], "title": "TagRecommendationResult" }, "TagStat": { "properties": { "tag": { "$ref": "#/components/schemas/TagRead", "description": "The counted document tag." }, "filtered_count": { "type": "integer", "title": "Filtered Count", "description": "Number of occurrences of the document tag in the filtered documents" }, "global_count": { "type": "integer", "title": "Global Count", "description": "Number of occurrences of the document tag in all documents" } }, "type": "object", "required": ["tag", "filtered_count", "global_count"], "title": "TagStat" }, "TagUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name of the Tag" }, "color": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Color", "description": "Color of the Tag" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the Tag" }, "parent_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Parent Id", "description": "Parent of the Tag" } }, "type": "object", "title": "TagUpdate" }, "TaggingLLMJobResult": { "properties": { "llm_job_type": { "type": "string", "const": "TAGGING", "title": "Llm Job Type" }, "results": { "items": { "$ref": "#/components/schemas/TaggingResult" }, "type": "array", "title": "Results" } }, "type": "object", "required": ["llm_job_type", "results"], "title": "TaggingLLMJobResult" }, "TaggingParams": { "properties": { "llm_job_type": { "type": "string", "const": "TAGGING", "title": "Llm Job Type" }, "sdoc_ids": { "items": { "type": "integer" }, "type": "array", "title": "Sdoc Ids", "description": "IDs of the source documents to analyse" }, "tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Tag Ids", "description": "IDs of the tags to use for the document tagging" } }, "type": "object", "required": ["llm_job_type", "sdoc_ids", "tag_ids"], "title": "TaggingParams" }, "TaggingResult": { "properties": { "status": { "type": "string", "enum": ["error", "finished"], "title": "Status", "description": "Status of the Result" }, "status_message": { "type": "string", "title": "Status Message", "description": "Status message of the result" }, "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the source document" }, "current_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Current Tag Ids", "description": "IDs of the tags currently assigned to the document" }, "suggested_tag_ids": { "items": { "type": "integer" }, "type": "array", "title": "Suggested Tag Ids", "description": "IDs of the tags suggested by the LLM to assign to the document" }, "reasoning": { "type": "string", "title": "Reasoning", "description": "Reasoning for the tagging" } }, "type": "object", "required": ["status", "status_message", "sdoc_id", "current_tag_ids", "suggested_tag_ids", "reasoning"], "title": "TaggingResult" }, "TaskType": { "type": "string", "enum": ["TAGGING", "METADATA_EXTRACTION", "ANNOTATION", "SENTENCE_ANNOTATION"], "title": "TaskType" }, "TextNodeData": { "properties": { "text": { "type": "string", "title": "Text", "description": "Text of the text" }, "color": { "type": "string", "title": "Color", "description": "Text color of the text" }, "horizontalAlign": { "$ref": "#/components/schemas/HorizontalAlign", "description": "Horizontal alignment of the text" }, "verticalAlign": { "$ref": "#/components/schemas/VerticalAlign", "description": "Vertical alignment of the text" }, "bold": { "type": "boolean", "title": "Bold", "description": "Boldness of the text" }, "italic": { "type": "boolean", "title": "Italic", "description": "Italicness of the text" }, "underline": { "type": "boolean", "title": "Underline", "description": "Underlinedness of the text" }, "strikethrough": { "type": "boolean", "title": "Strikethrough", "description": "Strikethroughness of the text" }, "fontSize": { "type": "integer", "title": "Fontsize", "description": "Font size of the text" }, "fontFamily": { "type": "string", "title": "Fontfamily", "description": "Font family of the text" }, "type": { "type": "string", "const": "text", "title": "Type" } }, "type": "object", "required": [ "text", "color", "horizontalAlign", "verticalAlign", "bold", "italic", "underline", "strikethrough", "fontSize", "fontFamily", "type" ], "title": "TextNodeData" }, "TimelineAnalysisConcept": { "properties": { "timeline_analysis_type": { "$ref": "#/components/schemas/TimelineAnalysisType", "description": "Type of the Timeline Analysis" }, "id": { "type": "string", "title": "Id", "description": "ID of the Concept" }, "name": { "type": "string", "title": "Name", "description": "Name of the Concept" }, "description": { "type": "string", "title": "Description", "description": "Description of the Concept" }, "color": { "type": "string", "title": "Color", "description": "Color of the Concept" }, "visible": { "type": "boolean", "title": "Visible", "description": "Visibility of the Concept" }, "ta_specific_filter": { "oneOf": [ { "$ref": "#/components/schemas/SdocTimelineAnalysisFilter-Output" }, { "$ref": "#/components/schemas/SentAnnoTimelineAnalysisFilter-Output" }, { "$ref": "#/components/schemas/SpanAnnoTimelineAnalysisFilter-Output" }, { "$ref": "#/components/schemas/BBoxAnnoTimelineAnalysisFilter-Output" } ], "title": "Ta Specific Filter", "description": "List of Concepts that are part of the TimelineAnalysis", "discriminator": { "propertyName": "timeline_analysis_type", "mapping": { "bbox_annotation": "#/components/schemas/BBoxAnnoTimelineAnalysisFilter-Output", "document": "#/components/schemas/SdocTimelineAnalysisFilter-Output", "sentence_annotation": "#/components/schemas/SentAnnoTimelineAnalysisFilter-Output", "span_annotation": "#/components/schemas/SpanAnnoTimelineAnalysisFilter-Output" } } }, "filter_hash": { "type": "integer", "title": "Filter Hash", "description": "Hash of the filter to identify changes" }, "results": { "items": { "$ref": "#/components/schemas/TimelineAnalysisResult" }, "type": "array", "title": "Results", "description": "List of Results of the TimelineAnalysis" } }, "type": "object", "required": [ "timeline_analysis_type", "id", "name", "description", "color", "visible", "ta_specific_filter", "filter_hash", "results" ], "title": "TimelineAnalysisConcept" }, "TimelineAnalysisConceptUpdate": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the Concept" }, "name": { "type": "string", "title": "Name", "description": "Name of the Concept" }, "description": { "type": "string", "title": "Description", "description": "Description of the Concept" }, "color": { "type": "string", "title": "Color", "description": "Color of the Concept" }, "visible": { "type": "boolean", "title": "Visible", "description": "Visibility of the Concept" }, "ta_specific_filter": { "oneOf": [ { "$ref": "#/components/schemas/SdocTimelineAnalysisFilter-Input" }, { "$ref": "#/components/schemas/SentAnnoTimelineAnalysisFilter-Input" }, { "$ref": "#/components/schemas/SpanAnnoTimelineAnalysisFilter-Input" }, { "$ref": "#/components/schemas/BBoxAnnoTimelineAnalysisFilter-Input" } ], "title": "Ta Specific Filter", "description": "List of Concepts that are part of the TimelineAnalysis", "discriminator": { "propertyName": "timeline_analysis_type", "mapping": { "bbox_annotation": "#/components/schemas/BBoxAnnoTimelineAnalysisFilter-Input", "document": "#/components/schemas/SdocTimelineAnalysisFilter-Input", "sentence_annotation": "#/components/schemas/SentAnnoTimelineAnalysisFilter-Input", "span_annotation": "#/components/schemas/SpanAnnoTimelineAnalysisFilter-Input" } } } }, "type": "object", "required": ["id", "name", "description", "color", "visible", "ta_specific_filter"], "title": "TimelineAnalysisConceptUpdate" }, "TimelineAnalysisCreate": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the TimelineAnalysis" }, "timeline_analysis_type": { "$ref": "#/components/schemas/TimelineAnalysisType", "description": "The type of the TimelineAnalysis" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the TimelineAnalysis belongs to" } }, "type": "object", "required": ["name", "timeline_analysis_type", "project_id"], "title": "TimelineAnalysisCreate" }, "TimelineAnalysisRead": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the TimelineAnalysis" }, "timeline_analysis_type": { "$ref": "#/components/schemas/TimelineAnalysisType", "description": "The type of the TimelineAnalysis" }, "id": { "type": "integer", "title": "Id", "description": "ID of the TimelineAnalysis" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the TimelineAnalysis belongs to" }, "settings": { "$ref": "#/components/schemas/TimelineAnalysisSettings", "description": "Timeline Analysis Settings of the TimelineAnalysis." }, "concepts": { "items": { "$ref": "#/components/schemas/TimelineAnalysisConcept" }, "type": "array", "title": "Concepts", "description": "List of Concepts that are part of the TimelineAnalysis" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the TimelineAnalysis" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the TimelineAnalysis" } }, "type": "object", "required": [ "name", "timeline_analysis_type", "id", "project_id", "settings", "concepts", "created", "updated" ], "title": "TimelineAnalysisRead" }, "TimelineAnalysisResult": { "properties": { "date": { "type": "string", "title": "Date", "description": "The date." }, "data_ids": { "items": { "type": "integer" }, "type": "array", "title": "Data Ids", "description": "The data IDs used for provenance." }, "count": { "type": "integer", "title": "Count", "description": "The count / value used for plotting." } }, "type": "object", "required": ["date", "data_ids", "count"], "title": "TimelineAnalysisResult" }, "TimelineAnalysisSettings": { "properties": { "group_by": { "$ref": "#/components/schemas/DateGroupBy", "description": "Group by date", "default": "YEAR" }, "annotation_aggregation_type": { "anyOf": [{ "$ref": "#/components/schemas/TAAnnotationAggregationType" }, { "type": "null" }], "description": "The type of the annotation aggregation (only for TimelineAnalysisType != DOCUMENT)", "default": "annotation" }, "date_metadata_id": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Date Metadata Id", "description": "ID of the Project Date Metadata that is used for the TimelineAnalysis" } }, "type": "object", "title": "TimelineAnalysisSettings" }, "TimelineAnalysisType": { "type": "string", "enum": ["document", "sentence_annotation", "span_annotation", "bbox_annotation"], "title": "TimelineAnalysisType" }, "TimelineAnalysisUpdate": { "properties": { "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name of the TimelineAnalysis" }, "settings": { "anyOf": [{ "$ref": "#/components/schemas/TimelineAnalysisSettings" }, { "type": "null" }], "description": "Settings of the TimelineAnalysis." }, "concepts": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TimelineAnalysisConceptUpdate" }, "type": "array" }, { "type": "null" } ], "title": "Concepts", "description": "List of Concepts that are part of the TimelineAnalysis" } }, "type": "object", "title": "TimelineAnalysisUpdate" }, "UserAuthorizationHeaderData": { "properties": { "access_token": { "type": "string", "title": "Access Token", "description": "Value of the JWT" }, "access_token_expires": { "type": "string", "format": "date-time", "title": "Access Token Expires" }, "refresh_token": { "type": "string", "title": "Refresh Token", "description": "For obtaining a new access token" }, "refresh_token_expires": { "type": "string", "format": "date-time", "title": "Refresh Token Expires" }, "token_type": { "type": "string", "title": "Token Type", "description": "Type of the Token" } }, "type": "object", "required": ["access_token", "access_token_expires", "refresh_token", "refresh_token_expires", "token_type"], "title": "UserAuthorizationHeaderData" }, "UserCreate": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "E-Mail of the User" }, "first_name": { "type": "string", "title": "First Name", "description": "First name of the User" }, "last_name": { "type": "string", "title": "Last Name", "description": "Last name of the User" }, "password": { "type": "string", "title": "Password", "description": "Hashed password of the User" } }, "type": "object", "required": ["email", "first_name", "last_name", "password"], "title": "UserCreate" }, "UserRead": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "E-Mail of the User" }, "first_name": { "type": "string", "title": "First Name", "description": "First name of the User" }, "last_name": { "type": "string", "title": "Last Name", "description": "Last name of the User" }, "id": { "type": "integer", "title": "Id", "description": "ID of the User" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the User" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the User" } }, "type": "object", "required": ["email", "first_name", "last_name", "id", "created", "updated"], "title": "UserRead" }, "UserUpdate": { "properties": { "email": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Email", "description": "E-Mail of the User" }, "first_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "First Name", "description": "First name of the User" }, "last_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Last Name", "description": "Last name of the User" }, "password": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Password", "description": "Hashed password of the User" } }, "type": "object", "title": "UserUpdate" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError" }, "VerticalAlign": { "type": "string", "enum": ["top", "center", "bottom"], "title": "VerticalAlign" }, "WhiteboardContent": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/WhiteboardNode" }, "type": "array", "title": "Nodes", "description": "Nodes of the Whiteboard" }, "edges": { "items": { "$ref": "#/components/schemas/WhiteboardEdge" }, "type": "array", "title": "Edges", "description": "Edges of the Whiteboard" } }, "type": "object", "required": ["nodes", "edges"], "title": "WhiteboardContent" }, "WhiteboardCreate": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Whiteboard" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Whiteboard belongs to" } }, "type": "object", "required": ["title", "project_id"], "title": "WhiteboardCreate" }, "WhiteboardData": { "properties": { "sdocs": { "items": { "$ref": "#/components/schemas/SourceDocumentRead" }, "type": "array", "title": "Sdocs", "description": "List of source documents" }, "codes": { "items": { "$ref": "#/components/schemas/CodeRead" }, "type": "array", "title": "Codes", "description": "List of codes" }, "tags": { "items": { "$ref": "#/components/schemas/TagRead" }, "type": "array", "title": "Tags", "description": "List of tags" }, "span_annotations": { "items": { "$ref": "#/components/schemas/SpanAnnotationRead" }, "type": "array", "title": "Span Annotations", "description": "List of span annotations" }, "sent_annotations": { "items": { "$ref": "#/components/schemas/SentenceAnnotationRead" }, "type": "array", "title": "Sent Annotations", "description": "List of sentence annotations" }, "bbox_annotations": { "items": { "$ref": "#/components/schemas/BBoxAnnotationRead" }, "type": "array", "title": "Bbox Annotations", "description": "List of bbox annotations" }, "memos": { "items": { "$ref": "#/components/schemas/MemoRead" }, "type": "array", "title": "Memos", "description": "List of memos" } }, "type": "object", "required": ["sdocs", "codes", "tags", "span_annotations", "sent_annotations", "bbox_annotations", "memos"], "title": "WhiteboardData" }, "WhiteboardEdge": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the edge" }, "type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Type", "description": "Type of the edge" }, "source": { "type": "string", "title": "Source", "description": "Source node ID" }, "sourceHandle": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Sourcehandle", "description": "Source handle position" }, "target": { "type": "string", "title": "Target", "description": "Target node ID" }, "targetHandle": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Targethandle", "description": "Target handle position" }, "data": { "anyOf": [{ "$ref": "#/components/schemas/WhiteboardEdgeData" }, { "type": "null" }], "description": "Data of the edge" }, "style": { "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Style", "description": "Style of the edge" }, "markerEnd": { "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "string" }], "title": "Markerend", "description": "Marker end of the edge", "default": "" }, "markerStart": { "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "string" }], "title": "Markerstart", "description": "Marker start of the edge", "default": "" } }, "type": "object", "required": ["id", "source", "target"], "title": "WhiteboardEdge" }, "WhiteboardEdgeData": { "properties": { "type": { "$ref": "#/components/schemas/WhiteboardEdgeType", "description": "Type of the edge" }, "label": { "$ref": "#/components/schemas/WhiteboardEdgeLabelData" } }, "type": "object", "required": ["type", "label"], "title": "WhiteboardEdgeData" }, "WhiteboardEdgeLabelData": { "properties": { "text": { "type": "string", "title": "Text", "description": "Text of the text" }, "color": { "type": "string", "title": "Color", "description": "Text color of the text" }, "horizontalAlign": { "$ref": "#/components/schemas/HorizontalAlign", "description": "Horizontal alignment of the text" }, "verticalAlign": { "$ref": "#/components/schemas/VerticalAlign", "description": "Vertical alignment of the text" }, "bold": { "type": "boolean", "title": "Bold", "description": "Boldness of the text" }, "italic": { "type": "boolean", "title": "Italic", "description": "Italicness of the text" }, "underline": { "type": "boolean", "title": "Underline", "description": "Underlinedness of the text" }, "strikethrough": { "type": "boolean", "title": "Strikethrough", "description": "Strikethroughness of the text" }, "fontSize": { "type": "integer", "title": "Fontsize", "description": "Font size of the text" }, "fontFamily": { "type": "string", "title": "Fontfamily", "description": "Font family of the text" }, "bgcolor": { "type": "string", "title": "Bgcolor", "description": "Background color of the text" }, "bgalpha": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Bgalpha", "description": "Background color alpha of the text" } }, "type": "object", "required": [ "text", "color", "horizontalAlign", "verticalAlign", "bold", "italic", "underline", "strikethrough", "fontSize", "fontFamily", "bgcolor", "bgalpha" ], "title": "WhiteboardEdgeLabelData" }, "WhiteboardEdgeType": { "type": "string", "enum": ["bezier", "straight", "simplebezier", "smoothstep"], "title": "WhiteboardEdgeType" }, "WhiteboardNode": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID of the node" }, "type": { "anyOf": [{ "$ref": "#/components/schemas/WhiteboardNodeType" }, { "type": "string" }], "title": "Type", "description": "Type of the node", "default": "text" }, "data": { "oneOf": [ { "$ref": "#/components/schemas/TextNodeData" }, { "$ref": "#/components/schemas/NoteNodeData" }, { "$ref": "#/components/schemas/BorderNodeData" }, { "$ref": "#/components/schemas/SdocNodeData" }, { "$ref": "#/components/schemas/MemoNodeData" }, { "$ref": "#/components/schemas/CodeNodeData" }, { "$ref": "#/components/schemas/TagNodeData" }, { "$ref": "#/components/schemas/SpanAnnotationNodeData" }, { "$ref": "#/components/schemas/SentenceAnnotationNodeData" }, { "$ref": "#/components/schemas/BBoxAnnotationNodeData" } ], "title": "Data", "description": "Data of the node", "discriminator": { "propertyName": "type", "mapping": { "bboxAnnotation": "#/components/schemas/BBoxAnnotationNodeData", "border": "#/components/schemas/BorderNodeData", "code": "#/components/schemas/CodeNodeData", "memo": "#/components/schemas/MemoNodeData", "note": "#/components/schemas/NoteNodeData", "sdoc": "#/components/schemas/SdocNodeData", "sentenceAnnotation": "#/components/schemas/SentenceAnnotationNodeData", "spanAnnotation": "#/components/schemas/SpanAnnotationNodeData", "tag": "#/components/schemas/TagNodeData", "text": "#/components/schemas/TextNodeData" } } }, "position": { "$ref": "#/components/schemas/XYPosition", "description": "Position of the node" }, "width": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Width", "description": "Width of the node" }, "height": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Height", "description": "Height of the node" }, "style": { "additionalProperties": true, "type": "object", "title": "Style", "description": "Style of the node", "default": {} } }, "type": "object", "required": ["id", "data", "position"], "title": "WhiteboardNode" }, "WhiteboardNodeType": { "type": "string", "enum": [ "text", "note", "border", "sdoc", "memo", "code", "tag", "spanAnnotation", "sentenceAnnotation", "bboxAnnotation" ], "title": "WhiteboardNodeType" }, "WhiteboardRead": { "properties": { "title": { "type": "string", "title": "Title", "description": "Title of the Whiteboard" }, "id": { "type": "integer", "title": "Id", "description": "ID of the Whiteboard" }, "project_id": { "type": "integer", "title": "Project Id", "description": "Project the Whiteboard belongs to" }, "created": { "type": "string", "format": "date-time", "title": "Created", "description": "Created timestamp of the Whiteboard" }, "updated": { "type": "string", "format": "date-time", "title": "Updated", "description": "Updated timestamp of the Whiteboard" }, "content": { "$ref": "#/components/schemas/WhiteboardContent", "description": "Content of the Whiteboard" } }, "type": "object", "required": ["title", "id", "project_id", "created", "updated", "content"], "title": "WhiteboardRead" }, "WhiteboardUpdate": { "properties": { "title": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Title", "description": "Title of the Whiteboard" }, "content": { "anyOf": [{ "$ref": "#/components/schemas/WhiteboardContent" }, { "type": "null" }], "description": "Conten of the Whiteboard" } }, "type": "object", "title": "WhiteboardUpdate" }, "WordFrequencyColumns": { "type": "string", "enum": [ "WF_WORD", "WF_WORD_FREQUENCY", "WF_WORD_PERCENT", "WF_SOURCE_DOCUMENT_FREQUENCY", "WF_SOURCE_DOCUMENT_PERCENT", "WF_SOURCE_DOCUMENT_NAME", "WF_TAG_ID_LIST_RECURSIVE", "WF_CODE_ID_LIST_RECURSIVE", "WF_FOLDER_ID_LIST_RECURSIVE", "WF_USER_ID_LIST", "WF_SPAN_ANNOTATIONS" ], "title": "WordFrequencyColumns" }, "WordFrequencyRead": { "properties": { "sdoc_id": { "type": "integer", "title": "Sdoc Id", "description": "ID of the SourceDocument" }, "word": { "type": "string", "title": "Word", "description": "Word" }, "count": { "type": "integer", "title": "Count", "description": "Count of the word in the SourceDocument" } }, "type": "object", "required": ["sdoc_id", "word", "count"], "title": "WordFrequencyRead" }, "WordFrequencyResult": { "properties": { "total_results": { "type": "integer", "title": "Total Results", "description": "The total number of word_frequencies. Used for pagination." }, "sdocs_total": { "type": "integer", "title": "Sdocs Total", "description": "The total number of SourceDocuments." }, "words_total": { "type": "integer", "title": "Words Total", "description": "The total number of words." }, "word_frequencies": { "items": { "$ref": "#/components/schemas/WordFrequencyStat" }, "type": "array", "title": "Word Frequencies", "description": "The WordFrequencies." } }, "type": "object", "required": ["total_results", "sdocs_total", "words_total", "word_frequencies"], "title": "WordFrequencyResult" }, "WordFrequencyStat": { "properties": { "word": { "type": "string", "title": "Word", "description": "The word." }, "word_percent": { "type": "number", "title": "Word Percent", "description": "The percentage of the word." }, "count": { "type": "integer", "title": "Count", "description": "The SourceDoument IDs." }, "sdocs": { "type": "integer", "title": "Sdocs", "description": "The number of SourceDocuments." }, "sdocs_percent": { "type": "number", "title": "Sdocs Percent", "description": "The percentage of SourceDocuments." } }, "type": "object", "required": ["word", "word_percent", "count", "sdocs", "sdocs_percent"], "title": "WordFrequencyStat" }, "WordLevelTranscription": { "properties": { "text": { "type": "string", "title": "Text" }, "start_ms": { "type": "integer", "title": "Start Ms" }, "end_ms": { "type": "integer", "title": "End Ms" } }, "type": "object", "required": ["text", "start_ms", "end_ms"], "title": "WordLevelTranscription" }, "XYPosition": { "properties": { "x": { "type": "number", "title": "X", "description": "X coordinate of the position" }, "y": { "type": "number", "title": "Y", "description": "Y coordinate of the position" } }, "type": "object", "required": ["x", "y"], "title": "XYPosition" }, "ZeroShotParams": { "properties": { "llm_approach_type": { "type": "string", "const": "LLM_ZERO_SHOT", "title": "Llm Approach Type" }, "prompts": { "items": { "$ref": "#/components/schemas/LLMPromptTemplates" }, "type": "array", "title": "Prompts", "description": "The prompt templates to use for the job" }, "model": { "type": "string", "title": "Model", "description": "Large Language Model to use for the job" } }, "type": "object", "required": ["llm_approach_type", "prompts", "model"], "title": "ZeroShotParams" } }, "securitySchemes": { "OAuth2PasswordBearer": { "type": "oauth2", "flows": { "password": { "scopes": {}, "tokenUrl": "/authentication/login" } } } } } }