@cherryin/api-client 0.0.18 → 0.0.20

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 (121) hide show
  1. package/.openapi-generator/FILES +46 -42
  2. package/README.md +70 -64
  3. package/api.ts +3089 -2216
  4. package/dist/api.d.ts +2068 -1343
  5. package/dist/api.js +723 -470
  6. package/dist/esm/api.d.ts +2068 -1343
  7. package/dist/esm/api.js +723 -470
  8. package/docs/AIModelAdminServiceApi.md +98 -87
  9. package/docs/AIModelPricingConfig.md +10 -10
  10. package/docs/AdminAIModel.md +73 -0
  11. package/docs/{AIModelCheckConnectionResponse.md → AdminAIModelCheckConnectionResponse.md} +4 -4
  12. package/docs/{AIModelCheckItem.md → AdminAIModelCheckItem.md} +3 -3
  13. package/docs/{AIModelCheckResult.md → AdminAIModelCheckResult.md} +5 -5
  14. package/docs/AdminAIModelCreateRequest.md +63 -0
  15. package/docs/AdminAIModelCreateResponse.md +25 -0
  16. package/docs/{AIModelDeleteResponse.md → AdminAIModelDeleteResponse.md} +4 -4
  17. package/docs/AdminAIModelDisableRequest.md +23 -0
  18. package/docs/AdminAIModelDisableResponse.md +25 -0
  19. package/docs/{AIModelDiscountConfig.md → AdminAIModelDiscountConfig.md} +4 -4
  20. package/docs/{AIModelGetResponse.md → AdminAIModelGetResponse.md} +5 -5
  21. package/docs/{AIModelListResponse.md → AdminAIModelListResponse.md} +5 -5
  22. package/docs/AdminAIModelProviderConfigItem.md +29 -0
  23. package/docs/AdminAIModelPublishRequest.md +23 -0
  24. package/docs/{AIModelDisableResponse.md → AdminAIModelPublishResponse.md} +5 -5
  25. package/docs/AdminAIModelUpdateRequest.md +25 -0
  26. package/docs/{AIModelUpdateResponse.md → AdminAIModelUpdateResponse.md} +5 -5
  27. package/docs/AdminProvider.md +46 -0
  28. package/docs/AdminProviderCreateRequest.md +39 -0
  29. package/docs/AdminProviderCreateResponse.md +25 -0
  30. package/docs/{ProviderModelDeleteResponse.md → AdminProviderDeleteResponse.md} +4 -4
  31. package/docs/AdminProviderGetResponse.md +25 -0
  32. package/docs/AdminProviderListResponse.md +27 -0
  33. package/docs/AdminProviderModel.md +66 -0
  34. package/docs/AdminProviderModelCreateRequest.md +59 -0
  35. package/docs/AdminProviderModelCreateResponse.md +25 -0
  36. package/docs/{ProviderDeleteResponse.md → AdminProviderModelDeleteResponse.md} +4 -4
  37. package/docs/{ProviderGetResponse.md → AdminProviderModelGetResponse.md} +5 -5
  38. package/docs/{ProviderModelListResponse.md → AdminProviderModelListResponse.md} +6 -6
  39. package/docs/AdminProviderModelUpdateRequest.md +25 -0
  40. package/docs/{AIModelCreateResponse.md → AdminProviderModelUpdateResponse.md} +5 -5
  41. package/docs/AdminProviderUpdateRequest.md +25 -0
  42. package/docs/{AIModelPublishResponse.md → AdminProviderUpdateResponse.md} +5 -5
  43. package/docs/AudioPricing.md +8 -8
  44. package/docs/DiscountDeleteResponse.md +1 -1
  45. package/docs/DiscountGetResponse.md +1 -1
  46. package/docs/DiscountListResponse.md +1 -1
  47. package/docs/DiscountUpdateResponse.md +1 -1
  48. package/docs/FeatureCostPricing.md +5 -5
  49. package/docs/FrontAIModel.md +15 -17
  50. package/docs/FrontendModelCost.md +57 -0
  51. package/docs/FrontendModelExtraInfo.md +21 -0
  52. package/docs/FrontendModelsResponse.md +29 -0
  53. package/docs/FrontendProviderInfo.md +31 -0
  54. package/docs/FrontendProviderModel.md +55 -0
  55. package/docs/FrontendProvidersResponse.md +29 -0
  56. package/docs/FrontendSearchContextCost.md +25 -0
  57. package/docs/ImagePricing.md +7 -7
  58. package/docs/LabelCreateResponse.md +1 -1
  59. package/docs/LabelDeleteResponse.md +1 -1
  60. package/docs/LabelListResponse.md +1 -1
  61. package/docs/LabelUpdateResponse.md +1 -1
  62. package/docs/ModelCapabilities.md +59 -0
  63. package/docs/ModelLimits.md +41 -0
  64. package/docs/{UserModelListResponse.md → ModelListResponse.md} +10 -11
  65. package/docs/ModelModalities.md +23 -0
  66. package/docs/MultimodalPricing.md +4 -4
  67. package/docs/PricingConditions.md +7 -7
  68. package/docs/PricingRules.md +6 -6
  69. package/docs/{AWSAuth.md → ProviderAWSAuth.md} +4 -3
  70. package/docs/ProviderAdminServiceApi.md +74 -53
  71. package/docs/ProviderAuth.md +6 -6
  72. package/docs/ProviderGCPAuth.md +27 -0
  73. package/docs/ProviderModelAdminServiceApi.md +74 -56
  74. package/docs/RequestPricing.md +3 -3
  75. package/docs/TextTokenInputPricing.md +5 -5
  76. package/docs/TextTokenOutputPricing.md +4 -4
  77. package/docs/TextTokenPricing.md +3 -3
  78. package/docs/TokenTier.md +4 -4
  79. package/docs/UserAPIKey.md +15 -15
  80. package/docs/UserAPIKeyCreateRequest.md +9 -9
  81. package/docs/UserAPIKeyCreateResponse.md +4 -4
  82. package/docs/UserAPIKeyDeleteResponse.md +3 -3
  83. package/docs/UserAPIKeyGetResponse.md +4 -4
  84. package/docs/UserAPIKeyListResponse.md +5 -5
  85. package/docs/UserAPIKeyServiceApi.md +26 -27
  86. package/docs/UserAPIKeyUpdateResponse.md +3 -3
  87. package/docs/UserBalanceChangeResponse.md +2 -2
  88. package/docs/UserBalanceEditResponse.md +2 -2
  89. package/docs/UserBalanceListResponse.md +2 -2
  90. package/docs/UserBalanceServiceApi.md +4 -4
  91. package/docs/UserLabelListResponse.md +1 -1
  92. package/docs/UserLabelPairChangeResponse.md +1 -1
  93. package/docs/UserModelServiceApi.md +124 -11
  94. package/docs/VersionedAPISchema.md +6 -6
  95. package/docs/VideoPricing.md +8 -8
  96. package/package.json +1 -1
  97. package/docs/AIModel.md +0 -45
  98. package/docs/AIModelArchitecture.md +0 -25
  99. package/docs/AIModelCreateRequest.md +0 -35
  100. package/docs/AIModelDeleteRequest.md +0 -21
  101. package/docs/AIModelDisableRequest.md +0 -21
  102. package/docs/AIModelMeta.md +0 -25
  103. package/docs/AIModelProviderConfigItem.md +0 -29
  104. package/docs/AIModelPublishRequest.md +0 -21
  105. package/docs/AIModelUpdateRequest.md +0 -37
  106. package/docs/GCPAuth.md +0 -27
  107. package/docs/Provider.md +0 -37
  108. package/docs/ProviderCreateRequest.md +0 -29
  109. package/docs/ProviderCreateResponse.md +0 -25
  110. package/docs/ProviderListResponse.md +0 -27
  111. package/docs/ProviderModel.md +0 -37
  112. package/docs/ProviderModelCreateRequest.md +0 -29
  113. package/docs/ProviderModelCreateResponse.md +0 -25
  114. package/docs/ProviderModelGetResponse.md +0 -25
  115. package/docs/ProviderModelPayload.md +0 -23
  116. package/docs/ProviderModelUpdateRequest.md +0 -31
  117. package/docs/ProviderModelUpdateResponse.md +0 -25
  118. package/docs/ProviderPayload.md +0 -21
  119. package/docs/ProviderUpdateRequest.md +0 -31
  120. package/docs/ProviderUpdateResponse.md +0 -25
  121. package/docs/UserAPIKeyDeleteRequest.md +0 -21
