Cheat Sheet, Downloads and Edition Notes
Keep this page nearby while working through the cases. Download the example package, extract it and read its run instructions. Run the commands from the extracted project root.
Three starting commands
python -m examples.hello_jev tickets --mode offline
python -m examples.hello_jev content --mode offline
python -m examples.hello_jev route --mode offline
These commands need no API key. They replay authored responses to exercise application behavior. Once you have real access, have set the environment variable and understand that inputs will be sent to the provider, replace offline with live. The mock order tool is not a connection to a real commerce system.
| Setting | Purpose |
|---|---|
| TYPESAFE_API_KEY | Authentication for real requests; set locally |
| TYPESAFE_MODEL | Optional model name; default jev-latest |
| --mode offline | Replay clearly labeled teaching responses |
| --mode live | Send real requests to TypeSafe |
| --output | Choose a local report destination; see command help |
Your system may launch Python with python3 or py. Use the same interpreter for setup, checks and execution. The three bundled cases use the standard library. The official SDK shown in the text is an optional alternative integration path.
Types and fields at a glance
| Type | Define | Read |
|---|---|---|
| Choice | Question, named options and meanings | choice, probabilities, confidence |
| Score | Question and ordered rubric levels | score, probabilities, confidence |
| Noul | One clear proposition | noul |
Questions belong under questions, and evidence belongs in state. The request's model selects a model. The response's model name records the actual answering version. Consult the official API reference for complete field definitions.
English and Chinese terminology
| English | 中文 | Meaning in this handbook |
|---|---|---|
| State | 状态／材料 | Evidence available to the judgment |
| Question | 问题 | A clearly scoped judgment task |
| Criteria / Rubric | 标准 | Definitions of options or levels |
| Probability | 选项概率 | A probability for a candidate or proposition |
| Confidence | 置信度 | A summary of a Choice/Score distribution |
| Review | 复核 | Further checking by a person or workflow |
| Fixture | 离线响应 | Authored data for exercising a program |
| Holdout set | 留出集 | Examples not used for tuning |
| Routing | 路由 | Choosing a handling path |
| Fallback | 回退 | A next step when the normal path cannot run |
Official references
- Introduction: the model's basic interface and purpose.
- Quick start: Playground, HTTP and SDK entry points.
- API reference: request fields, response fields and error statuses.
- Choice, Score and Noul: detailed primitive contracts.
- Confidence: interpretation of the confidence field.
- Patterns: composition, scoring and routing patterns.
- Models: current versions, prices, limits and language support.
What this edition establishes
CoolJev independently produced this handbook. It is not an official TypeSafe publication. Interface facts are checked against public official documentation. The scenarios, sample data, questions, application policies and offline responses are original teaching designs. Documentation was checked on September 20, 2026.
This edition does not present offline execution as measured model accuracy. Latency, quality and cost unsupported by real-call records are not labeled as measured results. Numbers marked as arithmetic examples or teaching responses are explanatory. The example package includes a record of local checks.
For the next edition, recheck request fields, setup instructions, model names, prices, all three commands and download links. Update the version and date when content changes. A new cover or layout does not make an old experiment a new experiment.
Turn one case into your project
Copy one case, replace its input material and describe the exact outcome you want. Retain the original sample as a regression check. Revise the rules on development examples, validate on separate examples and only then increase volume.
If you cannot explain why a judgment should enter a particular branch, clarify the business rule first. A small workflow that is understandable, inspectable and able to handle failure is a useful foundation for the next one.