@effect/ai-openai 4.0.0-beta.65 → 4.0.0-beta.67
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/dist/Generated.d.ts +1 -1
- package/dist/Generated.js +1 -1
- package/dist/OpenAiClient.d.ts +18 -11
- package/dist/OpenAiClient.d.ts.map +1 -1
- package/dist/OpenAiClient.js +11 -9
- package/dist/OpenAiClient.js.map +1 -1
- package/dist/OpenAiClientGenerated.d.ts +5 -5
- package/dist/OpenAiClientGenerated.js +5 -5
- package/dist/OpenAiConfig.d.ts +43 -8
- package/dist/OpenAiConfig.d.ts.map +1 -1
- package/dist/OpenAiConfig.js +28 -4
- package/dist/OpenAiConfig.js.map +1 -1
- package/dist/OpenAiEmbeddingModel.d.ts +13 -9
- package/dist/OpenAiEmbeddingModel.d.ts.map +1 -1
- package/dist/OpenAiEmbeddingModel.js +8 -6
- package/dist/OpenAiEmbeddingModel.js.map +1 -1
- package/dist/OpenAiError.d.ts +124 -3
- package/dist/OpenAiError.d.ts.map +1 -1
- package/dist/OpenAiError.js +1 -1
- package/dist/OpenAiLanguageModel.d.ts +161 -10
- package/dist/OpenAiLanguageModel.d.ts.map +1 -1
- package/dist/OpenAiLanguageModel.js +9 -7
- package/dist/OpenAiLanguageModel.js.map +1 -1
- package/dist/OpenAiSchema.d.ts +108 -35
- package/dist/OpenAiSchema.d.ts.map +1 -1
- package/dist/OpenAiSchema.js +55 -18
- package/dist/OpenAiSchema.js.map +1 -1
- package/dist/OpenAiTelemetry.d.ts +13 -10
- package/dist/OpenAiTelemetry.d.ts.map +1 -1
- package/dist/OpenAiTelemetry.js +2 -2
- package/dist/OpenAiTelemetry.js.map +1 -1
- package/dist/OpenAiTool.d.ts +26 -26
- package/dist/OpenAiTool.js +10 -10
- package/dist/index.d.ts +11 -11
- package/dist/index.js +11 -11
- package/package.json +3 -3
- package/src/Generated.ts +1 -1
- package/src/OpenAiClient.ts +20 -13
- package/src/OpenAiClientGenerated.ts +6 -6
- package/src/OpenAiConfig.ts +43 -8
- package/src/OpenAiEmbeddingModel.ts +15 -11
- package/src/OpenAiError.ts +124 -3
- package/src/OpenAiLanguageModel.ts +163 -12
- package/src/OpenAiSchema.ts +109 -36
- package/src/OpenAiTelemetry.ts +14 -11
- package/src/OpenAiTool.ts +11 -11
- package/src/index.ts +11 -11
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Provides an EmbeddingModel implementation for OpenAI's embeddings API.
|
|
5
5
|
*
|
|
6
|
-
* @since
|
|
6
|
+
* @since 4.0.0
|
|
7
7
|
*/
|
|
8
8
|
import * as Context from "effect/Context";
|
|
9
9
|
import * as Effect from "effect/Effect";
|
|
@@ -16,13 +16,15 @@ import { OpenAiClient } from "./OpenAiClient.js";
|
|
|
16
16
|
/**
|
|
17
17
|
* Service definition for OpenAI embedding model configuration.
|
|
18
18
|
*
|
|
19
|
-
* @since 1.0.0
|
|
20
19
|
* @category services
|
|
20
|
+
* @since 4.0.0
|
|
21
21
|
*/
|
|
22
22
|
export class Config extends /*#__PURE__*/Context.Service()("@effect/ai-openai/OpenAiEmbeddingModel/Config") {}
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Creates an `AiModel` for an OpenAI embedding model with its configured vector dimensions.
|
|
25
|
+
*
|
|
25
26
|
* @category constructors
|
|
27
|
+
* @since 4.0.0
|
|
26
28
|
*/
|
|
27
29
|
export const model = (model, options) => AiModel.make("openai", model, Layer.merge(layer({
|
|
28
30
|
model,
|
|
@@ -34,8 +36,8 @@ export const model = (model, options) => AiModel.make("openai", model, Layer.mer
|
|
|
34
36
|
/**
|
|
35
37
|
* Creates an OpenAI embedding model service.
|
|
36
38
|
*
|
|
37
|
-
* @since 1.0.0
|
|
38
39
|
* @category constructors
|
|
40
|
+
* @since 4.0.0
|
|
39
41
|
*/
|
|
40
42
|
export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
|
|
41
43
|
model,
|
|
@@ -66,15 +68,15 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* ({
|
|
|
66
68
|
/**
|
|
67
69
|
* Creates a layer for the OpenAI embedding model.
|
|
68
70
|
*
|
|
69
|
-
* @since 1.0.0
|
|
70
71
|
* @category layers
|
|
72
|
+
* @since 4.0.0
|
|
71
73
|
*/
|
|
72
74
|
export const layer = options => Layer.effect(EmbeddingModel.EmbeddingModel, make(options));
|
|
73
75
|
/**
|
|
74
76
|
* Provides config overrides for OpenAI embedding model operations.
|
|
75
77
|
*
|
|
76
|
-
* @since 1.0.0
|
|
77
78
|
* @category configuration
|
|
79
|
+
* @since 4.0.0
|
|
78
80
|
*/
|
|
79
81
|
export const withConfigOverride = /*#__PURE__*/dual(2, (self, overrides) => Effect.flatMap(Effect.serviceOption(Config), config => Effect.provideService(self, Config, {
|
|
80
82
|
...(config._tag === "Some" ? config.value : {}),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAiEmbeddingModel.js","names":["Context","Effect","dual","Layer","AiError","EmbeddingModel","AiModel","OpenAiClient","Config","Service","model","options","make","merge","layer","config","dimensions","succeed","Dimensions","fnUntraced","providerConfig","client","makeConfig","gen","services","context","mapUnsafe","get","key","embedMany","inputs","response","createEmbedding","input","mapProviderResponse","length","effect","withConfigOverride","self","overrides","flatMap","serviceOption","provideService","_tag","value","inputLength","data","fail","invalidOutput","results","Array","seen","Set","entry","Number","isInteger","index","has","isArray","embedding","add","size","usage","inputTokens","prompt_tokens","description","module","method","reason","InvalidOutputError"],"sources":["../src/OpenAiEmbeddingModel.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,KAAK,MAAM,cAAc;AAErC,OAAO,KAAKC,OAAO,MAAM,4BAA4B;AACrD,OAAO,KAAKC,cAAc,MAAM,mCAAmC;AACnE,OAAO,KAAKC,OAAO,MAAM,0BAA0B;AACnD,SAASC,YAAY,QAAQ,mBAAmB;
|
|
1
|
+
{"version":3,"file":"OpenAiEmbeddingModel.js","names":["Context","Effect","dual","Layer","AiError","EmbeddingModel","AiModel","OpenAiClient","Config","Service","model","options","make","merge","layer","config","dimensions","succeed","Dimensions","fnUntraced","providerConfig","client","makeConfig","gen","services","context","mapUnsafe","get","key","embedMany","inputs","response","createEmbedding","input","mapProviderResponse","length","effect","withConfigOverride","self","overrides","flatMap","serviceOption","provideService","_tag","value","inputLength","data","fail","invalidOutput","results","Array","seen","Set","entry","Number","isInteger","index","has","isArray","embedding","add","size","usage","inputTokens","prompt_tokens","description","module","method","reason","InvalidOutputError"],"sources":["../src/OpenAiEmbeddingModel.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AAOA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,KAAK,MAAM,cAAc;AAErC,OAAO,KAAKC,OAAO,MAAM,4BAA4B;AACrD,OAAO,KAAKC,cAAc,MAAM,mCAAmC;AACnE,OAAO,KAAKC,OAAO,MAAM,0BAA0B;AACnD,SAASC,YAAY,QAAQ,mBAAmB;AAWhD;;;;;;AAMA,OAAM,MAAOC,MAAO,sBAAQR,OAAO,CAACS,OAAO,EAaxC,CAAC,+CAA+C,CAAC;AAEpD;;;;;;AAMA,OAAO,MAAMC,KAAK,GAAGA,CACnBA,KAA4B,EAC5BC,OAGC,KAEDL,OAAO,CAACM,IAAI,CACV,QAAQ,EACRF,KAAK,EACLP,KAAK,CAACU,KAAK,CACTC,KAAK,CAAC;EACJJ,KAAK;EACLK,MAAM,EAAE;IACN,GAAGJ,OAAO,CAACI,MAAM;IACjBC,UAAU,EAAEL,OAAO,CAACK;;CAEvB,CAAC,EACFb,KAAK,CAACc,OAAO,CAACZ,cAAc,CAACa,UAAU,EAAEP,OAAO,CAACK,UAAU,CAAC,CAC7D,CACF;AAEH;;;;;;AAMA,OAAO,MAAMJ,IAAI,gBAAGX,MAAM,CAACkB,UAAU,CAAC,WAAU;EAAET,KAAK;EAAEK,MAAM,EAAEK;AAAc,CAG9E;EACC,MAAMC,MAAM,GAAG,OAAOd,YAAY;EAElC,MAAMe,UAAU,GAAGrB,MAAM,CAACsB,GAAG,CAAC,aAAS;IACrC,MAAMC,QAAQ,GAAG,OAAOvB,MAAM,CAACwB,OAAO,EAAS;IAC/C,OAAO;MAAEf,KAAK;MAAE,GAAGU,cAAc;MAAE,GAAGI,QAAQ,CAACE,SAAS,CAACC,GAAG,CAACnB,MAAM,CAACoB,GAAG;IAAC,CAAE;EAC5E,CAAC,CAAC;EAEF,OAAO,OAAOvB,cAAc,CAACO,IAAI,CAAC;IAChCiB,SAAS,EAAE5B,MAAM,CAACkB,UAAU,CAAC,WAAU;MAAEW;IAAM,CAAE;MAC/C,MAAMf,MAAM,GAAG,OAAOO,UAAU;MAChC,MAAMS,QAAQ,GAAG,OAAOV,MAAM,CAACW,eAAe,CAAC;QAAE,GAAGjB,MAAM;QAAEkB,KAAK,EAAEH;MAAM,CAAE,CAAC;MAC5E,OAAO,OAAOI,mBAAmB,CAACJ,MAAM,CAACK,MAAM,EAAEJ,QAAQ,CAAC;IAC5D,CAAC;GACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMjB,KAAK,GAAIH,OAGrB,IACCR,KAAK,CAACiC,MAAM,CAAC/B,cAAc,CAACA,cAAc,EAAEO,IAAI,CAACD,OAAO,CAAC,CAAC;AAE5D;;;;;;AAMA,OAAO,MAAM0B,kBAAkB,gBAe3BnC,IAAI,CAeN,CAAC,EAAE,CAACoC,IAAI,EAAEC,SAAS,KACnBtC,MAAM,CAACuC,OAAO,CACZvC,MAAM,CAACwC,aAAa,CAACjC,MAAM,CAAC,EAC3BO,MAAM,IACLd,MAAM,CAACyC,cAAc,CAACJ,IAAI,EAAE9B,MAAM,EAAE;EAClC,IAAIO,MAAM,CAAC4B,IAAI,KAAK,MAAM,GAAG5B,MAAM,CAAC6B,KAAK,GAAG,EAAE,CAAC;EAC/C,GAAGL;CACJ,CAAC,CACL,CAAC;AAEJ,MAAML,mBAAmB,GAAGA,CAC1BW,WAAmB,EACnBd,QAA0D,KACS;EACnE,IAAIA,QAAQ,CAACe,IAAI,CAACX,MAAM,KAAKU,WAAW,EAAE;IACxC,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,oBAAoB,GAAGjB,QAAQ,CAACe,IAAI,CAACX,MAAM,GAAG,2BAA2B,GAAGU,WAAW,CAAC,CACvG;EACH;EAEA,MAAMI,OAAO,GAAG,IAAIC,KAAK,CAAgBL,WAAW,CAAC;EACrD,MAAMM,IAAI,GAAG,IAAIC,GAAG,EAAU;EAE9B,KAAK,MAAMC,KAAK,IAAItB,QAAQ,CAACe,IAAI,EAAE;IACjC,IAAI,CAACQ,MAAM,CAACC,SAAS,CAACF,KAAK,CAACG,KAAK,CAAC,IAAIH,KAAK,CAACG,KAAK,GAAG,CAAC,IAAIH,KAAK,CAACG,KAAK,IAAIX,WAAW,EAAE;MACnF,OAAO5C,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,6CAA6C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAChG;IACA,IAAIL,IAAI,CAACM,GAAG,CAACJ,KAAK,CAACG,KAAK,CAAC,EAAE;MACzB,OAAOvD,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,+CAA+C,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IAClG;IACA,IAAI,CAACN,KAAK,CAACQ,OAAO,CAACL,KAAK,CAACM,SAAS,CAAC,EAAE;MACnC,OAAO1D,MAAM,CAAC8C,IAAI,CAACC,aAAa,CAAC,kDAAkD,GAAGK,KAAK,CAACG,KAAK,CAAC,CAAC;IACrG;IAEAL,IAAI,CAACS,GAAG,CAACP,KAAK,CAACG,KAAK,CAAC;IACrBP,OAAO,CAACI,KAAK,CAACG,KAAK,CAAC,GAAG,CAAC,GAAGH,KAAK,CAACM,SAAS,CAAC;EAC7C;EAEA,IAAIR,IAAI,CAACU,IAAI,KAAKhB,WAAW,EAAE;IAC7B,OAAO5C,MAAM,CAAC8C,IAAI,CAChBC,aAAa,CAAC,mCAAmC,GAAGG,IAAI,CAACU,IAAI,GAAG,uBAAuB,GAAGhB,WAAW,CAAC,CACvG;EACH;EAEA,OAAO5C,MAAM,CAACgB,OAAO,CAAC;IACpBgC,OAAO;IACPa,KAAK,EAAE;MACLC,WAAW,EAAEhC,QAAQ,CAAC+B,KAAK,EAAEE;;GAEhC,CAAC;AACJ,CAAC;AAED,MAAMhB,aAAa,GAAIiB,WAAmB,IACxC7D,OAAO,CAACQ,IAAI,CAAC;EACXsD,MAAM,EAAE,sBAAsB;EAC9BC,MAAM,EAAE,WAAW;EACnBC,MAAM,EAAE,IAAIhE,OAAO,CAACiE,kBAAkB,CAAC;IAAEJ;EAAW,CAAE;CACvD,CAAC","ignoreList":[]}
|
package/dist/OpenAiError.d.ts
CHANGED
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
* Provides OpenAI-specific metadata fields for AI error types through module
|
|
5
5
|
* augmentation, enabling typed access to OpenAI error details.
|
|
6
6
|
*
|
|
7
|
-
* @since
|
|
7
|
+
* @since 4.0.0
|
|
8
8
|
*/
|
|
9
9
|
/**
|
|
10
10
|
* OpenAI-specific error metadata fields.
|
|
11
11
|
*
|
|
12
|
-
* @since 1.0.0
|
|
13
12
|
* @category models
|
|
13
|
+
* @since 4.0.0
|
|
14
14
|
*/
|
|
15
15
|
export type OpenAiErrorMetadata = {
|
|
16
16
|
/**
|
|
@@ -32,8 +32,8 @@ export type OpenAiErrorMetadata = {
|
|
|
32
32
|
* Extends base error metadata with rate limit specific information from
|
|
33
33
|
* OpenAI's rate limit headers.
|
|
34
34
|
*
|
|
35
|
-
* @since 1.0.0
|
|
36
35
|
* @category models
|
|
36
|
+
* @since 4.0.0
|
|
37
37
|
*/
|
|
38
38
|
export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
|
|
39
39
|
/**
|
|
@@ -54,34 +54,155 @@ export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
|
|
|
54
54
|
readonly resetTokens: string | null;
|
|
55
55
|
};
|
|
56
56
|
declare module "effect/unstable/ai/AiError" {
|
|
57
|
+
/**
|
|
58
|
+
* OpenAI metadata attached to `RateLimitError` values.
|
|
59
|
+
*
|
|
60
|
+
* Captures OpenAI error details together with rate limit header information
|
|
61
|
+
* from responses where the provider rejected the request because a limit was
|
|
62
|
+
* reached.
|
|
63
|
+
*
|
|
64
|
+
* @category provider options
|
|
65
|
+
* @since 4.0.0
|
|
66
|
+
*/
|
|
57
67
|
interface RateLimitErrorMetadata {
|
|
68
|
+
/**
|
|
69
|
+
* OpenAI-specific details for the rate limit response.
|
|
70
|
+
*/
|
|
58
71
|
readonly openai?: OpenAiRateLimitMetadata | null;
|
|
59
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* OpenAI metadata attached to `QuotaExhaustedError` values.
|
|
75
|
+
*
|
|
76
|
+
* Preserves provider error details for failures caused by exhausted account,
|
|
77
|
+
* billing, or usage quota.
|
|
78
|
+
*
|
|
79
|
+
* @category provider options
|
|
80
|
+
* @since 4.0.0
|
|
81
|
+
*/
|
|
60
82
|
interface QuotaExhaustedErrorMetadata {
|
|
83
|
+
/**
|
|
84
|
+
* OpenAI-specific details for the quota exhaustion response.
|
|
85
|
+
*/
|
|
61
86
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
62
87
|
}
|
|
88
|
+
/**
|
|
89
|
+
* OpenAI metadata attached to `AuthenticationError` values.
|
|
90
|
+
*
|
|
91
|
+
* Preserves provider error details for failed API key, authorization, or
|
|
92
|
+
* permission checks.
|
|
93
|
+
*
|
|
94
|
+
* @category provider options
|
|
95
|
+
* @since 4.0.0
|
|
96
|
+
*/
|
|
63
97
|
interface AuthenticationErrorMetadata {
|
|
98
|
+
/**
|
|
99
|
+
* OpenAI-specific details for the authentication failure.
|
|
100
|
+
*/
|
|
64
101
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
65
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* OpenAI metadata attached to `ContentPolicyError` values.
|
|
105
|
+
*
|
|
106
|
+
* Preserves provider error details when OpenAI rejects input or output because
|
|
107
|
+
* it violates a content policy.
|
|
108
|
+
*
|
|
109
|
+
* @category provider options
|
|
110
|
+
* @since 4.0.0
|
|
111
|
+
*/
|
|
66
112
|
interface ContentPolicyErrorMetadata {
|
|
113
|
+
/**
|
|
114
|
+
* OpenAI-specific details for the content policy response.
|
|
115
|
+
*/
|
|
67
116
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
68
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* OpenAI metadata attached to `InvalidRequestError` values.
|
|
120
|
+
*
|
|
121
|
+
* Preserves provider error details for malformed requests, unsupported
|
|
122
|
+
* parameters, or other request validation failures reported by OpenAI.
|
|
123
|
+
*
|
|
124
|
+
* @category provider options
|
|
125
|
+
* @since 4.0.0
|
|
126
|
+
*/
|
|
69
127
|
interface InvalidRequestErrorMetadata {
|
|
128
|
+
/**
|
|
129
|
+
* OpenAI-specific details for the invalid request response.
|
|
130
|
+
*/
|
|
70
131
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
71
132
|
}
|
|
133
|
+
/**
|
|
134
|
+
* OpenAI metadata attached to `InternalProviderError` values.
|
|
135
|
+
*
|
|
136
|
+
* Preserves provider error details for OpenAI-side failures such as transient
|
|
137
|
+
* server errors.
|
|
138
|
+
*
|
|
139
|
+
* @category provider options
|
|
140
|
+
* @since 4.0.0
|
|
141
|
+
*/
|
|
72
142
|
interface InternalProviderErrorMetadata {
|
|
143
|
+
/**
|
|
144
|
+
* OpenAI-specific details for the internal provider response.
|
|
145
|
+
*/
|
|
73
146
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
74
147
|
}
|
|
148
|
+
/**
|
|
149
|
+
* OpenAI metadata attached to `InvalidOutputError` values.
|
|
150
|
+
*
|
|
151
|
+
* Preserves provider error details when an OpenAI response cannot be parsed or
|
|
152
|
+
* validated as the expected output.
|
|
153
|
+
*
|
|
154
|
+
* @category provider options
|
|
155
|
+
* @since 4.0.0
|
|
156
|
+
*/
|
|
75
157
|
interface InvalidOutputErrorMetadata {
|
|
158
|
+
/**
|
|
159
|
+
* OpenAI-specific details for the invalid output response.
|
|
160
|
+
*/
|
|
76
161
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
77
162
|
}
|
|
163
|
+
/**
|
|
164
|
+
* OpenAI metadata attached to `StructuredOutputError` values.
|
|
165
|
+
*
|
|
166
|
+
* Preserves provider error details when OpenAI returns content that does not
|
|
167
|
+
* satisfy the requested structured output schema.
|
|
168
|
+
*
|
|
169
|
+
* @category provider options
|
|
170
|
+
* @since 4.0.0
|
|
171
|
+
*/
|
|
78
172
|
interface StructuredOutputErrorMetadata {
|
|
173
|
+
/**
|
|
174
|
+
* OpenAI-specific details for the structured output failure.
|
|
175
|
+
*/
|
|
79
176
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
80
177
|
}
|
|
178
|
+
/**
|
|
179
|
+
* OpenAI metadata attached to `UnsupportedSchemaError` values.
|
|
180
|
+
*
|
|
181
|
+
* Preserves provider error details when an unsupported schema failure is
|
|
182
|
+
* associated with an OpenAI response.
|
|
183
|
+
*
|
|
184
|
+
* @category provider options
|
|
185
|
+
* @since 4.0.0
|
|
186
|
+
*/
|
|
81
187
|
interface UnsupportedSchemaErrorMetadata {
|
|
188
|
+
/**
|
|
189
|
+
* OpenAI-specific details for the unsupported schema failure.
|
|
190
|
+
*/
|
|
82
191
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
83
192
|
}
|
|
193
|
+
/**
|
|
194
|
+
* OpenAI metadata attached to `UnknownError` values.
|
|
195
|
+
*
|
|
196
|
+
* Preserves provider error details for OpenAI failures that do not map cleanly
|
|
197
|
+
* to a more specific AI error category.
|
|
198
|
+
*
|
|
199
|
+
* @category provider options
|
|
200
|
+
* @since 4.0.0
|
|
201
|
+
*/
|
|
84
202
|
interface UnknownErrorMetadata {
|
|
203
|
+
/**
|
|
204
|
+
* OpenAI-specific details for the unclassified provider failure.
|
|
205
|
+
*/
|
|
85
206
|
readonly openai?: OpenAiErrorMetadata | null;
|
|
86
207
|
}
|
|
87
208
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAiError.d.ts","sourceRoot":"","sources":["../src/OpenAiError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C,UAAiB,sBAAsB;QACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;KACjD;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,8BAA8B;QAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED,UAAiB,oBAAoB;QACnC,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;CACF"}
|
|
1
|
+
{"version":3,"file":"OpenAiError.d.ts","sourceRoot":"","sources":["../src/OpenAiError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C;;;;;;;;;OASG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;KACjD;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,0BAA0B;QACzC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,6BAA6B;QAC5C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;IAED;;;;;;;;OAQG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAA;KAC7C;CACF"}
|
package/dist/OpenAiError.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Provides a LanguageModel implementation for OpenAI's responses API,
|
|
5
5
|
* supporting text generation, structured output, tool calling, and streaming.
|
|
6
6
|
*
|
|
7
|
-
* @since
|
|
7
|
+
* @since 4.0.0
|
|
8
8
|
*/
|
|
9
9
|
import * as Context from "effect/Context";
|
|
10
10
|
import * as Effect from "effect/Effect";
|
|
@@ -17,8 +17,10 @@ import type * as OpenAiSchema from "./OpenAiSchema.ts";
|
|
|
17
17
|
declare const ResponseModelIds: Schema.Literals<readonly ["o1-pro", "o1-pro-2025-03-19", "o3-pro", "o3-pro-2025-06-10", "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research", "o4-mini-deep-research-2025-06-26", "computer-use-preview", "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5-pro", "gpt-5-pro-2025-10-06", "gpt-5.1-codex-max"]>;
|
|
18
18
|
declare const SharedModelIds: Schema.Literals<readonly ["gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.4-mini-2026-03-17", "gpt-5.4-nano-2026-03-17", "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", "gpt-5.2-pro", "gpt-5.2-pro-2025-12-11", "gpt-5.1", "gpt-5.1-2025-11-13", "gpt-5.1-codex", "gpt-5.1-mini", "gpt-5.1-chat-latest", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07", "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "gpt-5-chat-latest", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16", "o3", "o3-2025-04-16", "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "gpt-4o-search-preview", "gpt-4o-mini-search-preview", "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11", "chatgpt-4o-latest", "codex-mini-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613"]>;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* OpenAI model identifiers supported by the Responses API language model.
|
|
21
|
+
*
|
|
21
22
|
* @category models
|
|
23
|
+
* @since 4.0.0
|
|
22
24
|
*/
|
|
23
25
|
export type Model = typeof ResponseModelIds.Encoded | typeof SharedModelIds.Encoded;
|
|
24
26
|
/**
|
|
@@ -43,8 +45,8 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openai/OpenA
|
|
|
43
45
|
readonly instructions?: string | undefined;
|
|
44
46
|
readonly max_output_tokens?: number | undefined;
|
|
45
47
|
readonly reasoning?: {
|
|
46
|
-
readonly summary?: "auto" | "concise" | "detailed" | undefined;
|
|
47
48
|
readonly effort?: "low" | "high" | "none" | "minimal" | "medium" | "xhigh" | undefined;
|
|
49
|
+
readonly summary?: "auto" | "concise" | "detailed" | undefined;
|
|
48
50
|
readonly generate_summary?: "auto" | "concise" | "detailed" | undefined;
|
|
49
51
|
} | undefined;
|
|
50
52
|
readonly truncation?: "auto" | "disabled" | undefined;
|
|
@@ -73,13 +75,19 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openai/OpenA
|
|
|
73
75
|
/**
|
|
74
76
|
* Service definition for OpenAI language model configuration.
|
|
75
77
|
*
|
|
76
|
-
* @since 1.0.0
|
|
77
78
|
* @category services
|
|
79
|
+
* @since 4.0.0
|
|
78
80
|
*/
|
|
79
81
|
export declare class Config extends Config_base {
|
|
80
82
|
}
|
|
81
83
|
declare module "effect/unstable/ai/Prompt" {
|
|
84
|
+
/**
|
|
85
|
+
* OpenAI-specific options for file prompt parts.
|
|
86
|
+
*/
|
|
82
87
|
interface FilePartOptions extends ProviderOptions {
|
|
88
|
+
/**
|
|
89
|
+
* Provider-specific file options for the OpenAI Responses API.
|
|
90
|
+
*/
|
|
83
91
|
readonly openai?: {
|
|
84
92
|
/**
|
|
85
93
|
* The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`.
|
|
@@ -87,7 +95,13 @@ declare module "effect/unstable/ai/Prompt" {
|
|
|
87
95
|
readonly imageDetail?: ImageDetail | null;
|
|
88
96
|
} | null;
|
|
89
97
|
}
|
|
98
|
+
/**
|
|
99
|
+
* OpenAI-specific options for reasoning prompt parts.
|
|
100
|
+
*/
|
|
90
101
|
interface ReasoningPartOptions extends ProviderOptions {
|
|
102
|
+
/**
|
|
103
|
+
* Provider-specific reasoning options for the OpenAI Responses API.
|
|
104
|
+
*/
|
|
91
105
|
readonly openai?: {
|
|
92
106
|
/**
|
|
93
107
|
* The ID of the item to reference.
|
|
@@ -101,7 +115,13 @@ declare module "effect/unstable/ai/Prompt" {
|
|
|
101
115
|
readonly encryptedContent?: string | null;
|
|
102
116
|
} | null;
|
|
103
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* OpenAI-specific options for assistant tool-call prompt parts.
|
|
120
|
+
*/
|
|
104
121
|
interface ToolCallPartOptions extends ProviderOptions {
|
|
122
|
+
/**
|
|
123
|
+
* Provider-specific tool-call options for the OpenAI Responses API.
|
|
124
|
+
*/
|
|
105
125
|
readonly openai?: {
|
|
106
126
|
/**
|
|
107
127
|
* The ID of the item to reference.
|
|
@@ -117,7 +137,13 @@ declare module "effect/unstable/ai/Prompt" {
|
|
|
117
137
|
readonly approvalRequestId?: string | null;
|
|
118
138
|
} | null;
|
|
119
139
|
}
|
|
140
|
+
/**
|
|
141
|
+
* OpenAI-specific options for tool-result prompt parts.
|
|
142
|
+
*/
|
|
120
143
|
interface ToolResultPartOptions extends ProviderOptions {
|
|
144
|
+
/**
|
|
145
|
+
* Provider-specific tool-result options for the OpenAI Responses API.
|
|
146
|
+
*/
|
|
121
147
|
readonly openai?: {
|
|
122
148
|
/**
|
|
123
149
|
* The ID of the item to reference.
|
|
@@ -133,7 +159,13 @@ declare module "effect/unstable/ai/Prompt" {
|
|
|
133
159
|
readonly approvalId?: string | null;
|
|
134
160
|
} | null;
|
|
135
161
|
}
|
|
162
|
+
/**
|
|
163
|
+
* OpenAI-specific options for text prompt parts.
|
|
164
|
+
*/
|
|
136
165
|
interface TextPartOptions extends ProviderOptions {
|
|
166
|
+
/**
|
|
167
|
+
* Provider-specific text options for the OpenAI Responses API.
|
|
168
|
+
*/
|
|
137
169
|
readonly openai?: {
|
|
138
170
|
/**
|
|
139
171
|
* The ID of the item to reference.
|
|
@@ -151,8 +183,17 @@ declare module "effect/unstable/ai/Prompt" {
|
|
|
151
183
|
}
|
|
152
184
|
}
|
|
153
185
|
declare module "effect/unstable/ai/Response" {
|
|
186
|
+
/**
|
|
187
|
+
* OpenAI metadata attached to a complete text response part.
|
|
188
|
+
*/
|
|
154
189
|
interface TextPartMetadata extends ProviderMetadata {
|
|
190
|
+
/**
|
|
191
|
+
* Provider-specific metadata returned for the text part.
|
|
192
|
+
*/
|
|
155
193
|
readonly openai?: {
|
|
194
|
+
/**
|
|
195
|
+
* The OpenAI item ID associated with the text part.
|
|
196
|
+
*/
|
|
156
197
|
readonly itemId?: string | null;
|
|
157
198
|
/**
|
|
158
199
|
* If the model emits a refusal content part, the refusal explanation
|
|
@@ -170,47 +211,131 @@ declare module "effect/unstable/ai/Response" {
|
|
|
170
211
|
readonly annotations?: ReadonlyArray<typeof OpenAiSchema.Annotation.Encoded> | null;
|
|
171
212
|
};
|
|
172
213
|
}
|
|
214
|
+
/**
|
|
215
|
+
* OpenAI metadata emitted when a streamed text part starts.
|
|
216
|
+
*/
|
|
173
217
|
interface TextStartPartMetadata extends ProviderMetadata {
|
|
218
|
+
/**
|
|
219
|
+
* Provider-specific metadata returned for the streamed text start.
|
|
220
|
+
*/
|
|
174
221
|
readonly openai?: {
|
|
222
|
+
/**
|
|
223
|
+
* The OpenAI item ID associated with the streamed text part.
|
|
224
|
+
*/
|
|
175
225
|
readonly itemId?: string | null;
|
|
176
226
|
} | null;
|
|
177
227
|
}
|
|
228
|
+
/**
|
|
229
|
+
* OpenAI metadata emitted when a streamed text part ends.
|
|
230
|
+
*/
|
|
178
231
|
interface TextEndPartMetadata extends ProviderMetadata {
|
|
232
|
+
/**
|
|
233
|
+
* Provider-specific metadata returned for the streamed text end.
|
|
234
|
+
*/
|
|
179
235
|
readonly openai?: {
|
|
236
|
+
/**
|
|
237
|
+
* The OpenAI item ID associated with the streamed text part.
|
|
238
|
+
*/
|
|
180
239
|
readonly itemId?: string | null;
|
|
240
|
+
/**
|
|
241
|
+
* The annotations collected for the completed streamed text part.
|
|
242
|
+
*/
|
|
181
243
|
readonly annotations?: ReadonlyArray<typeof OpenAiSchema.Annotation.Encoded> | null;
|
|
182
244
|
} | null;
|
|
183
245
|
}
|
|
246
|
+
/**
|
|
247
|
+
* OpenAI metadata attached to a complete reasoning response part.
|
|
248
|
+
*/
|
|
184
249
|
interface ReasoningPartMetadata extends ProviderMetadata {
|
|
250
|
+
/**
|
|
251
|
+
* Provider-specific metadata returned for the reasoning part.
|
|
252
|
+
*/
|
|
185
253
|
readonly openai?: {
|
|
254
|
+
/**
|
|
255
|
+
* The OpenAI item ID associated with the reasoning part.
|
|
256
|
+
*/
|
|
186
257
|
readonly itemId?: string | null;
|
|
258
|
+
/**
|
|
259
|
+
* Encrypted reasoning content that can be sent back in later requests.
|
|
260
|
+
*/
|
|
187
261
|
readonly encryptedContent?: string | null;
|
|
188
262
|
} | null;
|
|
189
263
|
}
|
|
264
|
+
/**
|
|
265
|
+
* OpenAI metadata emitted when a streamed reasoning part starts.
|
|
266
|
+
*/
|
|
190
267
|
interface ReasoningStartPartMetadata extends ProviderMetadata {
|
|
268
|
+
/**
|
|
269
|
+
* Provider-specific metadata returned for the streamed reasoning start.
|
|
270
|
+
*/
|
|
191
271
|
readonly openai?: {
|
|
272
|
+
/**
|
|
273
|
+
* The OpenAI item ID associated with the reasoning part.
|
|
274
|
+
*/
|
|
192
275
|
readonly itemId?: string | null;
|
|
276
|
+
/**
|
|
277
|
+
* Encrypted reasoning content that can be sent back in later requests.
|
|
278
|
+
*/
|
|
193
279
|
readonly encryptedContent?: string | null;
|
|
194
280
|
} | null;
|
|
195
281
|
}
|
|
282
|
+
/**
|
|
283
|
+
* OpenAI metadata emitted for a streamed reasoning delta.
|
|
284
|
+
*/
|
|
196
285
|
interface ReasoningDeltaPartMetadata extends ProviderMetadata {
|
|
286
|
+
/**
|
|
287
|
+
* Provider-specific metadata returned for the streamed reasoning delta.
|
|
288
|
+
*/
|
|
197
289
|
readonly openai?: {
|
|
290
|
+
/**
|
|
291
|
+
* The OpenAI item ID associated with the reasoning part.
|
|
292
|
+
*/
|
|
198
293
|
readonly itemId?: string | null;
|
|
199
294
|
} | null;
|
|
200
295
|
}
|
|
296
|
+
/**
|
|
297
|
+
* OpenAI metadata emitted when a streamed reasoning part ends.
|
|
298
|
+
*/
|
|
201
299
|
interface ReasoningEndPartMetadata extends ProviderMetadata {
|
|
300
|
+
/**
|
|
301
|
+
* Provider-specific metadata returned for the streamed reasoning end.
|
|
302
|
+
*/
|
|
202
303
|
readonly openai?: {
|
|
304
|
+
/**
|
|
305
|
+
* The OpenAI item ID associated with the reasoning part.
|
|
306
|
+
*/
|
|
203
307
|
readonly itemId?: string | null;
|
|
308
|
+
/**
|
|
309
|
+
* Encrypted reasoning content that can be sent back in later requests.
|
|
310
|
+
*/
|
|
204
311
|
readonly encryptedContent?: string;
|
|
205
312
|
} | null;
|
|
206
313
|
}
|
|
314
|
+
/**
|
|
315
|
+
* OpenAI metadata attached to tool-call response parts.
|
|
316
|
+
*/
|
|
207
317
|
interface ToolCallPartMetadata extends ProviderMetadata {
|
|
318
|
+
/**
|
|
319
|
+
* Provider-specific metadata returned for the tool call.
|
|
320
|
+
*/
|
|
208
321
|
readonly openai?: {
|
|
322
|
+
/**
|
|
323
|
+
* The OpenAI item ID associated with the tool call.
|
|
324
|
+
*/
|
|
209
325
|
readonly itemId?: string | null;
|
|
210
326
|
} | null;
|
|
211
327
|
}
|
|
328
|
+
/**
|
|
329
|
+
* OpenAI metadata attached to document source citations.
|
|
330
|
+
*/
|
|
212
331
|
interface DocumentSourcePartMetadata extends ProviderMetadata {
|
|
332
|
+
/**
|
|
333
|
+
* Provider-specific citation metadata for the OpenAI Responses API.
|
|
334
|
+
*/
|
|
213
335
|
readonly openai?: {
|
|
336
|
+
/**
|
|
337
|
+
* Identifies a citation to an uploaded file.
|
|
338
|
+
*/
|
|
214
339
|
readonly type: "file_citation";
|
|
215
340
|
/**
|
|
216
341
|
* The index of the file in the list of files.
|
|
@@ -221,6 +346,9 @@ declare module "effect/unstable/ai/Response" {
|
|
|
221
346
|
*/
|
|
222
347
|
readonly fileId: string;
|
|
223
348
|
} | {
|
|
349
|
+
/**
|
|
350
|
+
* Identifies a citation to a generated file path.
|
|
351
|
+
*/
|
|
224
352
|
readonly type: "file_path";
|
|
225
353
|
/**
|
|
226
354
|
* The index of the file in the list of files.
|
|
@@ -231,6 +359,9 @@ declare module "effect/unstable/ai/Response" {
|
|
|
231
359
|
*/
|
|
232
360
|
readonly fileId: string;
|
|
233
361
|
} | {
|
|
362
|
+
/**
|
|
363
|
+
* Identifies a citation to a file inside a container.
|
|
364
|
+
*/
|
|
234
365
|
readonly type: "container_file_citation";
|
|
235
366
|
/**
|
|
236
367
|
* The ID of the file.
|
|
@@ -242,8 +373,17 @@ declare module "effect/unstable/ai/Response" {
|
|
|
242
373
|
readonly containerId: string;
|
|
243
374
|
} | null;
|
|
244
375
|
}
|
|
376
|
+
/**
|
|
377
|
+
* OpenAI metadata attached to URL source citations.
|
|
378
|
+
*/
|
|
245
379
|
interface UrlSourcePartMetadata extends ProviderMetadata {
|
|
380
|
+
/**
|
|
381
|
+
* Provider-specific URL citation metadata for the OpenAI Responses API.
|
|
382
|
+
*/
|
|
246
383
|
readonly openai?: {
|
|
384
|
+
/**
|
|
385
|
+
* Identifies a citation to a URL.
|
|
386
|
+
*/
|
|
247
387
|
readonly type: "url_citation";
|
|
248
388
|
/**
|
|
249
389
|
* The index of the first character of the URL citation in the message.
|
|
@@ -255,22 +395,33 @@ declare module "effect/unstable/ai/Response" {
|
|
|
255
395
|
readonly endIndex: number;
|
|
256
396
|
} | null;
|
|
257
397
|
}
|
|
398
|
+
/**
|
|
399
|
+
* OpenAI metadata attached to finish response parts.
|
|
400
|
+
*/
|
|
258
401
|
interface FinishPartMetadata extends ProviderMetadata {
|
|
402
|
+
/**
|
|
403
|
+
* Provider-specific metadata returned when generation finishes.
|
|
404
|
+
*/
|
|
259
405
|
readonly openai?: {
|
|
406
|
+
/**
|
|
407
|
+
* The service tier reported by OpenAI for the response.
|
|
408
|
+
*/
|
|
260
409
|
readonly serviceTier?: "default" | "auto" | "flex" | "scale" | "priority" | null;
|
|
261
410
|
} | null;
|
|
262
411
|
}
|
|
263
412
|
}
|
|
264
413
|
/**
|
|
265
|
-
*
|
|
414
|
+
* Creates an OpenAI language model that can be used with `AiModel.provide`.
|
|
415
|
+
*
|
|
266
416
|
* @category constructors
|
|
417
|
+
* @since 4.0.0
|
|
267
418
|
*/
|
|
268
419
|
export declare const model: (model: (string & {}) | Model, config?: Omit<typeof Config.Service, "model">) => AiModel.Model<"openai", LanguageModel.LanguageModel, OpenAiClient>;
|
|
269
420
|
/**
|
|
270
421
|
* Creates an OpenAI language model service.
|
|
271
422
|
*
|
|
272
|
-
* @since 1.0.0
|
|
273
423
|
* @category constructors
|
|
424
|
+
* @since 4.0.0
|
|
274
425
|
*/
|
|
275
426
|
export declare const make: (args_0: {
|
|
276
427
|
readonly model: (string & {}) | Model;
|
|
@@ -279,8 +430,8 @@ export declare const make: (args_0: {
|
|
|
279
430
|
/**
|
|
280
431
|
* Creates a layer for the OpenAI language model.
|
|
281
432
|
*
|
|
282
|
-
* @since 1.0.0
|
|
283
433
|
* @category layers
|
|
434
|
+
* @since 4.0.0
|
|
284
435
|
*/
|
|
285
436
|
export declare const layer: (options: {
|
|
286
437
|
readonly model: (string & {}) | Model;
|
|
@@ -289,22 +440,22 @@ export declare const layer: (options: {
|
|
|
289
440
|
/**
|
|
290
441
|
* Provides config overrides for OpenAI language model operations.
|
|
291
442
|
*
|
|
292
|
-
* @since 1.0.0
|
|
293
443
|
* @category configuration
|
|
444
|
+
* @since 4.0.0
|
|
294
445
|
*/
|
|
295
446
|
export declare const withConfigOverride: {
|
|
296
447
|
/**
|
|
297
448
|
* Provides config overrides for OpenAI language model operations.
|
|
298
449
|
*
|
|
299
|
-
* @since 1.0.0
|
|
300
450
|
* @category configuration
|
|
451
|
+
* @since 4.0.0
|
|
301
452
|
*/
|
|
302
453
|
(overrides: typeof Config.Service): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Config>>;
|
|
303
454
|
/**
|
|
304
455
|
* Provides config overrides for OpenAI language model operations.
|
|
305
456
|
*
|
|
306
|
-
* @since 1.0.0
|
|
307
457
|
* @category configuration
|
|
458
|
+
* @since 4.0.0
|
|
308
459
|
*/
|
|
309
460
|
<A, E, R>(self: Effect.Effect<A, E, R>, overrides: typeof Config.Service): Effect.Effect<A, E, Exclude<R, Config>>;
|
|
310
461
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAiLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenAiLanguageModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAIrC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAOvC,OAAO,KAAK,aAAa,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AASnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAItD,QAAA,MAAM,gBAAgB,8UAAyC,CAAA;AAC/D,QAAA,MAAM,cAAc,qlDAAsC,CAAA;AAE1D
|
|
1
|
+
{"version":3,"file":"OpenAiLanguageModel.d.ts","sourceRoot":"","sources":["../src/OpenAiLanguageModel.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAIrC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAOvC,OAAO,KAAK,aAAa,MAAM,kCAAkC,CAAA;AACjE,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AASnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAItD,QAAA,MAAM,gBAAgB,8UAAyC,CAAA;AAC/D,QAAA,MAAM,cAAc,qlDAAsC,CAAA;AAE1D;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,OAAO,gBAAgB,CAAC,OAAO,GAAG,OAAO,cAAc,CAAC,OAAO,CAAA;AAEnF;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAkCpB;QACd;;;;;;WAMG;QACH,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAA;KAC3D,GAAG,SAAS;IACb;;;;OAIG;;gCACyB,OAAO,GAAG,SAAS;;AA3CrD;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAwCuB;CAAG;AAMtD,OAAO,QAAQ,2BAA2B,CAAC;IACzC;;OAEG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,oBAAqB,SAAQ,eAAe;QAC3D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,mBAAoB,SAAQ,eAAe;QAC1D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAA;YAClE;;eAEG;YACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC3C,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,qBAAsB,SAAQ,eAAe;QAC5D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAA;YAClE;;eAEG;YACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SACpC,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,eAAgB,SAAQ,eAAe;QACtD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAA;YAClE;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,OAAO,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;SACpF,GAAG,IAAI,CAAA;KACT;CACF;AAED,OAAO,QAAQ,6BAA6B,CAAC;IAC3C;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,gBAAgB;QACxD;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;;;eAIG;YACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAChC;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAA;YAClE;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,OAAO,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;SACpF,CAAA;KACF;IAED;;OAEG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,mBAAoB,SAAQ,gBAAgB;QAC3D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,OAAO,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;SACpF,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAC1C,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,wBAAyB,SAAQ,gBAAgB;QAChE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;YAC/B;;eAEG;YACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;SACnC,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,oBAAqB,SAAQ,gBAAgB;QAC5D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAChC,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,0BAA2B,SAAQ,gBAAgB;QAClE;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EACZ;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;YAC9B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;YAC1B;;eAEG;YACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;YACtB;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SACxB,GACC;YACA;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,yBAAyB,CAAA;YACxC;;eAEG;YACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;YACvB;;eAEG;YACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAC7B,GACC,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,qBAAsB,SAAQ,gBAAgB;QAC7D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;YAC7B;;eAEG;YACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;YAC3B;;eAEG;YACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;SAC1B,GAAG,IAAI,CAAA;KACT;IAED;;OAEG;IACH,UAAiB,kBAAmB,SAAQ,gBAAgB;QAC1D;;WAEG;QACH,QAAQ,CAAC,MAAM,CAAC,EAAE;YAChB;;eAEG;YACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAA;SACjF,GAAG,IAAI,CAAA;KACT;CACF;AAMD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAChB,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK,EAC5B,SAAS,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAC5C,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,CAAC,aAAa,EAAE,YAAY,CACX,CAAA;AAazD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;oBACC,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK;sBACnB,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS;+DA6FlE,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS;IAC7B,QAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK,CAAA;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CACnE,KAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,EAAE,KAAK,EAAE,YAAY,CACN,CAAA;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE;IAC/B;;;;;OAKG;IACH,CAAC,SAAS,EAAE,OAAO,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IACtH;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;CAwBhH,CAAA"}
|