@@ -0,0 +1,59 @@
1
+ # AdminProviderModelCreateRequest
2
+
3
+ AdminProviderModelCreateRequest 创建 ProviderModel 的请求
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 模型 ID | [optional] [default to undefined]
10
+ **name** | **string** | name 模型名称 | [optional] [default to undefined]
11
+ **family** | **string** | family 模型家族 | [optional] [default to undefined]
12
+ **source** | **string** | source 模型信息源 | [optional] [default to undefined]
13
+ **model_card** | **string** | model_card 模型卡片 URL | [optional] [default to undefined]
14
+ **temperature** | **boolean** | temperature 是否支持温度参数 | [optional] [default to undefined]
15
+ **knowledge** | **string** | knowledge 知识截止日期 | [optional] [default to undefined]
16
+ **release_date** | **string** | release_date 发布日期 | [optional] [default to undefined]
17
+ **last_updated** | **string** | last_updated 最后更新日期 | [optional] [default to undefined]
18
+ **open_weights** | **boolean** | open_weights 是否开源权重 | [optional] [default to undefined]
19
+ **deprecation_date** | **string** | deprecation_date 弃用日期 | [optional] [default to undefined]
20
+ **context_length** | **string** | 最大上下文长度(即 limits.max_input_tokens + max_output_tokens) | [optional] [default to undefined]
21
+ **modalities** | [**ModelModalities**](ModelModalities.md) | modalities 模态信息 | [optional] [default to undefined]
22
+ **limits** | [**ModelLimits**](ModelLimits.md) | limits 模型限制 | [optional] [default to undefined]
23
+ **capabilities** | [**ModelCapabilities**](ModelCapabilities.md) | capabilities 模型能力 | [optional] [default to undefined]
24
+ **cost** | [**FrontendModelCost**](FrontendModelCost.md) | cost 模型成本 | [optional] [default to undefined]
25
+ **extra_info** | [**FrontendModelExtraInfo**](FrontendModelExtraInfo.md) | extra_info 额外信息 | [optional] [default to undefined]
26
+ **is_official** | **boolean** | 是否为官方供应商,官方供应商会额外写官方供应商表. | [optional] [default to undefined]
27
+ **endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | endpoints 端点配置列表 - 供应商往往支持多个 API 端点 注意,这是 CherryIN 网关独有的配置,需要和 ModelCapabilities.supported_endpoints 进行映射检查 | [optional] [default to undefined]
28
+ **provider_id** | **string** | 关联的 AdminProvider id | [optional] [default to undefined]
29
+
30
+ ## Example
31
+
32
+ ```typescript
33
+ import { AdminProviderModelCreateRequest } from '@cherryin/api-client';
34
+
35
+ const instance: AdminProviderModelCreateRequest = {
36
+ id,
37
+ name,
38
+ family,
39
+ source,
40
+ model_card,
41
+ temperature,
42
+ knowledge,
43
+ release_date,
44
+ last_updated,
45
+ open_weights,
46
+ deprecation_date,
47
+ context_length,
48
+ modalities,
49
+ limits,
50
+ capabilities,
51
+ cost,
52
+ extra_info,
53
+ is_official,
54
+ endpoints,
55
+ provider_id,
56
+ };
57
+ ```
58
+
59
+ [[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
+ # AdminProviderModelCreateResponse
2
+
3
+ AdminProviderModelCreateResponse 创建 ProviderModel 的响应 Response message for provider model creation
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
+ **message** | **string** | | [optional] [default to undefined]
11
+ **data** | [**AdminProviderModel**](AdminProviderModel.md) | data 创建成功后返回的 ProviderModel 信息 | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AdminProviderModelCreateResponse } from '@cherryin/api-client';
17
+
18
+ const instance: AdminProviderModelCreateResponse = {
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)
@@ -1,6 +1,6 @@
1
- # ProviderDeleteResponse
1
+ # AdminProviderModelDeleteResponse
2
2
 
3
- ProviderDeleteResponse 删除 Provider 的响应 Response message for provider deletion
3
+ AdminProviderModelDeleteResponse 删除 ProviderModel 的响应
4
4
 
5
5
  ## Properties
6
6
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import { ProviderDeleteResponse } from '@cherryin/api-client';
15
+ import { AdminProviderModelDeleteResponse } from '@cherryin/api-client';
16
16
 
17
- const instance: ProviderDeleteResponse = {
17
+ const instance: AdminProviderModelDeleteResponse = {
18
18
  code,
19
19
  message,
20
20
  };
@@ -1,6 +1,6 @@
1
- # ProviderGetResponse
1
+ # AdminProviderModelGetResponse
2
2
 
3
- ProviderGetResponse 获取单个 Provider 的响应 Response message for provider retrieval
3
+ AdminProviderModelGetResponse 获取单个 ProviderModel 的响应
4
4
 
5
5
  ## Properties
6
6
 
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
10
  **message** | **string** | | [optional] [default to undefined]
11
- **data** | [**Provider**](Provider.md) | data Provider 信息 Provider information | [optional] [default to undefined]
11
+ **data** | [**AdminProviderModel**](AdminProviderModel.md) | data ProviderModel 信息 | [optional] [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
15
15
  ```typescript
16
- import { ProviderGetResponse } from '@cherryin/api-client';
16
+ import { AdminProviderModelGetResponse } from '@cherryin/api-client';
17
17
 
18
- const instance: ProviderGetResponse = {
18
+ const instance: AdminProviderModelGetResponse = {
19
19
  code,
20
20
  message,
21
21
  data,
@@ -1,6 +1,6 @@
1
- # ProviderModelListResponse
1
+ # AdminProviderModelListResponse
2
2
 
3
- ProviderModelListResponse 分页查询 ProviderModel 列表的响应 Response message for provider model listing
3
+ AdminProviderModelListResponse 分页查询 ProviderModel 列表的响应 Response message for provider model listing
4
4
 
5
5
  ## Properties
6
6
 
@@ -8,15 +8,15 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
10
  **message** | **string** | | [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]
11
+ **list** | [**Array<AdminProviderModel>**](AdminProviderModel.md) | list ProviderModel 列表 | [optional] [default to undefined]
12
+ **total** | **string** | total 符合条件的 ProviderModel 总数 | [optional] [default to undefined]
13
13
 
14
14
  ## Example
15
15
 
16
16
  ```typescript
17
- import { ProviderModelListResponse } from '@cherryin/api-client';
17
+ import { AdminProviderModelListResponse } from '@cherryin/api-client';
18
18
 
19
- const instance: ProviderModelListResponse = {
19
+ const instance: AdminProviderModelListResponse = {
20
20
  code,
21
21
  message,
22
22
  list,
@@ -0,0 +1,25 @@
1
+ # AdminProviderModelUpdateRequest
2
+
3
+ AdminProviderModelUpdateRequest 更新 ProviderModel 的请求 Request message for updating an existing provider model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | Provider 的唯一标识符 | [optional] [default to undefined]
10
+ **record_id** | **string** | Provider 数据库自增 id - record_id optional: id or record_id | [optional] [default to undefined]
11
+ **payload** | [**AdminProviderModel**](AdminProviderModel.md) | payload 模型的配置详情 | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AdminProviderModelUpdateRequest } from '@cherryin/api-client';
17
+
18
+ const instance: AdminProviderModelUpdateRequest = {
19
+ id,
20
+ record_id,
21
+ payload,
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)
@@ -1,6 +1,6 @@
1
- # AIModelCreateResponse
1
+ # AdminProviderModelUpdateResponse
2
2
 
3
- AIModelCreateResponse 创建 AIModel 的响应 Response message for AI model creation
3
+ AdminProviderModelUpdateResponse 更新 ProviderModel 的响应 Response message for provider model update
4
4
 
5
5
  ## Properties
6
6
 
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
10
  **message** | **string** | | [optional] [default to undefined]
11
- **data** | [**AIModel**](AIModel.md) | data 创建成功后返回的 AIModel 信息 AIModel information returned after successful creation | [optional] [default to undefined]
11
+ **data** | [**AdminProviderModel**](AdminProviderModel.md) | data 更新后的 ProviderModel 信息 | [optional] [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
15
15
  ```typescript
16
- import { AIModelCreateResponse } from '@cherryin/api-client';
16
+ import { AdminProviderModelUpdateResponse } from '@cherryin/api-client';
17
17
 
18
- const instance: AIModelCreateResponse = {
18
+ const instance: AdminProviderModelUpdateResponse = {
19
19
  code,
20
20
  message,
21
21
  data,
@@ -0,0 +1,25 @@
1
+ # AdminProviderUpdateRequest
2
+
3
+ AdminProviderUpdateRequest 更新 Provider 的请求 Request message for updating an existing provider
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | Provider 的唯一标识符 | [optional] [default to undefined]
10
+ **record_id** | **string** | Provider 数据库自增 id - record_id optional: id or record_id | [optional] [default to undefined]
11
+ **payload** | [**AdminProvider**](AdminProvider.md) | 需要修改的数据 | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AdminProviderUpdateRequest } from '@cherryin/api-client';
17
+
18
+ const instance: AdminProviderUpdateRequest = {
19
+ id,
20
+ record_id,
21
+ payload,
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)
@@ -1,6 +1,6 @@
1
- # AIModelPublishResponse
1
+ # AdminProviderUpdateResponse
2
2
 
3
- AIModelPublishResponse 发布 AIModel 的响应 Response message for AI model publish
3
+ AdminProviderUpdateResponse 更新 Provider 的响应 Response message for provider update
4
4
 
5
5
  ## Properties
6
6
 
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
10
  **message** | **string** | | [optional] [default to undefined]
11
- **data** | [**AIModel**](AIModel.md) | data 发布后的 AIModel 信息 Published AI model information | [optional] [default to undefined]
11
+ **data** | [**AdminProvider**](AdminProvider.md) | data 更新后的 Provider 信息 | [optional] [default to undefined]
12
12
 
13
13
  ## Example
14
14
 
15
15
  ```typescript
16
- import { AIModelPublishResponse } from '@cherryin/api-client';
16
+ import { AdminProviderUpdateResponse } from '@cherryin/api-client';
17
17
 
18
- const instance: AIModelPublishResponse = {
18
+ const instance: AdminProviderUpdateResponse = {
19
19
  code,
20
20
  message,
21
21
  data,
@@ -1,18 +1,18 @@
1
1
  # AudioPricing
2
2
 
3
- AudioPricing 音频计费 Audio pricing
3
+ AudioPricing 音频计费
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 价格配置ID Price configuration ID | [optional] [default to undefined]
10
- **mode** | **string** | mode 计费模式: \"per_second\", \"per_token\" Pricing mode | [optional] [default to undefined]
11
- **input_per_token** | **string** | input_per_token 输入每Token费用 Input fee per token | [optional] [default to undefined]
12
- **output_per_token** | **string** | output_per_token 输出每Token费用 Output fee per token | [optional] [default to undefined]
13
- **input_per_second** | **string** | input_per_second 输入每秒费用 Input fee per second | [optional] [default to undefined]
14
- **output_per_second** | **string** | output_per_second 输出每秒费用 Output fee per second | [optional] [default to undefined]
15
- **extra** | **{ [key: string]: string; }** | extra 扩展计算 Extra calculation options | [optional] [default to undefined]
9
+ **id** | **string** | id 价格配置ID | [optional] [default to undefined]
10
+ **mode** | **string** | mode 计费模式: \"per_second\", \"per_token\" | [optional] [default to undefined]
11
+ **input_per_token** | **string** | input_per_token 输入每Token费用 | [optional] [default to undefined]
12
+ **output_per_token** | **string** | output_per_token 输出每Token费用 | [optional] [default to undefined]
13
+ **input_per_second** | **string** | input_per_second 输入每秒费用 | [optional] [default to undefined]
14
+ **output_per_second** | **string** | output_per_second 输出每秒费用 | [optional] [default to undefined]
15
+ **extra** | **{ [key: string]: string; }** | extra 扩展计算 | [optional] [default to undefined]
16
16
 
17
17
  ## Example
18
18
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | code 响应状态码,0 表示成功 | [optional] [default to undefined]
8
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
9
9
  **message** | **string** | message 响应消息 | [optional] [default to undefined]
10
10
 
11
11
  ## Example
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | code 响应状态码,0 表示成功 | [optional] [default to undefined]
8
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
9
9
  **message** | **string** | message 响应消息 | [optional] [default to undefined]
10
10
  **discount** | [**DiscountInfo**](DiscountInfo.md) | | [optional] [default to undefined]
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | code 响应状态码,0 表示成功 | [optional] [default to undefined]
8
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
9
9
  **message** | **string** | message 响应消息 | [optional] [default to undefined]
10
10
  **discount** | [**Array<DiscountInfo>**](DiscountInfo.md) | | [optional] [default to undefined]
11
11
  **total** | **string** | | [optional] [default to undefined]
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | code 响应状态码,0 表示成功 | [optional] [default to undefined]
8
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
9
9
  **message** | **string** | message 响应消息 | [optional] [default to undefined]
10
10
  **discount** | [**DiscountInfo**](DiscountInfo.md) | 更新后的 Discount 信息 | [optional] [default to undefined]
11
11
 
@@ -1,15 +1,15 @@
1
1
  # FeatureCostPricing
2
2
 
3
- FeatureCostPricing 特殊功能计费(新版) Feature cost pricing (new version)
3
+ FeatureCostPricing 特殊功能计费(新版)
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 价格配置ID Price configuration ID | [optional] [default to undefined]
10
- **name** | **string** | name 功能名称 Feature name | [optional] [default to undefined]
11
- **per_cost** | **string** | per_cost 每次使用费用 Cost per usage | [optional] [default to undefined]
12
- **extra** | **{ [key: string]: string; }** | extra 扩展规则 Extra rules | [optional] [default to undefined]
9
+ **id** | **string** | id 价格配置ID | [optional] [default to undefined]
10
+ **name** | **string** | name 功能名称 | [optional] [default to undefined]
11
+ **per_cost** | **string** | per_cost 每次使用费用 | [optional] [default to undefined]
12
+ **extra** | **{ [key: string]: string; }** | extra 扩展规则 | [optional] [default to undefined]
13
13
 
14
14
  ## Example
15
15
 
@@ -1,24 +1,23 @@
1
1
  # FrontAIModel
2
2
 
3
- FrontAIModel 代表面向终端用户的 AI 模型配置(符合 OpenAI API 格式) FrontAIModel represents an AI model configuration exposed to end users (OpenAI API compatible)
3
+ FrontAIModel 代表面向终端用户的 AI 模型配置(符合 OpenAI API 格式) 注意,这是最经典、最精简的模型列表,一般不会给很多数据
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 模型的唯一名称标识,例如 \"gpt-4\", \"claude-3-opus\" 对应 OpenAI API 的 \"id\" 字段 Unique name identifier for the model, e.g., \"gpt-4\", \"claude-3-opus\" Maps to OpenAI API \"id\" field | [optional] [default to undefined]
9
+ **id** | **string** | id 模型的唯一名称标识,例如 \"gpt-4\", \"claude-3-opus\" 对应 OpenAI API 的 \"id\" 字段 | [optional] [default to undefined]
10
10
  **name** | **string** | name 模型的唯一名称标识,例如 \"gpt-4\", \"claude-3-opus\" 对应 OpenAI API 的 \"id\" 字段, Gemini 兼容 | [optional] [default to undefined]
11
- **object** | **string** | object 对象类型,固定为 \"model\"(OpenAI API 格式) Object type, always \"model\" (OpenAI API format) | [optional] [default to undefined]
12
- **created** | **string** | created_at 创建时间戳(Unix 时间戳) 对应 OpenAI API 的 \"created\" 字段 Creation timestamp (Unix timestamp) Maps to OpenAI API \"created\" field | [optional] [default to undefined]
13
- **updated** | **string** | updated_at 更新时间戳(Unix 时间戳) Last update timestamp (Unix timestamp) | [optional] [default to undefined]
14
- **display_name** | **string** | display_name 模型的显示名称,例如 \"GPT-4\", \"Claude 3 Opus\" Display name for the model, e.g., \"GPT-4\", \"Claude 3 Opus\" | [optional] [default to undefined]
15
- **description** | **string** | description 模型描述 Model description | [optional] [default to undefined]
11
+ **object** | **string** | object 对象类型,固定为 \"model\"(OpenAI API 格式) | [optional] [default to undefined]
12
+ **created** | **string** | created_at 创建时间戳(Unix 时间戳) 对应 OpenAI API 的 \"created\" 字段 | [optional] [default to undefined]
13
+ **updated** | **string** | updated_at 更新时间戳(Unix 时间戳) | [optional] [default to undefined]
14
+ **display_name** | **string** | display_name 模型的显示名称,例如 \"GPT-4\", \"Claude 3 Opus\" | [optional] [default to undefined]
15
+ **baseModelID** | **string** | gemini 接口兼容的基础模型 ID,而且是必须字段,例如 \"gemini-1.5-pro\" json tag 也需要遵循 gemini 命名规范 - camelCase | [optional] [default to undefined]
16
+ **description** | **string** | description 模型描述 | [optional] [default to undefined]
16
17
  **status** | **number** | status 模型状态 Model status 1: 草稿 (Draft) 2: 已发布 (Published) 3: 已禁用 (Disabled) | [optional] [default to undefined]
17
- **meta** | [**AIModelMeta**](AIModelMeta.md) | meta 元数据 Metadata | [optional] [default to undefined]
18
- **pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | pricing_configs 价格配置列表(支持多货币和多种价格类型) Pricing configurations (supports multiple currencies and pricing types) | [optional] [default to undefined]
19
- **owned_by** | **string** | owned_by 模型所有者,例如 \"openai\", \"anthropic\", \"organization-owner\"(OpenAI API 格式) Model owner, e.g., \"openai\", \"anthropic\", \"organization-owner\" (OpenAI API format) | [optional] [default to undefined]
20
- **internal_id** | **string** | internal_id AIModel 的内部数据库 ID Internal database ID for the AI model | [optional] [default to undefined]
21
- **baseModelID** | **string** | gemini 接口兼容的基础模型 ID,而且是必须字段,例如 \"gemini-1.5-pro\" json tag 也需要遵循 gemini 命名规范 - camelCase Gemini-compatible base model ID, also a required field, e.g., \"gemini-1.5-pro\" json tag also needs to follow gemini naming convention - camelCase | [optional] [default to undefined]
18
+ **modalities** | [**ModelModalities**](ModelModalities.md) | modalities 模态信息 | [optional] [default to undefined]
19
+ **limits** | [**ModelLimits**](ModelLimits.md) | limits 模型限制 | [optional] [default to undefined]
20
+ **provider_id** | **string** | 关联的供应商 id (一般是 FrontendProviderInfo.id) | [optional] [default to undefined]
22
21
 
23
22
  ## Example
24
23
 
@@ -32,13 +31,12 @@ const instance: FrontAIModel = {
32
31
  created,
33
32
  updated,
34
33
  display_name,
34
+ baseModelID,
35
35
  description,
36
36
  status,
37
- meta,
38
- pricing_configs,
39
- owned_by,
40
- internal_id,
41
- baseModelID,
37
+ modalities,
38
+ limits,
39
+ provider_id,
42
40
  };
43
41
  ```
44
42
 
@@ -0,0 +1,57 @@
1
+ # FrontendModelCost
2
+
3
+ FrontendModelCost 模型成本 Model cost
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **free** | **boolean** | free 是否免费 | [optional] [default to undefined]
10
+ **input_cost_per_token** | **number** | input_cost_per_token 输入每 token 成本 | [optional] [default to undefined]
11
+ **input_cost_per_token_above_128k_tokens** | **number** | input_cost_per_token_above_128k_tokens 超过 128k token 时的输入每 token 成本 | [optional] [default to undefined]
12
+ **input_cost_per_token_above_200k_tokens** | **number** | input_cost_per_token_above_200k_tokens 超过 200k token 时的输入每 token 成本 | [optional] [default to undefined]
13
+ **input_cost_per_token_batches** | **number** | input_cost_per_token_batches 批量输入每 token 成本 | [optional] [default to undefined]
14
+ **input_cost_per_audio_token** | **number** | input_cost_per_audio_token 输入每音频 token 成本 | [optional] [default to undefined]
15
+ **input_cost_per_image** | **number** | input_cost_per_image 输入每图片成本 | [optional] [default to undefined]
16
+ **input_cost_per_pixel** | **number** | input_cost_per_pixel 输入每像素成本 | [optional] [default to undefined]
17
+ **output_cost_per_token** | **number** | output_cost_per_token 输出每 token 成本 | [optional] [default to undefined]
18
+ **output_cost_per_token_above_200k_tokens** | **number** | output_cost_per_token_above_200k_tokens 超过 200k token 时的输出每 token 成本 | [optional] [default to undefined]
19
+ **output_cost_per_token_above_128k_tokens** | **number** | output_cost_per_token_above_128k_tokens 超过 128k token 时的输出每 token 成本 | [optional] [default to undefined]
20
+ **output_cost_per_token_batches** | **number** | output_cost_per_token_batches 批量输出每 token 成本 | [optional] [default to undefined]
21
+ **output_cost_per_image** | **number** | output_cost_per_image 输出每图片成本 | [optional] [default to undefined]
22
+ **output_cost_per_pixel** | **number** | output_cost_per_pixel 输出每像素成本 | [optional] [default to undefined]
23
+ **cache_read_input_token_cost** | **number** | cache_read_input_token_cost 缓存读取输入 token 成本 | [optional] [default to undefined]
24
+ **cache_read_input_token_cost_above_200k_tokens** | **number** | cache_read_input_token_cost_above_200k_tokens 超过 200k token 时的缓存读取输入 token 成本 | [optional] [default to undefined]
25
+ **cache_creation_input_token_cost** | **number** | cache_creation_input_token_cost 缓存创建输入 token 成本 | [optional] [default to undefined]
26
+ **cache_creation_input_token_cost_above_200k_tokens** | **number** | cache_creation_input_token_cost_above_200k_tokens 超过 200k token 时的缓存创建输入 token 成本 | [optional] [default to undefined]
27
+ **search_context_cost_per_query** | [**FrontendSearchContextCost**](FrontendSearchContextCost.md) | search_context_cost_per_query 搜索上下文成本 | [optional] [default to undefined]
28
+
29
+ ## Example
30
+
31
+ ```typescript
32
+ import { FrontendModelCost } from '@cherryin/api-client';
33
+
34
+ const instance: FrontendModelCost = {
35
+ free,
36
+ input_cost_per_token,
37
+ input_cost_per_token_above_128k_tokens,
38
+ input_cost_per_token_above_200k_tokens,
39
+ input_cost_per_token_batches,
40
+ input_cost_per_audio_token,
41
+ input_cost_per_image,
42
+ input_cost_per_pixel,
43
+ output_cost_per_token,
44
+ output_cost_per_token_above_200k_tokens,
45
+ output_cost_per_token_above_128k_tokens,
46
+ output_cost_per_token_batches,
47
+ output_cost_per_image,
48
+ output_cost_per_pixel,
49
+ cache_read_input_token_cost,
50
+ cache_read_input_token_cost_above_200k_tokens,
51
+ cache_creation_input_token_cost,
52
+ cache_creation_input_token_cost_above_200k_tokens,
53
+ search_context_cost_per_query,
54
+ };
55
+ ```
56
+
57
+ [[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
+ # FrontendModelExtraInfo
2
+
3
+ FrontendModelExtraInfo 模型额外信息 Model extra information
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **tool_use_system_prompt_tokens** | **number** | tool_use_system_prompt_tokens 工具使用系统提示词 token 数 Tool use system prompt tokens count | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { FrontendModelExtraInfo } from '@cherryin/api-client';
15
+
16
+ const instance: FrontendModelExtraInfo = {
17
+ tool_use_system_prompt_tokens,
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,29 @@
1
+ # FrontendModelsResponse
2
+
3
+ FrontendModelsResponse 前端模型列表响应
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | code 响应状态码,200 表示成功 | [optional] [default to undefined]
10
+ **message** | **string** | message 响应消息 | [optional] [default to undefined]
11
+ **data** | [**Array<FrontendProviderModel>**](FrontendProviderModel.md) | data 模型列表 | [optional] [default to undefined]
12
+ **total** | **string** | total 总数量(分页时返回) | [optional] [default to undefined]
13
+ **has_more** | **boolean** | has_more 是否还有更多数据 | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { FrontendModelsResponse } from '@cherryin/api-client';
19
+
20
+ const instance: FrontendModelsResponse = {
21
+ code,
22
+ message,
23
+ data,
24
+ total,
25
+ has_more,
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,31 @@
1
+ # FrontendProviderInfo
2
+
3
+ FrontendProviderInfo 供应商信息 Provider information
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 供应商 ID | [optional] [default to undefined]
10
+ **name** | **string** | name 供应商名称 | [optional] [default to undefined]
11
+ **env** | **Array<string>** | env 供应商使用的环境变量 | [optional] [default to undefined]
12
+ **npm** | **string** | npm 供应商提供的 NPM 包 | [optional] [default to undefined]
13
+ **api** | **string** | api 供应商的 API BaseURL | [optional] [default to undefined]
14
+ **doc** | **string** | doc 供应商官方文档地址 | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { FrontendProviderInfo } from '@cherryin/api-client';
20
+
21
+ const instance: FrontendProviderInfo = {
22
+ id,
23
+ name,
24
+ env,
25
+ npm,
26
+ api,
27
+ doc,
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,55 @@
1
+ # FrontendProviderModel
2
+
3
+ FrontendProviderModel 供应商模型信息
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id 模型 ID | [optional] [default to undefined]
10
+ **name** | **string** | name 模型名称 | [optional] [default to undefined]
11
+ **family** | **string** | family 模型家族 | [optional] [default to undefined]
12
+ **source** | **string** | source 模型信息源 | [optional] [default to undefined]
13
+ **model_card** | **string** | model_card 模型卡片 URL | [optional] [default to undefined]
14
+ **temperature** | **boolean** | temperature 是否支持温度参数 | [optional] [default to undefined]
15
+ **knowledge** | **string** | knowledge 知识截止日期 | [optional] [default to undefined]
16
+ **release_date** | **string** | release_date 发布日期 | [optional] [default to undefined]
17
+ **last_updated** | **string** | last_updated 最后更新日期 | [optional] [default to undefined]
18
+ **open_weights** | **boolean** | open_weights 是否开源权重 | [optional] [default to undefined]
19
+ **deprecation_date** | **string** | deprecation_date 弃用日期 | [optional] [default to undefined]
20
+ **context_length** | **string** | 最大上下文长度(即 limits.max_input_tokens + max_output_tokens) | [optional] [default to undefined]
21
+ **modalities** | [**ModelModalities**](ModelModalities.md) | modalities 模态信息 | [optional] [default to undefined]
22
+ **limits** | [**ModelLimits**](ModelLimits.md) | limits 模型限制 | [optional] [default to undefined]
23
+ **capabilities** | [**ModelCapabilities**](ModelCapabilities.md) | capabilities 模型能力 | [optional] [default to undefined]
24
+ **cost** | [**FrontendModelCost**](FrontendModelCost.md) | cost 模型成本 | [optional] [default to undefined]
25
+ **extra_info** | [**FrontendModelExtraInfo**](FrontendModelExtraInfo.md) | extra_info 额外信息 | [optional] [default to undefined]
26
+ **provider_id** | **string** | 关联的供应商 id (一般是 FrontendProviderInfo.id) | [optional] [default to undefined]
27
+
28
+ ## Example
29
+
30
+ ```typescript
31
+ import { FrontendProviderModel } from '@cherryin/api-client';
32
+
33
+ const instance: FrontendProviderModel = {
34
+ id,
35
+ name,
36
+ family,
37
+ source,
38
+ model_card,
39
+ temperature,
40
+ knowledge,
41
+ release_date,
42
+ last_updated,
43
+ open_weights,
44
+ deprecation_date,
45
+ context_length,
46
+ modalities,
47
+ limits,
48
+ capabilities,
49
+ cost,
50
+ extra_info,
51
+ provider_id,
52
+ };
53
+ ```
54
+
55
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)