General — Metadata Studio 3.10.0 documentation

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-11346334-10']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <title>General — Metadata Studio 3.10.0 documentation</title> <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/bootstrap.min.css" type="text/css" /> <link rel="stylesheet" href="_static/css/bootstrap-ontotext-theme.css" type="text/css" /> <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> <script src="_static/language_data.js"></script> <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Architecture & Components" href="architecture-and-components.html" /> <link rel="prev" title="Table of contents" href="toc.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> <meta name="apple-mobile-web-app-capable" content="yes">  <link rel="apple-touch-icon" sizes="180x180" href="/omds/3.10/_static/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/omds/3.10/_static/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/omds/3.10/_static/favicon-16x16.png"> <link rel="manifest" type="application/manifest+json" href="/omds/3.10/_static/site.webmanifest"> <script src="/omds/3.10/_static/js/jquery-1.12.4.min.js"></script> <script src="/omds/3.10/_static/js/jquery-fix.js"></script> <script src="/omds/3.10/_static/bootstrap-sphinx.js"></script>  <script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js" integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb" crossorigin="anonymous"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script> <script type="text/javascript"> //temporary solution to remove sphinx css $(document).ready(function() { $("link[href*='basic.css']").remove(); $("link[href*='bootstrap-sphinx.css']").remove(); }); //hide the other collapsible elements on collapsing a menu item var $myGroup = $('#side-menu-accoridion'); $myGroup.on('show.bs.collapse','.collapse', function() { $myGroup.find('.collapse.show').collapse('hide'); }); $(function () { $('[data-toggle="tooltip"]').tooltip(); $('#scrollToTop').click( function() { $('html, body').animate({scrollTop: '0px'}, 300); }); }); </script>  <script src="https://cdn.jsdelivr.net/react/15.4.2/react.min.js"></script> <script src="https://cdn.jsdelivr.net/react/15.4.2/react-dom.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/jazzyray/sphinx-graphiql@master/static/graphiql/graphiql.min.js"></script> <link href="https://cdn.jsdelivr.net/gh/jazzyray/sphinx-graphiql@master/static/graphiql/graphiql.css" rel="stylesheet"> <link href="https://cdn.jsdelivr.net/gh/jazzyray/sphinx-graphiql@a048f5e9c6fb3932d7ba3bcea8c56e1d918903d0/static/styles.css" rel="stylesheet"> <script type="text/javascript"> // graphql query fetcher const graphQLFetcher = function(endpoint, token, insecure) { endpoint = endpoint || "https://swapi-platform.ontotext.com/graphql"; insecure = insecure || false return function(graphQLParams) { const params = { method: 'post', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer ' + token }, body: JSON.stringify(graphQLParams), credentials: 'include', insecure: true, }; return fetch(endpoint, params) .then(function (response) { return response.text(); }) .then(function (responseBody) { try { return JSON.parse(responseBody); } catch (error) { return responseBody; } }); } }; // create GraphiQL components and embed into HTML const setupGraphiQL = function() { if (typeof(React) === 'undefined' || typeof(ReactDOM) === 'undefined' || typeof(GraphiQL) === 'undefined') { return; } const targets = document.getElementsByClassName('graphiql'); for (let i = 0; i < targets.length; i++) { const target = targets[i]; const endpoint = target.getElementsByClassName("endpoint")[0].innerHTML.trim(); let token = target.getElementsByClassName("token") if ((token === null) || (token[0].innerHTML.trim() === "")) { // No token so default it to a pre-baked ReadOnly Token // Expires 20 April 2022 token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkhYajdRQndWRzVPVERuMjlobWJsUDZLVHVKLTZZdnpUIn0.eyJhdWQiOiI2NzJjYTdiMy1jMzcyLTRkZjMtODJkOC05YTFhMGQ3ZDY4YzEiLCJleHAiOjE2NTA4NjAwNjAsImlhdCI6MTU4Nzc0NjE1NiwiaXNzIjoic3dhcGktcGxhdGZvcm0ub250b3RleHQuY29tIiwic3ViIjoiMDNhNDlkZjQtMGQwOS00NmNmLWFhNWUtNjVhNzNiNmYxN2ZmIiwiYXV0aGVudGljYXRpb25UeXBlIjoiUEFTU1dPUkQiLCJlbWFpbCI6InJlYWRvbmx5dXNlckBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJSZWFkT25seVVzZXIiLCJhcHBsaWNhdGlvbklkIjoiNjcyY2E3YjMtYzM3Mi00ZGYzLTgyZDgtOWExYTBkN2Q2OGMxIiwicm9sZXMiOlsiUmVhZE9ubHkiXX0.iZiHf-vgNddiNOCBXT6cdYDOnpR_fk1EQn6UICBTETY" } else { token = token[0].innerHTML.trim(); } const insecure = target.getElementsByClassName("insecure")[0].innerHTML.trim(); const query = target.getElementsByClassName("query")[0].innerHTML.trim(); const response = target.getElementsByClassName("response")[0].innerHTML.trim(); const graphiQLElement = React.createElement(GraphiQL, { fetcher: graphQLFetcher(endpoint, token, insecure), schema: undefined, query: query, response: response, token: token }); ReactDOM.render(graphiQLElement, target); } }; $(document).ready(function() { // if graphiql elements present, setup graphiql if (document.getElementsByClassName('graphiql').length > 0) { setupGraphiQL(); } }) </script> <meta name="msapplication-TileImage" content="/search/documentation/home/images/visual_Logo_GraphDB_02_12_2015.png"> </head><body> <div id="page"> <div id="sidebar" class="bs-sidenav bg-lightgray" data-spy="affix"> <div class="hidden-xs hidden-sm"> <div class="bg-secondary d-flex"> <a href="/omds/3.10/index.html" class="brand" title="Metadata Studio 3.10"> <img src="/omds/3.10/_static/metadata-studio.png" alt="Metadata Studio logo" height="44" class="logo"> <span>3.10</span> </a> <a class="ml-auto btn btn-primary hidden-lg-up d-flex" data-toggle="collapse" href="#collapseSideNav" aria-expanded="false" aria-controls="collapseExample"> <span class="icon-hbars align-self-center"></span> </a> </div> <div id="collapseSideNav" class="hidden-mobile-nav"> <div class="p-3"> <form action="/omds/3.10/search.html" method="get"> <div class="input-group input-group-sm"> <span class="input-group-addon icon"><span class="icon-search icon-lg text-muted"></span></span> <input type="text" name="q" class="form-control" placeholder="Search the documentation..."> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </div> </form> <div class="mt-3"> <div class="dropdown d-inline-block"> <button class="btn btn-link dropdown-toggle p-0" type="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> Metadata Studio </button> <span class="dropdown-menu" aria-labelledby="dropdownMenuButton"> <script type="text/javascript"> var xmlHttp = new XMLHttpRequest(); xmlHttp.open( "GET", "https://platform.ontotext.com/services.txt", false ); xmlHttp.send( null ); var services = xmlHttp.responseText; var servicesSplit = services.split("\n"); for (var i = 0; i < servicesSplit.length; i++) { var serviceSplit = servicesSplit[i]; if (serviceSplit.length !== 0) { document.write('<a class="dropdown-item" href="/' + serviceSplit.split(",")[1] + '">' + serviceSplit.split(",")[0] + '</a>'); } } </script> </span> </div> </div> </div> <div class="sidebar-menu"> <ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">General</a><ul> <li class="toctree-l2"><a class="reference internal" href="#high-level-overview">High-Level Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="#credits-licensing">Credits & Licensing</a></li> <li class="toctree-l2"><a class="reference internal" href="#helpful-hints">Helpful Hints</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="architecture-and-components.html">Architecture & Components</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> <li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li> <li class="toctree-l1"><a class="reference internal" href="migration-guide.html">Migration Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="dependencies-and-license.html">Dependencies & License</a></li> <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> </ul> </div> <hr class="m-0"> <div class="sidebar-menu"> <ul id="side-menu-accoridion" role="tablist" aria-multiselectable="true"> <li class="toctree-l1"> <a data-toggle="collapse" data-parent="#side-menu-accoridion" href="#collapse7" aria-expanded="false" aria-controls="collapse7"> Previous versions </a> <ul id="collapse7" class="collapse" role="tabpanel" aria-labelledby="heading7" aria-expanded="true">  </ul> </li> </ul> </div></div> </div> </div> <div class="main-container pb-5"> <div class="container-fluid"> <div class="section" id="general"> <h1>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h1> <div class="contents local topic" id="what-s-in-this-document"> <p class="topic-title"><cite>What’s in this document?</cite></p> <ul class="simple"> <li><a class="reference internal" href="#high-level-overview" id="id1">High-Level Overview</a></li> <li><a class="reference internal" href="#credits-licensing" id="id2">Credits & Licensing</a></li> <li><a class="reference internal" href="#helpful-hints" id="id3">Helpful Hints</a></li> </ul> </div> <div class="section" id="high-level-overview"> <span id="general-high-level-overview"></span><h2><a class="toc-backref" href="#what-s-in-this-document">High-Level Overview</a><a class="headerlink" href="#high-level-overview" title="Permalink to this headline">¶</a></h2> <p>Ontotext Metadata Studio (OMDS) is a horizontal, domain-neutral, manual annotation tool that enables organizations in possession of various amount of unstructured content to utilize their own subject matter experts in order to evaluate if their use case can be solved by any pre-existing text analysis service on the market, and if not – to produce the foundational data to build their own NLP models.</p> <p>This documentation is a comprehensive guide that explains every feature of the product, as well as how to <a class="reference internal" href="installation.html"><span class="doc">install</span></a>, <a class="reference internal" href="configuration.html"><span class="doc">configure</span></a>, and <a class="reference internal" href="usage.html"><span class="doc">start using</span></a> it.</p> <p>Metadata Studio is natively built on top of GraphDB, thus having a GraphDB 9.11 and newer is a prerequisite.</p> <p>If you need a quick overview of Metadata Studio or are interested in seeing it in action, please visit the Metadata Studio <a class="reference external" href="https://www.ontotext.com/products/ontotext-metadata-studio/">product section</a> on our website.</p> </div> <div class="section" id="credits-licensing"> <span id="general-credits-and-licensing"></span><h2><a class="toc-backref" href="#what-s-in-this-document">Credits & Licensing</a><a class="headerlink" href="#credits-licensing" title="Permalink to this headline">¶</a></h2> <p>Metadata Studio uses <a class="reference external" href="https://www.ontotext.com/products/graphdb/">GraphDB</a> as its database, <a class="reference external" href="https://www.ontotext.com/products/ontotext-platform/">Ontotext Platform</a> for providing an API, and <a class="reference external" href="https://www.keycloak.org">Keycloak</a> for access control.</p> <p>Full dependencies and licensing information are available <a class="reference internal" href="dependencies-and-license.html"><span class="doc">here</span></a>.</p> </div> <div class="section" id="helpful-hints"> <span id="general-helpful-hints"></span><h2><a class="toc-backref" href="#what-s-in-this-document">Helpful Hints</a><a class="headerlink" href="#helpful-hints" title="Permalink to this headline">¶</a></h2> <p>Throughout the documentation, there are a number of helpful pieces of information that can give you additional information, warn you, or save you time and unnecessary effort. Here is what to pay attention to:</p> <div class="admonition hint"> <p class="first admonition-title">Hint</p> <p class="last">Hint badges give additional information you may find useful.</p> </div> <div class="admonition tip"> <p class="first admonition-title">Tip</p> <p class="last">Tip badges are handy pieces of information.</p> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Notes are comments or references that may save you time and unnecessary effort.</p> </div> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p class="last">Warnings are pieces of advice that turn your attention to things you should be cautious about.</p> </div> </div> </div> </div> </div> <hr class="m-0"> <footer class="main-container py-5"> <div class="container-fluid"> <div class="row"> <div class="col-12 col-sm-6 col-lg-4"> <h4>Download documentation</h4> <ul class="list-inline"> <li class="list-inline-item"> <a href="/omds/3.10/pdf/Metadata-Studio.pdf" download class="btn btn-link text-secondary px-0" target="_blank"><span class="icon-download text-tertiary"></span> PDF</a> </li> <li class="list-inline-item"> <a href="/omds/3.10/epub/Metadata-Studio.epub" download class="btn btn-link text-secondary px-0" target="_blank"><span class="icon-download text-tertiary"></span> ePUB</a> </li> </ul> </div> <div class="col-12 col-sm-6 col-lg-4"> <h4>Contacts</h4> <ul class="list-unstyled mb-4"> <li class="m-0"> <a href="mailto:platform-support@ontotext.com" class="btn btn-link text-secondary px-0" target="_blank"> <span class="icon-email text-tertiary"></span> <b>Support</b> <span class="hidden-lg-down">· platform-support@ontotext.com</span> </a> </li> <li class="m-0"> <a href="mailto:sales@ontotext.com" class="btn btn-link text-secondary px-0" target="_blank"> <span class="icon-email text-tertiary"></span> <b>Sales</b> <span class="hidden-lg-down">· sales@ontotext.com</span> </a> </li> <li class="m-0 mb-3"> <a href="mailto:info@ontotext.com" class="btn btn-link text-secondary px-0" target="_blank"> <span class="icon-email text-tertiary"></span> <b>General</b> <span class="hidden-lg-down">· info@ontotext.com</span> </a> </li> <li class="m-0"><span href="mailto:info@ontotext.com" class="btn btn-link text-secondary px-0"><span class="icon-phone text-tertiary"></span> <b>US (toll free)</b> · 1-866-972-6686</span></li> <li class="m-0"><span href="mailto:info@ontotext.com" class="btn btn-link text-secondary px-0"><span class="icon-phone text-tertiary"></span> <b>Europe</b> · +359 2 974 61 60</span></li> </ul> </div> <div class="col-12 col-sm-6 col-lg-4 mb-4"> <h4>More info</h4> <ul class="list-unstyled mb-4"> <li class="m-0"><a href="http://www.ontotext.com/company/" class="btn btn-link text-secondary px-0" target="_blank"><span class="icon-external text-tertiary"></span> About Ontotext</a></li> <li class="m-0"><a href="https://www.w3.org/standards/semanticweb/" class="btn btn-link text-secondary px-0" target="_blank"><span class="icon-external text-tertiary"></span> Semantic web</a></li> </ul> <h4>Follow us</h4> <div class="mb-4"> <a data-toggle="tooltip" title="" href="https://www.linkedin.com/company/ontotext-ad" class="btn btn-link px-0" target="_blank" data-original-title="LinkedIn"><span class="icon-linkedin icon-lg text-linkedin"></span></a> <a data-toggle="tooltip" title="" href="https://twitter.com/ontotext" class="btn btn-link px-0" target="_blank" data-original-title="Twitter"><span class="icon-twitter icon-lg text-twitter"></span></a> <a data-toggle="tooltip" title="" href="https://www.facebook.com/Ontotext" class="btn btn-link px-0" target="_blank" data-original-title="Facebook"><span class="icon-facebook icon-lg text-facebook"></span></a> <a data-toggle="tooltip" title="" href="https://www.youtube.com/ontotext" class="btn btn-link px-0" target="_blank" data-original-title="Youtube"><span class="icon-youtube icon-lg text-youtube"></span></a>  </div> </div> </div>  <div class="text-muted small d-flex align-items-center"> <div> <a href="http://ontotext.com/" target="_blank" class="d-inline-block mb-3 mb-md-0 mr-2"><img src="_static/ot-logo.svg" class="m-0" height="26" alt="Ontotext logo"></a> <br class="hidden-md-up"> © Copyright 2024, Ontotext. Last updated on 01 October, 2024. | <a href="https://ontotext.com/privacy-policy-2/">Privacy</a> </div> <div class="ml-auto"> <button id="scrollToTop" class="btn btn-link" data-toggle="tooltip" data-placement="top" title="" data-original-title="Back to top"><span class="icon-arrow-up icon-2x"></span></button> </div> </div> </div> </footer> </div> </body> </html>

CINXE.COM

General — Metadata Studio 3.10.0 documentation