@cherryin/api-client 0.0.19 → 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 (120) hide show
  1. package/.openapi-generator/FILES +46 -41
  2. package/README.md +69 -62
  3. package/api.ts +3081 -2198
  4. package/dist/api.d.ts +2070 -1336
  5. package/dist/api.js +712 -458
  6. package/dist/esm/api.d.ts +2070 -1336
  7. package/dist/esm/api.js +712 -458
  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 +21 -21
  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
@@ -6,12 +6,12 @@ VersionedAPISchema represents a versioned API schema configuration 代表一个
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 约定的 ID Conventional ID | [optional] [default to undefined]
10
- **name** | **string** | name API schema 的描述性名称 Descriptive name for the API schema 例如: \"chat/completion\", \"response\" Examples: \"chat/completion\", \"response\" | [optional] [default to undefined]
11
- **schema** | **string** | schema API schema 的名称 Name of the API schema 例如: \"openai\", \"anthropic\" Examples: \"openai\", \"anthropic\" | [optional] [default to undefined]
12
- **version** | **string** | version API schema 的版本(可选) Version of the API schema (optional) | [optional] [default to undefined]
13
- **path** | **string** | path API 端点路径(可选) API path for this endpoint (optional) | [optional] [default to undefined]
14
- **method** | **string** | method HTTP 方法,例如 \"POST\", \"GET\"(可选) HTTP method for this endpoint, e.g., \"POST\", \"GET\" (optional) | [optional] [default to undefined]
9
+ **id** | **string** | id 约定的 ID | [optional] [default to undefined]
10
+ **name** | **string** | name API schema 的描述性名称 例如: \"chat/completion\", \"response\" | [optional] [default to undefined]
11
+ **schema** | **string** | schema API schema 的名称 例如: \"openai\", \"anthropic\" | [optional] [default to undefined]
12
+ **version** | **string** | version API schema 的版本(可选) | [optional] [default to undefined]
13
+ **path** | **string** | path API 端点路径(可选) | [optional] [default to undefined]
14
+ **method** | **string** | method HTTP 方法,例如 \"POST\", \"GET\"(可选) | [optional] [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
@@ -1,18 +1,18 @@
1
1
  # VideoPricing
2
2
 
3
- VideoPricing 视频计费 Video pricing
3
+ VideoPricing 视频计费
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
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cherryin/api-client",
3
- "version": "0.0.19",
3
+ "version": "0.0.20",
4
4
  "description": "OpenAPI client for @cherryin/api-client",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
