openai-compatible-errors 0.1.0 → 0.1.1
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/README.md +26 -0
- data/lib/openai_compatible_errors/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 74a3d5e06d4de5152845fedeaedf88d34652cb1668b14026ea0154c57e3f3c0b
|
|
4
|
+
data.tar.gz: 914a794ef4536b9edad342fcb7e06e873ca2e1cde30a41af6b0baa5dc7f4d313
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 602a9610567b531ea7227512a763715986282c37630850b5853158c5e105da49e23696cf6da9b16e79f142cbc09592934980cd006b77e80c2227da768cf5b266
|
|
7
|
+
data.tar.gz: 5a8ac65d6a7b68eb9bf7c57bb369d5f98cc667e2a378d2e3a3a0d824b396d9916d38ad1e41b84ca28742c3f56245ba5aa5bcc189f1f65c31d843dc8779f6002e
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this gem are documented here.
|
|
4
4
|
|
|
5
|
+
## [0.1.1] - 2026-08-09
|
|
6
|
+
|
|
7
|
+
Documentation release.
|
|
8
|
+
|
|
9
|
+
- Add contextual links to the API gateway, protocol references, replay-safety
|
|
10
|
+
research, and the maintained packages in other language ecosystems.
|
|
11
|
+
- Keep the Ruby implementation and its zero-runtime-dependency contract
|
|
12
|
+
unchanged.
|
|
13
|
+
|
|
5
14
|
## [0.1.0] - 2026-08-09
|
|
6
15
|
|
|
7
16
|
Initial public release.
|
|
@@ -18,4 +27,5 @@ Initial public release.
|
|
|
18
27
|
without retaining generated output.
|
|
19
28
|
- Provide bounded recursive log sanitization with cycle detection.
|
|
20
29
|
|
|
30
|
+
[0.1.1]: https://github.com/airouter-dev/openai-compatible-errors-ruby/releases/tag/v0.1.1
|
|
21
31
|
[0.1.0]: https://github.com/airouter-dev/openai-compatible-errors-ruby/releases/tag/v0.1.0
|
data/README.md
CHANGED
|
@@ -11,6 +11,24 @@ It does not send requests, sleep, retry automatically, buffer an entire stream,
|
|
|
11
11
|
or retain a raw provider response. The caller remains responsible for
|
|
12
12
|
idempotency, cancellation, budget accounting and request replay.
|
|
13
13
|
|
|
14
|
+
## Project resources
|
|
15
|
+
|
|
16
|
+
The [AI-ROUTER API gateway](https://ai-router.dev/) is the service context for
|
|
17
|
+
the compatible-endpoint examples. The library itself remains transport-neutral:
|
|
18
|
+
you can use it with any gateway or provider that follows the same API shape.
|
|
19
|
+
|
|
20
|
+
For the protocol details behind the implementation, see the
|
|
21
|
+
[OpenAI error-code guide](https://developers.openai.com/api/docs/guides/error-codes),
|
|
22
|
+
the [MDN Retry-After reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Retry-After),
|
|
23
|
+
and the [WHATWG Server-Sent Events specification](https://html.spec.whatwg.org/multipage/server-sent-events.html).
|
|
24
|
+
For a worked replay-safety model, read the
|
|
25
|
+
[LLM stream retry-safety walkthrough](https://ai-router.hashnode.dev/rust-llm-stream-retry-safety).
|
|
26
|
+
|
|
27
|
+
The package is available from
|
|
28
|
+
[RubyGems](https://rubygems.org/gems/openai-compatible-errors). Teams using PHP
|
|
29
|
+
can compare the [native Composer implementation](https://packagist.org/packages/airouter/openai-compatible-errors);
|
|
30
|
+
the two packages share the same safety boundary but do not share runtime code.
|
|
31
|
+
|
|
14
32
|
## Install
|
|
15
33
|
|
|
16
34
|
gem "openai-compatible-errors"
|
|
@@ -201,6 +219,14 @@ Use a full resilience library when you need circuit breaking, cancellation-aware
|
|
|
201
219
|
sleep, hedging or request execution. Keep a provider SDK's native exception when
|
|
202
220
|
one stable provider contract is all your application needs.
|
|
203
221
|
|
|
222
|
+
## Related language packages
|
|
223
|
+
|
|
224
|
+
- [JavaScript and TypeScript package on npm](https://www.npmjs.com/package/@ai-router/openai-compatible-errors)
|
|
225
|
+
- [Python package on PyPI](https://pypi.org/project/openai-compatible-errors/)
|
|
226
|
+
- [.NET package on NuGet](https://www.nuget.org/packages/AiRouter.OpenAICompatibleErrors/)
|
|
227
|
+
- [JVM contract package on Maven Central](https://central.sonatype.com/artifact/dev.ai-router/openai-compatible-contract-junit)
|
|
228
|
+
- [Rust stream guard on crates.io](https://crates.io/crates/llm-stream-guard)
|
|
229
|
+
|
|
204
230
|
## Development
|
|
205
231
|
|
|
206
232
|
bundle install
|