@99percentpeople/pi-codex-api 0.2.2 → 0.2.5

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.
package/README.md CHANGED
@@ -34,6 +34,38 @@ Image generation with `gpt-image-2` (saved PNG + description):
34
34
 
35
35
  ![codex image demo](../../promo/demo/codex-image.gif)
36
36
 
37
+ ## Search output
38
+
39
+ `codex_search` keeps each result family readable:
40
+
41
+ - Web and image searches render compact source cards.
42
+ - `open`, `click`, and `find` render grouped document previews; collapsed output
43
+ shows at most three documents, while expanded output keeps every result.
44
+ - Weather forecasts, finance quotes, sports standings/schedules, and time
45
+ lookups render structured cards. Weather alert details are reduced to their
46
+ actionable summaries instead of injecting the provider's full object dump.
47
+ - Structured lookup text is compacted before it reaches the model. Other search
48
+ output is bounded to 2,000 lines or 50 KB and tells the model to open fewer
49
+ references if truncation occurs.
50
+
51
+ For page workflows, search first and open returned reference IDs. Direct URLs
52
+ are best effort because Codex's browsing backend can reject otherwise valid
53
+ URLs. Keep page-navigation batches to three pages or fewer; `response_length`
54
+ and `open.lineno` do not reliably shorten page bodies.
55
+
56
+ Current Codex backend limitations are surfaced as actionable result hints:
57
+
58
+ - Weather can become temporarily unavailable even with valid locations; retry
59
+ once, then fall back to web search rather than looping over modes or locations.
60
+ - Crypto quotes require bare tickers such as `BTC` or `ETH`, not `BTC-USD`.
61
+ - NHL standings are not served by the structured sports lookup.
62
+ - `finance.market` is only a provider hint and does not reliably resolve
63
+ international exchange listings such as `0700.HK`.
64
+
65
+ When a batched lookup silently omits one item, the extension compares returned
66
+ reference indexes with the request and reports the missing item's applicable
67
+ hint instead of presenting the batch as fully successful.
68
+
37
69
  ## Quick start
38
70
 
39
71
  ```bash