package/docs/AIModel.md DELETED
@@ -1,45 +0,0 @@
1
- # AIModel
2
-
3
- AIModel 代表面向终端用户的 AI 模型配置 - 内部统一定义,提供给用户的是裁剪信息后的 FrontAIModel AIModel represents an AI model configuration exposed to end users
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id AIModel 的唯一标识符 Unique identifier for the AI model | [optional] [default to undefined]
10
- **created_at** | **string** | created_at 创建时间戳(Unix 时间戳) Creation timestamp (Unix timestamp) | [optional] [default to undefined]
11
- **updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) Last update timestamp (Unix timestamp) | [optional] [default to undefined]
12
- **deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 Soft deletion timestamp, 0 means not deleted | [optional] [default to undefined]
13
- **name** | **string** | name 模型的唯一名称标识,例如 \"gpt-4\", \"claude-3-opus\" Unique name identifier for the model, e.g., \"gpt-4\", \"claude-3-opus\" | [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
- **group** | **string** | group 模型分组,例如 \"gpt-4\", \"claude-3\" Model group, e.g., \"gpt-4\", \"claude-3\" | [optional] [default to undefined]
16
- **description** | **string** | description 模型描述 Model description | [optional] [default to undefined]
17
- **status** | **number** | status 模型状态 Model status 1: 草稿 (Draft) 2: 已发布 (Published) 3: 已禁用 (Disabled) | [optional] [default to undefined]
18
- **meta** | [**AIModelMeta**](AIModelMeta.md) | meta 元数据 Metadata | [optional] [default to undefined]
19
- **provider_configs** | [**Array<AIModelProviderConfigItem>**](AIModelProviderConfigItem.md) | provider_configs Provider 配置列表 Provider configuration list | [optional] [default to undefined]
20
- **pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | pricing_configs 价格配置列表 (NEW) Pricing configurations | [optional] [default to undefined]
21
- **discount_config** | [**AIModelDiscountConfig**](AIModelDiscountConfig.md) | discount_config 折扣配置 | [optional] [default to undefined]
22
-
23
- ## Example
24
-
25
- ```typescript
26
- import { AIModel } from '@cherryin/api-client';
27
-
28
- const instance: AIModel = {
29
- id,
30
- created_at,
31
- updated_at,
32
- deleted_at,
33
- name,
34
- display_name,
35
- group,
36
- description,
37
- status,
38
- meta,
39
- provider_configs,
40
- pricing_configs,
41
- discount_config,
42
- };
43
- ```
44
-
45
- [[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,25 +0,0 @@
1
- # AIModelArchitecture
2
-
3
- AIModelArchitecture AI模型架构信息 AI model architecture information
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **modality** | **string** | modality 模态类型,例如 \"text+image->text\" Modality type, e.g., \"text+image->text\" | [optional] [default to undefined]
10
- **input_modalities** | **Array<string>** | input_modalities 输入模态列表,例如 [\"file\", \"image\", \"text\", \"audio\"] List of input modalities, e.g., [\"file\", \"image\", \"text\", \"audio\"] | [optional] [default to undefined]
11
- **output_modalities** | **Array<string>** | output_modalities 输出模态列表,例如 [\"text\"] List of output modalities, e.g., [\"text\"] | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { AIModelArchitecture } from '@cherryin/api-client';
17
-
18
- const instance: AIModelArchitecture = {
19
- modality,
20
- input_modalities,
21
- output_modalities,
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,35 +0,0 @@
1
- # AIModelCreateRequest
2
-
3
- AIModelCreateRequest 创建 AIModel 的请求(草稿状态) Request message for creating a new AI model (draft status)
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **name** | **string** | name 模型的唯一名称标识,例如 \"gpt-4\" Unique name identifier for the model, e.g., \"gpt-4\" | [optional] [default to undefined]
10
- **display_name** | **string** | display_name 模型的显示名称,例如 \"GPT-4\" Display name for the model, e.g., \"GPT-4\" | [optional] [default to undefined]
11
- **group** | **string** | group 模型分组,例如 \"gpt-4\" Model group, e.g., \"gpt-4\" | [optional] [default to undefined]
12
- **description** | **string** | description 模型描述(可选) Model description (optional) | [optional] [default to undefined]
13
- **meta** | [**AIModelMeta**](AIModelMeta.md) | meta 元数据(可选) Metadata (optional) | [optional] [default to undefined]
14
- **pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | pricing_configs 价格配置列表(可选,草稿时可为空) Pricing configurations (optional, can be empty for draft) | [optional] [default to undefined]
15
- **provider_configs** | [**Array<AIModelProviderConfigItem>**](AIModelProviderConfigItem.md) | provider_configs Provider 配置列表(可选,草稿时可为空) Provider configuration list (optional, can be empty for draft) | [optional] [default to undefined]
16
- **discount_config** | [**AIModelDiscountConfig**](AIModelDiscountConfig.md) | discount_config 折扣配置 | [optional] [default to undefined]
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import { AIModelCreateRequest } from '@cherryin/api-client';
22
-
23
- const instance: AIModelCreateRequest = {
24
- name,
25
- display_name,
26
- group,
27
- description,
28
- meta,
29
- pricing_configs,
30
- provider_configs,
31
- discount_config,
32
- };
33
- ```
34
-
35
- [[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,21 +0,0 @@
1
- # AIModelDeleteRequest
2
-
3
- AIModelDeleteRequest 删除 AIModel 的请求 Request message for deleting an AI model
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 要删除的 AIModel 的唯一标识符 Unique identifier of the AI model to delete @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { AIModelDeleteRequest } from '@cherryin/api-client';
15
-
16
- const instance: AIModelDeleteRequest = {
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)
@@ -1,21 +0,0 @@
1
- # AIModelDisableRequest
2
-
3
- AIModelDisableRequest 禁用 AIModel 的请求 Request message for disabling an AI model
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 要禁用的 AIModel 的唯一标识符 Unique identifier of the AI model to disable @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { AIModelDisableRequest } from '@cherryin/api-client';
15
-
16
- const instance: AIModelDisableRequest = {
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)
@@ -1,25 +0,0 @@
1
- # AIModelMeta
2
-
3
- AIModelMeta AI模型元数据 AI model metadata
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | endpoints 端点配置列表 - 这个模型支持的后端 API 列表 List of endpoint configurations - supported backend APIs for this model | [optional] [default to undefined]
10
- **context_length** | **string** | context_length 上下文长度(token 数量) Context length (number of tokens) | [optional] [default to undefined]
11
- **architecture** | [**AIModelArchitecture**](AIModelArchitecture.md) | architecture 模型架构信息 Model architecture information | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { AIModelMeta } from '@cherryin/api-client';
17
-
18
- const instance: AIModelMeta = {
19
- endpoints,
20
- context_length,
21
- architecture,
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,29 +0,0 @@
1
- # AIModelProviderConfigItem
2
-
3
- AIModelProviderConfigItem 代表创建/更新 AIModel 时的 Provider 配置项 Represents a provider configuration item when creating/updating AIModel
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
- **provider_model_id** | **string** | provider_model_id 关联的 ProviderModel ID Associated ProviderModel ID | [optional] [default to undefined]
11
- **priority** | **string** | priority 优先级,数值越小优先级越高 Priority, lower value means higher priority | [optional] [default to undefined]
12
- **traffic_permille** | **string** | traffic_permille 流量千分比 (0-1000) Traffic permille (0-1000) | [optional] [default to undefined]
13
- **endpoint_mapping** | **{ [key: string]: string; }** | endpoint_mapping 端点映射配置 Endpoint mapping configuration key: ai model endpoint id (e.g., \"openai:chat/completions\") value: provider api endpoint id (e.g., \"anthropic:messages\") | [optional] [default to undefined]
14
-
15
- ## Example
16
-
17
- ```typescript
18
- import { AIModelProviderConfigItem } from '@cherryin/api-client';
19
-
20
- const instance: AIModelProviderConfigItem = {
21
- provider_id,
22
- provider_model_id,
23
- priority,
24
- traffic_permille,
25
- endpoint_mapping,
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)
@@ -1,21 +0,0 @@
1
- # AIModelPublishRequest
2
-
3
- AIModelPublishRequest 发布 AIModel 的请求 Request message for publishing an AI model
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id 要发布的 AIModel 的唯一标识符 Unique identifier of the AI model to publish @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { AIModelPublishRequest } from '@cherryin/api-client';
15
-
16
- const instance: AIModelPublishRequest = {
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)
@@ -1,37 +0,0 @@
1
- # AIModelUpdateRequest
2
-
3
- AIModelUpdateRequest 更新 AIModel 的请求 Request message for updating an existing AI model
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id AIModel 的唯一标识符 Unique identifier of the AI model to update | [optional] [default to undefined]
10
- **name** | **string** | name 模型的唯一名称标识 Unique name identifier for the model | [optional] [default to undefined]
11
- **display_name** | **string** | display_name 模型的显示名称 Display name for the model | [optional] [default to undefined]
12
- **group** | **string** | group 模型分组 Model group | [optional] [default to undefined]
13
- **description** | **string** | description 模型描述 Model description | [optional] [default to undefined]
14
- **meta** | [**AIModelMeta**](AIModelMeta.md) | meta 元数据 Metadata | [optional] [default to undefined]
15
- **pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | pricing_configs 价格配置列表 Pricing configurations | [optional] [default to undefined]
16
- **provider_configs** | [**Array<AIModelProviderConfigItem>**](AIModelProviderConfigItem.md) | provider_configs Provider 配置列表 Provider configuration list | [optional] [default to undefined]
17
- **discount_config** | [**AIModelDiscountConfig**](AIModelDiscountConfig.md) | discount_config 折扣配置 | [optional] [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { AIModelUpdateRequest } from '@cherryin/api-client';
23
-
24
- const instance: AIModelUpdateRequest = {
25
- id,
26
- name,
27
- display_name,
28
- group,
29
- description,
30
- meta,
31
- pricing_configs,
32
- provider_configs,
33
- discount_config,
34
- };
35
- ```
36
-
37
- [[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/GCPAuth.md DELETED
@@ -1,27 +0,0 @@
1
- # GCPAuth
2
-
3
- GCPAuth 代表 Google Cloud Platform 的认证详情 GCP authentication details for Google Cloud Platform services
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **region** | **string** | region GCP 区域,例如 \"us-central1\", \"europe-west4\" GCP region, e.g., \"us-central1\", \"europe-west4\" | [optional] [default to undefined]
10
- **project_name** | **string** | project_name GCP 项目名称 GCP project name where Vertex AI APIs are enabled | [optional] [default to undefined]
11
- **credentials** | **string** | credentials GCP 凭证的 JSON 格式内容 JSON-formatted GCP credentials content | [optional] [default to undefined]
12
- **backend** | **number** | backend Google 后端类型 Google backend type 1: Gemini API 2: Vertex AI | [optional] [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { GCPAuth } from '@cherryin/api-client';
18
-
19
- const instance: GCPAuth = {
20
- region,
21
- project_name,
22
- credentials,
23
- backend,
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)
package/docs/Provider.md DELETED
@@ -1,37 +0,0 @@
1
- # Provider
2
-
3
- Provider 代表第三方 AI 模型提供商(例如 OpenAI、Anthropic、Google) Provider represents a third-party AI model provider (e.g., OpenAI, Anthropic, Google)
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id Provider 的唯一标识符 Unique identifier for the provider | [optional] [default to undefined]
10
- **created_at** | **string** | created_at 创建时间戳(Unix 时间戳) Creation timestamp (Unix timestamp) | [optional] [default to undefined]
11
- **updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) Last update timestamp (Unix timestamp) | [optional] [default to undefined]
12
- **deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 Soft deletion timestamp, 0 means not deleted | [optional] [default to undefined]
13
- **name** | **string** | name Provider 的唯一名称标识,例如 \"openai-prod-1\" Unique name identifier for the provider, e.g., \"openai-prod-1\" 用于系统内部引用,必须唯一 Used for internal system reference, must be unique | [optional] [default to undefined]
14
- **display_name** | **string** | display_name Provider 的显示名称,例如 \"OpenAI Production\" Display name for the provider, e.g., \"OpenAI Production\" 用于用户界面显示 Used for UI display | [optional] [default to undefined]
15
- **provider_type** | **string** | provider_type Provider 类型,例如 \"openai\", \"anthropic\", \"google\" Provider type, e.g., \"openai\", \"anthropic\", \"google\" 可选值: \"openai\", \"anthropic\", \"google\" Available values: \"openai\", \"anthropic\", \"google\" | [optional] [default to undefined]
16
- **provider_status** | **number** | provider_status Provider 状态 Provider status 1: 启用 (Active) 2: 禁用 (Disabled) | [optional] [default to undefined]
17
- **payload** | [**ProviderPayload**](ProviderPayload.md) | payload Provider 的认证和配置详情 Authentication and configuration details for the provider | [optional] [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { Provider } from '@cherryin/api-client';
23
-
24
- const instance: Provider = {
25
- id,
26
- created_at,
27
- updated_at,
28
- deleted_at,
29
- name,
30
- display_name,
31
- provider_type,
32
- provider_status,
33
- payload,
34
- };
35
- ```
36
-
37
- [[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,29 +0,0 @@
1
- # ProviderCreateRequest
2
-
3
- ProviderCreateRequest 创建 Provider 的请求 Request message for creating a new provider
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **name** | **string** | name Provider 的唯一名称标识,例如 \"openai-prod-1\" Unique name identifier for the provider, e.g., \"openai-prod-1\" 必须唯一,用于系统内部引用 Must be unique, used for internal system reference | [optional] [default to undefined]
10
- **display_name** | **string** | display_name Provider 的显示名称,例如 \"OpenAI Production\" Display name for the provider, e.g., \"OpenAI Production\" 用于用户界面显示 Used for UI display | [optional] [default to undefined]
11
- **provider_type** | **string** | provider_type Provider 类型 Provider type 可选值: \"openai\", \"anthropic\", \"google\" Available values: \"openai\", \"anthropic\", \"google\" | [optional] [default to undefined]
12
- **provider_status** | **number** | provider_status Provider 状态 Provider status 1: 启用 (Active) 2: 禁用 (Disabled) | [optional] [default to undefined]
13
- **payload** | [**ProviderPayload**](ProviderPayload.md) | payload Provider 的认证和配置详情 Authentication and configuration details for the provider | [optional] [default to undefined]
14
-
15
- ## Example
16
-
17
- ```typescript
18
- import { ProviderCreateRequest } from '@cherryin/api-client';
19
-
20
- const instance: ProviderCreateRequest = {
21
- name,
22
- display_name,
23
- provider_type,
24
- provider_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)
@@ -1,25 +0,0 @@
1
- # ProviderCreateResponse
2
-
3
- ProviderCreateResponse 创建 Provider 的响应 Response message for provider 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** | [**Provider**](Provider.md) | data 创建成功后返回的 Provider 信息 Provider information returned after successful creation | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { ProviderCreateResponse } from '@cherryin/api-client';
17
-
18
- const instance: ProviderCreateResponse = {
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,27 +0,0 @@
1
- # ProviderListResponse
2
-
3
- ProviderListResponse 分页查询 Provider 列表的响应 Response message for provider listing
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
- **list** | [**Array<Provider>**](Provider.md) | list Provider 列表 List of providers | [optional] [default to undefined]
12
- **total** | **string** | total 符合条件的 Provider 总数 Total number of providers matching the filter criteria | [optional] [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { ProviderListResponse } from '@cherryin/api-client';
18
-
19
- const instance: ProviderListResponse = {
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)
@@ -1,37 +0,0 @@
1
- # ProviderModel
2
-
3
- ProviderModel represents a specific model offered by a provider (e.g., gpt-4-turbo, claude-3-opus) ProviderModel 代表供应商提供的特定模型(例如 gpt-4-turbo、claude-3-opus)
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | id ProviderModel 的唯一标识符 Unique identifier for the provider model | [optional] [default to undefined]
10
- **created_at** | **string** | created_at 创建时间戳(Unix 时间戳) Creation timestamp (Unix timestamp) | [optional] [default to undefined]
11
- **updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) Last update timestamp (Unix timestamp) | [optional] [default to undefined]
12
- **deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 Soft deletion timestamp, 0 means not deleted | [optional] [default to undefined]
13
- **provider_id** | **string** | provider_id 关联的 Provider ID Associated Provider ID | [optional] [default to undefined]
14
- **name** | **string** | name 模型的唯一名称标识,例如 \"gpt-4-turbo\", \"claude-3-opus\" Unique name identifier for the model, e.g., \"gpt-4-turbo\", \"claude-3-opus\" | [optional] [default to undefined]
15
- **display_name** | **string** | display_name 模型的显示名称,例如 \"GPT-4 Turbo\", \"Claude 3 Opus\" Display name for the model, e.g., \"GPT-4 Turbo\", \"Claude 3 Opus\" | [optional] [default to undefined]
16
- **status** | **number** | status 模型状态 Model status 1: 草稿 (Draft) 2: 启用 (Active) 3: 禁用 (Disabled) | [optional] [default to undefined]
17
- **payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情 Configuration details for the model | [optional] [default to undefined]
18
-
19
- ## Example
20
-
21
- ```typescript
22
- import { ProviderModel } from '@cherryin/api-client';
23
-
24
- const instance: ProviderModel = {
25
- id,
26
- created_at,
27
- updated_at,
28
- deleted_at,
29
- provider_id,
30
- name,
31
- display_name,
32
- status,
33
- payload,
34
- };
35
- ```
36
-
37
- [[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,29 +0,0 @@
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)
@@ -1,25 +0,0 @@
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 响应状态码,200 表示成功 | [optional] [default to undefined]
10
- **message** | **string** | | [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)
@@ -1,25 +0,0 @@
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 响应状态码,200 表示成功 | [optional] [default to undefined]
10
- **message** | **string** | | [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)
@@ -1,23 +0,0 @@
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)