krun-ai 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- krun_ai-0.1.0/.gitignore +13 -0
- krun_ai-0.1.0/CHANGELOG.md +16 -0
- krun_ai-0.1.0/LICENSE +202 -0
- krun_ai-0.1.0/PKG-INFO +360 -0
- krun_ai-0.1.0/README.md +335 -0
- krun_ai-0.1.0/openapi/openapi.json +800 -0
- krun_ai-0.1.0/pyproject.toml +72 -0
- krun_ai-0.1.0/src/krun/__init__.py +76 -0
- krun_ai-0.1.0/src/krun/_client.py +395 -0
- krun_ai-0.1.0/src/krun/_constants.py +20 -0
- krun_ai-0.1.0/src/krun/_exceptions.py +216 -0
- krun_ai-0.1.0/src/krun/_models.py +189 -0
- krun_ai-0.1.0/src/krun/_version.py +1 -0
- krun_ai-0.1.0/src/krun/py.typed +0 -0
- krun_ai-0.1.0/src/krun/types.py +141 -0
- krun_ai-0.1.0/tests/__init__.py +0 -0
- krun_ai-0.1.0/tests/mock_server.py +175 -0
- krun_ai-0.1.0/tests/test_client.py +640 -0
- krun_ai-0.1.0/tests/test_contract.py +121 -0
- krun_ai-0.1.0/tests/test_integration.py +170 -0
- krun_ai-0.1.0/tests/test_live.py +83 -0
krun_ai-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project are documented here. The format follows
|
|
4
|
+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses [Semantic Versioning](https://semver.org/).
|
|
5
|
+
|
|
6
|
+
## [0.1.0] - Unreleased
|
|
7
|
+
|
|
8
|
+
Initial SDK, licensed under Apache-2.0.
|
|
9
|
+
|
|
10
|
+
- `Krun` (sync) and `AsyncKrun` (async) clients for Krun API v1 (OpenAPI `1.0.0-beta`).
|
|
11
|
+
- `decide()`: context + 1–16 named `choice` questions, including tool routing (`task_type="tool"`), returns
|
|
12
|
+
`DecisionResult` (`model`, `answers`, `usage.input_tokens`, `request_id` from `X-Request-ID`).
|
|
13
|
+
- `feedback()` and `models()`.
|
|
14
|
+
- Error hierarchy mapped from the API's error codes, carrying `message`, `request_id`, `status_code`, `error_code`.
|
|
15
|
+
- 70 s default timeout; conservative retries (decide/models only, connection errors and 502/503/504, default 1).
|
|
16
|
+
- OpenAPI snapshot, contract tests and drift check.
|
krun_ai-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
krun_ai-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,360 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: krun-ai
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Official Python SDK for the Krun API.
|
|
5
|
+
Project-URL: Homepage, https://krun.ai
|
|
6
|
+
Project-URL: Repository, https://github.com/krun-ai/krun-python
|
|
7
|
+
Project-URL: Changelog, https://github.com/krun-ai/krun-python/blob/main/CHANGELOG.md
|
|
8
|
+
Project-URL: API reference, https://api.krun.ai/openapi.json
|
|
9
|
+
Author: Krun
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: classification,decisions,krun,llm,routing,sdk
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Typing :: Typed
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Requires-Dist: httpx<1,>=0.25
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# Krun Python SDK
|
|
27
|
+
|
|
28
|
+
Official Python SDK for the Krun API.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pip install krun-ai
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
> **Not published yet.** The package is ready but not on PyPI yet. It is distributed as **`krun-ai`** (the name
|
|
35
|
+
> `krun` belongs to an unrelated PyPI project) and imported as `krun`. Until it is published, install from a checkout:
|
|
36
|
+
>
|
|
37
|
+
> ```bash
|
|
38
|
+
> pip install "git+https://github.com/krun-ai/krun-python.git" # or: pip install -e . (local development)
|
|
39
|
+
> ```
|
|
40
|
+
|
|
41
|
+
- Python 3.10+
|
|
42
|
+
- One runtime dependency: [`httpx`](https://www.python-httpx.org/)
|
|
43
|
+
- Sync (`Krun`) and async (`AsyncKrun`) clients with the same methods
|
|
44
|
+
- Fully typed (`py.typed`), frozen dataclasses for results, plain dicts for requests
|
|
45
|
+
- Supports **Krun API v1** (`/v1/*`, OpenAPI `1.0.0-beta`)
|
|
46
|
+
|
|
47
|
+
## Quickstart
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from krun import Krun
|
|
51
|
+
|
|
52
|
+
client = Krun(api_key="krun_live_...") # or Krun() to read KRUN_API_KEY
|
|
53
|
+
|
|
54
|
+
result = client.decide(
|
|
55
|
+
context="Customer wants to return an item.",
|
|
56
|
+
questions={
|
|
57
|
+
"department": {
|
|
58
|
+
"type": "choice",
|
|
59
|
+
"options": {
|
|
60
|
+
"shipping": "Shipping and delivery issues",
|
|
61
|
+
"returns": "Returns and refunds",
|
|
62
|
+
"billing": "Billing and payment issues",
|
|
63
|
+
},
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
)
|
|
67
|
+
|
|
68
|
+
answer = result.answers["department"]
|
|
69
|
+
|
|
70
|
+
print(answer.choice) # "returns", or None if the model abstains
|
|
71
|
+
print(answer.confidence) # 0.9788: top-1 minus top-2 probability
|
|
72
|
+
print(answer.probabilities) # {"shipping": 0.0056, "returns": 0.9866, "billing": 0.0078}
|
|
73
|
+
print(result.request_id) # "req_...": pass it to feedback()
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Reading an answer
|
|
77
|
+
|
|
78
|
+
Every question gets one `ChoiceAnswer`:
|
|
79
|
+
|
|
80
|
+
| field | type | meaning |
|
|
81
|
+
|---|---|---|
|
|
82
|
+
| `type` | `"choice"` | question type (the only type today) |
|
|
83
|
+
| `choice` | `str \| None` | selected option id, **`None` when `abstain` is true** |
|
|
84
|
+
| `confidence` | `float` | **top-1 probability − top-2 probability**, in [0, 1] |
|
|
85
|
+
| `probabilities` | `dict[str, float]` | calibrated probability per option id, keys exactly as sent, in request order |
|
|
86
|
+
| `abstain` | `bool` | `confidence` is below the model's abstention threshold |
|
|
87
|
+
| `abstention_status` | `"calibrated" \| "advisory"` | how much to trust `abstain` (below) |
|
|
88
|
+
|
|
89
|
+
**`confidence` is a margin, not "the probability that the answer is correct".** It measures how clearly the best
|
|
90
|
+
option beats the runner-up: `0.97` means a clear winner, `0.02` means a near tie. It is the score the abstention
|
|
91
|
+
threshold is applied to.
|
|
92
|
+
|
|
93
|
+
**`choice` can be `None`.** When the model abstains, `choice` is `None` and the SDK does **not** replace it with the most
|
|
94
|
+
likely option. The ranking is still in `probabilities` if you want a best guess:
|
|
95
|
+
|
|
96
|
+
```python
|
|
97
|
+
if answer.abstain:
|
|
98
|
+
best_guess = max(answer.probabilities, key=answer.probabilities.__getitem__)
|
|
99
|
+
route_to_human(best_guess)
|
|
100
|
+
else:
|
|
101
|
+
route(answer.choice)
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
**`abstention_status`**:
|
|
105
|
+
|
|
106
|
+
- `calibrated`: intent questions with label-only options (`""`/`None` descriptions). Abstention was validated for
|
|
107
|
+
this setup.
|
|
108
|
+
- `advisory`: tool routing and options with descriptions. `abstain` is a hint, not a validated guarantee.
|
|
109
|
+
|
|
110
|
+
`result.usage.input_tokens` is the number of input tokens the model processed, summed over questions. Krun scores
|
|
111
|
+
options and does not generate text, so there are no output tokens.
|
|
112
|
+
|
|
113
|
+
## Multiple questions
|
|
114
|
+
|
|
115
|
+
Ask several questions about the same context in **one call**. Answers come back under the same ids, in request
|
|
116
|
+
order:
|
|
117
|
+
|
|
118
|
+
```python
|
|
119
|
+
result = client.decide(
|
|
120
|
+
context="My card was charged twice and I need the money back today!",
|
|
121
|
+
questions={
|
|
122
|
+
"department": {"type": "choice", "options": {"shipping": "", "returns": "", "billing": ""}},
|
|
123
|
+
"priority": {"type": "choice", "options": {"low": "Can wait", "normal": "", "high": "Urgent"}},
|
|
124
|
+
"risk": {"type": "choice", "options": {"low": "", "high": ""}},
|
|
125
|
+
},
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
result.answers["department"].choice # "billing"
|
|
129
|
+
result.answers["priority"].choice # "high"
|
|
130
|
+
result.answers["risk"].choice
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Limits (enforced by the API, reported as `InvalidRequestError` before any inference): 1–16 questions, 2–64 options
|
|
134
|
+
per question, `context` 1–8,000 characters. Option descriptions can be a string, `""` or `None` (label-only).
|
|
135
|
+
Question and option ids are yours: they are sent and returned verbatim (`transaction_charged_twice`,
|
|
136
|
+
`calendar_search`, ...).
|
|
137
|
+
|
|
138
|
+
## Tool routing
|
|
139
|
+
|
|
140
|
+
Set `task_type: "tool"` to pick a tool or function:
|
|
141
|
+
|
|
142
|
+
```python
|
|
143
|
+
from krun import ChoiceQuestion
|
|
144
|
+
|
|
145
|
+
result = client.decide(
|
|
146
|
+
context="Find my meetings tomorrow.",
|
|
147
|
+
questions={
|
|
148
|
+
"tool": {
|
|
149
|
+
"type": "choice",
|
|
150
|
+
"task_type": "tool",
|
|
151
|
+
"options": {
|
|
152
|
+
"calendar_search": "Search calendar events",
|
|
153
|
+
"send_email": "Send an email",
|
|
154
|
+
},
|
|
155
|
+
}
|
|
156
|
+
},
|
|
157
|
+
)
|
|
158
|
+
# or, as an object: {"tool": ChoiceQuestion(options={...}, task_type="tool")}
|
|
159
|
+
|
|
160
|
+
answer = result.answers["tool"]
|
|
161
|
+
answer.choice # "calendar_search"
|
|
162
|
+
answer.abstention_status # "advisory": tool abstention is a hint, keep your own fallback
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
## Feedback
|
|
166
|
+
|
|
167
|
+
Tell Krun whether an answer was right. `question_id` is always required:
|
|
168
|
+
|
|
169
|
+
```python
|
|
170
|
+
client.feedback(
|
|
171
|
+
request_id=result.request_id,
|
|
172
|
+
question_id="department",
|
|
173
|
+
correct=False,
|
|
174
|
+
expected_decision="billing",
|
|
175
|
+
metadata={"ticket": "T-1234"}, # optional JSON object, ≤ 8 KiB; no personal data
|
|
176
|
+
)
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Feedback for a `request_id` this project never decided raises `NotFoundError`.
|
|
180
|
+
|
|
181
|
+
## Models
|
|
182
|
+
|
|
183
|
+
```python
|
|
184
|
+
for model in client.models():
|
|
185
|
+
print(model.id, model.status) # krun-one-v0 available
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Async
|
|
189
|
+
|
|
190
|
+
```python
|
|
191
|
+
import asyncio
|
|
192
|
+
from krun import AsyncKrun
|
|
193
|
+
|
|
194
|
+
async def main() -> None:
|
|
195
|
+
async with AsyncKrun() as client:
|
|
196
|
+
result = await client.decide(context="...", questions={...})
|
|
197
|
+
await client.feedback(request_id=result.request_id, question_id="department", correct=True)
|
|
198
|
+
|
|
199
|
+
asyncio.run(main())
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
`Krun` and `AsyncKrun` take the same arguments and return the same types.
|
|
203
|
+
|
|
204
|
+
## Configuration
|
|
205
|
+
|
|
206
|
+
```python
|
|
207
|
+
client = Krun(
|
|
208
|
+
api_key="krun_live_...", # default: KRUN_API_KEY
|
|
209
|
+
base_url="http://localhost:8080", # default: https://api.krun.ai
|
|
210
|
+
timeout=70.0, # seconds per attempt (default 70)
|
|
211
|
+
max_retries=1, # decide()/models() only (default 1)
|
|
212
|
+
http_client=None, # optional httpx.Client (proxies, custom transport, ...)
|
|
213
|
+
)
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Per call: `client.decide(..., timeout=10.0, request_id="my-trace-id")`. Use `with Krun() as client:` or
|
|
217
|
+
`client.close()` to release connections.
|
|
218
|
+
|
|
219
|
+
### Timeouts
|
|
220
|
+
|
|
221
|
+
The default is **70 seconds** because a Serverless cold start can use most of the API's own 60-second deadline. The
|
|
222
|
+
timeout applies to each attempt (connect and read). It cannot be disabled: `None`, `0` and `inf` are rejected. When it
|
|
223
|
+
elapses you get `APITimeoutError`.
|
|
224
|
+
|
|
225
|
+
### Retries
|
|
226
|
+
|
|
227
|
+
The API already retries its model backend, so the SDK retries only a little:
|
|
228
|
+
|
|
229
|
+
| call | retried on | default |
|
|
230
|
+
|---|---|---|
|
|
231
|
+
| `decide()`, `models()` | connection errors, HTTP 502 / 503 / 504 | 1 retry (`max_retries`) |
|
|
232
|
+
| `feedback()` | never: it writes a row and the API has no idempotency key | – |
|
|
233
|
+
|
|
234
|
+
- The wait between attempts follows `Retry-After` when the API sends it (capped at 10 s). Otherwise it is 0.5 s,
|
|
235
|
+
then 1 s, 2 s, and so on.
|
|
236
|
+
- SDK timeouts (`APITimeoutError`) are not retried.
|
|
237
|
+
- 4xx errors and 500 are not retried.
|
|
238
|
+
- A retried `decide()` can count one extra decision against usage if the first attempt reached the model.
|
|
239
|
+
- Use `max_retries=0` to disable retries.
|
|
240
|
+
|
|
241
|
+
### Request IDs
|
|
242
|
+
|
|
243
|
+
Every decision gets an id from the `X-Request-ID` response header. The SDK puts it on `result.request_id`. Errors
|
|
244
|
+
carry it too (`exc.request_id`, from the error body or the header), so you can quote it to support. You can send your
|
|
245
|
+
own with `decide(..., request_id="...")` (1–128 characters of `[A-Za-z0-9._:-]`). The API keeps it and returns it.
|
|
246
|
+
|
|
247
|
+
## Errors
|
|
248
|
+
|
|
249
|
+
All errors inherit from `krun.KrunError` and expose `message`, `request_id`, `status_code` and `error_code` when
|
|
250
|
+
available:
|
|
251
|
+
|
|
252
|
+
```text
|
|
253
|
+
KrunError
|
|
254
|
+
├── APIError the API answered with an error (status_code always set)
|
|
255
|
+
│ ├── InvalidRequestError 400/413 INVALID_REQUEST, INVALID_OPTIONS, PAYLOAD_TOO_LARGE
|
|
256
|
+
│ ├── AuthenticationError 401 UNAUTHORIZED
|
|
257
|
+
│ ├── NotFoundError 404 NOT_FOUND
|
|
258
|
+
│ ├── RateLimitError 429 RATE_LIMITED (.retry_after)
|
|
259
|
+
│ ├── QuotaExceededError 429 QUOTA_EXCEEDED
|
|
260
|
+
│ ├── InferenceFailedError 502 INFERENCE_FAILED
|
|
261
|
+
│ ├── ServiceUnavailableError 503 UPSTREAM_UNAVAILABLE (.retry_after)
|
|
262
|
+
│ ├── UpstreamTimeoutError 504 UPSTREAM_TIMEOUT
|
|
263
|
+
│ └── InternalServerError 500 INTERNAL_ERROR
|
|
264
|
+
├── APIConnectionError no HTTP response (DNS, refused, reset, TLS)
|
|
265
|
+
│ └── APITimeoutError the SDK timeout elapsed
|
|
266
|
+
└── APIResponseValidationError a 2xx response did not match the contract
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
```python
|
|
270
|
+
import krun
|
|
271
|
+
|
|
272
|
+
try:
|
|
273
|
+
client.decide(context="...", questions={...})
|
|
274
|
+
except krun.InvalidRequestError as e:
|
|
275
|
+
print(e.error_code, e.message, e.request_id) # INVALID_OPTIONS questions.q: 1 options given; ...
|
|
276
|
+
except krun.RateLimitError as e:
|
|
277
|
+
time.sleep(e.retry_after or 1)
|
|
278
|
+
except krun.KrunError as e:
|
|
279
|
+
log.warning("krun failed: %s", e)
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
Wrong argument types (e.g. `context=None`) raise `TypeError` before any request is made.
|
|
283
|
+
|
|
284
|
+
## Privacy and logging
|
|
285
|
+
|
|
286
|
+
- No telemetry: the SDK sends requests only to the Krun API and records nothing itself. Usage is recorded by the
|
|
287
|
+
API.
|
|
288
|
+
- Silent by default. The SDK logs to the `krun` logger at DEBUG, and only method, path, status, request id and
|
|
289
|
+
retries. It never logs the API key, context, options or answers. To see these logs:
|
|
290
|
+
`logging.getLogger("krun").setLevel(logging.DEBUG)`.
|
|
291
|
+
- The API key never appears in `repr(client)`, error messages or logs.
|
|
292
|
+
- Requests carry `User-Agent: krun-python/<version>`.
|
|
293
|
+
|
|
294
|
+
## Examples
|
|
295
|
+
|
|
296
|
+
[`examples/`](examples/): `basic_decision.py`, `multiple_questions.py`, `tool_routing.py`, `feedback.py`,
|
|
297
|
+
`async_decision.py`, `error_handling.py`.
|
|
298
|
+
|
|
299
|
+
```bash
|
|
300
|
+
export KRUN_API_KEY=krun_live_...
|
|
301
|
+
python examples/basic_decision.py
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
## Development
|
|
305
|
+
|
|
306
|
+
```bash
|
|
307
|
+
uv sync # Python 3.10+ venv with dev tools
|
|
308
|
+
uv run ruff check . && uv run ruff format --check .
|
|
309
|
+
uv run mypy
|
|
310
|
+
uv run pytest # unit + contract + mock-server integration tests (no network)
|
|
311
|
+
uv build # dist/krun_ai-0.1.0-py3-none-any.whl + .tar.gz
|
|
312
|
+
uv run python scripts/bench.py # SDK overhead vs raw httpx on a local mock server
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Tests
|
|
316
|
+
|
|
317
|
+
- `tests/test_client.py`: unit tests with `httpx.MockTransport`. Covers auth header, serialization, parsing,
|
|
318
|
+
`choice=None`, `input_tokens`, `X-Request-ID`, the full error mapping, retries, timeouts, base URL, feedback,
|
|
319
|
+
models, key redaction and the absence of output tokens.
|
|
320
|
+
- `tests/test_integration.py`: real HTTP against `tests/mock_server.py`, a local server that validates every
|
|
321
|
+
request body against the OpenAPI snapshot. Covers sync and async clients, real timeouts, connection refused and
|
|
322
|
+
retry after 503.
|
|
323
|
+
- `tests/test_contract.py`: offline checks that the hand-written models match `openapi/openapi.json` (every error
|
|
324
|
+
code mapped, answer/usage/feedback fields, OpenAPI examples round-trip).
|
|
325
|
+
- `tests/test_live.py`: **opt-in** production checks, never run in CI:
|
|
326
|
+
|
|
327
|
+
```bash
|
|
328
|
+
KRUN_LIVE_TESTS=1 KRUN_API_KEY=krun_live_... uv run pytest tests/test_live.py -v # 1 real decision
|
|
329
|
+
KRUN_API_KEY=krun_live_... uv run python scripts/smoke.py # manual smoke, 1 real decision
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### OpenAPI contract and drift
|
|
333
|
+
|
|
334
|
+
The public API is hand-written, and `https://api.krun.ai/openapi.json` is the reference:
|
|
335
|
+
|
|
336
|
+
- `openapi/openapi.json` is the snapshot this release was written against. Its version and hash are pinned in
|
|
337
|
+
`src/krun/_constants.py`, and `tests/test_contract.py` fails if they disagree.
|
|
338
|
+
- `python scripts/check_openapi.py` compares production with the snapshot. It exits 1 on drift and prints what
|
|
339
|
+
changed. `--update` refreshes the snapshot.
|
|
340
|
+
- The `contract-drift` workflow runs that check weekly and on demand. The unit tests never use the network.
|
|
341
|
+
|
|
342
|
+
## Versioning and releases
|
|
343
|
+
|
|
344
|
+
SemVer, starting at `0.1.0`. SDK versions are independent of model versions (`krun-one-v0`) and of the API version
|
|
345
|
+
(v1). See [CHANGELOG.md](CHANGELOG.md).
|
|
346
|
+
|
|
347
|
+
Release flow (not yet executed):
|
|
348
|
+
|
|
349
|
+
1. Bump `version` in `pyproject.toml` and `src/krun/_version.py`, and update `CHANGELOG.md`.
|
|
350
|
+
2. Merge to `main`. CI runs lint, type check, tests on 3.10–3.13 and the package build.
|
|
351
|
+
3. Tag `vX.Y.Z` and publish a GitHub Release.
|
|
352
|
+
4. `.github/workflows/publish.yml` runs on the release. It checks that the tag matches the package version, builds
|
|
353
|
+
the wheel and sdist, and uploads them to PyPI with **Trusted Publishing** (OIDC, no stored token).
|
|
354
|
+
|
|
355
|
+
Trusted Publishing is configured on PyPI (owner `krun-ai`, repo `krun-python`, workflow `publish.yml`, environment
|
|
356
|
+
`pypi`); the `pypi` environment exists in the GitHub repo settings.
|
|
357
|
+
|
|
358
|
+
## License
|
|
359
|
+
|
|
360
|
+
[Apache License 2.0](LICENSE).
|