@cherryin/api-client 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/.openapi-generator/FILES +135 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +219 -0
  5. package/api.ts +6364 -0
  6. package/base.ts +62 -0
  7. package/common.ts +113 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +4175 -0
  10. package/dist/api.js +3694 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +28 -0
  14. package/dist/common.js +124 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +4175 -0
  18. package/dist/esm/api.js +3643 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +28 -0
  22. package/dist/esm/common.js +112 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/AIModel.md +45 -0
  30. package/docs/AIModelAdminServiceApi.md +398 -0
  31. package/docs/AIModelArchitecture.md +25 -0
  32. package/docs/AIModelCreateRequest.md +35 -0
  33. package/docs/AIModelCreateResponse.md +25 -0
  34. package/docs/AIModelDeleteRequest.md +21 -0
  35. package/docs/AIModelDeleteResponse.md +23 -0
  36. package/docs/AIModelDisableRequest.md +21 -0
  37. package/docs/AIModelDisableResponse.md +25 -0
  38. package/docs/AIModelDiscountConfig.md +21 -0
  39. package/docs/AIModelGetResponse.md +25 -0
  40. package/docs/AIModelListResponse.md +27 -0
  41. package/docs/AIModelMeta.md +25 -0
  42. package/docs/AIModelPricingConfig.md +37 -0
  43. package/docs/AIModelProviderConfigItem.md +29 -0
  44. package/docs/AIModelPublishRequest.md +21 -0
  45. package/docs/AIModelPublishResponse.md +25 -0
  46. package/docs/AIModelUpdateRequest.md +37 -0
  47. package/docs/AIModelUpdateResponse.md +25 -0
  48. package/docs/AWSAuth.md +24 -0
  49. package/docs/AdminAuthFlowInitResponse.md +24 -0
  50. package/docs/AdminAuthServiceApi.md +81 -0
  51. package/docs/AudioPricing.md +33 -0
  52. package/docs/AuthFlowResult.md +23 -0
  53. package/docs/AuthTokenPair.md +27 -0
  54. package/docs/DiscountAdminServiceApi.md +281 -0
  55. package/docs/DiscountCreateRequest.md +36 -0
  56. package/docs/DiscountDeleteRequest.md +20 -0
  57. package/docs/DiscountDeleteResponse.md +22 -0
  58. package/docs/DiscountGetResponse.md +24 -0
  59. package/docs/DiscountInfo.md +42 -0
  60. package/docs/DiscountListResponse.md +26 -0
  61. package/docs/DiscountUpdateRequest.md +38 -0
  62. package/docs/DiscountUpdateResponse.md +24 -0
  63. package/docs/FeatureCostPricing.md +27 -0
  64. package/docs/FrontAIModel.md +45 -0
  65. package/docs/GCPAuth.md +27 -0
  66. package/docs/GoogleProtobufAny.md +21 -0
  67. package/docs/ImagePricing.md +31 -0
  68. package/docs/Label.md +28 -0
  69. package/docs/LabelCreateRequest.md +22 -0
  70. package/docs/LabelCreateResponse.md +24 -0
  71. package/docs/LabelDeleteRequest.md +20 -0
  72. package/docs/LabelDeleteResponse.md +22 -0
  73. package/docs/LabelListRequest.md +24 -0
  74. package/docs/LabelListResponse.md +26 -0
  75. package/docs/LabelUpdateRequest.md +24 -0
  76. package/docs/LabelUpdateResponse.md +24 -0
  77. package/docs/MultimodalPricing.md +25 -0
  78. package/docs/PricingConditions.md +31 -0
  79. package/docs/PricingRules.md +29 -0
  80. package/docs/Provider.md +37 -0
  81. package/docs/ProviderAdminServiceApi.md +284 -0
  82. package/docs/ProviderAuth.md +29 -0
  83. package/docs/ProviderCreateRequest.md +29 -0
  84. package/docs/ProviderCreateResponse.md +25 -0
  85. package/docs/ProviderDeleteRequest.md +21 -0
  86. package/docs/ProviderDeleteResponse.md +23 -0
  87. package/docs/ProviderGetResponse.md +25 -0
  88. package/docs/ProviderListResponse.md +27 -0
  89. package/docs/ProviderModel.md +37 -0
  90. package/docs/ProviderModelAdminServiceApi.md +287 -0
  91. package/docs/ProviderModelCreateRequest.md +29 -0
  92. package/docs/ProviderModelCreateResponse.md +25 -0
  93. package/docs/ProviderModelDeleteRequest.md +21 -0
  94. package/docs/ProviderModelDeleteResponse.md +23 -0
  95. package/docs/ProviderModelGetResponse.md +25 -0
  96. package/docs/ProviderModelListResponse.md +27 -0
  97. package/docs/ProviderModelPayload.md +23 -0
  98. package/docs/ProviderModelUpdateRequest.md +31 -0
  99. package/docs/ProviderModelUpdateResponse.md +25 -0
  100. package/docs/ProviderPayload.md +21 -0
  101. package/docs/ProviderUpdateRequest.md +31 -0
  102. package/docs/ProviderUpdateResponse.md +25 -0
  103. package/docs/RequestPricing.md +23 -0
  104. package/docs/Status.md +25 -0
  105. package/docs/TextTokenInputPricing.md +27 -0
  106. package/docs/TextTokenOutputPricing.md +25 -0
  107. package/docs/TextTokenPricing.md +23 -0
  108. package/docs/TokenTier.md +25 -0
  109. package/docs/UserAPIKey.md +47 -0
  110. package/docs/UserAPIKeyCreateRequest.md +37 -0
  111. package/docs/UserAPIKeyCreateResponse.md +25 -0
  112. package/docs/UserAPIKeyDeleteRequest.md +21 -0
  113. package/docs/UserAPIKeyDeleteResponse.md +23 -0
  114. package/docs/UserAPIKeyGetResponse.md +25 -0
  115. package/docs/UserAPIKeyListResponse.md +27 -0
  116. package/docs/UserAPIKeyServiceApi.md +290 -0
  117. package/docs/UserAPIKeyUpdateRequest.md +33 -0
  118. package/docs/UserAPIKeyUpdateResponse.md +25 -0
  119. package/docs/UserAuthFlowCodeResponse.md +26 -0
  120. package/docs/UserAuthFlowInitResponse.md +28 -0
  121. package/docs/UserAuthFlowInitResponseOAuthResult.md +20 -0
  122. package/docs/UserAuthFlowOAuthCallbackRequest.md +24 -0
  123. package/docs/UserAuthFlowOAuthCallbackResponse.md +26 -0
  124. package/docs/UserAuthInfo.md +20 -0
  125. package/docs/UserAuthServiceApi.md +279 -0
  126. package/docs/UserBalance.md +42 -0
  127. package/docs/UserBalanceBrief.md +32 -0
  128. package/docs/UserBalanceChangeResponse.md +24 -0
  129. package/docs/UserBalanceEditResponse.md +24 -0
  130. package/docs/UserBalanceListResponse.md +26 -0
  131. package/docs/UserBalanceServiceApi.md +226 -0
  132. package/docs/UserInfo.md +26 -0
  133. package/docs/UserLabelItem.md +22 -0
  134. package/docs/UserLabelListResponse.md +26 -0
  135. package/docs/UserLabelPair.md +22 -0
  136. package/docs/UserLabelPairChangeAction.md +22 -0
  137. package/docs/UserLabelPairChangeRequest.md +20 -0
  138. package/docs/UserLabelPairChangeResponse.md +22 -0
  139. package/docs/UserLabelServiceApi.md +386 -0
  140. package/docs/UserMeInfo.md +24 -0
  141. package/docs/UserMeInfoResponse.md +24 -0
  142. package/docs/UserModelListResponse.md +33 -0
  143. package/docs/UserModelServiceApi.md +71 -0
  144. package/docs/UserPayServiceApi.md +62 -0
  145. package/docs/UserPayStripeCheckout.md +20 -0
  146. package/docs/UserPayStripeCheckoutResponse.md +24 -0
  147. package/docs/UserPoralServiceApi.md +52 -0
  148. package/docs/UserSettings.md +20 -0
  149. package/docs/VersionedAPISchema.md +31 -0
  150. package/docs/VideoPricing.md +33 -0
  151. package/git_push.sh +57 -0
  152. package/index.ts +18 -0
  153. package/package.json +36 -0
  154. package/tsconfig.esm.json +7 -0
  155. package/tsconfig.json +18 -0
