@effect/ai-openai 4.0.0-beta.4 → 4.0.0-beta.40
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 +4060 -4038
- package/dist/Generated.d.ts.map +1 -1
- package/dist/Generated.js +1 -1
- package/dist/Generated.js.map +1 -1
- package/dist/OpenAiClient.d.ts +56 -10
- package/dist/OpenAiClient.d.ts.map +1 -1
- package/dist/OpenAiClient.js +202 -7
- package/dist/OpenAiClient.js.map +1 -1
- package/dist/OpenAiEmbeddingModel.d.ts +85 -0
- package/dist/OpenAiEmbeddingModel.d.ts.map +1 -0
- package/dist/OpenAiEmbeddingModel.js +116 -0
- package/dist/OpenAiEmbeddingModel.js.map +1 -0
- package/dist/OpenAiError.d.ts +22 -32
- package/dist/OpenAiError.d.ts.map +1 -1
- package/dist/OpenAiLanguageModel.d.ts.map +1 -1
- package/dist/OpenAiLanguageModel.js +177 -64
- package/dist/OpenAiLanguageModel.js.map +1 -1
- package/dist/OpenAiTool.d.ts +24 -24
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/errors.js +4 -4
- package/dist/internal/errors.js.map +1 -1
- package/package.json +3 -3
- package/src/Generated.ts +125 -122
- package/src/OpenAiClient.ts +318 -40
- package/src/OpenAiEmbeddingModel.ts +200 -0
- package/src/OpenAiError.ts +24 -32
- package/src/OpenAiLanguageModel.ts +218 -66
- package/src/index.ts +9 -0
- package/src/internal/errors.ts +6 -4
package/src/Generated.ts
CHANGED
|
@@ -14156,80 +14156,6 @@ export const ChatCompletionRequestAssistantMessage = Schema.Struct({
|
|
|
14156
14156
|
"title": "Assistant message",
|
|
14157
14157
|
"description": "Messages sent by the model in response to user messages.\n"
|
|
14158
14158
|
})
|
|
14159
|
-
export type FineTuneChatCompletionRequestAssistantMessage = {
|
|
14160
|
-
readonly "role": "assistant"
|
|
14161
|
-
readonly "weight"?: 0 | 1
|
|
14162
|
-
readonly "content"?: string | ReadonlyArray<ChatCompletionRequestAssistantMessageContentPart> | null
|
|
14163
|
-
readonly "refusal"?: string | null
|
|
14164
|
-
readonly "name"?: string
|
|
14165
|
-
readonly "audio"?: { readonly "id": string } | null
|
|
14166
|
-
readonly "tool_calls"?: ChatCompletionMessageToolCalls
|
|
14167
|
-
readonly "function_call"?: { readonly "arguments": string; readonly "name": string } | null
|
|
14168
|
-
}
|
|
14169
|
-
export const FineTuneChatCompletionRequestAssistantMessage = Schema.Struct({
|
|
14170
|
-
"role": Schema.Literal("assistant").annotate({
|
|
14171
|
-
"description": "The role of the messages author, in this case `assistant`."
|
|
14172
|
-
}),
|
|
14173
|
-
"weight": Schema.optionalKey(
|
|
14174
|
-
Schema.Literals([0, 1]).annotate({
|
|
14175
|
-
"description": "Controls whether the assistant message is trained against (0 or 1)"
|
|
14176
|
-
})
|
|
14177
|
-
),
|
|
14178
|
-
"content": Schema.optionalKey(
|
|
14179
|
-
Schema.Union([
|
|
14180
|
-
Schema.Union([
|
|
14181
|
-
Schema.String.annotate({ "title": "Text content", "description": "The contents of the assistant message." }),
|
|
14182
|
-
Schema.Array(ChatCompletionRequestAssistantMessageContentPart).annotate({
|
|
14183
|
-
"title": "Array of content parts",
|
|
14184
|
-
"description":
|
|
14185
|
-
"An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."
|
|
14186
|
-
}).check(Schema.isMinLength(1))
|
|
14187
|
-
], { mode: "oneOf" }).annotate({
|
|
14188
|
-
"description":
|
|
14189
|
-
"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n"
|
|
14190
|
-
}),
|
|
14191
|
-
Schema.Null
|
|
14192
|
-
])
|
|
14193
|
-
),
|
|
14194
|
-
"refusal": Schema.optionalKey(
|
|
14195
|
-
Schema.Union([Schema.String.annotate({ "description": "The refusal message by the assistant." }), Schema.Null])
|
|
14196
|
-
),
|
|
14197
|
-
"name": Schema.optionalKey(
|
|
14198
|
-
Schema.String.annotate({
|
|
14199
|
-
"description":
|
|
14200
|
-
"An optional name for the participant. Provides the model information to differentiate between participants of the same role."
|
|
14201
|
-
})
|
|
14202
|
-
),
|
|
14203
|
-
"audio": Schema.optionalKey(
|
|
14204
|
-
Schema.Union([
|
|
14205
|
-
Schema.Struct({
|
|
14206
|
-
"id": Schema.String.annotate({
|
|
14207
|
-
"description": "Unique identifier for a previous audio response from the model.\n"
|
|
14208
|
-
})
|
|
14209
|
-
}).annotate({
|
|
14210
|
-
"description": "Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).\n"
|
|
14211
|
-
}),
|
|
14212
|
-
Schema.Null
|
|
14213
|
-
])
|
|
14214
|
-
),
|
|
14215
|
-
"tool_calls": Schema.optionalKey(ChatCompletionMessageToolCalls),
|
|
14216
|
-
"function_call": Schema.optionalKey(Schema.Union([
|
|
14217
|
-
Schema.Struct({
|
|
14218
|
-
"arguments": Schema.String.annotate({
|
|
14219
|
-
"description":
|
|
14220
|
-
"The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
|
|
14221
|
-
}),
|
|
14222
|
-
"name": Schema.String.annotate({ "description": "The name of the function to call." })
|
|
14223
|
-
}).annotate({
|
|
14224
|
-
"description":
|
|
14225
|
-
"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
|
|
14226
|
-
}),
|
|
14227
|
-
Schema.Null
|
|
14228
|
-
]))
|
|
14229
|
-
}).annotate({
|
|
14230
|
-
"title": "Assistant message",
|
|
14231
|
-
"description": "Messages sent by the model in response to user messages.\n"
|
|
14232
|
-
})
|
|
14233
14159
|
export type ChatCompletionRequestSystemMessage = {
|
|
14234
14160
|
readonly "content": string | ReadonlyArray<ChatCompletionRequestSystemMessageContentPart>
|
|
14235
14161
|
readonly "role": "system"
|
|
@@ -19408,7 +19334,9 @@ export const EvalItemContent = Schema.Union([EvalItemContentItem, EvalItemConten
|
|
|
19408
19334
|
"Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.\n"
|
|
19409
19335
|
})
|
|
19410
19336
|
export type OutputMessageContent = OutputTextContent | RefusalContent
|
|
19411
|
-
export const OutputMessageContent = Schema.Union([OutputTextContent, RefusalContent], {
|
|
19337
|
+
export const OutputMessageContent = Schema.Union([OutputTextContent, RefusalContent], {
|
|
19338
|
+
mode: "oneOf"
|
|
19339
|
+
})
|
|
19412
19340
|
export type ResponseContentPartAddedEvent = {
|
|
19413
19341
|
readonly "type": "response.content_part.added"
|
|
19414
19342
|
readonly "item_id": string
|
|
@@ -19824,7 +19752,7 @@ export const CreateChatCompletionRequest = Schema.Struct({
|
|
|
19824
19752
|
"safety_identifier": Schema.optionalKey(
|
|
19825
19753
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
19826
19754
|
"description":
|
|
19827
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
19755
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
19828
19756
|
})
|
|
19829
19757
|
),
|
|
19830
19758
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -21714,7 +21642,7 @@ export const Response = Schema.Struct({
|
|
|
21714
21642
|
"safety_identifier": Schema.optionalKey(
|
|
21715
21643
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
21716
21644
|
"description":
|
|
21717
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
21645
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
21718
21646
|
})
|
|
21719
21647
|
),
|
|
21720
21648
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -21990,7 +21918,7 @@ export const ResponseCompletedEvent = Schema.Struct({
|
|
|
21990
21918
|
"safety_identifier": Schema.optionalKey(
|
|
21991
21919
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
21992
21920
|
"description":
|
|
21993
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
21921
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
21994
21922
|
})
|
|
21995
21923
|
),
|
|
21996
21924
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -22271,7 +22199,7 @@ export const ResponseCreatedEvent = Schema.Struct({
|
|
|
22271
22199
|
"safety_identifier": Schema.optionalKey(
|
|
22272
22200
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
22273
22201
|
"description":
|
|
22274
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22202
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22275
22203
|
})
|
|
22276
22204
|
),
|
|
22277
22205
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -22555,7 +22483,7 @@ export const ResponseFailedEvent = Schema.Struct({
|
|
|
22555
22483
|
"safety_identifier": Schema.optionalKey(
|
|
22556
22484
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
22557
22485
|
"description":
|
|
22558
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22486
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22559
22487
|
})
|
|
22560
22488
|
),
|
|
22561
22489
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -22833,7 +22761,7 @@ export const ResponseInProgressEvent = Schema.Struct({
|
|
|
22833
22761
|
"safety_identifier": Schema.optionalKey(
|
|
22834
22762
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
22835
22763
|
"description":
|
|
22836
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22764
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
22837
22765
|
})
|
|
22838
22766
|
),
|
|
22839
22767
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -23114,7 +23042,7 @@ export const ResponseIncompleteEvent = Schema.Struct({
|
|
|
23114
23042
|
"safety_identifier": Schema.optionalKey(
|
|
23115
23043
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
23116
23044
|
"description":
|
|
23117
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23045
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23118
23046
|
})
|
|
23119
23047
|
),
|
|
23120
23048
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -23395,7 +23323,7 @@ export const ResponseQueuedEvent = Schema.Struct({
|
|
|
23395
23323
|
"safety_identifier": Schema.optionalKey(
|
|
23396
23324
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
23397
23325
|
"description":
|
|
23398
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23326
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23399
23327
|
})
|
|
23400
23328
|
),
|
|
23401
23329
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -23778,7 +23706,7 @@ export const CreateResponse = Schema.Struct({
|
|
|
23778
23706
|
"safety_identifier": Schema.optionalKey(
|
|
23779
23707
|
Schema.Union([Schema.String, Schema.Null]).annotate({
|
|
23780
23708
|
"description":
|
|
23781
|
-
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23709
|
+
"A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n"
|
|
23782
23710
|
})
|
|
23783
23711
|
),
|
|
23784
23712
|
"prompt_cache_key": Schema.optionalKey(
|
|
@@ -23915,6 +23843,21 @@ export const CreateResponse = Schema.Struct({
|
|
|
23915
23843
|
])
|
|
23916
23844
|
)
|
|
23917
23845
|
})
|
|
23846
|
+
export type ResponseKeepAliveEvent = {
|
|
23847
|
+
readonly "type": "keepalive"
|
|
23848
|
+
readonly "sequence_number": number
|
|
23849
|
+
}
|
|
23850
|
+
export const ResponseKeepAliveEvent = Schema.Struct({
|
|
23851
|
+
"type": Schema.Literal("keepalive").annotate({
|
|
23852
|
+
"description": "The type of the keepalive event. Always `keepalive`."
|
|
23853
|
+
}),
|
|
23854
|
+
"sequence_number": Schema.Number.annotate({ "description": "The sequence number of this keepalive event." }).check(
|
|
23855
|
+
Schema.isInt()
|
|
23856
|
+
)
|
|
23857
|
+
}).annotate({
|
|
23858
|
+
"title": "Keep alive",
|
|
23859
|
+
"description": "A keepalive event emitted during long-running response streams."
|
|
23860
|
+
})
|
|
23918
23861
|
export type ResponseStreamEvent =
|
|
23919
23862
|
| ResponseAudioDeltaEvent
|
|
23920
23863
|
| ResponseAudioDoneEvent
|
|
@@ -23938,6 +23881,7 @@ export type ResponseStreamEvent =
|
|
|
23938
23881
|
| ResponseInProgressEvent
|
|
23939
23882
|
| ResponseFailedEvent
|
|
23940
23883
|
| ResponseIncompleteEvent
|
|
23884
|
+
| ResponseKeepAliveEvent
|
|
23941
23885
|
| ResponseOutputItemAddedEvent
|
|
23942
23886
|
| ResponseOutputItemDoneEvent
|
|
23943
23887
|
| ResponseReasoningSummaryPartAddedEvent
|
|
@@ -23994,6 +23938,7 @@ export const ResponseStreamEvent = Schema.Union([
|
|
|
23994
23938
|
ResponseInProgressEvent,
|
|
23995
23939
|
ResponseFailedEvent,
|
|
23996
23940
|
ResponseIncompleteEvent,
|
|
23941
|
+
ResponseKeepAliveEvent,
|
|
23997
23942
|
ResponseOutputItemAddedEvent,
|
|
23998
23943
|
ResponseOutputItemDoneEvent,
|
|
23999
23944
|
ResponseReasoningSummaryPartAddedEvent,
|
|
@@ -26017,7 +25962,7 @@ export const make = (
|
|
|
26017
25962
|
}))
|
|
26018
25963
|
),
|
|
26019
25964
|
"deleteAssistant": (assistantId, options) =>
|
|
26020
|
-
HttpClientRequest.
|
|
25965
|
+
HttpClientRequest.delete(`/assistants/${assistantId}`).pipe(
|
|
26021
25966
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26022
25967
|
"2xx": decodeSuccess(DeleteAssistant200),
|
|
26023
25968
|
orElse: unexpectedStatus
|
|
@@ -26096,7 +26041,7 @@ export const make = (
|
|
|
26096
26041
|
}))
|
|
26097
26042
|
),
|
|
26098
26043
|
"deleteVoiceConsent": (consentId, options) =>
|
|
26099
|
-
HttpClientRequest.
|
|
26044
|
+
HttpClientRequest.delete(`/audio/voice_consents/${consentId}`).pipe(
|
|
26100
26045
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26101
26046
|
"2xx": decodeSuccess(DeleteVoiceConsent200),
|
|
26102
26047
|
orElse: unexpectedStatus
|
|
@@ -26186,7 +26131,7 @@ export const make = (
|
|
|
26186
26131
|
}))
|
|
26187
26132
|
),
|
|
26188
26133
|
"deleteChatCompletion": (completionId, options) =>
|
|
26189
|
-
HttpClientRequest.
|
|
26134
|
+
HttpClientRequest.delete(`/chat/completions/${completionId}`).pipe(
|
|
26190
26135
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26191
26136
|
"2xx": decodeSuccess(DeleteChatCompletion200),
|
|
26192
26137
|
orElse: unexpectedStatus
|
|
@@ -26241,7 +26186,7 @@ export const make = (
|
|
|
26241
26186
|
}))
|
|
26242
26187
|
),
|
|
26243
26188
|
"DeleteContainer": (containerId, options) =>
|
|
26244
|
-
HttpClientRequest.
|
|
26189
|
+
HttpClientRequest.delete(`/containers/${containerId}`).pipe(
|
|
26245
26190
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26246
26191
|
"200": () => Effect.void,
|
|
26247
26192
|
orElse: unexpectedStatus
|
|
@@ -26275,7 +26220,7 @@ export const make = (
|
|
|
26275
26220
|
}))
|
|
26276
26221
|
),
|
|
26277
26222
|
"DeleteContainerFile": (containerId, fileId, options) =>
|
|
26278
|
-
HttpClientRequest.
|
|
26223
|
+
HttpClientRequest.delete(`/containers/${containerId}/files/${fileId}`).pipe(
|
|
26279
26224
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26280
26225
|
"200": () => Effect.void,
|
|
26281
26226
|
orElse: unexpectedStatus
|
|
@@ -26319,7 +26264,7 @@ export const make = (
|
|
|
26319
26264
|
}))
|
|
26320
26265
|
),
|
|
26321
26266
|
"deleteConversationItem": (conversationId, itemId, options) =>
|
|
26322
|
-
HttpClientRequest.
|
|
26267
|
+
HttpClientRequest.delete(`/conversations/${conversationId}/items/${itemId}`).pipe(
|
|
26323
26268
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26324
26269
|
"2xx": decodeSuccess(DeleteConversationItem200),
|
|
26325
26270
|
orElse: unexpectedStatus
|
|
@@ -26370,7 +26315,7 @@ export const make = (
|
|
|
26370
26315
|
}))
|
|
26371
26316
|
),
|
|
26372
26317
|
"deleteEval": (evalId, options) =>
|
|
26373
|
-
HttpClientRequest.
|
|
26318
|
+
HttpClientRequest.delete(`/evals/${evalId}`).pipe(
|
|
26374
26319
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26375
26320
|
"2xx": decodeSuccess(DeleteEval200),
|
|
26376
26321
|
"404": decodeError("DeleteEval404", DeleteEval404),
|
|
@@ -26414,7 +26359,7 @@ export const make = (
|
|
|
26414
26359
|
}))
|
|
26415
26360
|
),
|
|
26416
26361
|
"deleteEvalRun": (evalId, runId, options) =>
|
|
26417
|
-
HttpClientRequest.
|
|
26362
|
+
HttpClientRequest.delete(`/evals/${evalId}/runs/${runId}`).pipe(
|
|
26418
26363
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26419
26364
|
"2xx": decodeSuccess(DeleteEvalRun200),
|
|
26420
26365
|
"404": decodeError("DeleteEvalRun404", DeleteEvalRun404),
|
|
@@ -26470,7 +26415,7 @@ export const make = (
|
|
|
26470
26415
|
}))
|
|
26471
26416
|
),
|
|
26472
26417
|
"deleteFile": (fileId, options) =>
|
|
26473
|
-
HttpClientRequest.
|
|
26418
|
+
HttpClientRequest.delete(`/files/${fileId}`).pipe(
|
|
26474
26419
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26475
26420
|
"2xx": decodeSuccess(DeleteFile200),
|
|
26476
26421
|
orElse: unexpectedStatus
|
|
@@ -26521,7 +26466,7 @@ export const make = (
|
|
|
26521
26466
|
}))
|
|
26522
26467
|
),
|
|
26523
26468
|
"deleteFineTuningCheckpointPermission": (fineTunedModelCheckpoint, permissionId, options) =>
|
|
26524
|
-
HttpClientRequest.
|
|
26469
|
+
HttpClientRequest.delete(`/fine_tuning/checkpoints/${fineTunedModelCheckpoint}/permissions/${permissionId}`).pipe(
|
|
26525
26470
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26526
26471
|
"2xx": decodeSuccess(DeleteFineTuningCheckpointPermission200),
|
|
26527
26472
|
orElse: unexpectedStatus
|
|
@@ -26646,7 +26591,7 @@ export const make = (
|
|
|
26646
26591
|
}))
|
|
26647
26592
|
),
|
|
26648
26593
|
"deleteModel": (model, options) =>
|
|
26649
|
-
HttpClientRequest.
|
|
26594
|
+
HttpClientRequest.delete(`/models/${model}`).pipe(
|
|
26650
26595
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26651
26596
|
"2xx": decodeSuccess(DeleteModel200),
|
|
26652
26597
|
orElse: unexpectedStatus
|
|
@@ -26688,7 +26633,7 @@ export const make = (
|
|
|
26688
26633
|
}))
|
|
26689
26634
|
),
|
|
26690
26635
|
"adminApiKeysDelete": (keyId, options) =>
|
|
26691
|
-
HttpClientRequest.
|
|
26636
|
+
HttpClientRequest.delete(`/organization/admin_api_keys/${keyId}`).pipe(
|
|
26692
26637
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26693
26638
|
"2xx": decodeSuccess(AdminApiKeysDelete200),
|
|
26694
26639
|
orElse: unexpectedStatus
|
|
@@ -26768,7 +26713,7 @@ export const make = (
|
|
|
26768
26713
|
}))
|
|
26769
26714
|
),
|
|
26770
26715
|
"deleteCertificate": (certificateId, options) =>
|
|
26771
|
-
HttpClientRequest.
|
|
26716
|
+
HttpClientRequest.delete(`/organization/certificates/${certificateId}`).pipe(
|
|
26772
26717
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26773
26718
|
"2xx": decodeSuccess(DeleteCertificate200),
|
|
26774
26719
|
orElse: unexpectedStatus
|
|
@@ -26819,7 +26764,7 @@ export const make = (
|
|
|
26819
26764
|
}))
|
|
26820
26765
|
),
|
|
26821
26766
|
"deleteGroup": (groupId, options) =>
|
|
26822
|
-
HttpClientRequest.
|
|
26767
|
+
HttpClientRequest.delete(`/organization/groups/${groupId}`).pipe(
|
|
26823
26768
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26824
26769
|
"2xx": decodeSuccess(DeleteGroup200),
|
|
26825
26770
|
orElse: unexpectedStatus
|
|
@@ -26846,7 +26791,7 @@ export const make = (
|
|
|
26846
26791
|
}))
|
|
26847
26792
|
),
|
|
26848
26793
|
"unassignGroupRole": (groupId, roleId, options) =>
|
|
26849
|
-
HttpClientRequest.
|
|
26794
|
+
HttpClientRequest.delete(`/organization/groups/${groupId}/roles/${roleId}`).pipe(
|
|
26850
26795
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26851
26796
|
"2xx": decodeSuccess(UnassignGroupRole200),
|
|
26852
26797
|
orElse: unexpectedStatus
|
|
@@ -26873,7 +26818,7 @@ export const make = (
|
|
|
26873
26818
|
}))
|
|
26874
26819
|
),
|
|
26875
26820
|
"removeGroupUser": (groupId, userId, options) =>
|
|
26876
|
-
HttpClientRequest.
|
|
26821
|
+
HttpClientRequest.delete(`/organization/groups/${groupId}/users/${userId}`).pipe(
|
|
26877
26822
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26878
26823
|
"2xx": decodeSuccess(RemoveGroupUser200),
|
|
26879
26824
|
orElse: unexpectedStatus
|
|
@@ -26906,7 +26851,7 @@ export const make = (
|
|
|
26906
26851
|
}))
|
|
26907
26852
|
),
|
|
26908
26853
|
"deleteInvite": (inviteId, options) =>
|
|
26909
|
-
HttpClientRequest.
|
|
26854
|
+
HttpClientRequest.delete(`/organization/invites/${inviteId}`).pipe(
|
|
26910
26855
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26911
26856
|
"2xx": decodeSuccess(DeleteInvite200),
|
|
26912
26857
|
orElse: unexpectedStatus
|
|
@@ -26967,7 +26912,7 @@ export const make = (
|
|
|
26967
26912
|
}))
|
|
26968
26913
|
),
|
|
26969
26914
|
"deleteProjectApiKey": (projectId, keyId, options) =>
|
|
26970
|
-
HttpClientRequest.
|
|
26915
|
+
HttpClientRequest.delete(`/organization/projects/${projectId}/api_keys/${keyId}`).pipe(
|
|
26971
26916
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
26972
26917
|
"2xx": decodeSuccess(DeleteProjectApiKey200),
|
|
26973
26918
|
"400": decodeError("DeleteProjectApiKey400", DeleteProjectApiKey400),
|
|
@@ -27030,7 +26975,7 @@ export const make = (
|
|
|
27030
26975
|
}))
|
|
27031
26976
|
),
|
|
27032
26977
|
"removeProjectGroup": (projectId, groupId, options) =>
|
|
27033
|
-
HttpClientRequest.
|
|
26978
|
+
HttpClientRequest.delete(`/organization/projects/${projectId}/groups/${groupId}`).pipe(
|
|
27034
26979
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27035
26980
|
"2xx": decodeSuccess(RemoveProjectGroup200),
|
|
27036
26981
|
orElse: unexpectedStatus
|
|
@@ -27086,7 +27031,7 @@ export const make = (
|
|
|
27086
27031
|
}))
|
|
27087
27032
|
),
|
|
27088
27033
|
"deleteProjectServiceAccount": (projectId, serviceAccountId, options) =>
|
|
27089
|
-
HttpClientRequest.
|
|
27034
|
+
HttpClientRequest.delete(`/organization/projects/${projectId}/service_accounts/${serviceAccountId}`).pipe(
|
|
27090
27035
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27091
27036
|
"2xx": decodeSuccess(DeleteProjectServiceAccount200),
|
|
27092
27037
|
orElse: unexpectedStatus
|
|
@@ -27130,7 +27075,7 @@ export const make = (
|
|
|
27130
27075
|
}))
|
|
27131
27076
|
),
|
|
27132
27077
|
"deleteProjectUser": (projectId, userId, options) =>
|
|
27133
|
-
HttpClientRequest.
|
|
27078
|
+
HttpClientRequest.delete(`/organization/projects/${projectId}/users/${userId}`).pipe(
|
|
27134
27079
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27135
27080
|
"2xx": decodeSuccess(DeleteProjectUser200),
|
|
27136
27081
|
"400": decodeError("DeleteProjectUser400", DeleteProjectUser400),
|
|
@@ -27166,7 +27111,7 @@ export const make = (
|
|
|
27166
27111
|
}))
|
|
27167
27112
|
),
|
|
27168
27113
|
"deleteRole": (roleId, options) =>
|
|
27169
|
-
HttpClientRequest.
|
|
27114
|
+
HttpClientRequest.delete(`/organization/roles/${roleId}`).pipe(
|
|
27170
27115
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27171
27116
|
"2xx": decodeSuccess(DeleteRole200),
|
|
27172
27117
|
orElse: unexpectedStatus
|
|
@@ -27349,7 +27294,7 @@ export const make = (
|
|
|
27349
27294
|
}))
|
|
27350
27295
|
),
|
|
27351
27296
|
"deleteUser": (userId, options) =>
|
|
27352
|
-
HttpClientRequest.
|
|
27297
|
+
HttpClientRequest.delete(`/organization/users/${userId}`).pipe(
|
|
27353
27298
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27354
27299
|
"2xx": decodeSuccess(DeleteUser200),
|
|
27355
27300
|
orElse: unexpectedStatus
|
|
@@ -27376,7 +27321,7 @@ export const make = (
|
|
|
27376
27321
|
}))
|
|
27377
27322
|
),
|
|
27378
27323
|
"unassignUserRole": (userId, roleId, options) =>
|
|
27379
|
-
HttpClientRequest.
|
|
27324
|
+
HttpClientRequest.delete(`/organization/users/${userId}/roles/${roleId}`).pipe(
|
|
27380
27325
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27381
27326
|
"2xx": decodeSuccess(UnassignUserRole200),
|
|
27382
27327
|
orElse: unexpectedStatus
|
|
@@ -27403,7 +27348,7 @@ export const make = (
|
|
|
27403
27348
|
}))
|
|
27404
27349
|
),
|
|
27405
27350
|
"unassignProjectGroupRole": (projectId, groupId, roleId, options) =>
|
|
27406
|
-
HttpClientRequest.
|
|
27351
|
+
HttpClientRequest.delete(`/projects/${projectId}/groups/${groupId}/roles/${roleId}`).pipe(
|
|
27407
27352
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27408
27353
|
"2xx": decodeSuccess(UnassignProjectGroupRole200),
|
|
27409
27354
|
orElse: unexpectedStatus
|
|
@@ -27438,7 +27383,7 @@ export const make = (
|
|
|
27438
27383
|
}))
|
|
27439
27384
|
),
|
|
27440
27385
|
"deleteProjectRole": (projectId, roleId, options) =>
|
|
27441
|
-
HttpClientRequest.
|
|
27386
|
+
HttpClientRequest.delete(`/projects/${projectId}/roles/${roleId}`).pipe(
|
|
27442
27387
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27443
27388
|
"2xx": decodeSuccess(DeleteProjectRole200),
|
|
27444
27389
|
orElse: unexpectedStatus
|
|
@@ -27465,7 +27410,7 @@ export const make = (
|
|
|
27465
27410
|
}))
|
|
27466
27411
|
),
|
|
27467
27412
|
"unassignProjectUserRole": (projectId, userId, roleId, options) =>
|
|
27468
|
-
HttpClientRequest.
|
|
27413
|
+
HttpClientRequest.delete(`/projects/${projectId}/users/${userId}/roles/${roleId}`).pipe(
|
|
27469
27414
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27470
27415
|
"2xx": decodeSuccess(UnassignProjectUserRole200),
|
|
27471
27416
|
orElse: unexpectedStatus
|
|
@@ -27560,7 +27505,7 @@ export const make = (
|
|
|
27560
27505
|
}))
|
|
27561
27506
|
),
|
|
27562
27507
|
"deleteResponse": (responseId, options) =>
|
|
27563
|
-
HttpClientRequest.
|
|
27508
|
+
HttpClientRequest.delete(`/responses/${responseId}`).pipe(
|
|
27564
27509
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27565
27510
|
"404": decodeError("DeleteResponse404", DeleteResponse404),
|
|
27566
27511
|
"200": () => Effect.void,
|
|
@@ -27620,7 +27565,7 @@ export const make = (
|
|
|
27620
27565
|
}))
|
|
27621
27566
|
),
|
|
27622
27567
|
"deleteThread": (threadId, options) =>
|
|
27623
|
-
HttpClientRequest.
|
|
27568
|
+
HttpClientRequest.delete(`/threads/${threadId}`).pipe(
|
|
27624
27569
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27625
27570
|
"2xx": decodeSuccess(DeleteThread200),
|
|
27626
27571
|
orElse: unexpectedStatus
|
|
@@ -27664,7 +27609,7 @@ export const make = (
|
|
|
27664
27609
|
}))
|
|
27665
27610
|
),
|
|
27666
27611
|
"deleteMessage": (threadId, messageId, options) =>
|
|
27667
|
-
HttpClientRequest.
|
|
27612
|
+
HttpClientRequest.delete(`/threads/${threadId}/messages/${messageId}`).pipe(
|
|
27668
27613
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27669
27614
|
"2xx": decodeSuccess(DeleteMessage200),
|
|
27670
27615
|
orElse: unexpectedStatus
|
|
@@ -27812,7 +27757,7 @@ export const make = (
|
|
|
27812
27757
|
}))
|
|
27813
27758
|
),
|
|
27814
27759
|
"deleteVectorStore": (vectorStoreId, options) =>
|
|
27815
|
-
HttpClientRequest.
|
|
27760
|
+
HttpClientRequest.delete(`/vector_stores/${vectorStoreId}`).pipe(
|
|
27816
27761
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27817
27762
|
"2xx": decodeSuccess(DeleteVectorStore200),
|
|
27818
27763
|
orElse: unexpectedStatus
|
|
@@ -27892,7 +27837,7 @@ export const make = (
|
|
|
27892
27837
|
}))
|
|
27893
27838
|
),
|
|
27894
27839
|
"deleteVectorStoreFile": (vectorStoreId, fileId, options) =>
|
|
27895
|
-
HttpClientRequest.
|
|
27840
|
+
HttpClientRequest.delete(`/vector_stores/${vectorStoreId}/files/${fileId}`).pipe(
|
|
27896
27841
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27897
27842
|
"2xx": decodeSuccess(DeleteVectorStoreFile200),
|
|
27898
27843
|
orElse: unexpectedStatus
|
|
@@ -27937,7 +27882,7 @@ export const make = (
|
|
|
27937
27882
|
}))
|
|
27938
27883
|
),
|
|
27939
27884
|
"deleteConversation": (conversationId, options) =>
|
|
27940
|
-
HttpClientRequest.
|
|
27885
|
+
HttpClientRequest.delete(`/conversations/${conversationId}`).pipe(
|
|
27941
27886
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27942
27887
|
"2xx": decodeSuccess(DeleteConversation200),
|
|
27943
27888
|
orElse: unexpectedStatus
|
|
@@ -27971,7 +27916,7 @@ export const make = (
|
|
|
27971
27916
|
}))
|
|
27972
27917
|
),
|
|
27973
27918
|
"DeleteVideo": (videoId, options) =>
|
|
27974
|
-
HttpClientRequest.
|
|
27919
|
+
HttpClientRequest.delete(`/videos/${videoId}`).pipe(
|
|
27975
27920
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
27976
27921
|
"2xx": decodeSuccess(DeleteVideo200),
|
|
27977
27922
|
orElse: unexpectedStatus
|
|
@@ -28045,7 +27990,7 @@ export const make = (
|
|
|
28045
27990
|
}))
|
|
28046
27991
|
),
|
|
28047
27992
|
"DeleteSkill": (skillId, options) =>
|
|
28048
|
-
HttpClientRequest.
|
|
27993
|
+
HttpClientRequest.delete(`/skills/${skillId}`).pipe(
|
|
28049
27994
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
28050
27995
|
"2xx": decodeSuccess(DeleteSkill200),
|
|
28051
27996
|
orElse: unexpectedStatus
|
|
@@ -28086,7 +28031,7 @@ export const make = (
|
|
|
28086
28031
|
}))
|
|
28087
28032
|
),
|
|
28088
28033
|
"DeleteSkillVersion": (skillId, version, options) =>
|
|
28089
|
-
HttpClientRequest.
|
|
28034
|
+
HttpClientRequest.delete(`/skills/${skillId}/versions/${version}`).pipe(
|
|
28090
28035
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
28091
28036
|
"2xx": decodeSuccess(DeleteSkillVersion200),
|
|
28092
28037
|
orElse: unexpectedStatus
|
|
@@ -28135,7 +28080,7 @@ export const make = (
|
|
|
28135
28080
|
}))
|
|
28136
28081
|
),
|
|
28137
28082
|
"DeleteThreadMethod": (threadId, options) =>
|
|
28138
|
-
HttpClientRequest.
|
|
28083
|
+
HttpClientRequest.delete(`/chatkit/threads/${threadId}`).pipe(
|
|
28139
28084
|
withResponse(options?.config)(HttpClientResponse.matchStatus({
|
|
28140
28085
|
"2xx": decodeSuccess(DeleteThreadMethod200),
|
|
28141
28086
|
orElse: unexpectedStatus
|
|
@@ -28212,12 +28157,16 @@ export interface OpenAiClient {
|
|
|
28212
28157
|
>
|
|
28213
28158
|
/**
|
|
28214
28159
|
* Generates audio from the input text.
|
|
28160
|
+
*
|
|
28161
|
+
* Returns the audio file content, or a stream of audio events.
|
|
28215
28162
|
*/
|
|
28216
28163
|
readonly "createSpeech": <Config extends OperationConfig>(
|
|
28217
28164
|
options: { readonly payload: typeof CreateSpeechRequestJson.Encoded; readonly config?: Config | undefined }
|
|
28218
28165
|
) => Effect.Effect<WithOptionalResponse<void, Config>, HttpClientError.HttpClientError | SchemaError>
|
|
28219
28166
|
/**
|
|
28220
28167
|
* Generates audio from the input text.
|
|
28168
|
+
*
|
|
28169
|
+
* Returns the audio file content, or a stream of audio events.
|
|
28221
28170
|
*/
|
|
28222
28171
|
readonly "createSpeechSse": (
|
|
28223
28172
|
options: { readonly payload: typeof CreateSpeechRequestJson.Encoded }
|
|
@@ -28228,12 +28177,17 @@ export interface OpenAiClient {
|
|
|
28228
28177
|
>
|
|
28229
28178
|
/**
|
|
28230
28179
|
* Generates audio from the input text.
|
|
28180
|
+
*
|
|
28181
|
+
* Returns the audio file content, or a stream of audio events.
|
|
28231
28182
|
*/
|
|
28232
28183
|
readonly "createSpeechStream": (
|
|
28233
28184
|
options: { readonly payload: typeof CreateSpeechRequestJson.Encoded }
|
|
28234
28185
|
) => Stream.Stream<Uint8Array, HttpClientError.HttpClientError>
|
|
28235
28186
|
/**
|
|
28236
28187
|
* Transcribes audio into the input language.
|
|
28188
|
+
*
|
|
28189
|
+
* Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
|
|
28190
|
+
* format, or a stream of transcript events.
|
|
28237
28191
|
*/
|
|
28238
28192
|
readonly "createTranscription": <Config extends OperationConfig>(
|
|
28239
28193
|
options: {
|
|
@@ -28246,6 +28200,9 @@ export interface OpenAiClient {
|
|
|
28246
28200
|
>
|
|
28247
28201
|
/**
|
|
28248
28202
|
* Transcribes audio into the input language.
|
|
28203
|
+
*
|
|
28204
|
+
* Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
|
|
28205
|
+
* format, or a stream of transcript events.
|
|
28249
28206
|
*/
|
|
28250
28207
|
readonly "createTranscriptionSse": (
|
|
28251
28208
|
options: { readonly payload: typeof CreateTranscriptionRequestFormData.Encoded }
|
|
@@ -28407,6 +28364,9 @@ export interface OpenAiClient {
|
|
|
28407
28364
|
* supported for reasoning models are noted below. For the current state of
|
|
28408
28365
|
* unsupported parameters in reasoning models,
|
|
28409
28366
|
* [refer to the reasoning guide](/docs/guides/reasoning).
|
|
28367
|
+
*
|
|
28368
|
+
* Returns a chat completion object, or a streamed sequence of chat completion
|
|
28369
|
+
* chunk objects if the request is streamed.
|
|
28410
28370
|
*/
|
|
28411
28371
|
readonly "createChatCompletion": <Config extends OperationConfig>(
|
|
28412
28372
|
options: { readonly payload: typeof CreateChatCompletionRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -28430,6 +28390,9 @@ export interface OpenAiClient {
|
|
|
28430
28390
|
* supported for reasoning models are noted below. For the current state of
|
|
28431
28391
|
* unsupported parameters in reasoning models,
|
|
28432
28392
|
* [refer to the reasoning guide](/docs/guides/reasoning).
|
|
28393
|
+
*
|
|
28394
|
+
* Returns a chat completion object, or a streamed sequence of chat completion
|
|
28395
|
+
* chunk objects if the request is streamed.
|
|
28433
28396
|
*/
|
|
28434
28397
|
readonly "createChatCompletionSse": (
|
|
28435
28398
|
options: { readonly payload: typeof CreateChatCompletionRequestJson.Encoded }
|
|
@@ -28489,6 +28452,8 @@ export interface OpenAiClient {
|
|
|
28489
28452
|
>
|
|
28490
28453
|
/**
|
|
28491
28454
|
* Creates a completion for the provided prompt and parameters.
|
|
28455
|
+
*
|
|
28456
|
+
* Returns a completion object, or a sequence of completion objects if the request is streamed.
|
|
28492
28457
|
*/
|
|
28493
28458
|
readonly "createCompletion": <Config extends OperationConfig>(
|
|
28494
28459
|
options: { readonly payload: typeof CreateCompletionRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -29460,6 +29425,9 @@ export interface OpenAiClient {
|
|
|
29460
29425
|
>
|
|
29461
29426
|
/**
|
|
29462
29427
|
* Deletes an API key from the project.
|
|
29428
|
+
*
|
|
29429
|
+
* Returns confirmation of the key deletion, or an error if the key belonged to
|
|
29430
|
+
* a service account.
|
|
29463
29431
|
*/
|
|
29464
29432
|
readonly "deleteProjectApiKey": <Config extends OperationConfig>(
|
|
29465
29433
|
projectId: string,
|
|
@@ -29629,6 +29597,9 @@ export interface OpenAiClient {
|
|
|
29629
29597
|
>
|
|
29630
29598
|
/**
|
|
29631
29599
|
* Deletes a service account from the project.
|
|
29600
|
+
*
|
|
29601
|
+
* Returns confirmation of service account deletion, or an error if the project
|
|
29602
|
+
* is archived (archived projects have no service accounts).
|
|
29632
29603
|
*/
|
|
29633
29604
|
readonly "deleteProjectServiceAccount": <Config extends OperationConfig>(
|
|
29634
29605
|
projectId: string,
|
|
@@ -29691,6 +29662,9 @@ export interface OpenAiClient {
|
|
|
29691
29662
|
>
|
|
29692
29663
|
/**
|
|
29693
29664
|
* Deletes a user from the project.
|
|
29665
|
+
*
|
|
29666
|
+
* Returns confirmation of project user deletion, or an error if the project is
|
|
29667
|
+
* archived (archived projects have no users).
|
|
29694
29668
|
*/
|
|
29695
29669
|
readonly "deleteProjectUser": <Config extends OperationConfig>(
|
|
29696
29670
|
projectId: string,
|
|
@@ -30056,6 +30030,18 @@ export interface OpenAiClient {
|
|
|
30056
30030
|
) => Effect.Effect<WithOptionalResponse<void, Config>, HttpClientError.HttpClientError | SchemaError>
|
|
30057
30031
|
/**
|
|
30058
30032
|
* Create a Realtime client secret with an associated session configuration.
|
|
30033
|
+
*
|
|
30034
|
+
* Client secrets are short-lived tokens that can be passed to a client app,
|
|
30035
|
+
* such as a web frontend or mobile client, which grants access to the Realtime API without
|
|
30036
|
+
* leaking your main API key. You can configure a custom TTL for each client secret.
|
|
30037
|
+
*
|
|
30038
|
+
* You can also attach session configuration options to the client secret, which will be
|
|
30039
|
+
* applied to any sessions created using that client secret, but these can also be overridden
|
|
30040
|
+
* by the client connection.
|
|
30041
|
+
*
|
|
30042
|
+
* [Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc).
|
|
30043
|
+
*
|
|
30044
|
+
* Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`.
|
|
30059
30045
|
*/
|
|
30060
30046
|
readonly "createRealtimeClientSecret": <Config extends OperationConfig>(
|
|
30061
30047
|
options: {
|
|
@@ -30074,6 +30060,8 @@ export interface OpenAiClient {
|
|
|
30074
30060
|
* It responds with a session object, plus a `client_secret` key which contains
|
|
30075
30061
|
* a usable ephemeral API token that can be used to authenticate browser clients
|
|
30076
30062
|
* for the Realtime API.
|
|
30063
|
+
*
|
|
30064
|
+
* Returns the created Realtime session object, plus an ephemeral key.
|
|
30077
30065
|
*/
|
|
30078
30066
|
readonly "createRealtimeSession": <Config extends OperationConfig>(
|
|
30079
30067
|
options: { readonly payload: typeof CreateRealtimeSessionRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -30089,6 +30077,8 @@ export interface OpenAiClient {
|
|
|
30089
30077
|
* It responds with a session object, plus a `client_secret` key which contains
|
|
30090
30078
|
* a usable ephemeral API token that can be used to authenticate browser clients
|
|
30091
30079
|
* for the Realtime API.
|
|
30080
|
+
*
|
|
30081
|
+
* Returns the created Realtime transcription session object, plus an ephemeral key.
|
|
30092
30082
|
*/
|
|
30093
30083
|
readonly "createRealtimeTranscriptionSession": <Config extends OperationConfig>(
|
|
30094
30084
|
options: {
|
|
@@ -30395,6 +30385,8 @@ export interface OpenAiClient {
|
|
|
30395
30385
|
* For guidance on the proper filename extensions for each purpose, please
|
|
30396
30386
|
* follow the documentation on [creating a
|
|
30397
30387
|
* File](/docs/api-reference/files/create).
|
|
30388
|
+
*
|
|
30389
|
+
* Returns the Upload object with status `pending`.
|
|
30398
30390
|
*/
|
|
30399
30391
|
readonly "createUpload": <Config extends OperationConfig>(
|
|
30400
30392
|
options: { readonly payload: typeof CreateUploadRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -30404,6 +30396,8 @@ export interface OpenAiClient {
|
|
|
30404
30396
|
>
|
|
30405
30397
|
/**
|
|
30406
30398
|
* Cancels the Upload. No Parts may be added after an Upload is cancelled.
|
|
30399
|
+
*
|
|
30400
|
+
* Returns the Upload object with status `cancelled`.
|
|
30407
30401
|
*/
|
|
30408
30402
|
readonly "cancelUpload": <Config extends OperationConfig>(
|
|
30409
30403
|
uploadId: string,
|
|
@@ -30420,6 +30414,7 @@ export interface OpenAiClient {
|
|
|
30420
30414
|
* You can specify the order of the Parts by passing in an ordered list of the Part IDs.
|
|
30421
30415
|
*
|
|
30422
30416
|
* The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
|
|
30417
|
+
* Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.
|
|
30423
30418
|
*/
|
|
30424
30419
|
readonly "completeUpload": <Config extends OperationConfig>(
|
|
30425
30420
|
uploadId: string,
|
|
@@ -30703,6 +30698,8 @@ export interface OpenAiClient {
|
|
|
30703
30698
|
>
|
|
30704
30699
|
/**
|
|
30705
30700
|
* Download the generated video bytes or a derived preview asset.
|
|
30701
|
+
*
|
|
30702
|
+
* Streams the rendered video content for the specified video job.
|
|
30706
30703
|
*/
|
|
30707
30704
|
readonly "RetrieveVideoContent": <Config extends OperationConfig>(
|
|
30708
30705
|
videoId: string,
|
|
@@ -30726,6 +30723,8 @@ export interface OpenAiClient {
|
|
|
30726
30723
|
>
|
|
30727
30724
|
/**
|
|
30728
30725
|
* Returns input token counts of the request.
|
|
30726
|
+
*
|
|
30727
|
+
* Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.
|
|
30729
30728
|
*/
|
|
30730
30729
|
readonly "Getinputtokencounts": <Config extends OperationConfig>(
|
|
30731
30730
|
options: { readonly payload: typeof GetinputtokencountsRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -30734,7 +30733,9 @@ export interface OpenAiClient {
|
|
|
30734
30733
|
HttpClientError.HttpClientError | SchemaError
|
|
30735
30734
|
>
|
|
30736
30735
|
/**
|
|
30737
|
-
*
|
|
30736
|
+
* Compact a conversation. Returns a compacted response object.
|
|
30737
|
+
*
|
|
30738
|
+
* Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced).
|
|
30738
30739
|
*/
|
|
30739
30740
|
readonly "Compactconversation": <Config extends OperationConfig>(
|
|
30740
30741
|
options: { readonly payload: typeof CompactconversationRequestJson.Encoded; readonly config?: Config | undefined }
|
|
@@ -30866,6 +30867,8 @@ export interface OpenAiClient {
|
|
|
30866
30867
|
>
|
|
30867
30868
|
/**
|
|
30868
30869
|
* Cancel an active ChatKit session and return its most recent metadata.
|
|
30870
|
+
*
|
|
30871
|
+
* Cancelling prevents new requests from using the issued client secret.
|
|
30869
30872
|
*/
|
|
30870
30873
|
readonly "CancelChatSessionMethod": <Config extends OperationConfig>(
|
|
30871
30874
|
sessionId: string,
|