b259ec2c4f
Fresh export of all 20 diagrams as PNG and full HTML documentation site after the Grand Unification UML sync. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
636 lines
16 KiB
HTML
636 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>SkillAdaptor</title>
|
|
<link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,700,300italic,400italic,700italic|Source+Code+Pro:300,400,700' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" href="../assets/css/bootstrap.css">
|
|
<link rel="stylesheet" href="../assets/css/jquery.bonsai.css">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<link rel="stylesheet" href="../assets/icon-font/icons.css">
|
|
<script type="text/javascript" src="../assets/js/jquery-2.1.0.min.js"></script>
|
|
<script type="text/javascript" src="../assets/js/bootstrap.js"></script>
|
|
<script type="text/javascript" src="../assets/js/jquery.bonsai.js"></script>
|
|
<script type="text/javascript" src="../assets/js/imageMapResizer.min.js"></script>
|
|
|
|
</head>
|
|
<body>
|
|
<div>
|
|
|
|
<!-- Name Title -->
|
|
|
|
<h1>SkillAdaptor</h1>
|
|
|
|
<!-- Type and Stereotype -->
|
|
|
|
<section style="margin-top: .5em;">
|
|
<span class="alert alert-info">
|
|
<span class="node-icon staruml-icon icon-UMLClass"></span>
|
|
UMLClass
|
|
</span>
|
|
|
|
</section>
|
|
|
|
<!-- Path -->
|
|
|
|
<section style="margin-top: 10px">
|
|
|
|
|
|
|
|
|
|
<span class="label label-info"><a href='cf9c8b720f3815adeccaf3ef6e48c6c4.html'><span class='node-icon staruml-icon icon-Project'></span>Skill Seekers</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='6a4361334e8b649314ed681b9e6798c3.html'><span class='node-icon staruml-icon icon-UMLModel'></span>skill_seekers</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='a5b96ea6baa365812d11f82ccfb1d272.html'><span class='node-icon staruml-icon icon-UMLPackage'></span>Adaptors</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='5fd7099b44c2e60f64faacf64a025a80.html'><span class='node-icon staruml-icon icon-UMLClass'></span>SkillAdaptor</a></span>
|
|
|
|
</section>
|
|
|
|
<!-- Diagram -->
|
|
|
|
|
|
|
|
<!-- Description -->
|
|
|
|
|
|
<section>
|
|
<h3>Description</h3>
|
|
<div>
|
|
|
|
<p>Abstract base class for platform-specific skill adaptors. Each platform (Claude, Gemini, OpenAI) implements this interface to handle platform-specific SKILL.md formatting, package structure, upload endpoints, and optional AI enhancement.</p>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<!-- Specification -->
|
|
|
|
|
|
|
|
<!-- Directed Relationship -->
|
|
|
|
|
|
|
|
<!-- Undirected Relationship -->
|
|
|
|
|
|
|
|
<!-- Classifier -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Specialized Elements</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='05d6ebcd7c258f23a170566a10c631f2.html'><span class='node-icon staruml-icon icon-UMLClass'></span>OpenAICompatibleAdaptor</a></li>
|
|
|
|
<li><a href='5e3aad043322f2f5b2acedbc3f2b9fb6.html'><span class='node-icon staruml-icon icon-UMLClass'></span>ClaudeAdaptor</a></li>
|
|
|
|
<li><a href='a105d0fe3d5cea9b47c7afa6c8557686.html'><span class='node-icon staruml-icon icon-UMLClass'></span>GeminiAdaptor</a></li>
|
|
|
|
<li><a href='e1ede8cbef14cf9e04df47940ca9a264.html'><span class='node-icon staruml-icon icon-UMLClass'></span>OpenAIAdaptor</a></li>
|
|
|
|
<li><a href='f2600e75f17963b2cc3da3ed298b9298.html'><span class='node-icon staruml-icon icon-UMLClass'></span>MarkdownAdaptor</a></li>
|
|
|
|
<li><a href='8d1de6d935c965309d9ef3bb1a8b9635.html'><span class='node-icon staruml-icon icon-UMLClass'></span>OpenCodeAdaptor</a></li>
|
|
|
|
<li><a href='3759fb92985a12b31125dcacb827ec1a.html'><span class='node-icon staruml-icon icon-UMLClass'></span>LangChainAdaptor</a></li>
|
|
|
|
<li><a href='c7ad530b5039be62efa6fad88dc7abe3.html'><span class='node-icon staruml-icon icon-UMLClass'></span>LlamaIndexAdaptor</a></li>
|
|
|
|
<li><a href='0025564de1473d71f4a6a0503fcdb056.html'><span class='node-icon staruml-icon icon-UMLClass'></span>HaystackAdaptor</a></li>
|
|
|
|
<li><a href='7ea4f5f139979f2c7d48cf9f7ec3185f.html'><span class='node-icon staruml-icon icon-UMLClass'></span>ChromaAdaptor</a></li>
|
|
|
|
<li><a href='3ee818ae6c9bd7e11ec089321851094b.html'><span class='node-icon staruml-icon icon-UMLClass'></span>FAISSHelpers</a></li>
|
|
|
|
<li><a href='5736244f884406b943017aa39ea7b5af.html'><span class='node-icon staruml-icon icon-UMLClass'></span>QdrantAdaptor</a></li>
|
|
|
|
<li><a href='6507dc9541a8ed8d8ee52ff88ca32048.html'><span class='node-icon staruml-icon icon-UMLClass'></span>WeaviateAdaptor</a></li>
|
|
|
|
<li><a href='887262ae67612443c37a535a586c2b80.html'><span class='node-icon staruml-icon icon-UMLClass'></span>PineconeAdaptor</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Interface -->
|
|
|
|
|
|
|
|
<!-- Component -->
|
|
|
|
|
|
|
|
<!-- Node -->
|
|
|
|
|
|
|
|
<!-- Actor -->
|
|
|
|
|
|
|
|
<!-- Use Case -->
|
|
|
|
|
|
|
|
<!-- Template Parameters -->
|
|
|
|
|
|
|
|
<!-- Literals -->
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
|
|
|
|
<section>
|
|
<h3>Attributes</h3>
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th>Visibility</th>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="07cf2536e7dbcf8d87afb33d4f6b2bdf.html">PLATFORM</a></td>
|
|
<td>str </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="9a39c46c59af6274ee67dd3e27e46110.html">PLATFORM_NAME</a></td>
|
|
<td>str </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="8ab269a69c218e234df18b6940889082.html">DEFAULT_API_ENDPOINT</a></td>
|
|
<td>str | None </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="fa3298062baeeef9ca73909a471665aa.html">config</a></td>
|
|
<td>dict[str, Any] </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</section>
|
|
|
|
|
|
<!-- Operations -->
|
|
|
|
|
|
<section>
|
|
<h3>Operations</h3>
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th>Visibility</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="cf11361424551336e643636cafe9aeb7.html">format_skill_md()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="f407456ae508f0fbdc8d0cbf8ae71d6a.html">package()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="386d402c41239aa9ce3138dbcfecb60e.html">upload()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="4bf2408399265322afe89766d5bbc282.html">validate_api_key()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="7fc3001dbd7469604a183722623e59db.html">supports_enhancement()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="4eb8263776fcb815ebd7504b2f74cad5.html">get_env_var_name()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="1fdec12e919d6e94c4996d066fb65247.html">enhance()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="55503044f6056ca833de6ac0cb10ee2c.html">_read_existing_content()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="e01952890b6c6621008fd8e7666ec546.html">_extract_quick_reference()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="b04a3a89b6738348a56da1d800bcb9b7.html">_read_skill_md()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="46198b621922b88dcb8b4ab74746c82b.html">_read_frontmatter()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="dc18b7c112f1e5530e7ac575780b673b.html">_build_skill_metadata()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="fb6851a8aa75cb9004aceff7140bef44.html">_iterate_references()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="b3f712c63e1ab095470cab84aaacf261.html">_build_metadata_dict()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="10ddb05d66e61da66fdd5294e32336db.html">_maybe_chunk_content()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="58cfeae64fa36a7df5c9ae66690fbfe9.html">_format_output_path()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="4a9deec81e6f7aaedf8c08afbd86cbcf.html">_generate_deterministic_id()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="0a0f1f352ebda364e54afcee85ff8e31.html">_generate_openai_embeddings()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="779ab8ca8a1c581a052ece1414bfafec.html">_generate_st_embeddings()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="3551222ab96be3dde77819d7f92a28bb.html">_generate_toc()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</section>
|
|
|
|
|
|
<!-- Receptions -->
|
|
|
|
|
|
|
|
<!-- Extension Points -->
|
|
|
|
|
|
|
|
<!-- Parameters -->
|
|
|
|
|
|
|
|
<!-- Diagrams -->
|
|
|
|
|
|
|
|
|
|
<!-- Behavior -->
|
|
|
|
|
|
|
|
<!-- Action -->
|
|
|
|
|
|
|
|
<!-- Interaction -->
|
|
|
|
|
|
|
|
<!-- CombinedFragment -->
|
|
|
|
|
|
|
|
<!-- Activity -->
|
|
|
|
|
|
|
|
<!-- State Machine -->
|
|
|
|
|
|
|
|
<!-- State Machine -->
|
|
|
|
|
|
|
|
<!-- State -->
|
|
|
|
|
|
|
|
<!-- Vertex -->
|
|
|
|
|
|
|
|
<!-- Transition -->
|
|
|
|
|
|
|
|
<!-- Data Model (ERD) -->
|
|
|
|
|
|
|
|
<!-- Columns (ERD) -->
|
|
|
|
|
|
|
|
<!-- Related Entities (ERD) -->
|
|
|
|
|
|
|
|
<!-- Data Flows (DFD) -->
|
|
|
|
|
|
|
|
<!-- Flows (Flowchart) -->
|
|
|
|
|
|
|
|
<!-- Properties -->
|
|
|
|
<section>
|
|
<h3>Properties</h3>
|
|
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th width="50%">Name</th>
|
|
<th width="50%">Value</th>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>name</td>
|
|
<td>SkillAdaptor</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>stereotype</td>
|
|
<td><span class='label label-info'>null</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>visibility</td>
|
|
<td>public</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isAbstract</td>
|
|
<td><span class='label label-info'>true</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isFinalSpecialization</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isLeaf</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isActive</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</section>
|
|
|
|
<!-- Tags -->
|
|
|
|
|
|
|
|
<!-- Constraints, Dependencies, Dependants -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Dependencies</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='a293dadefd34e66600cdbc1288986a62.html'><span class='node-icon staruml-icon icon-UMLDataType'></span>SkillMetadata</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Relationships -->
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Relationships</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='b43587a6a5e45406abfe403d54813405.html'><span class='node-icon staruml-icon icon-UMLDependency'></span>uses (SkillAdaptor→SkillMetadata)</a></li>
|
|
|
|
<li><a href='7a3bbda7afd18c42d6f8e6b3ebc9e3c9.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(OpenAICompatibleAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='b6198e5a4981c20f4227f62ef31612de.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(ClaudeAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='0eae83fbc2e3eaaf8315f122a5692fa0.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(GeminiAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='6508d6381747583eede472d7cb949f1c.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(OpenAIAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='a4bfbb5ae93384d9a636d338b5be635f.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(MarkdownAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='32d7a1b4118e89e761afb4bd1535397c.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(OpenCodeAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='e49f2cc316faf16f05f056fe2c782758.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(LangChainAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='7a8a0f803d91a59c886f6ad900f4d9ad.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(LlamaIndexAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='3d866dbc23f140338a9a34bb70a05bcc.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(HaystackAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='17a6b3d24bf0cd5698d284f3b94d7960.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(ChromaAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='538b954053f58dad6ca48ee1883835e6.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(FAISSHelpers→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='acf17c3a75bcabacbcb34a57a4772bfa.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(QdrantAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='957f734957e810e5036c7ab29f371773.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(WeaviateAdaptor→SkillAdaptor)</a></li>
|
|
|
|
<li><a href='3a9462557ef3868d93f06820c9fc0497.html'><span class='node-icon staruml-icon icon-UMLGeneralization'></span>(PineconeAdaptor→SkillAdaptor)</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<!-- Owned Elements -->
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Owned Elements</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='b43587a6a5e45406abfe403d54813405.html'><span class='node-icon staruml-icon icon-UMLDependency'></span>uses (SkillAdaptor→SkillMetadata)</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<!-- Diagrams -->
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Diagrams</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='4323069cfc9640314abce0f13b6c11a6.html'><span class='node-icon staruml-icon icon-UMLClassDiagram'></span>Adaptors</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<!-- Image Map Resizer (https://github.com/davidjbradshaw/image-map-resizer) -->
|
|
<script>
|
|
imageMapResize();
|
|
</script>
|
|
</div>
|
|
</body>
|
|
</html>
|