@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.
- package/.openapi-generator/FILES +46 -42
- package/README.md +70 -64
- package/api.ts +3089 -2216
- package/dist/api.d.ts +2068 -1343
- package/dist/api.js +723 -470
- package/dist/esm/api.d.ts +2068 -1343
- package/dist/esm/api.js +723 -470
- package/docs/AIModelAdminServiceApi.md +98 -87
- package/docs/AIModelPricingConfig.md +10 -10
- package/docs/AdminAIModel.md +73 -0
- package/docs/{AIModelCheckConnectionResponse.md → AdminAIModelCheckConnectionResponse.md} +4 -4
- package/docs/{AIModelCheckItem.md → AdminAIModelCheckItem.md} +3 -3
- package/docs/{AIModelCheckResult.md → AdminAIModelCheckResult.md} +5 -5
- package/docs/AdminAIModelCreateRequest.md +63 -0
- package/docs/AdminAIModelCreateResponse.md +25 -0
- package/docs/{AIModelDeleteResponse.md → AdminAIModelDeleteResponse.md} +4 -4
- package/docs/AdminAIModelDisableRequest.md +23 -0
- package/docs/AdminAIModelDisableResponse.md +25 -0
- package/docs/{AIModelDiscountConfig.md → AdminAIModelDiscountConfig.md} +4 -4
- package/docs/{AIModelGetResponse.md → AdminAIModelGetResponse.md} +5 -5
- package/docs/{AIModelListResponse.md → AdminAIModelListResponse.md} +5 -5
- package/docs/AdminAIModelProviderConfigItem.md +29 -0
- package/docs/AdminAIModelPublishRequest.md +23 -0
- package/docs/{AIModelDisableResponse.md → AdminAIModelPublishResponse.md} +5 -5
- package/docs/AdminAIModelUpdateRequest.md +25 -0
- package/docs/{AIModelUpdateResponse.md → AdminAIModelUpdateResponse.md} +5 -5
- package/docs/AdminProvider.md +46 -0
- package/docs/AdminProviderCreateRequest.md +39 -0
- package/docs/AdminProviderCreateResponse.md +25 -0
- package/docs/{ProviderModelDeleteResponse.md → AdminProviderDeleteResponse.md} +4 -4
- package/docs/AdminProviderGetResponse.md +25 -0
- package/docs/AdminProviderListResponse.md +27 -0
- package/docs/AdminProviderModel.md +66 -0
- package/docs/AdminProviderModelCreateRequest.md +59 -0
- package/docs/AdminProviderModelCreateResponse.md +25 -0
- package/docs/{ProviderDeleteResponse.md → AdminProviderModelDeleteResponse.md} +4 -4
- package/docs/{ProviderGetResponse.md → AdminProviderModelGetResponse.md} +5 -5
- package/docs/{ProviderModelListResponse.md → AdminProviderModelListResponse.md} +6 -6
- package/docs/AdminProviderModelUpdateRequest.md +25 -0
- package/docs/{AIModelCreateResponse.md → AdminProviderModelUpdateResponse.md} +5 -5
- package/docs/AdminProviderUpdateRequest.md +25 -0
- package/docs/{AIModelPublishResponse.md → AdminProviderUpdateResponse.md} +5 -5
- package/docs/AudioPricing.md +8 -8
- package/docs/DiscountDeleteResponse.md +1 -1
- package/docs/DiscountGetResponse.md +1 -1
- package/docs/DiscountListResponse.md +1 -1
- package/docs/DiscountUpdateResponse.md +1 -1
- package/docs/FeatureCostPricing.md +5 -5
- package/docs/FrontAIModel.md +15 -17
- package/docs/FrontendModelCost.md +57 -0
- package/docs/FrontendModelExtraInfo.md +21 -0
- package/docs/FrontendModelsResponse.md +29 -0
- package/docs/FrontendProviderInfo.md +31 -0
- package/docs/FrontendProviderModel.md +55 -0
- package/docs/FrontendProvidersResponse.md +29 -0
- package/docs/FrontendSearchContextCost.md +25 -0
- package/docs/ImagePricing.md +7 -7
- package/docs/LabelCreateResponse.md +1 -1
- package/docs/LabelDeleteResponse.md +1 -1
- package/docs/LabelListResponse.md +1 -1
- package/docs/LabelUpdateResponse.md +1 -1
- package/docs/ModelCapabilities.md +59 -0
- package/docs/ModelLimits.md +41 -0
- package/docs/{UserModelListResponse.md → ModelListResponse.md} +10 -11
- package/docs/ModelModalities.md +23 -0
- package/docs/MultimodalPricing.md +4 -4
- package/docs/PricingConditions.md +7 -7
- package/docs/PricingRules.md +6 -6
- package/docs/{AWSAuth.md → ProviderAWSAuth.md} +4 -3
- package/docs/ProviderAdminServiceApi.md +74 -53
- package/docs/ProviderAuth.md +6 -6
- package/docs/ProviderGCPAuth.md +27 -0
- package/docs/ProviderModelAdminServiceApi.md +74 -56
- package/docs/RequestPricing.md +3 -3
- package/docs/TextTokenInputPricing.md +5 -5
- package/docs/TextTokenOutputPricing.md +4 -4
- package/docs/TextTokenPricing.md +3 -3
- package/docs/TokenTier.md +4 -4
- package/docs/UserAPIKey.md +15 -15
- package/docs/UserAPIKeyCreateRequest.md +9 -9
- package/docs/UserAPIKeyCreateResponse.md +4 -4
- package/docs/UserAPIKeyDeleteResponse.md +3 -3
- package/docs/UserAPIKeyGetResponse.md +4 -4
- package/docs/UserAPIKeyListResponse.md +5 -5
- package/docs/UserAPIKeyServiceApi.md +26 -27
- package/docs/UserAPIKeyUpdateResponse.md +3 -3
- package/docs/UserBalanceChangeResponse.md +2 -2
- package/docs/UserBalanceEditResponse.md +2 -2
- package/docs/UserBalanceListResponse.md +2 -2
- package/docs/UserBalanceServiceApi.md +4 -4
- package/docs/UserLabelListResponse.md +1 -1
- package/docs/UserLabelPairChangeResponse.md +1 -1
- package/docs/UserModelServiceApi.md +124 -11
- package/docs/VersionedAPISchema.md +6 -6
- package/docs/VideoPricing.md +8 -8
- package/package.json +1 -1
- package/docs/AIModel.md +0 -45
- package/docs/AIModelArchitecture.md +0 -25
- package/docs/AIModelCreateRequest.md +0 -35
- package/docs/AIModelDeleteRequest.md +0 -21
- package/docs/AIModelDisableRequest.md +0 -21
- package/docs/AIModelMeta.md +0 -25
- package/docs/AIModelProviderConfigItem.md +0 -29
- package/docs/AIModelPublishRequest.md +0 -21
- package/docs/AIModelUpdateRequest.md +0 -37
- package/docs/GCPAuth.md +0 -27
- package/docs/Provider.md +0 -37
- package/docs/ProviderCreateRequest.md +0 -29
- package/docs/ProviderCreateResponse.md +0 -25
- package/docs/ProviderListResponse.md +0 -27
- package/docs/ProviderModel.md +0 -37
- package/docs/ProviderModelCreateRequest.md +0 -29
- package/docs/ProviderModelCreateResponse.md +0 -25
- package/docs/ProviderModelGetResponse.md +0 -25
- package/docs/ProviderModelPayload.md +0 -23
- package/docs/ProviderModelUpdateRequest.md +0 -31
- package/docs/ProviderModelUpdateResponse.md +0 -25
- package/docs/ProviderPayload.md +0 -21
- package/docs/ProviderUpdateRequest.md +0 -31
- package/docs/ProviderUpdateResponse.md +0 -25
- package/docs/UserAPIKeyDeleteRequest.md +0 -21
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# AdminAIModelCreateRequest
|
|
2
|
+
|
|
3
|
+
AdminAIModelCreateRequest 创建 AIModel 的请求(草稿状态) Request message for creating a new AI model (draft status)
|
|
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 模型成本(注意需要和 AIModelPricingConfig 进行交叉比对) pricing_configs 是内部计价结构,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_configs** | [**Array<AdminAIModelProviderConfigItem>**](AdminAIModelProviderConfigItem.md) | provider_configs Provider 配置列表 | [optional] [default to undefined]
|
|
29
|
+
**pricing_configs** | [**Array<AIModelPricingConfig>**](AIModelPricingConfig.md) | pricing_configs 价格配置列表 (NEW) | [optional] [default to undefined]
|
|
30
|
+
**discount_config** | [**AdminAIModelDiscountConfig**](AdminAIModelDiscountConfig.md) | discount_config 折扣配置 | [optional] [default to undefined]
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { AdminAIModelCreateRequest } from '@cherryin/api-client';
|
|
36
|
+
|
|
37
|
+
const instance: AdminAIModelCreateRequest = {
|
|
38
|
+
id,
|
|
39
|
+
name,
|
|
40
|
+
family,
|
|
41
|
+
source,
|
|
42
|
+
model_card,
|
|
43
|
+
temperature,
|
|
44
|
+
knowledge,
|
|
45
|
+
release_date,
|
|
46
|
+
last_updated,
|
|
47
|
+
open_weights,
|
|
48
|
+
deprecation_date,
|
|
49
|
+
context_length,
|
|
50
|
+
modalities,
|
|
51
|
+
limits,
|
|
52
|
+
capabilities,
|
|
53
|
+
cost,
|
|
54
|
+
extra_info,
|
|
55
|
+
is_official,
|
|
56
|
+
endpoints,
|
|
57
|
+
provider_configs,
|
|
58
|
+
pricing_configs,
|
|
59
|
+
discount_config,
|
|
60
|
+
};
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
[[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
|
+
# AdminAIModelCreateResponse
|
|
2
|
+
|
|
3
|
+
AdminAIModelCreateResponse 创建 AIModel 的响应 Response message for AI 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** | [**AdminAIModel**](AdminAIModel.md) | data 创建成功后返回的 AIModel 信息 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminAIModelCreateResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: AdminAIModelCreateResponse = {
|
|
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
|
-
#
|
|
1
|
+
# AdminAIModelDeleteResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelDeleteResponse 删除 AIModel 的响应 Response message for AI model deletion
|
|
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 {
|
|
15
|
+
import { AdminAIModelDeleteResponse } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: AdminAIModelDeleteResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
20
|
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AdminAIModelDisableRequest
|
|
2
|
+
|
|
3
|
+
AdminAIModelDisableRequest 禁用 AIModel 的请求
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Provider 的唯一标识符 @gotags: form:\"id\" | [optional] [default to undefined]
|
|
10
|
+
**record_id** | **string** | Provider 数据库自增 id - record_id @gotags: form:\"record_id\" | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminAIModelDisableRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: AdminAIModelDisableRequest = {
|
|
18
|
+
id,
|
|
19
|
+
record_id,
|
|
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
|
+
# AdminAIModelDisableResponse
|
|
2
|
+
|
|
3
|
+
AdminAIModelDisableResponse 禁用 AIModel 的响应 Response message for AI model disable
|
|
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** | [**AdminAIModel**](AdminAIModel.md) | data 禁用后的 AIModel 信息 Disabled AI model information | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminAIModelDisableResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: AdminAIModelDisableResponse = {
|
|
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
|
-
#
|
|
1
|
+
# AdminAIModelDiscountConfig
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelDiscountConfig AI模型折扣配置
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { AdminAIModelDiscountConfig } from '@cherryin/api-client';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: AdminAIModelDiscountConfig = {
|
|
17
17
|
discount_ids,
|
|
18
18
|
};
|
|
19
19
|
```
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AdminAIModelGetResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelGetResponse 获取单个 AIModel 的响应
|
|
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** | [**
|
|
11
|
+
**data** | [**AdminAIModel**](AdminAIModel.md) | data AIModel 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { AdminAIModelGetResponse } from '@cherryin/api-client';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: AdminAIModelGetResponse = {
|
|
19
19
|
code,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AdminAIModelListResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelListResponse 分页查询 AIModel 列表的响应 Response message for AI 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<
|
|
11
|
+
**list** | [**Array<AdminAIModel>**](AdminAIModel.md) | list AIModel 列表 List of AI models | [optional] [default to undefined]
|
|
12
12
|
**total** | **string** | total 符合条件的 AIModel 总数 Total number of AI models matching the filter criteria | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
import {
|
|
17
|
+
import { AdminAIModelListResponse } from '@cherryin/api-client';
|
|
18
18
|
|
|
19
|
-
const instance:
|
|
19
|
+
const instance: AdminAIModelListResponse = {
|
|
20
20
|
code,
|
|
21
21
|
message,
|
|
22
22
|
list,
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# AdminAIModelProviderConfigItem
|
|
2
|
+
|
|
3
|
+
AdminAIModelProviderConfigItem 代表创建/更新 AIModel 时的 Provider 配置项
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**provider_id** | **string** | provider_id 关联的 Provider ID | [optional] [default to undefined]
|
|
10
|
+
**provider_model_id** | **string** | provider_model_id 关联的 ProviderModel ID | [optional] [default to undefined]
|
|
11
|
+
**priority** | **string** | priority 优先级,数值越小优先级越高 | [optional] [default to undefined]
|
|
12
|
+
**traffic_permille** | **string** | traffic_permille 流量千分比 (0-1000) | [optional] [default to undefined]
|
|
13
|
+
**endpoint_mapping** | **{ [key: string]: string; }** | endpoint_mapping 端点映射配置 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 { AdminAIModelProviderConfigItem } from '@cherryin/api-client';
|
|
19
|
+
|
|
20
|
+
const instance: AdminAIModelProviderConfigItem = {
|
|
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)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AdminAIModelPublishRequest
|
|
2
|
+
|
|
3
|
+
AdminAIModelPublishRequest 发布 AIModel 的请求
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Provider 的唯一标识符 @gotags: form:\"id\" | [optional] [default to undefined]
|
|
10
|
+
**record_id** | **string** | Provider 数据库自增 id - record_id @gotags: form:\"record_id\" | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminAIModelPublishRequest } from '@cherryin/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: AdminAIModelPublishRequest = {
|
|
18
|
+
id,
|
|
19
|
+
record_id,
|
|
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)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AdminAIModelPublishResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelPublishResponse 发布 AIModel 的响应 Response message for AI model publish
|
|
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** | [**
|
|
11
|
+
**data** | [**AdminAIModel**](AdminAIModel.md) | data 发布后的 AIModel 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { AdminAIModelPublishResponse } from '@cherryin/api-client';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: AdminAIModelPublishResponse = {
|
|
19
19
|
code,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AdminAIModelUpdateRequest
|
|
2
|
+
|
|
3
|
+
AdminAIModelUpdateRequest 更新 AIModel 的请求 Request message for updating an existing AI 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** | [**AdminAIModel**](AdminAIModel.md) | payload 模型的配置详情 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminAIModelUpdateRequest } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: AdminAIModelUpdateRequest = {
|
|
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
|
-
#
|
|
1
|
+
# AdminAIModelUpdateResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminAIModelUpdateResponse 更新 AIModel 的响应 Response message for AI 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** | [**
|
|
11
|
+
**data** | [**AdminAIModel**](AdminAIModel.md) | data 更新后的 AIModel 信息 | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { AdminAIModelUpdateResponse } from '@cherryin/api-client';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: AdminAIModelUpdateResponse = {
|
|
19
19
|
code,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# AdminProvider
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | id 供应商 ID | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | name 供应商名称 | [optional] [default to undefined]
|
|
10
|
+
**env** | **Array<string>** | env 供应商使用的环境变量 | [optional] [default to undefined]
|
|
11
|
+
**npm** | **string** | npm 供应商提供的 NPM 包 | [optional] [default to undefined]
|
|
12
|
+
**api** | **string** | api 供应商的 API BaseURL | [optional] [default to undefined]
|
|
13
|
+
**doc** | **string** | doc 供应商官方文档地址 | [optional] [default to undefined]
|
|
14
|
+
**provider_status** | **number** | provider_status Provider 状态 1: 启用 (Active) 2: 禁用 (Disabled) | [optional] [default to undefined]
|
|
15
|
+
**provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 供应商的认证授权配置 | [optional] [default to undefined]
|
|
16
|
+
**is_official** | **boolean** | 是否为官方供应商,官方供应商会额外写官方供应商表. | [optional] [default to undefined]
|
|
17
|
+
**record_id** | **string** | 数据库自增 id,方便区别 | [optional] [default to undefined]
|
|
18
|
+
**created_at** | **string** | created_at 创建时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
19
|
+
**updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
20
|
+
**deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 | [optional] [default to undefined]
|
|
21
|
+
**provider_type** | **string** | provider_type 供应商类型, 对齐创建供应商时的类型 | [optional] [default to undefined]
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { AdminProvider } from '@cherryin/api-client';
|
|
27
|
+
|
|
28
|
+
const instance: AdminProvider = {
|
|
29
|
+
id,
|
|
30
|
+
name,
|
|
31
|
+
env,
|
|
32
|
+
npm,
|
|
33
|
+
api,
|
|
34
|
+
doc,
|
|
35
|
+
provider_status,
|
|
36
|
+
provider_auth,
|
|
37
|
+
is_official,
|
|
38
|
+
record_id,
|
|
39
|
+
created_at,
|
|
40
|
+
updated_at,
|
|
41
|
+
deleted_at,
|
|
42
|
+
provider_type,
|
|
43
|
+
};
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
[[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,39 @@
|
|
|
1
|
+
# AdminProviderCreateRequest
|
|
2
|
+
|
|
3
|
+
AdminProviderCreateRequest 创建 Provider 的请求
|
|
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
|
+
**provider_status** | **number** | provider_status Provider 状态 1: 启用 (Active) 2: 禁用 (Disabled) | [optional] [default to undefined]
|
|
16
|
+
**provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 供应商的认证授权配置 | [optional] [default to undefined]
|
|
17
|
+
**is_official** | **boolean** | 是否为官方供应商,官方供应商会额外写官方供应商表. | [optional] [default to undefined]
|
|
18
|
+
**provider_type** | **string** | provider_type 供应商类型 目前支持: - openai - anthropic - vertex - gemini - azure | [optional] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { AdminProviderCreateRequest } from '@cherryin/api-client';
|
|
24
|
+
|
|
25
|
+
const instance: AdminProviderCreateRequest = {
|
|
26
|
+
id,
|
|
27
|
+
name,
|
|
28
|
+
env,
|
|
29
|
+
npm,
|
|
30
|
+
api,
|
|
31
|
+
doc,
|
|
32
|
+
provider_status,
|
|
33
|
+
provider_auth,
|
|
34
|
+
is_official,
|
|
35
|
+
provider_type,
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[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
|
+
# AdminProviderCreateResponse
|
|
2
|
+
|
|
3
|
+
AdminProviderCreateResponse 创建 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** | [**AdminProvider**](AdminProvider.md) | data 创建成功后返回的 Provider 信息 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminProviderCreateResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: AdminProviderCreateResponse = {
|
|
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
|
-
#
|
|
1
|
+
# AdminProviderDeleteResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AdminProviderDeleteResponse 删除 Provider 的响应 Response message for provider deletion
|
|
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 {
|
|
15
|
+
import { AdminProviderDeleteResponse } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: AdminProviderDeleteResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
20
|
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AdminProviderGetResponse
|
|
2
|
+
|
|
3
|
+
AdminProviderGetResponse 获取单个 Provider 的响应 Response message for provider 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** | [**AdminProvider**](AdminProvider.md) | data Provider 信息 | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminProviderGetResponse } from '@cherryin/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: AdminProviderGetResponse = {
|
|
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
|
+
# AdminProviderListResponse
|
|
2
|
+
|
|
3
|
+
AdminProviderListResponse 分页查询 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<AdminProvider>**](AdminProvider.md) | list Provider 列表 | [optional] [default to undefined]
|
|
12
|
+
**total** | **string** | total 符合条件的 Provider 总数 | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AdminProviderListResponse } from '@cherryin/api-client';
|
|
18
|
+
|
|
19
|
+
const instance: AdminProviderListResponse = {
|
|
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,66 @@
|
|
|
1
|
+
# AdminProviderModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | id 模型 ID | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | name 模型名称 | [optional] [default to undefined]
|
|
10
|
+
**family** | **string** | family 模型家族 | [optional] [default to undefined]
|
|
11
|
+
**source** | **string** | source 模型信息源 | [optional] [default to undefined]
|
|
12
|
+
**model_card** | **string** | model_card 模型卡片 URL | [optional] [default to undefined]
|
|
13
|
+
**temperature** | **boolean** | temperature 是否支持温度参数 | [optional] [default to undefined]
|
|
14
|
+
**knowledge** | **string** | knowledge 知识截止日期 | [optional] [default to undefined]
|
|
15
|
+
**release_date** | **string** | release_date 发布日期 | [optional] [default to undefined]
|
|
16
|
+
**last_updated** | **string** | last_updated 最后更新日期 | [optional] [default to undefined]
|
|
17
|
+
**open_weights** | **boolean** | open_weights 是否开源权重 | [optional] [default to undefined]
|
|
18
|
+
**deprecation_date** | **string** | deprecation_date 弃用日期 | [optional] [default to undefined]
|
|
19
|
+
**context_length** | **string** | 最大上下文长度(即 limits.max_input_tokens + max_output_tokens) | [optional] [default to undefined]
|
|
20
|
+
**modalities** | [**ModelModalities**](ModelModalities.md) | modalities 模态信息 | [optional] [default to undefined]
|
|
21
|
+
**limits** | [**ModelLimits**](ModelLimits.md) | limits 模型限制 | [optional] [default to undefined]
|
|
22
|
+
**capabilities** | [**ModelCapabilities**](ModelCapabilities.md) | capabilities 模型能力 | [optional] [default to undefined]
|
|
23
|
+
**cost** | [**FrontendModelCost**](FrontendModelCost.md) | cost 模型成本 | [optional] [default to undefined]
|
|
24
|
+
**extra_info** | [**FrontendModelExtraInfo**](FrontendModelExtraInfo.md) | extra_info 额外信息 | [optional] [default to undefined]
|
|
25
|
+
**is_official** | **boolean** | 是否为官方供应商,官方供应商会额外写官方供应商表. | [optional] [default to undefined]
|
|
26
|
+
**endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | endpoints 端点配置列表 - 供应商往往支持多个 API 端点 注意,这是 CherryIN 网关独有的配置,需要和 ModelCapabilities.supported_endpoints 进行映射检查 | [optional] [default to undefined]
|
|
27
|
+
**provider_id** | **string** | 关联的 AdminProvider id | [optional] [default to undefined]
|
|
28
|
+
**record_id** | **string** | 数据库自增 id,方便区别 | [optional] [default to undefined]
|
|
29
|
+
**created_at** | **string** | created_at 创建时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
30
|
+
**updated_at** | **string** | updated_at 更新时间戳(Unix 时间戳) | [optional] [default to undefined]
|
|
31
|
+
**deleted_at** | **string** | deleted_at 软删除时间戳,0 表示未删除 | [optional] [default to undefined]
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { AdminProviderModel } from '@cherryin/api-client';
|
|
37
|
+
|
|
38
|
+
const instance: AdminProviderModel = {
|
|
39
|
+
id,
|
|
40
|
+
name,
|
|
41
|
+
family,
|
|
42
|
+
source,
|
|
43
|
+
model_card,
|
|
44
|
+
temperature,
|
|
45
|
+
knowledge,
|
|
46
|
+
release_date,
|
|
47
|
+
last_updated,
|
|
48
|
+
open_weights,
|
|
49
|
+
deprecation_date,
|
|
50
|
+
context_length,
|
|
51
|
+
modalities,
|
|
52
|
+
limits,
|
|
53
|
+
capabilities,
|
|
54
|
+
cost,
|
|
55
|
+
extra_info,
|
|
56
|
+
is_official,
|
|
57
|
+
endpoints,
|
|
58
|
+
provider_id,
|
|
59
|
+
record_id,
|
|
60
|
+
created_at,
|
|
61
|
+
updated_at,
|
|
62
|
+
deleted_at,
|
|
63
|
+
};
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|