{"openapi":"3.0.1","info":{"title":"Annotation Service API","description":"Annotation Service API documentation","termsOfService":"","contact":{"name":"","url":"","email":""},"license":{"name":"unlicensed","url":""},"version":"0.0.1"},"servers":[{"url":"https://service.tib.eu","description":"Generated server url"}],"tags":[{"name":"annotation","description":"the annotation API"}],"paths":{"/api/annotation/entitylinking/text":{"post":{"tags":["annotation"],"summary":"retrieves a text and delivers a list of all recognized entities and relations within the specified datasources as well as the corresponding class hierachy tree","description":"Uses the specified datasources to retrieve entities and relations. Adds the category hierarchy graph for these entities and relations.","operationId":"getTextEntities","parameters":[{"name":"wikidata","in":"query","description":"Optional parameter to include or exclude entities from wikidata","required":false,"schema":{"type":"boolean"}},{"name":"wikidata_dbpedia","in":"query","description":"Optional parameter to include or exclude entities from dbpedia","required":false,"schema":{"type":"boolean"}},{"name":"iconclass","in":"query","description":"Optional parameter to include or exclude entities(notations) from iconclass","required":false,"schema":{"type":"boolean"}},{"name":"ts4tib","in":"query","description":"Optional parameter to include or exclude entities(notations) from ols terminology service TIB Hannove","required":false,"schema":{"type":"boolean"}},{"name":"ts4tib_collection","in":"query","description":"Optional parameter to restrict search within the TIB terminology service to one or more ontology collections. More than one collection can be defined using comma seperator. only used when parameter 'ts4tib' is set 'true'","required":false,"schema":{"type":"string"}},{"name":"ts4tib_ontology","in":"query","description":"Optional parameter to restrict search within the TIB terminology service to one or more specific ontologies. More than one ontology can be defined using comma seperator. only used when parameter 'ts4tib' is set 'true'","required":false,"schema":{"type":"string"}},{"name":"allowDuplicates","in":"query","description":"if 'true', the hierarchy graph is allowed to contain superclasses multiple times (in different branches). This will show more complete results but the graph will be bigger and might contain the same information multiple times","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextEntityLinkingRequest"}}},"required":true},"responses":{"200":{"description":"Annotations of the given post parameters","content":{"application/json":{"schema":{"type":"string"}}}},"default":{"description":"Generic error response","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/entitylinking/image":{"post":{"tags":["annotation"],"summary":"test call for iart integration","operationId":"getImageEntities","parameters":[{"name":"model","in":"query","description":"name of a iart plugin, valid parameters can be get via /annotation/parameterOptions/imagemodels","required":false,"schema":{"type":"string"}},{"name":"iconclass","in":"query","description":"Optional parameter to include or exclude entities(notations) from iconclass","required":false,"schema":{"type":"boolean"}},{"name":"text","in":"query","description":"optional text that describes the image. this will be used to further finetune the results","required":false,"schema":{"type":"string"}},{"name":"threshold","in":"query","description":"filter returned classifications by probability. return only results with probability >= threshold","required":false,"schema":{"type":"number"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary"},"dictionary":{"$ref":"#/components/schemas/Dictionary"}}}}}},"responses":{"200":{"description":"a list of entities depending on the choosen plugin","content":{"text/html":{"schema":{"type":"string"}}}},"default":{"description":"Unexpected error","content":{"text/html":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/clipEmbedding/text":{"post":{"tags":["annotation"],"summary":"get a vector for texts that define their position in the vectorspace defined by the openAI CLIP model","operationId":"getClipTextEmbedding","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"texts to process","items":{"type":"string"}}}}},"responses":{"200":{"description":"a list of vectors define the position of the given texts in the vectorspace defined by the openAI CLIP model","content":{"text/html":{"schema":{"type":"string"}}}},"default":{"description":"Unexpected error","content":{"text/html":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/clipEmbedding/image":{"post":{"tags":["annotation"],"summary":"get a vector for an image that define the position in the vectorspace defined by the openAI CLIP model","operationId":"getClipImageEmbedding","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"a list of vectors define the position of the given texts in the vectorspace defined by the openAI CLIP model","content":{"text/html":{"schema":{"type":"string"}}}},"default":{"description":"Unexpected error","content":{"text/html":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/terminology":{"get":{"tags":["annotation"],"summary":"retrieves a text and delivers a list of all recognized entities and relations within the specified datasources as well as the corresponding class hierachy tree","description":"Uses the specified datasources to retrieve entities and relations. Adds the category hierarchy graph for these entities and relations.","operationId":"getTerminology","parameters":[{"name":"searchtext","in":"query","description":"text that contains or describes the wanted entity/terminology","required":true,"schema":{"type":"string"}},{"name":"wikidata","in":"query","description":"Optional parameter to include or exclude entities from wikidata","required":false,"schema":{"type":"boolean"}},{"name":"wikidata_dbpedia","in":"query","description":"Optional parameter to include or exclude entities from dbpedia","required":false,"schema":{"type":"boolean"}},{"name":"iconclass","in":"query","description":"Optional parameter to include or exclude entities(notations) from iconclass","required":false,"schema":{"type":"boolean"}},{"name":"ts4tib","in":"query","description":"Optional parameter to include or exclude entities(notations) from ols terminology service TIB Hannove","required":false,"schema":{"type":"boolean"}},{"name":"gnd","in":"query","description":"Optional parameter to include or exclude entities from GND subjectClasses and SubjectHeadings","required":false,"schema":{"type":"boolean"}},{"name":"aat","in":"query","description":"Optional parameter to include or exclude entities from Getty AAT","required":false,"schema":{"type":"boolean"}},{"name":"ts4tib_collection","in":"query","description":"Optional parameter to restrict search within the TIB terminology service to one or more ontology collections. More than one collection can be defined using comma seperator. only used when parameter 'ts4tib' is set 'true'","required":false,"schema":{"type":"string"}},{"name":"ts4tib_ontology","in":"query","description":"Optional parameter to restrict search within the TIB terminology service to one or more specific ontologies. More than one ontology can be defined using comma seperator. only used when parameter 'ts4tib' is set 'true'","required":false,"schema":{"type":"string"}},{"name":"allowDuplicates","in":"query","description":"if 'true', the hierarchy graph is allowed to contain superclasses multiple times (in different branches). This will show more complete results but the graph will be bigger and might contain the same information multiple times","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Annotations of the given searchtext","content":{"application/json":{"schema":{"type":"string"}}}},"default":{"description":"Generic error response","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/status":{"get":{"tags":["annotation"],"summary":"get the current status of the service","operationId":"getStatus","responses":{"200":{"description":"Service is running","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"Unexpected error","content":{"text/plain":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/parameterOptions/ts4tib_ontology":{"get":{"tags":["annotation"],"summary":"get valid parameter options for the parameter 'ts4tib_ontology'","description":"retrieves actual ontology names from the tib terminology service","operationId":"getParameterTs4tibOntology","parameters":[{"name":"collection","in":"query","description":"name of a collection. use '/annotation/getValidParameterOptions/ts4tib_collection' to get valid names. use multiple names seperated by comma.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Parameter options for ts4tib_ontology","content":{"application/json":{"schema":{"type":"string"}}}},"default":{"description":"error in retrieving valid parameter options","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/parameterOptions/ts4tib_collection":{"get":{"tags":["annotation"],"summary":"get valid parameter options for the parameter 'ts4tib_collection'","description":"retrieves actual collection names from the tib terminology service","operationId":"getParameterTs4tibCollection","responses":{"200":{"description":"Parameter options for ts4tib_collection","content":{"application/json":{"schema":{"type":"string"}}}},"default":{"description":"error in retrieving valid parameter options for parameter 'ts4tib'","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/parameterOptions/imagemodels":{"get":{"tags":["annotation"],"summary":"get list of available model names (iart plugins) as parameter value for /annotation/entities/image","operationId":"getParameterImageModels","responses":{"200":{"description":"a list of entities depending on the choosen plugin","content":{"application/json":{"schema":{"type":"string"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"type":"string"}}}}},"security":[{"jwt":[]},{"basic":[]}]}},"/api/annotation/entities/selectcomponent":{"get":{"tags":["annotation"],"summary":"get a html selectbox for all found entities according to the delivered text","description":"retrieves a text and delivers a html page, containing an interactive selectbox of all recognized entities within the specified datasources. The selectpage can be embedded via the