@@ -0,0 +1,287 @@
1
+ # ProviderModelAdminServiceApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**providerModelAdminServiceProviderModelCreate**](#providermodeladminserviceprovidermodelcreate) | **POST** /admin/provider-model/create | |
8
+ |[**providerModelAdminServiceProviderModelDelete**](#providermodeladminserviceprovidermodeldelete) | **DELETE** /admin/provider-model/delete | |
9
+ |[**providerModelAdminServiceProviderModelGet**](#providermodeladminserviceprovidermodelget) | **GET** /admin/provider-model/get | |
10
+ |[**providerModelAdminServiceProviderModelList**](#providermodeladminserviceprovidermodellist) | **GET** /admin/provider-model/list | |
11
+ |[**providerModelAdminServiceProviderModelUpdate**](#providermodeladminserviceprovidermodelupdate) | **POST** /admin/provider-model/update | |
12
+
13
+ # **providerModelAdminServiceProviderModelCreate**
14
+ > ProviderModelCreateResponse providerModelAdminServiceProviderModelCreate(providerModelCreateRequest)
15
+
16
+ ProviderModelCreate 创建新的 ProviderModel Create a new provider model 请求路径: POST /admin/provider-model/create Request path: POST /admin/provider-model/create 权限要求: 需要管理员权限 Permission: Requires admin authentication
17
+
18
+ ### Example
19
+
20
+ ```typescript
21
+ import {
22
+ ProviderModelAdminServiceApi,
23
+ Configuration,
24
+ ProviderModelCreateRequest
25
+ } from '@cherryin/api-client';
26
+
27
+ const configuration = new Configuration();
28
+ const apiInstance = new ProviderModelAdminServiceApi(configuration);
29
+
30
+ let providerModelCreateRequest: ProviderModelCreateRequest; //
31
+
32
+ const { status, data } = await apiInstance.providerModelAdminServiceProviderModelCreate(
33
+ providerModelCreateRequest
34
+ );
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ |Name | Type | Description | Notes|
40
+ |------------- | ------------- | ------------- | -------------|
41
+ | **providerModelCreateRequest** | **ProviderModelCreateRequest**| | |
42
+
43
+
44
+ ### Return type
45
+
46
+ **ProviderModelCreateResponse**
47
+
48
+ ### Authorization
49
+
50
+ No authorization required
51
+
52
+ ### HTTP request headers
53
+
54
+ - **Content-Type**: application/json
55
+ - **Accept**: application/json
56
+
57
+
58
+ ### HTTP response details
59
+ | Status code | Description | Response headers |
60
+ |-------------|-------------|------------------|
61
+ |**200** | OK | - |
62
+ |**0** | Default error response | - |
63
+
64
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
65
+
66
+ # **providerModelAdminServiceProviderModelDelete**
67
+ > ProviderModelDeleteResponse providerModelAdminServiceProviderModelDelete(providerModelDeleteRequest)
68
+
69
+ ProviderModelDelete 删除 ProviderModel(软删除) Delete a provider model (soft delete) 请求路径: POST /admin/provider-model/delete Request path: POST /admin/provider-model/delete 权限要求: 需要管理员权限 Permission: Requires admin authentication
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ ProviderModelAdminServiceApi,
76
+ Configuration,
77
+ ProviderModelDeleteRequest
78
+ } from '@cherryin/api-client';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new ProviderModelAdminServiceApi(configuration);
82
+
83
+ let providerModelDeleteRequest: ProviderModelDeleteRequest; //
84
+
85
+ const { status, data } = await apiInstance.providerModelAdminServiceProviderModelDelete(
86
+ providerModelDeleteRequest
87
+ );
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ |Name | Type | Description | Notes|
93
+ |------------- | ------------- | ------------- | -------------|
94
+ | **providerModelDeleteRequest** | **ProviderModelDeleteRequest**| | |
95
+
96
+
97
+ ### Return type
98
+
99
+ **ProviderModelDeleteResponse**
100
+
101
+ ### Authorization
102
+
103
+ No authorization required
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: application/json
108
+ - **Accept**: application/json
109
+
110
+
111
+ ### HTTP response details
112
+ | Status code | Description | Response headers |
113
+ |-------------|-------------|------------------|
114
+ |**200** | OK | - |
115
+ |**0** | Default error response | - |
116
+
117
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
118
+
119
+ # **providerModelAdminServiceProviderModelGet**
120
+ > ProviderModelGetResponse providerModelAdminServiceProviderModelGet()
121
+
122
+ ProviderModelGet 根据 ID 获取单个 ProviderModel Retrieve a single provider model by ID 请求路径: GET /admin/provider-model/get?id={id} Request path: GET /admin/provider-model/get?id={id} 权限要求: 需要管理员权限 Permission: Requires admin authentication
123
+
124
+ ### Example
125
+
126
+ ```typescript
127
+ import {
128
+ ProviderModelAdminServiceApi,
129
+ Configuration
130
+ } from '@cherryin/api-client';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new ProviderModelAdminServiceApi(configuration);
134
+
135
+ let id: string; //id 要获取的 ProviderModel 的唯一标识符 Unique identifier of the provider model to retrieve @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
136
+
137
+ const { status, data } = await apiInstance.providerModelAdminServiceProviderModelGet(
138
+ id
139
+ );
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ |Name | Type | Description | Notes|
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **id** | [**string**] | id 要获取的 ProviderModel 的唯一标识符 Unique identifier of the provider model to retrieve @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
147
+
148
+
149
+ ### Return type
150
+
151
+ **ProviderModelGetResponse**
152
+
153
+ ### Authorization
154
+
155
+ No authorization required
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: application/json
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ |**200** | OK | - |
167
+ |**0** | Default error response | - |
168
+
169
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
170
+
171
+ # **providerModelAdminServiceProviderModelList**
172
+ > ProviderModelListResponse providerModelAdminServiceProviderModelList()
173
+
174
+ ProviderModelList 分页查询 ProviderModel 列表,支持按 Provider、状态和名称前缀过滤 List provider models with pagination, supports filtering by provider, status and name prefix 请求路径: GET /admin/provider-model/list?page={page}&page_size={page_size}&provider_id={provider_id}&status={status}&name_prefix={prefix} Request path: GET /admin/provider-model/list?page={page}&page_size={page_size}&provider_id={provider_id}&status={status}&name_prefix={prefix} 权限要求: 需要管理员权限 Permission: Requires admin authentication
175
+
176
+ ### Example
177
+
178
+ ```typescript
179
+ import {
180
+ ProviderModelAdminServiceApi,
181
+ Configuration
182
+ } from '@cherryin/api-client';
183
+
184
+ const configuration = new Configuration();
185
+ const apiInstance = new ProviderModelAdminServiceApi(configuration);
186
+
187
+ let page: number; //page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
188
+ let pageSize: number; //page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
189
+ let providerId: string; //provider_id 按 Provider ID 过滤(可选) Filter by Provider ID (optional) 0: 返回所有 Provider 的模型 > 0: 仅返回指定 Provider 的模型 0: return models from all providers > 0: return models from specific provider only @gotags: form:\"provider_id\" (optional) (default to undefined)
190
+ let status: number; //status 按状态过滤(可选) Filter by status (optional) 0: 返回所有状态 1: 仅返回草稿状态 2: 仅返回启用状态 3: 仅返回禁用状态 0: return all statuses 1: return draft models only 2: return active models only 3: return disabled models only @gotags: form:\"status\" (optional) (default to undefined)
191
+ let namePrefix: string; //name_prefix 按名称前缀过滤(可选) Filter by name prefix (optional) 例如: \"gpt-4\" 会匹配 \"gpt-4-turbo\", \"gpt-4-vision\" 等 Example: \"gpt-4\" matches \"gpt-4-turbo\", \"gpt-4-vision\", etc. @gotags: form:\"name_prefix\" (optional) (default to undefined)
192
+
193
+ const { status, data } = await apiInstance.providerModelAdminServiceProviderModelList(
194
+ page,
195
+ pageSize,
196
+ providerId,
197
+ status,
198
+ namePrefix
199
+ );
200
+ ```
201
+
202
+ ### Parameters
203
+
204
+ |Name | Type | Description | Notes|
205
+ |------------- | ------------- | ------------- | -------------|
206
+ | **page** | [**number**] | page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
207
+ | **pageSize** | [**number**] | page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
208
+ | **providerId** | [**string**] | provider_id 按 Provider ID 过滤(可选) Filter by Provider ID (optional) 0: 返回所有 Provider 的模型 > 0: 仅返回指定 Provider 的模型 0: return models from all providers > 0: return models from specific provider only @gotags: form:\"provider_id\" | (optional) defaults to undefined|
209
+ | **status** | [**number**] | status 按状态过滤(可选) Filter by status (optional) 0: 返回所有状态 1: 仅返回草稿状态 2: 仅返回启用状态 3: 仅返回禁用状态 0: return all statuses 1: return draft models only 2: return active models only 3: return disabled models only @gotags: form:\"status\" | (optional) defaults to undefined|
210
+ | **namePrefix** | [**string**] | name_prefix 按名称前缀过滤(可选) Filter by name prefix (optional) 例如: \"gpt-4\" 会匹配 \"gpt-4-turbo\", \"gpt-4-vision\" 等 Example: \"gpt-4\" matches \"gpt-4-turbo\", \"gpt-4-vision\", etc. @gotags: form:\"name_prefix\" | (optional) defaults to undefined|
211
+
212
+
213
+ ### Return type
214
+
215
+ **ProviderModelListResponse**
216
+
217
+ ### Authorization
218
+
219
+ No authorization required
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: Not defined
224
+ - **Accept**: application/json
225
+
226
+
227
+ ### HTTP response details
228
+ | Status code | Description | Response headers |
229
+ |-------------|-------------|------------------|
230
+ |**200** | OK | - |
231
+ |**0** | Default error response | - |
232
+
233
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
234
+
235
+ # **providerModelAdminServiceProviderModelUpdate**
236
+ > ProviderModelUpdateResponse providerModelAdminServiceProviderModelUpdate(providerModelUpdateRequest)
237
+
238
+ ProviderModelUpdate 更新现有的 ProviderModel Update an existing provider model 请求路径: POST /admin/provider-model/update Request path: POST /admin/provider-model/update 权限要求: 需要管理员权限 Permission: Requires admin authentication
239
+
240
+ ### Example
241
+
242
+ ```typescript
243
+ import {
244
+ ProviderModelAdminServiceApi,
245
+ Configuration,
246
+ ProviderModelUpdateRequest
247
+ } from '@cherryin/api-client';
248
+
249
+ const configuration = new Configuration();
250
+ const apiInstance = new ProviderModelAdminServiceApi(configuration);
251
+
252
+ let providerModelUpdateRequest: ProviderModelUpdateRequest; //
253
+
254
+ const { status, data } = await apiInstance.providerModelAdminServiceProviderModelUpdate(
255
+ providerModelUpdateRequest
256
+ );
257
+ ```
258
+
259
+ ### Parameters
260
+
261
+ |Name | Type | Description | Notes|
262
+ |------------- | ------------- | ------------- | -------------|
263
+ | **providerModelUpdateRequest** | **ProviderModelUpdateRequest**| | |
264
+
265
+
266
+ ### Return type
267
+
268
+ **ProviderModelUpdateResponse**
269
+
270
+ ### Authorization
271
+
272
+ No authorization required
273
+
274
+ ### HTTP request headers
275
+
276
+ - **Content-Type**: application/json
277
+ - **Accept**: application/json
278
+
279
+
280
+ ### HTTP response details
281
+ | Status code | Description | Response headers |
282
+ |-------------|-------------|------------------|
283
+ |**200** | OK | - |
284
+ |**0** | Default error response | - |
285
+
286
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
287
+
@@ -0,0 +1,29 @@
1
+ # ProviderModelCreateRequest
2
+
3
+ ProviderModelCreateRequest 创建 ProviderModel 的请求 Request message for creating a new provider model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **provider_id** | **string** | provider_id 关联的 Provider ID Associated Provider ID | [optional] [default to undefined]
10
+ **name** | **string** | name 模型的唯一名称标识,例如 \"gpt-4-turbo\" Unique name identifier for the model, e.g., \"gpt-4-turbo\" | [optional] [default to undefined]
11
+ **display_name** | **string** | display_name 模型的显示名称,例如 \"GPT-4 Turbo\" Display name for the model, e.g., \"GPT-4 Turbo\" | [optional] [default to undefined]
12
+ **status** | **number** | status 模型状态 Model status 1: 草稿 (Draft) 2: 启用 (Active) 3: 禁用 (Disabled) | [optional] [default to undefined]
13
+ **payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情 Configuration details for the model | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { ProviderModelCreateRequest } from '@cherryin/api-client';
19
+
20
+ const instance: ProviderModelCreateRequest = {
21
+ provider_id,
22
+ name,
23
+ display_name,
24
+ status,
25
+ payload,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # ProviderModelCreateResponse
2
+
3
+ ProviderModelCreateResponse 创建 ProviderModel 的响应 Response message for provider model creation
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**ProviderModel**](ProviderModel.md) | data 创建成功后返回的 ProviderModel 信息 ProviderModel information returned after successful creation | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ProviderModelCreateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: ProviderModelCreateResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # ProviderModelDeleteRequest
2
+
3
+ ProviderModelDeleteRequest 删除 ProviderModel 的请求 Request message for deleting a provider model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 要删除的 ProviderModel 的唯一标识符 Unique identifier of the provider model to delete @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ProviderModelDeleteRequest } from '@cherryin/api-client';
15
+
16
+ const instance: ProviderModelDeleteRequest = {
17
+ id,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # ProviderModelDeleteResponse
2
+
3
+ ProviderModelDeleteResponse 删除 ProviderModel 的响应 Response message for provider model deletion
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ProviderModelDeleteResponse } from '@cherryin/api-client';
16
+
17
+ const instance: ProviderModelDeleteResponse = {
18
+ code,
19
+ message,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # ProviderModelGetResponse
2
+
3
+ ProviderModelGetResponse 获取单个 ProviderModel 的响应 Response message for provider model retrieval
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**ProviderModel**](ProviderModel.md) | data ProviderModel 信息 ProviderModel information | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ProviderModelGetResponse } from '@cherryin/api-client';
17
+
18
+ const instance: ProviderModelGetResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # ProviderModelListResponse
2
+
3
+ ProviderModelListResponse 分页查询 ProviderModel 列表的响应 Response message for provider model listing
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **list** | [**Array<ProviderModel>**](ProviderModel.md) | list ProviderModel 列表 List of provider models | [optional] [default to undefined]
12
+ **total** | **string** | total 符合条件的 ProviderModel 总数 Total number of provider models matching the filter criteria | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ProviderModelListResponse } from '@cherryin/api-client';
18
+
19
+ const instance: ProviderModelListResponse = {
20
+ code,
21
+ message,
22
+ list,
23
+ total,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # ProviderModelPayload
2
+
3
+ ProviderModelPayload contains the endpoint configuration for a provider model ProviderModel 的配置详情,包含端点配置
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | endpoints 端点配置列表 - 供应商往往支持多个 API 规范 List of endpoint configurations - providers often support multiple API specifications | [optional] [default to undefined]
10
+ **azure_api_version** | **string** | azure_api_version Azure API 版本,仅当使用 Azure OpenAI 服务时需要配置 | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ProviderModelPayload } from '@cherryin/api-client';
16
+
17
+ const instance: ProviderModelPayload = {
18
+ endpoints,
19
+ azure_api_version,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # ProviderModelUpdateRequest
2
+
3
+ ProviderModelUpdateRequest 更新 ProviderModel 的请求 Request message for updating an existing provider model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id ProviderModel 的唯一标识符 Unique identifier of the provider model to update | [optional] [default to undefined]
10
+ **provider_id** | **string** | provider_id 关联的 Provider ID Associated Provider ID | [optional] [default to undefined]
11
+ **name** | **string** | name 模型的唯一名称标识 Unique name identifier for the model | [optional] [default to undefined]
12
+ **display_name** | **string** | display_name 模型的显示名称 Display name for the model | [optional] [default to undefined]
13
+ **status** | **number** | status 模型状态 Model status 1: 草稿 (Draft) 2: 启用 (Active) 3: 禁用 (Disabled) | [optional] [default to undefined]
14
+ **payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情 Configuration details for the model | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { ProviderModelUpdateRequest } from '@cherryin/api-client';
20
+
21
+ const instance: ProviderModelUpdateRequest = {
22
+ id,
23
+ provider_id,
24
+ name,
25
+ display_name,
26
+ status,
27
+ payload,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # ProviderModelUpdateResponse
2
+
3
+ ProviderModelUpdateResponse 更新 ProviderModel 的响应 Response message for provider model update
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**ProviderModel**](ProviderModel.md) | data 更新后的 ProviderModel 信息 Updated provider model information | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ProviderModelUpdateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: ProviderModelUpdateResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # ProviderPayload
2
+
3
+ ProviderPayload 包含 Provider 的认证和配置详情 Provider payload contains authentication and configuration details
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 认证配置信息 Authentication configuration for the provider | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ProviderPayload } from '@cherryin/api-client';
15
+
16
+ const instance: ProviderPayload = {
17
+ provider_auth,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # ProviderUpdateRequest
2
+
3
+ ProviderUpdateRequest 更新 Provider 的请求 Request message for updating an existing provider
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id Provider 的唯一标识符 Unique identifier of the provider to update | [optional] [default to undefined]
10
+ **name** | **string** | name Provider 的唯一名称标识 Unique name identifier for the provider 如果修改名称,必须确保新名称唯一 If changing name, must ensure new name is unique | [optional] [default to undefined]
11
+ **display_name** | **string** | display_name Provider 的显示名称 Display name for the provider | [optional] [default to undefined]
12
+ **provider_type** | **string** | provider_type Provider 类型 Provider type 可选值: \"openai\", \"anthropic\", \"google\" Available values: \"openai\", \"anthropic\", \"google\" | [optional] [default to undefined]
13
+ **provider_status** | **number** | provider_status Provider 状态 Provider status 1: 启用 (Active) 2: 禁用 (Disabled) | [optional] [default to undefined]
14
+ **payload** | [**ProviderPayload**](ProviderPayload.md) | payload Provider 的认证和配置详情 Authentication and configuration details for the provider | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { ProviderUpdateRequest } from '@cherryin/api-client';
20
+
21
+ const instance: ProviderUpdateRequest = {
22
+ id,
23
+ name,
24
+ display_name,
25
+ provider_type,
26
+ provider_status,
27
+ payload,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # ProviderUpdateResponse
2
+
3
+ ProviderUpdateResponse 更新 Provider 的响应 Response message for provider update
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,0 表示成功 Response code, 0 indicates success | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 Response message | [optional] [default to undefined]
11
+ **data** | [**Provider**](Provider.md) | data 更新后的 Provider 信息 Updated provider information | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ProviderUpdateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: ProviderUpdateResponse = {
19
+ code,
20
+ message,
21
+ data,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # RequestPricing
2
+
3
+ RequestPricing 请求级别计费 Request-level pricing
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **base_fee** | **string** | base_fee 每请求基础费用 Base fee per request | [optional] [default to undefined]
10
+ **per_thousand_requests** | **string** | per_thousand_requests 每千次请求费用 Fee per thousand requests | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { RequestPricing } from '@cherryin/api-client';
16
+
17
+ const instance: RequestPricing = {
18
+ base_fee,
19
+ per_thousand_requests,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Status.md ADDED
@@ -0,0 +1,25 @@
1
+ # Status
2
+
3
+ The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **number** | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. | [optional] [default to undefined]
10
+ **message** | **string** | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. | [optional] [default to undefined]
11
+ **details** | [**Array<GoogleProtobufAny>**](GoogleProtobufAny.md) | A list of messages that carry the error details. There is a common set of message types for APIs to use. | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { Status } from '@cherryin/api-client';
17
+
18
+ const instance: Status = {
19
+ code,
20
+ message,
21
+ details,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)