@apicity/openai 0.6.4 → 0.6.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 +35 -1
- package/dist/src/example.d.ts.map +1 -1
- package/dist/src/example.js +13 -0
- package/dist/src/example.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
|
|
|
28
28
|
|
|
29
29
|
## API Reference
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
51 endpoints across 13 groups. Each method mirrors an upstream URL path.
|
|
32
32
|
|
|
33
33
|
### audio
|
|
34
34
|
|
|
@@ -186,6 +186,40 @@ Source: [`packages/provider/openai/src/openai.ts`](src/openai.ts)
|
|
|
186
186
|
|
|
187
187
|
</details>
|
|
188
188
|
|
|
189
|
+
### codex
|
|
190
|
+
|
|
191
|
+
<details>
|
|
192
|
+
<summary><code>GET</code> <b><code>openai.codex.usage</code></b></summary>
|
|
193
|
+
|
|
194
|
+
<code>GET https://chatgpt.com/backend-api/wham/usage</code>
|
|
195
|
+
|
|
196
|
+
[Upstream docs ↗](https://developers.openai.com/codex/pricing)
|
|
197
|
+
|
|
198
|
+
```typescript
|
|
199
|
+
const res = await openai.codex.usage({ /* ... */ });
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
Source: [`packages/provider/openai/src/openai.ts`](src/openai.ts)
|
|
203
|
+
|
|
204
|
+
</details>
|
|
205
|
+
|
|
206
|
+
### conversations
|
|
207
|
+
|
|
208
|
+
<details>
|
|
209
|
+
<summary><code>POST</code> <b><code>openai.v1.conversations</code></b></summary>
|
|
210
|
+
|
|
211
|
+
<code>POST https://api.openai.com/v1/conversations</code>
|
|
212
|
+
|
|
213
|
+
[Upstream docs ↗](https://platform.openai.com/docs/api-reference)
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
const res = await openai.v1.conversations({ /* ... */ });
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
Source: [`packages/provider/openai/src/openai.ts`](src/openai.ts)
|
|
220
|
+
|
|
221
|
+
</details>
|
|
222
|
+
|
|
189
223
|
### embeddings
|
|
190
224
|
|
|
191
225
|
<details>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,QAAA,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,QAAA,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CA8F7C,CAAC;AAEF,eAAe,QAAQ,CAAC;AAOxB,wBAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,CA6ChD"}
|
package/dist/src/example.js
CHANGED
|
@@ -17,6 +17,12 @@ const EXAMPLES = {
|
|
|
17
17
|
"limit": 1
|
|
18
18
|
}
|
|
19
19
|
},
|
|
20
|
+
"GET v1.fineTuning.jobs": {
|
|
21
|
+
"source": "openai/fine-tuning-jobs-list",
|
|
22
|
+
"payload": {
|
|
23
|
+
"limit": 5
|
|
24
|
+
}
|
|
25
|
+
},
|
|
20
26
|
"POST v1.audio.speech": {
|
|
21
27
|
"source": "openai/speech-hello",
|
|
22
28
|
"payload": {
|
|
@@ -84,6 +90,13 @@ const EXAMPLES = {
|
|
|
84
90
|
"temperature": 0,
|
|
85
91
|
"max_output_tokens": 100
|
|
86
92
|
}
|
|
93
|
+
},
|
|
94
|
+
"POST v1.responses.inputTokens": {
|
|
95
|
+
"source": "openai/responses-input-tokens",
|
|
96
|
+
"payload": {
|
|
97
|
+
"model": "gpt-4o-mini",
|
|
98
|
+
"input": "Say hello in one sentence."
|
|
99
|
+
}
|
|
87
100
|
}
|
|
88
101
|
};
|
|
89
102
|
export default EXAMPLES;
|
package/dist/src/example.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"example.js","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,+DAA+D;AAC/D,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,qEAAqE;AAOrE,MAAM,QAAQ,GAAoC;IAChD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,2BAA2B;QACrC,SAAS,EAAE;YACT,OAAO,EAAE,CAAC;SACX;KACF;IACD,yBAAyB,EAAE;QACzB,QAAQ,EAAE,sCAAsC;QAChD,SAAS,EAAE;YACT,OAAO,EAAE,CAAC;SACX;KACF;IACD,sBAAsB,EAAE;QACtB,QAAQ,EAAE,qBAAqB;QAC/B,SAAS,EAAE;YACT,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,eAAe;YACxB,OAAO,EAAE,OAAO;YAChB,iBAAiB,EAAE,KAAK;SACzB;KACF;IACD,0BAA0B,EAAE;QAC1B,QAAQ,EAAE,mBAAmB;QAC7B,SAAS,EAAE;YACT,OAAO,EAAE,oBAAoB;YAC7B,UAAU,EAAE;gBACV;oBACE,MAAM,EAAE,MAAM;oBACd,SAAS,EAAE,4BAA4B;iBACxC;aACF;YACD,aAAa,EAAE,CAAC;SACjB;KACF;IACD,uBAAuB,EAAE;QACvB,QAAQ,EAAE,6BAA6B;QACvC,SAAS,EAAE;YACT,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,MAAM;oBACd,SAAS,EAAE,oCAAoC;iBAChD;aACF;YACD,UAAU,EAAE;gBACV,OAAO,EAAE,UAAU;aACpB;SACF;KACF;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,yBAAyB;QACnC,SAAS,EAAE;YACT,OAAO,EAAE,wBAAwB;YACjC,OAAO,EAAE,aAAa;SACvB;KACF;IACD,4BAA4B,EAAE;QAC5B,QAAQ,EAAE,2BAA2B;QACrC,SAAS,EAAE;YACT,QAAQ,EAAE,qBAAqB;YAC/B,OAAO,EAAE,UAAU;YACnB,GAAG,EAAE,CAAC;YACN,MAAM,EAAE,SAAS;SAClB;KACF;IACD,qBAAqB,EAAE;QACrB,QAAQ,EAAE,0BAA0B;QACpC,SAAS,EAAE;YACT,OAAO,EAAE,4BAA4B;YACrC,OAAO,EAAE,wBAAwB;SAClC;KACF;IACD,mBAAmB,EAAE;QACnB,QAAQ,EAAE,wBAAwB;QAClC,SAAS,EAAE;YACT,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,4BAA4B;YACrC,aAAa,EAAE,CAAC;YAChB,mBAAmB,EAAE,GAAG;SACzB;KACF;CACF,CAAC;AAEF,eAAe,QAAQ,CAAC;AAExB,0EAA0E;AAC1E,2EAA2E;AAC3E,yEAAyE;AACzE,0EAA0E;AAC1E,oDAAoD;AACpD,MAAM,UAAU,cAAc,CAAI,QAAW;IAC3C,MAAM,IAAI,GAAG,QAAmC,CAAC;IACjD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7E,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtD,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,EAAE,GAAG,CAAC;YAAE,SAAS;QACrB,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAmB;YACjC,IAAI,CAAC,MAAM,CAAC;YACX,IAAI,CAAC,MAAM,CAAyC,EAAE,GAAG;YAC1D,IAAI;SACL,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,SAAS,GAAI,GAA+B,CAAC,MAAM,CAAC,CAAC;gBAC3D,IAAI,SAAS;oBAAE,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACjF,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC7B,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/B,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,QAAQ;YAAE,SAAS;QACvB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,SAAS;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,SAAS;YAC9C,MAAM,SAAS,GAAI,GAA+B,CAAC,MAAM,CAAC,CAAC;YAC3D,IAAI,CAAC,SAAS;gBAAE,SAAS;YACzB,MAAM,EAAE,GAAG,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACrC,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAE,IAAc;IAC9C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAK,KAAgB,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,KAAgD,CAAC;QACjE,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,GAAG,GAAY,KAAK,CAAC;IACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACnD,MAAM,CAAC,GAAG,OAAO,GAAG,CAAC;QACrB,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,UAAU;YAAE,OAAO,IAAI,CAAC;QACpD,GAAG,GAAI,GAA+B,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,OAAO,GAAG,KAAK,UAAU;QAC9B,CAAC,CAAE,GAAuC;QAC1C,CAAC,CAAC,IAAI,CAAC;AACX,CAAC"}
|
|
1
|
+
{"version":3,"file":"example.js","sourceRoot":"","sources":["../../src/example.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,+DAA+D;AAC/D,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,qEAAqE;AAOrE,MAAM,QAAQ,GAAoC;IAChD,gBAAgB,EAAE;QAChB,QAAQ,EAAE,2BAA2B;QACrC,SAAS,EAAE;YACT,OAAO,EAAE,CAAC;SACX;KACF;IACD,yBAAyB,EAAE;QACzB,QAAQ,EAAE,sCAAsC;QAChD,SAAS,EAAE;YACT,OAAO,EAAE,CAAC;SACX;KACF;IACD,wBAAwB,EAAE;QACxB,QAAQ,EAAE,8BAA8B;QACxC,SAAS,EAAE;YACT,OAAO,EAAE,CAAC;SACX;KACF;IACD,sBAAsB,EAAE;QACtB,QAAQ,EAAE,qBAAqB;QAC/B,SAAS,EAAE;YACT,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,eAAe;YACxB,OAAO,EAAE,OAAO;YAChB,iBAAiB,EAAE,KAAK;SACzB;KACF;IACD,0BAA0B,EAAE;QAC1B,QAAQ,EAAE,mBAAmB;QAC7B,SAAS,EAAE;YACT,OAAO,EAAE,oBAAoB;YAC7B,UAAU,EAAE;gBACV;oBACE,MAAM,EAAE,MAAM;oBACd,SAAS,EAAE,4BAA4B;iBACxC;aACF;YACD,aAAa,EAAE,CAAC;SACjB;KACF;IACD,uBAAuB,EAAE;QACvB,QAAQ,EAAE,6BAA6B;QACvC,SAAS,EAAE;YACT,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,MAAM;oBACd,SAAS,EAAE,oCAAoC;iBAChD;aACF;YACD,UAAU,EAAE;gBACV,OAAO,EAAE,UAAU;aACpB;SACF;KACF;IACD,oBAAoB,EAAE;QACpB,QAAQ,EAAE,yBAAyB;QACnC,SAAS,EAAE;YACT,OAAO,EAAE,wBAAwB;YACjC,OAAO,EAAE,aAAa;SACvB;KACF;IACD,4BAA4B,EAAE;QAC5B,QAAQ,EAAE,2BAA2B;QACrC,SAAS,EAAE;YACT,QAAQ,EAAE,qBAAqB;YAC/B,OAAO,EAAE,UAAU;YACnB,GAAG,EAAE,CAAC;YACN,MAAM,EAAE,SAAS;SAClB;KACF;IACD,qBAAqB,EAAE;QACrB,QAAQ,EAAE,0BAA0B;QACpC,SAAS,EAAE;YACT,OAAO,EAAE,4BAA4B;YACrC,OAAO,EAAE,wBAAwB;SAClC;KACF;IACD,mBAAmB,EAAE;QACnB,QAAQ,EAAE,wBAAwB;QAClC,SAAS,EAAE;YACT,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,4BAA4B;YACrC,aAAa,EAAE,CAAC;YAChB,mBAAmB,EAAE,GAAG;SACzB;KACF;IACD,+BAA+B,EAAE;QAC/B,QAAQ,EAAE,+BAA+B;QACzC,SAAS,EAAE;YACT,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,4BAA4B;SACtC;KACF;CACF,CAAC;AAEF,eAAe,QAAQ,CAAC;AAExB,0EAA0E;AAC1E,2EAA2E;AAC3E,yEAAyE;AACzE,0EAA0E;AAC1E,oDAAoD;AACpD,MAAM,UAAU,cAAc,CAAI,QAAW;IAC3C,MAAM,IAAI,GAAG,QAAmC,CAAC;IACjD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7E,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtD,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,EAAE,GAAG,CAAC;YAAE,SAAS;QACrB,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAmB;YACjC,IAAI,CAAC,MAAM,CAAC;YACX,IAAI,CAAC,MAAM,CAAyC,EAAE,GAAG;YAC1D,IAAI;SACL,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,SAAS,GAAI,GAA+B,CAAC,MAAM,CAAC,CAAC;gBAC3D,IAAI,SAAS;oBAAE,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACjF,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC7B,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/B,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM;YACR,CAAC;QACH,CAAC;QACD,IAAI,QAAQ;YAAE,SAAS;QACvB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,SAAS;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,SAAS;YAC9C,MAAM,SAAS,GAAI,GAA+B,CAAC,MAAM,CAAC,CAAC;YAC3D,IAAI,CAAC,SAAS;gBAAE,SAAS;YACzB,MAAM,EAAE,GAAG,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACrC,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC/B,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAE,IAAc;IAC9C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAK,KAAgB,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,KAAgD,CAAC;QACjE,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,GAAG,GAAY,KAAK,CAAC;IACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACnD,MAAM,CAAC,GAAG,OAAO,GAAG,CAAC;QACrB,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,UAAU;YAAE,OAAO,IAAI,CAAC;QACpD,GAAG,GAAI,GAA+B,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,OAAO,GAAG,KAAK,UAAU;QAC9B,CAAC,CAAE,GAAuC;QAC1C,CAAC,CAAC,IAAI,CAAC;AACX,CAAC"}
|