Repository navigation
Expand file tree
/
Copy pathsdk-python.html
More file actions
249 lines (224 loc) · 14.1 KB
/
Copy pathsdk-python.html
File metadata and controls
249 lines (224 loc) · 14.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python SDK — SuperInstance Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600;700&family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
<link rel="icon" type="image/svg+xml" href="https://superinstance-assets.casey-digennaro.workers.dev/favicon.svg">
<style>
:root { --bg: #0a0a0f; --surface: #12121a; --border: #1e1e2e; --accent: #00E6D6; --text: #e0e0e8; --muted: #8888a0; --code-bg: #0e0e16; }
* { margin: 0; padding: 0; box-sizing: border-box; }
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: var(--bg); color: var(--text); line-height: 1.7; }
a { color: var(--accent); text-decoration: none; } a:hover { text-decoration: underline; }
.container { max-width: 860px; margin: 0 auto; padding: 2rem 1.5rem; }
.back { display: inline-block; margin-bottom: 1.5rem; font-size: .9rem; color: var(--muted); }
.back:hover { color: var(--accent); }
h1 { font-size: 2rem; margin-bottom: .5rem; }
h1 span { color: var(--accent); }
.subtitle { color: var(--muted); margin-bottom: 2.5rem; }
h2 { font-size: 1.35rem; margin: 2.5rem 0 1rem; border-bottom: 1px solid var(--border); padding-bottom: .4rem; }
h3 { font-size: 1.1rem; margin: 1.5rem 0 .5rem; color: var(--accent); }
p { margin-bottom: 1rem; }
pre { background: var(--code-bg); border: 1px solid var(--border); border-radius: 8px; padding: 1.2rem; overflow-x: auto; position: relative; margin-bottom: 1.2rem; }
code { font-family: 'JetBrains Mono', 'Fira Code', 'Consolas', monospace; font-size: .88rem; }
pre code { color: #c8c8d8; }
:not(pre) > code { background: var(--code-bg); padding: .15em .4em; border-radius: 4px; font-size: .88rem; }
.copy-btn { position: absolute; top: .6rem; right: .6rem; background: var(--border); color: var(--muted); border: none; border-radius: 4px; padding: .3rem .6rem; font-size: .75rem; cursor: pointer; font-family: inherit; transition: all .15s; }
.copy-btn:hover { background: var(--accent); color: var(--bg); }
.copy-btn.copied { background: var(--accent); color: var(--bg); }
table { width: 100%; border-collapse: collapse; margin-bottom: 1.2rem; }
th, td { text-align: left; padding: .6rem .8rem; border-bottom: 1px solid var(--border); }
th { color: var(--accent); font-weight: 600; font-size: .85rem; text-transform: uppercase; letter-spacing: .04em; }
td { font-size: .92rem; }
td code { font-size: .82rem; }
.kw { color: #c792ea; } .str { color: #c3e88d; } .fn { color: #82aaff; } .cm { color: #546e7a; } .tp { color: #ffcb6b; } .num { color: #f78c6c; } .dec { color: #89ddff; }
@media (max-width: 640px) { .container { padding: 1rem; } h1 { font-size: 1.5rem; } pre { padding: .8rem; font-size: .82rem; } }
/* Unified Top Nav */
.top-nav {
position: fixed; top: 0; left: 0; right: 0; z-index: 1000;
background: rgba(10,10,15,0.92); backdrop-filter: blur(16px);
border-bottom: 1px solid #1a1a2e; height: 52px;
display: flex; align-items: center; padding: 0 1.5rem; gap: 1.5rem;
}
.top-nav .nav-logo {
font-family: 'JetBrains Mono', monospace; font-weight: 700;
color: #00E6D6; text-decoration: none; font-size: 1rem;
}
.top-nav .nav-links { display: flex; gap: 0.25rem; }
.top-nav .nav-links a {
font-family: 'JetBrains Mono', monospace; font-size: 0.78rem;
color: #888; text-decoration: none; padding: 0.35rem 0.65rem;
border-radius: 6px; transition: all 0.15s;
}
.top-nav .nav-links a:hover, .top-nav .nav-links a.active {
color: #00E6D6; background: rgba(0,230,214,0.15);
}
.top-nav .nav-links a svg { vertical-align: middle; }
@media (max-width: 640px) {
.top-nav { padding: 0 0.75rem; gap: 0.5rem; }
.top-nav .nav-links { gap: 0; }
.top-nav .nav-links a { padding: 0.35rem 0.4rem; font-size: 0.7rem; }
}
/* Breadcrumb */
.breadcrumb {
font-family: 'JetBrains Mono', monospace; font-size: 0.78rem;
color: #888; display: flex; gap: 0.5rem; align-items: center;
}
.breadcrumb a { color: #00E6D6; text-decoration: none; }
.breadcrumb a:hover { text-decoration: underline; }
.breadcrumb .sep { color: #1a1a2e; }
/* Unified Footer */
.site-footer {
padding: 1.5rem 2rem; border-top: 1px solid #1a1a2e;
font-size: 0.8rem; color: #888;
display: flex; gap: 1.5rem; flex-wrap: wrap; align-items: center;
}
.site-footer a { color: #00E6D6; text-decoration: none; }
.site-footer a:hover { text-decoration: underline; }
</style>
</head>
<body>
<!-- Unified Top Nav -->
<nav class="top-nav">
<a href="index.html" class="nav-logo">⬡ SuperInstance</a>
<div class="nav-links">
<a href="index.html">Docs</a>
<a href="api.html">API</a>
<a href="playground.html">Playground</a>
<a href="status.html">Status</a>
<a href="https://github.com/superinstance" target="_blank" rel="noopener"><svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg></a>
</div>
</nav>
<div class="page-wrapper" style="padding-top:52px">
<div class="breadcrumb"><a href="index.html">Docs</a> <span class="sep">›</span> SDKs <span class="sep">›</span> Python SDK</div>
<div class="container">
<h1>Python SDK <span>Quickstart</span></h1>
<p class="subtitle">superinstance-fleet — Semantic crate discovery for your Python projects</p>
<!-- Installation -->
<h2>Installation</h2>
<pre><code>pip install superinstance-fleet</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<p>Requires Python 3.8+. Uses <code>httpx</code> for async HTTP under the hood.</p>
<!-- Quick Start -->
<h2>Quick Start</h2>
<pre><code><span class="kw">from</span> superinstance_fleet <span class="kw">import</span> FleetClient
client = FleetClient(
base_url=<span class="str">"https://fleet-vector-api.casey-digennaro.workers.dev"</span>,
)
<span class="cm"># Search for crates by natural language</span>
results = client.<span class="fn">search</span>(<span class="str">"HTTP client with retry logic"</span>)
<span class="kw">for</span> crate <span class="kw">in</span> results:
<span class="fn">print</span>(<span class="str">f"</span>{crate.name:<span class="str">}</span> (score: {crate.score:<span class="str">:.2f</span>})<span class="str">"</span>)
<span class="cm"># Find crates similar to a known crate</span>
similar = client.<span class="fn">similar</span>(<span class="str">"reqwest"</span>, top_k=<span class="num">5</span>)
<span class="fn">print</span>(similar)
<span class="cm"># Get personalized recommendations</span>
recs = client.<span class="fn">recommend</span>(context=<span class="str">"web scraping"</span>)
<span class="fn">print</span>(recs)
<span class="cm"># Check index stats</span>
stats = client.<span class="fn">stats</span>()
<span class="fn">print</span>(stats) <span class="cm"># → IndexStats(vector_count=..., dimensions=...)</span></code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<h3>Async Usage</h3>
<pre><code><span class="kw">import</span> asyncio
<span class="kw">from</span> superinstance_fleet <span class="kw">import</span> AsyncFleetClient
<span class="kw">async def</span> <span class="fn">main</span>():
client = AsyncFleetClient()
results = <span class="kw">await</span> client.<span class="fn">search</span>(<span class="str">"async database driver"</span>)
<span class="fn">print</span>(results)
asyncio.<span class="fn">run</span>(<span class="fn">main</span>())</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<!-- API Reference -->
<h2>API Reference</h2>
<h3>search(query, *, top_k=10, threshold=0.5)</h3>
<p>Perform a semantic search across all indexed crates.</p>
<table>
<tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr>
<tr><td><code>query</code></td><td><code>str</code></td><td>—</td><td>Natural language search query</td></tr>
<tr><td><code>top_k</code></td><td><code>int</code></td><td><code>10</code></td><td>Max results to return</td></tr>
<tr><td><code>threshold</code></td><td><code>float</code></td><td><code>0.5</code></td><td>Minimum similarity score (0–1)</td></tr>
</table>
<pre><code>results = client.<span class="fn">search</span>(<span class="str">"async runtime"</span>, top_k=<span class="num">5</span>, threshold=<span class="num">0.7</span>)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<p>Returns <code>list[CrateResult]</code>.</p>
<h3>similar(name, *, top_k=10)</h3>
<p>Find crates similar to a known crate by name.</p>
<table>
<tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr>
<tr><td><code>name</code></td><td><code>str</code></td><td>—</td><td>Exact crate name to find similar items for</td></tr>
<tr><td><code>top_k</code></td><td><code>int</code></td><td><code>10</code></td><td>Max results to return</td></tr>
</table>
<pre><code>alike = client.<span class="fn">similar</span>(<span class="str">"tokio"</span>, top_k=<span class="num">3</span>)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<h3>recommend(*, context, top_k=5)</h3>
<p>Get crate recommendations based on a context or use case.</p>
<table>
<tr><th>Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr>
<tr><td><code>context</code></td><td><code>str</code></td><td>—</td><td>Description of your project or use case</td></tr>
<tr><td><code>top_k</code></td><td><code>int</code></td><td><code>5</code></td><td>Max results to return</td></tr>
</table>
<pre><code>picks = client.<span class="fn">recommend</span>(context=<span class="str">"CLI tool with config parsing"</span>)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<h3>stats()</h3>
<p>Retrieve index statistics.</p>
<pre><code>stats = client.<span class="fn">stats</span>()
<span class="fn">print</span>(stats.vector_count, stats.dimensions)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<p>Returns <code>IndexStats</code>.</p>
<!-- Configuration -->
<h2>Configuration</h2>
<table>
<tr><th>Option</th><th>Type</th><th>Default</th><th>Description</th></tr>
<tr><td><code>base_url</code></td><td><code>str</code></td><td><code>'https://fleet-vector-api.casey-digennaro.workers.dev'</code></td><td>API endpoint URL</td></tr>
<tr><td><code>timeout</code></td><td><code>float</code></td><td><code>10.0</code></td><td>Request timeout in seconds</td></tr>
<tr><td><code>api_key</code></td><td><code>str | None</code></td><td><code>None</code></td><td>Optional API key for authenticated endpoints</td></tr>
</table>
<pre><code><span class="kw">import</span> os
<span class="kw">from</span> superinstance_fleet <span class="kw">import</span> FleetClient
client = FleetClient(
base_url=os.environ[<span class="str">"FLEET_API_URL"</span>],
timeout=<span class="num">5.0</span>,
api_key=os.environ.get(<span class="str">"FLEET_API_KEY"</span>),
)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<!-- Error Handling -->
<h2>Error Handling</h2>
<pre><code><span class="kw">from</span> superinstance_fleet <span class="kw">import</span> FleetClient, FleetError
client = FleetClient()
<span class="kw">try</span>:
results = client.<span class="fn">search</span>(<span class="str">"database ORM"</span>)
<span class="kw">except</span> FleetError <span class="kw">as</span> e:
<span class="kw">if</span> e.code == <span class="str">"TIMEOUT"</span>:
<span class="fn">print</span>(<span class="str">"Request timed out"</span>)
<span class="kw">elif</span> e.code == <span class="str">"NOT_FOUND"</span>:
<span class="fn">print</span>(<span class="str">"Crate not found"</span>)
<span class="kw">elif</span> e.code == <span class="str">"INVALID_QUERY"</span>:
<span class="fn">print</span>(<span class="str">"Bad query"</span>)
<span class="kw">elif</span> e.code == <span class="str">"SERVER_ERROR"</span>:
<span class="fn">print</span>(<span class="str">f"Server error (status {e.status_code})"</span>)
<span class="kw">except</span> Exception <span class="kw">as</span> e:
<span class="fn">print</span>(<span class="str">f"Unexpected error: {e}"</span>)</code><button class="copy-btn" onclick="copyCode(this)">Copy</button></pre>
<h3>Exception Classes</h3>
<table>
<tr><th>Exception</th><th>Code</th><th>Description</th></tr>
<tr><td><code>FleetError</code></td><td><code>TIMEOUT</code></td><td>Request exceeded the configured timeout</td></tr>
<tr><td><code>FleetError</code></td><td><code>NOT_FOUND</code></td><td>Requested crate or resource not found</td></tr>
<tr><td><code>FleetError</code></td><td><code>INVALID_QUERY</code></td><td>Malformed or empty query string</td></tr>
<tr><td><code>FleetError</code></td><td><code>SERVER_ERROR</code></td><td>Upstream server returned 5xx</td></tr>
</table>
</div>
<script>
function copyCode(btn) {
const code = btn.parentElement.querySelector('code');
navigator.clipboard.writeText(code.textContent).then(() => {
btn.textContent = 'Copied!';
btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
</script>
<!-- Unified Footer -->
<footer class="site-footer">
<span>© 2026 SuperInstance</span>
<a href="https://github.com/superinstance">GitHub</a>
<a href="/security.html">Security</a>
<a href="https://www.npmjs.com/~superinstance">npm</a>
<a href="status.html">API Status</a>
</footer>
</div>
</body>
</html>