@cherryin/api-client 0.0.20 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +102 -235
- package/README.md +155 -342
- package/api.ts +3375 -9798
- package/dist/api.d.ts +2595 -6538
- package/dist/api.js +1630 -5652
- package/dist/esm/api.d.ts +2595 -6538
- package/dist/esm/api.js +1609 -5611
- package/docs/AIModel.md +45 -0
- package/docs/AIModelAdminServiceApi.md +90 -101
- package/docs/AIModelArchitecture.md +25 -0
- package/docs/{AdminAIModelCheckConnectionResponse.md → AIModelCheckConnectionResponse.md} +4 -4
- package/docs/{AdminAIModelCheckItem.md → AIModelCheckItem.md} +3 -3
- package/docs/{AdminAIModelCheckResult.md → AIModelCheckResult.md} +5 -5
- package/docs/AIModelCreateRequest.md +35 -0
- package/docs/{AdminAIModelCreateResponse.md → AIModelCreateResponse.md} +5 -5
- package/docs/AIModelDeleteRequest.md +21 -0
- package/docs/{AdminProviderModelDeleteResponse.md → AIModelDeleteResponse.md} +4 -4
- package/docs/AIModelDisableRequest.md +21 -0
- package/docs/{AdminAIModelPublishResponse.md → AIModelDisableResponse.md} +5 -5
- package/docs/{AdminAIModelDiscountConfig.md → AIModelDiscountConfig.md} +4 -4
- package/docs/{AdminAIModelGetResponse.md → AIModelGetResponse.md} +5 -5
- package/docs/{AdminAIModelListResponse.md → AIModelListResponse.md} +5 -5
- package/docs/AIModelMeta.md +25 -0
- package/docs/AIModelPricingConfig.md +10 -10
- package/docs/AIModelProviderConfigItem.md +29 -0
- package/docs/AIModelPublishRequest.md +21 -0
- package/docs/{AdminAIModelUpdateResponse.md → AIModelPublishResponse.md} +5 -5
- package/docs/AIModelUpdateRequest.md +37 -0
- package/docs/{AdminProviderGetResponse.md → AIModelUpdateResponse.md} +5 -5
- package/docs/{ProviderAWSAuth.md → AWSAuth.md} +3 -4
- package/docs/AudioPricing.md +8 -8
- package/docs/Auth2Account.md +33 -0
- package/docs/{AuthAdminUser.md → Auth2Admin.md} +7 -7
- package/docs/Auth2AdminServiceApi.md +469 -0
- package/docs/Auth2AdminSession.md +35 -0
- package/docs/{AuthIdToken.md → Auth2IdToken.md} +3 -3
- package/docs/Auth2Session.md +35 -0
- package/docs/Auth2User.md +33 -0
- package/docs/Auth2UserServiceApi.md +1261 -0
- package/docs/{PassportAuthAdminChangePasswordRequest.md → AuthAdminChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthEnterpriseChangePasswordResponse.md → AuthAdminChangePasswordResponse.md} +4 -4
- package/docs/{PassportAuthEnterpriseRefreshTokenResponse.md → AuthAdminGetSessionResponse.md} +6 -4
- package/docs/{PassportAuthListSessionsResponse.md → AuthAdminListSessionsResponse.md} +4 -4
- package/docs/{PassportAuthAdminUserDisableResponse.md → AuthAdminRevokeOtherSessionsResponse.md} +5 -3
- package/docs/{PassportAdminTokenAuthRequest.md → AuthAdminRevokeSessionRequest.md} +3 -3
- package/docs/{PassportAuthUserDeleteResponse.md → AuthAdminRevokeSessionResponse.md} +5 -3
- package/docs/{PassportAuthUserSignOutResponse.md → AuthAdminRevokeSessionsResponse.md} +5 -3
- package/docs/{PassportAdminSignInEmailRequest.md → AuthAdminSignInEmailRequest.md} +5 -7
- package/docs/{PassportAuthAdminUserModifyPermissionResponse.md → AuthAdminSignInEmailResponse.md} +6 -4
- package/docs/{PassportAuthRevokeOtherSessionsResponse.md → AuthAdminSignOutResponse.md} +3 -3
- package/docs/{PassportAuthAdminUpdateInfoRequest.md → AuthAdminUpdateUserRequest.md} +5 -5
- package/docs/{PassportUserInfoGetResponse.md → AuthAdminUpdateUserResponse.md} +5 -5
- package/docs/{PassportAuthUserChangeEmailRequest.md → AuthChangeEmailRequest.md} +3 -5
- package/docs/{PassportAuthAdminUpdateInfoResponse.md → AuthChangeEmailResponse.md} +6 -4
- package/docs/{PassportAuthEnterpriseChangePasswordRequest.md → AuthChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthAdminGetInfoResponse.md → AuthChangePasswordResponse.md} +6 -4
- package/docs/{PassportAuthRevokeSessionRequest.md → AuthDeleteUserRequest.md} +7 -3
- package/docs/{PassportAuthAdminRevokeOtherSessionsResponse.md → AuthDeleteUserResponse.md} +5 -3
- package/docs/{PassportAuthSocialRefreshTokenRequest.md → AuthGetAccessTokenRequest.md} +3 -3
- package/docs/{PassportAuthSocialRefreshTokenResponse.md → AuthGetAccessTokenResponse.md} +3 -3
- package/docs/AuthGetAccountInfoResponse.md +24 -0
- package/docs/{PassportAuthEnterpriseGetSessionResponse.md → AuthGetSessionResponse.md} +6 -4
- package/docs/{PassportAuthLinkSocialRequest.md → AuthLinkSocialRequest.md} +4 -6
- package/docs/{PassportAuthLinkSocialResponse.md → AuthLinkSocialResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseRevokeSessionsResponse.md → AuthListAccountsResponse.md} +5 -3
- package/docs/AuthListSessionsResponse.md +24 -0
- package/docs/{PassportEnterpriseSignUpEmailResponse.md → AuthOAuth2CallbackResponse.md} +10 -8
- package/docs/{PassportAuthSocialGetAccessTokenRequest.md → AuthRefreshTokenRequest.md} +3 -3
- package/docs/{PassportAuthSocialGetAccessTokenResponse.md → AuthRefreshTokenResponse.md} +3 -3
- package/docs/AuthRequestPasswordResetRequest.md +22 -0
- package/docs/{PassportAuthAdminSignOutResponse.md → AuthRequestPasswordResetResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseRevokeSessionRequest.md → AuthResetPasswordRequest.md} +5 -3
- package/docs/{PassportAuthAdminUserModifyInfoResponse.md → AuthResetPasswordResponse.md} +5 -5
- package/docs/AuthRevokeOtherSessionsResponse.md +24 -0
- package/docs/{PassportUserTokenAuthRequest.md → AuthRevokeSessionRequest.md} +3 -3
- package/docs/{PassportAdminSendVerificationEmailResponse.md → AuthRevokeSessionResponse.md} +5 -3
- package/docs/{PassportAuthAdminPassportDisableResponse.md → AuthRevokeSessionsResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseVerifyEmailRequest.md → AuthSendVerificationEmailRequest.md} +3 -5
- package/docs/{PassportAuthResetPasswordResponse.md → AuthSendVerificationEmailResponse.md} +5 -3
- package/docs/{PassportAuthDeleteAllRequest.md → AuthSignInEmailRequest.md} +7 -9
- package/docs/{PassportUserPasswordResetResponse.md → AuthSignInEmailResponse.md} +9 -5
- package/docs/{PassportUserSignInSocialRequest.md → AuthSignInSocialRequest.md} +6 -8
- package/docs/{PassportEnterpriseSignInEmailResponse.md → AuthSignInSocialResponse.md} +6 -6
- package/docs/{PassportAuthEnterpriseMaterialUploadResponse.md → AuthSignOutResponse.md} +5 -3
- package/docs/{PassportAuthEnterpriseDeleteRequest.md → AuthSignUpEmailRequest.md} +13 -9
- package/docs/{PassportEnterprisePasswordResetResponse.md → AuthSignUpEmailResponse.md} +7 -5
- package/docs/{PassportAuthUnlinkSocialRequest.md → AuthUnlinkAccountRequest.md} +3 -5
- package/docs/{PassportAuthAdminEnterpriseMaterialReviewResponse.md → AuthUnlinkAccountResponse.md} +5 -3
- package/docs/{PassportAuthUserUpdatePassportRequest.md → AuthUpdateUserRequest.md} +5 -5
- package/docs/AuthUpdateUserResponse.md +24 -0
- package/docs/AuthVerifyEmailResponse.md +24 -0
- package/docs/ConfigItem.md +0 -4
- 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 +17 -15
- package/docs/GCPAuth.md +27 -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/MultimodalPricing.md +4 -4
- package/docs/PricingConditions.md +7 -7
- package/docs/PricingRules.md +6 -6
- package/docs/Provider.md +37 -0
- package/docs/ProviderAdminServiceApi.md +53 -74
- package/docs/ProviderAuth.md +6 -6
- package/docs/ProviderCreateRequest.md +29 -0
- package/docs/{AdminAIModelDisableResponse.md → ProviderCreateResponse.md} +5 -5
- package/docs/{AdminAIModelDeleteResponse.md → ProviderDeleteResponse.md} +4 -4
- package/docs/{AdminProviderModelGetResponse.md → ProviderGetResponse.md} +5 -5
- package/docs/{AdminProviderListResponse.md → ProviderListResponse.md} +6 -6
- package/docs/ProviderModel.md +37 -0
- package/docs/ProviderModelAdminServiceApi.md +56 -74
- package/docs/ProviderModelCreateRequest.md +29 -0
- package/docs/{AdminProviderModelUpdateResponse.md → ProviderModelCreateResponse.md} +5 -5
- package/docs/{AdminProviderDeleteResponse.md → ProviderModelDeleteResponse.md} +4 -4
- package/docs/ProviderModelGetResponse.md +25 -0
- package/docs/{AdminProviderModelListResponse.md → ProviderModelListResponse.md} +6 -6
- package/docs/ProviderModelPayload.md +23 -0
- package/docs/ProviderModelUpdateRequest.md +31 -0
- package/docs/{AdminProviderCreateResponse.md → ProviderModelUpdateResponse.md} +5 -5
- package/docs/ProviderPayload.md +21 -0
- package/docs/ProviderUpdateRequest.md +31 -0
- package/docs/ProviderUpdateResponse.md +25 -0
- package/docs/RemoteConfigAdminServiceApi.md +3 -18
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +0 -6
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- 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/UserAPIKeyDeleteRequest.md +21 -0
- package/docs/UserAPIKeyDeleteResponse.md +3 -3
- package/docs/UserAPIKeyGetResponse.md +4 -4
- package/docs/UserAPIKeyListResponse.md +5 -5
- package/docs/UserAPIKeyServiceApi.md +27 -26
- 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/{ModelListResponse.md → UserModelListResponse.md} +11 -10
- package/docs/UserModelServiceApi.md +11 -124
- package/docs/VersionedAPISchema.md +6 -6
- package/docs/VideoPricing.md +8 -8
- package/package.json +1 -1
- package/docs/AdminAIModel.md +0 -73
- package/docs/AdminAIModelCreateRequest.md +0 -63
- package/docs/AdminAIModelDisableRequest.md +0 -23
- package/docs/AdminAIModelProviderConfigItem.md +0 -29
- package/docs/AdminAIModelPublishRequest.md +0 -23
- package/docs/AdminAIModelUpdateRequest.md +0 -25
- package/docs/AdminEnterpriseMaterials.md +0 -24
- package/docs/AdminEnterpriseUser.md +0 -24
- package/docs/AdminEnterpriseUserMaterials.md +0 -22
- package/docs/AdminPassportItem.md +0 -24
- package/docs/AdminProvider.md +0 -46
- package/docs/AdminProviderCreateRequest.md +0 -39
- package/docs/AdminProviderModel.md +0 -66
- package/docs/AdminProviderModelCreateRequest.md +0 -59
- package/docs/AdminProviderModelCreateResponse.md +0 -25
- package/docs/AdminProviderModelUpdateRequest.md +0 -25
- package/docs/AdminProviderUpdateRequest.md +0 -25
- package/docs/AdminProviderUpdateResponse.md +0 -25
- package/docs/AdminUserItem.md +0 -26
- package/docs/AuthAdminSession.md +0 -39
- package/docs/AuthEnterpriseMaterials.md +0 -33
- package/docs/AuthEnterpriseSession.md +0 -37
- package/docs/AuthEnterpriseUser.md +0 -37
- package/docs/AuthPassport.md +0 -35
- package/docs/AuthUser.md +0 -39
- package/docs/AuthUserMethod.md +0 -39
- package/docs/AuthUserSession.md +0 -41
- package/docs/FrontendModelCost.md +0 -57
- package/docs/FrontendModelExtraInfo.md +0 -21
- package/docs/FrontendModelsResponse.md +0 -29
- package/docs/FrontendProviderInfo.md +0 -31
- package/docs/FrontendProviderModel.md +0 -55
- package/docs/FrontendProvidersResponse.md +0 -29
- package/docs/FrontendSearchContextCost.md +0 -25
- package/docs/ModelCapabilities.md +0 -59
- package/docs/ModelLimits.md +0 -41
- package/docs/ModelModalities.md +0 -23
- package/docs/PassportAdminSendVerificationEmailRequest.md +0 -26
- package/docs/PassportAdminSignInEmailResponse.md +0 -26
- package/docs/PassportAdminTokenAuthResponse.md +0 -28
- package/docs/PassportAuthAdminChangePasswordResponse.md +0 -26
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +0 -28
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +0 -22
- package/docs/PassportAuthAdminGetSessionResponse.md +0 -26
- package/docs/PassportAuthAdminListSessionsResponse.md +0 -24
- package/docs/PassportAuthAdminPassportDisableRequest.md +0 -22
- package/docs/PassportAuthAdminPassportListRequest.md +0 -28
- package/docs/PassportAuthAdminPassportListResponse.md +0 -28
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +0 -28
- package/docs/PassportAuthAdminPassportModifyInfoResponse.md +0 -24
- package/docs/PassportAuthAdminRPCServiceApi.md +0 -61
- package/docs/PassportAuthAdminRevokeSessionRequest.md +0 -20
- package/docs/PassportAuthAdminRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthAdminRevokeSessionsResponse.md +0 -22
- package/docs/PassportAuthAdminServiceApi.md +0 -1069
- package/docs/PassportAuthAdminUserDisableRequest.md +0 -26
- package/docs/PassportAuthAdminUserListRequest.md +0 -28
- package/docs/PassportAuthAdminUserListResponse.md +0 -28
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +0 -32
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +0 -22
- package/docs/PassportAuthChangePasswordRequest.md +0 -26
- package/docs/PassportAuthChangePasswordResponse.md +0 -26
- package/docs/PassportAuthDeleteAllResponse.md +0 -22
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +0 -24
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +0 -22
- package/docs/PassportAuthEnterpriseDeleteResponse.md +0 -22
- package/docs/PassportAuthEnterpriseInfoGetResponse.md +0 -24
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +0 -24
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +0 -26
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +0 -24
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +0 -61
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +0 -20
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +0 -22
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +0 -22
- package/docs/PassportAuthEnterpriseRevokeOtherSessionsResponse.md +0 -22
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthEnterpriseServiceApi.md +0 -1170
- package/docs/PassportAuthEnterpriseSignOutRequest.md +0 -20
- package/docs/PassportAuthEnterpriseSignOutResponse.md +0 -22
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +0 -22
- package/docs/PassportAuthEnterpriseUpdateInfoResponse.md +0 -24
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +0 -22
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +0 -22
- package/docs/PassportAuthInfoGetResponse.md +0 -26
- package/docs/PassportAuthListMethodsResponse.md +0 -24
- package/docs/PassportAuthListSocialsResponse.md +0 -24
- package/docs/PassportAuthRefreshSessionTokenRequest.md +0 -20
- package/docs/PassportAuthRefreshSessionTokenResponse.md +0 -24
- package/docs/PassportAuthResetPasswordRequest.md +0 -24
- package/docs/PassportAuthRevokeOtherSessionsRequest.md +0 -20
- package/docs/PassportAuthRevokeSessionResponse.md +0 -22
- package/docs/PassportAuthRevokeSessionsRequest.md +0 -20
- package/docs/PassportAuthRevokeSessionsResponse.md +0 -22
- package/docs/PassportAuthSendVerificationEmailRequest.md +0 -26
- package/docs/PassportAuthSendVerificationEmailResponse.md +0 -22
- package/docs/PassportAuthSendVerificationPhoneRequest.md +0 -26
- package/docs/PassportAuthSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportAuthUnlinkSocialResponse.md +0 -22
- package/docs/PassportAuthUserChangeEmailResponse.md +0 -24
- package/docs/PassportAuthUserChangePhoneRequest.md +0 -26
- package/docs/PassportAuthUserChangePhoneResponse.md +0 -24
- package/docs/PassportAuthUserDeleteRequest.md +0 -30
- package/docs/PassportAuthUserGetSessionResponse.md +0 -24
- package/docs/PassportAuthUserInfoGetResponse.md +0 -24
- package/docs/PassportAuthUserRPCServiceApi.md +0 -223
- package/docs/PassportAuthUserServiceApi.md +0 -2000
- package/docs/PassportAuthUserSignOutRequest.md +0 -22
- package/docs/PassportAuthUserUpdateInfoRequest.md +0 -28
- package/docs/PassportAuthUserUpdateInfoResponse.md +0 -24
- package/docs/PassportAuthUserUpdatePassportResponse.md +0 -24
- package/docs/PassportAuthUserVerifyEmailRequest.md +0 -26
- package/docs/PassportAuthUserVerifyEmailResponse.md +0 -22
- package/docs/PassportAuthUserVerifyPhoneRequest.md +0 -24
- package/docs/PassportAuthUserVerifyPhoneResponse.md +0 -22
- package/docs/PassportEnterprisePasswordResetRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +0 -22
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +0 -24
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportEnterpriseSignInEmailRequest.md +0 -30
- package/docs/PassportEnterpriseSignInPhoneRequest.md +0 -24
- package/docs/PassportEnterpriseSignInPhoneResponse.md +0 -26
- package/docs/PassportEnterpriseSignUpEmailRequest.md +0 -34
- package/docs/PassportEnterpriseTokenAuthRequest.md +0 -20
- package/docs/PassportEnterpriseTokenAuthResponse.md +0 -28
- package/docs/PassportSendVerificationEmailRequest.md +0 -26
- package/docs/PassportSendVerificationEmailResponse.md +0 -22
- package/docs/PassportSendVerificationPhoneRequest.md +0 -26
- package/docs/PassportSendVerificationPhoneResponse.md +0 -22
- package/docs/PassportUserInfoBatchGetRequest.md +0 -24
- package/docs/PassportUserInfoBatchGetResponse.md +0 -24
- package/docs/PassportUserInfoGetRequest.md +0 -24
- package/docs/PassportUserOAuthCallbackResponse.md +0 -36
- package/docs/PassportUserPasswordForgetRequest.md +0 -24
- package/docs/PassportUserPasswordForgetResponse.md +0 -22
- package/docs/PassportUserPasswordResetRequest.md +0 -30
- package/docs/PassportUserPasswordResetTokenVerifyRequest.md +0 -22
- package/docs/PassportUserPasswordResetTokenVerifyResponse.md +0 -26
- package/docs/PassportUserSignInEmailRequest.md +0 -32
- package/docs/PassportUserSignInEmailResponse.md +0 -32
- package/docs/PassportUserSignInPhoneRequest.md +0 -26
- package/docs/PassportUserSignInPhoneResponse.md +0 -28
- package/docs/PassportUserSignInSocialResponse.md +0 -32
- package/docs/PassportUserSignUpEmailRequest.md +0 -36
- package/docs/PassportUserSignUpEmailResponse.md +0 -32
- package/docs/PassportUserTokenAuthResponse.md +0 -28
- package/docs/PassportUserUpdateInfoRequest.md +0 -30
- package/docs/PassportUserUpdateInfoResponse.md +0 -22
- package/docs/ProviderGCPAuth.md +0 -27
- package/docs/QRCodeAdminServiceApi.md +0 -286
- package/docs/QRCodeCreateRequest.md +0 -37
- package/docs/QRCodeCreateResponse.md +0 -25
- package/docs/QRCodeDeleteResponse.md +0 -23
- package/docs/QRCodeGetResponse.md +0 -25
- package/docs/QRCodeHistoryItem.md +0 -29
- package/docs/QRCodeInfo.md +0 -59
- package/docs/QRCodeListResponse.md +0 -27
- package/docs/QRCodeSnapshot.md +0 -37
- package/docs/QRCodeUpdateRequest.md +0 -39
- package/docs/QRCodeUpdateResponse.md +0 -25
- package/docs/QRCodeWithHistory.md +0 -23
- package/docs/UserBasic.md +0 -42
- package/docs/UserExtendInfo.md +0 -20
- package/docs/UserInfoQueryOptions.md +0 -28
- package/docs/UserPaymentInfo.md +0 -20
- package/docs/UserPreferences.md +0 -22
|
@@ -4,16 +4,16 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
7
|
+
|[**providerAdminServiceProviderCreate**](#provideradminserviceprovidercreate) | **POST** /admin/provider/create | |
|
|
8
|
+
|[**providerAdminServiceProviderDelete**](#provideradminserviceproviderdelete) | **DELETE** /admin/provider/delete | |
|
|
9
|
+
|[**providerAdminServiceProviderGet**](#provideradminserviceproviderget) | **GET** /admin/provider/get | |
|
|
10
|
+
|[**providerAdminServiceProviderList**](#provideradminserviceproviderlist) | **GET** /admin/provider/list | |
|
|
11
|
+
|[**providerAdminServiceProviderUpdate**](#provideradminserviceproviderupdate) | **POST** /admin/provider/update | |
|
|
12
12
|
|
|
13
|
-
# **
|
|
14
|
-
>
|
|
13
|
+
# **providerAdminServiceProviderCreate**
|
|
14
|
+
> ProviderCreateResponse providerAdminServiceProviderCreate(providerCreateRequest)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
ProviderCreate 创建新的 Provider Create a new AI model provider 请求路径: POST /admin/provider/create Request path: POST /admin/provider/create 权限要求: 需要管理员权限 Permission: Requires admin authentication
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -21,16 +21,16 @@ AdminProviderCreate 创建新的 Provider 请求路径: POST /admin/provider/cr
|
|
|
21
21
|
import {
|
|
22
22
|
ProviderAdminServiceApi,
|
|
23
23
|
Configuration,
|
|
24
|
-
|
|
24
|
+
ProviderCreateRequest
|
|
25
25
|
} from '@cherryin/api-client';
|
|
26
26
|
|
|
27
27
|
const configuration = new Configuration();
|
|
28
28
|
const apiInstance = new ProviderAdminServiceApi(configuration);
|
|
29
29
|
|
|
30
|
-
let
|
|
30
|
+
let providerCreateRequest: ProviderCreateRequest; //
|
|
31
31
|
|
|
32
|
-
const { status, data } = await apiInstance.
|
|
33
|
-
|
|
32
|
+
const { status, data } = await apiInstance.providerAdminServiceProviderCreate(
|
|
33
|
+
providerCreateRequest
|
|
34
34
|
);
|
|
35
35
|
```
|
|
36
36
|
|
|
@@ -38,12 +38,12 @@ const { status, data } = await apiInstance.providerAdminServiceAdminProviderCrea
|
|
|
38
38
|
|
|
39
39
|
|Name | Type | Description | Notes|
|
|
40
40
|
|------------- | ------------- | ------------- | -------------|
|
|
41
|
-
| **
|
|
41
|
+
| **providerCreateRequest** | **ProviderCreateRequest**| | |
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### Return type
|
|
45
45
|
|
|
46
|
-
**
|
|
46
|
+
**ProviderCreateResponse**
|
|
47
47
|
|
|
48
48
|
### Authorization
|
|
49
49
|
|
|
@@ -63,10 +63,10 @@ No authorization required
|
|
|
63
63
|
|
|
64
64
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
65
65
|
|
|
66
|
-
# **
|
|
67
|
-
>
|
|
66
|
+
# **providerAdminServiceProviderDelete**
|
|
67
|
+
> ProviderDeleteResponse providerAdminServiceProviderDelete()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
ProviderDelete 删除 Provider(软删除) Delete a provider (soft delete) 请求路径: DELETE /admin/provider/delete Request path: DELETE /admin/provider/delete 权限要求: 需要管理员权限 Permission: Requires admin authentication
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -79,12 +79,10 @@ import {
|
|
|
79
79
|
const configuration = new Configuration();
|
|
80
80
|
const apiInstance = new ProviderAdminServiceApi(configuration);
|
|
81
81
|
|
|
82
|
-
let id: string; //Provider 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
|
|
83
|
-
let recordId: string; //Provider 数据库自增 id - record_id @gotags: form:\"record_id\" (optional) (default to undefined)
|
|
82
|
+
let id: string; //id 要删除的 Provider 的唯一标识符 Unique identifier of the provider to delete @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
|
|
84
83
|
|
|
85
|
-
const { status, data } = await apiInstance.
|
|
86
|
-
id
|
|
87
|
-
recordId
|
|
84
|
+
const { status, data } = await apiInstance.providerAdminServiceProviderDelete(
|
|
85
|
+
id
|
|
88
86
|
);
|
|
89
87
|
```
|
|
90
88
|
|
|
@@ -92,13 +90,12 @@ const { status, data } = await apiInstance.providerAdminServiceAdminProviderDele
|
|
|
92
90
|
|
|
93
91
|
|Name | Type | Description | Notes|
|
|
94
92
|
|------------- | ------------- | ------------- | -------------|
|
|
95
|
-
| **id** | [**string**] | Provider 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
|
|
96
|
-
| **recordId** | [**string**] | Provider 数据库自增 id - record_id @gotags: form:\"record_id\" | (optional) defaults to undefined|
|
|
93
|
+
| **id** | [**string**] | id 要删除的 Provider 的唯一标识符 Unique identifier of the provider to delete @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
|
|
97
94
|
|
|
98
95
|
|
|
99
96
|
### Return type
|
|
100
97
|
|
|
101
|
-
**
|
|
98
|
+
**ProviderDeleteResponse**
|
|
102
99
|
|
|
103
100
|
### Authorization
|
|
104
101
|
|
|
@@ -118,10 +115,10 @@ No authorization required
|
|
|
118
115
|
|
|
119
116
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
120
117
|
|
|
121
|
-
# **
|
|
122
|
-
>
|
|
118
|
+
# **providerAdminServiceProviderGet**
|
|
119
|
+
> ProviderGetResponse providerAdminServiceProviderGet()
|
|
123
120
|
|
|
124
|
-
|
|
121
|
+
ProviderGet 根据 ID 获取单个 Provider Retrieve a single provider by ID 请求路径: GET /admin/provider/get?id={id} Request path: GET /admin/provider/get?id={id} 权限要求: 需要管理员权限 Permission: Requires admin authentication
|
|
125
122
|
|
|
126
123
|
### Example
|
|
127
124
|
|
|
@@ -134,14 +131,10 @@ import {
|
|
|
134
131
|
const configuration = new Configuration();
|
|
135
132
|
const apiInstance = new ProviderAdminServiceApi(configuration);
|
|
136
133
|
|
|
137
|
-
let id: string; //Provider 的唯一标识符 @gotags: form:\"id\" (optional) (default to undefined)
|
|
138
|
-
let recordId: string; //Provider 数据库自增 id - record_id optional: id or record_id @gotags: form:\"record_id\" (optional) (default to undefined)
|
|
139
|
-
let isOfficial: boolean; //是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) @gotags: form:\"is_official\" (optional) (default to undefined)
|
|
134
|
+
let id: string; //id 要获取的 Provider 的唯一标识符 Unique identifier of the provider to retrieve @gotags: form:\"id\" binding:\"required\" (optional) (default to undefined)
|
|
140
135
|
|
|
141
|
-
const { status, data } = await apiInstance.
|
|
142
|
-
id
|
|
143
|
-
recordId,
|
|
144
|
-
isOfficial
|
|
136
|
+
const { status, data } = await apiInstance.providerAdminServiceProviderGet(
|
|
137
|
+
id
|
|
145
138
|
);
|
|
146
139
|
```
|
|
147
140
|
|
|
@@ -149,14 +142,12 @@ const { status, data } = await apiInstance.providerAdminServiceAdminProviderGet(
|
|
|
149
142
|
|
|
150
143
|
|Name | Type | Description | Notes|
|
|
151
144
|
|------------- | ------------- | ------------- | -------------|
|
|
152
|
-
| **id** | [**string**] | Provider 的唯一标识符 @gotags: form:\"id\" | (optional) defaults to undefined|
|
|
153
|
-
| **recordId** | [**string**] | Provider 数据库自增 id - record_id optional: id or record_id @gotags: form:\"record_id\" | (optional) defaults to undefined|
|
|
154
|
-
| **isOfficial** | [**boolean**] | 是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) @gotags: form:\"is_official\" | (optional) defaults to undefined|
|
|
145
|
+
| **id** | [**string**] | id 要获取的 Provider 的唯一标识符 Unique identifier of the provider to retrieve @gotags: form:\"id\" binding:\"required\" | (optional) defaults to undefined|
|
|
155
146
|
|
|
156
147
|
|
|
157
148
|
### Return type
|
|
158
149
|
|
|
159
|
-
**
|
|
150
|
+
**ProviderGetResponse**
|
|
160
151
|
|
|
161
152
|
### Authorization
|
|
162
153
|
|
|
@@ -176,10 +167,10 @@ No authorization required
|
|
|
176
167
|
|
|
177
168
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
178
169
|
|
|
179
|
-
# **
|
|
180
|
-
>
|
|
170
|
+
# **providerAdminServiceProviderList**
|
|
171
|
+
> ProviderListResponse providerAdminServiceProviderList()
|
|
181
172
|
|
|
182
|
-
|
|
173
|
+
ProviderList 分页查询 Provider 列表,支持按状态和名称前缀过滤 List providers with pagination, supports filtering by status and name prefix 请求路径: GET /admin/provider/list?page={page}&page_size={page_size}&provider_status={status}&name_prefix={prefix} Request path: GET /admin/provider/list?page={page}&page_size={page_size}&provider_status={status}&name_prefix={prefix} 权限要求: 需要管理员权限 Permission: Requires admin authentication
|
|
183
174
|
|
|
184
175
|
### Example
|
|
185
176
|
|
|
@@ -192,24 +183,16 @@ import {
|
|
|
192
183
|
const configuration = new Configuration();
|
|
193
184
|
const apiInstance = new ProviderAdminServiceApi(configuration);
|
|
194
185
|
|
|
195
|
-
let page: number; //page 页码,从 1 开始 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
|
|
196
|
-
let pageSize: number; //page_size 每页数量 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
|
|
197
|
-
let providerStatus: number; //provider_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回启用的 Provider 2: 仅返回禁用的 Provider @gotags: form:\"provider_status\" (optional) (default to undefined)
|
|
198
|
-
let
|
|
199
|
-
let modelName: string; //name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_name\" (optional) (default to undefined)
|
|
200
|
-
let providerId: string; //provider_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_id\" (optional) (default to undefined)
|
|
201
|
-
let providerName: string; //provider_name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_name\" (optional) (default to undefined)
|
|
202
|
-
let isOfficial: boolean; //是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) (optional) (default to undefined)
|
|
186
|
+
let page: number; //page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" (optional) (default to undefined)
|
|
187
|
+
let pageSize: number; //page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" (optional) (default to undefined)
|
|
188
|
+
let providerStatus: number; //provider_status 按状态过滤(可选) Filter by provider status (optional) 0: 返回所有状态 1: 仅返回启用的 Provider 2: 仅返回禁用的 Provider 0: return all statuses 1: return only active providers 2: return only disabled providers @gotags: form:\"provider_status\" (optional) (default to undefined)
|
|
189
|
+
let namePrefix: string; //name_prefix 按名称前缀过滤(可选) Filter by name prefix (optional) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 Example: \"openai\" matches \"openai-prod-1\", \"openai-dev-1\", etc. @gotags: form:\"name_prefix\" (optional) (default to undefined)
|
|
203
190
|
|
|
204
|
-
const { status, data } = await apiInstance.
|
|
191
|
+
const { status, data } = await apiInstance.providerAdminServiceProviderList(
|
|
205
192
|
page,
|
|
206
193
|
pageSize,
|
|
207
194
|
providerStatus,
|
|
208
|
-
|
|
209
|
-
modelName,
|
|
210
|
-
providerId,
|
|
211
|
-
providerName,
|
|
212
|
-
isOfficial
|
|
195
|
+
namePrefix
|
|
213
196
|
);
|
|
214
197
|
```
|
|
215
198
|
|
|
@@ -217,19 +200,15 @@ const { status, data } = await apiInstance.providerAdminServiceAdminProviderList
|
|
|
217
200
|
|
|
218
201
|
|Name | Type | Description | Notes|
|
|
219
202
|
|------------- | ------------- | ------------- | -------------|
|
|
220
|
-
| **page** | [**number**] | page 页码,从 1 开始 Default: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
|
|
221
|
-
| **pageSize** | [**number**] | page_size 每页数量 Default: 20, Maximum: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
|
|
222
|
-
| **providerStatus** | [**number**] | provider_status 按状态过滤(可选) 0: 返回所有状态 1: 仅返回启用的 Provider 2: 仅返回禁用的 Provider @gotags: form:\"provider_status\" | (optional) defaults to undefined|
|
|
223
|
-
| **
|
|
224
|
-
| **modelName** | [**string**] | name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"model_name\" | (optional) defaults to undefined|
|
|
225
|
-
| **providerId** | [**string**] | provider_id 按 id 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_id\" | (optional) defaults to undefined|
|
|
226
|
-
| **providerName** | [**string**] | provider_name 按 name 前缀过滤(可选) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 @gotags: form:\"provider_name\" | (optional) defaults to undefined|
|
|
227
|
-
| **isOfficial** | [**boolean**] | 是否仅查询官方供应商,则返回的是官方供应商的信息(如果有) | (optional) defaults to undefined|
|
|
203
|
+
| **page** | [**number**] | page 页码,从 1 开始 Page number, starts from 1 默认值: 1 Default: 1 @gotags: form:\"page\" | (optional) defaults to undefined|
|
|
204
|
+
| **pageSize** | [**number**] | page_size 每页数量 Number of items per page 默认值: 20,最大值: 100 Default: 20, Maximum: 100 @gotags: form:\"page_size\" | (optional) defaults to undefined|
|
|
205
|
+
| **providerStatus** | [**number**] | provider_status 按状态过滤(可选) Filter by provider status (optional) 0: 返回所有状态 1: 仅返回启用的 Provider 2: 仅返回禁用的 Provider 0: return all statuses 1: return only active providers 2: return only disabled providers @gotags: form:\"provider_status\" | (optional) defaults to undefined|
|
|
206
|
+
| **namePrefix** | [**string**] | name_prefix 按名称前缀过滤(可选) Filter by name prefix (optional) 例如: \"openai\" 会匹配 \"openai-prod-1\", \"openai-dev-1\" 等 Example: \"openai\" matches \"openai-prod-1\", \"openai-dev-1\", etc. @gotags: form:\"name_prefix\" | (optional) defaults to undefined|
|
|
228
207
|
|
|
229
208
|
|
|
230
209
|
### Return type
|
|
231
210
|
|
|
232
|
-
**
|
|
211
|
+
**ProviderListResponse**
|
|
233
212
|
|
|
234
213
|
### Authorization
|
|
235
214
|
|
|
@@ -249,10 +228,10 @@ No authorization required
|
|
|
249
228
|
|
|
250
229
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
251
230
|
|
|
252
|
-
# **
|
|
253
|
-
>
|
|
231
|
+
# **providerAdminServiceProviderUpdate**
|
|
232
|
+
> ProviderUpdateResponse providerAdminServiceProviderUpdate(providerUpdateRequest)
|
|
254
233
|
|
|
255
|
-
|
|
234
|
+
ProviderUpdate 更新现有的 Provider Update an existing AI model provider 请求路径: POST /admin/provider/update Request path: POST /admin/provider/update 权限要求: 需要管理员权限 Permission: Requires admin authentication
|
|
256
235
|
|
|
257
236
|
### Example
|
|
258
237
|
|
|
@@ -260,16 +239,16 @@ AdminProviderUpdate 更新现有的 Provider 请求路径: POST /admin/provider
|
|
|
260
239
|
import {
|
|
261
240
|
ProviderAdminServiceApi,
|
|
262
241
|
Configuration,
|
|
263
|
-
|
|
242
|
+
ProviderUpdateRequest
|
|
264
243
|
} from '@cherryin/api-client';
|
|
265
244
|
|
|
266
245
|
const configuration = new Configuration();
|
|
267
246
|
const apiInstance = new ProviderAdminServiceApi(configuration);
|
|
268
247
|
|
|
269
|
-
let
|
|
248
|
+
let providerUpdateRequest: ProviderUpdateRequest; //
|
|
270
249
|
|
|
271
|
-
const { status, data } = await apiInstance.
|
|
272
|
-
|
|
250
|
+
const { status, data } = await apiInstance.providerAdminServiceProviderUpdate(
|
|
251
|
+
providerUpdateRequest
|
|
273
252
|
);
|
|
274
253
|
```
|
|
275
254
|
|
|
@@ -277,12 +256,12 @@ const { status, data } = await apiInstance.providerAdminServiceAdminProviderUpda
|
|
|
277
256
|
|
|
278
257
|
|Name | Type | Description | Notes|
|
|
279
258
|
|------------- | ------------- | ------------- | -------------|
|
|
280
|
-
| **
|
|
259
|
+
| **providerUpdateRequest** | **ProviderUpdateRequest**| | |
|
|
281
260
|
|
|
282
261
|
|
|
283
262
|
### Return type
|
|
284
263
|
|
|
285
|
-
**
|
|
264
|
+
**ProviderUpdateResponse**
|
|
286
265
|
|
|
287
266
|
### Authorization
|
|
288
267
|
|
package/docs/ProviderAuth.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# ProviderAuth
|
|
2
2
|
|
|
3
|
-
ProviderAuth 包含 Provider 的认证详情,支持多种认证方式
|
|
3
|
+
ProviderAuth 包含 Provider 的认证详情,支持多种认证方式 Provider authentication details, supports multiple authentication methods
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**auth_type** | **string** | auth_type 认证类型,例如 \"apikey\" 或 \"google\" 可选值: \"apikey\", \"google\" | [optional] [default to undefined]
|
|
10
|
-
**base_url** | **string** | base_url Provider 的基础 URL 地址 | [optional] [default to undefined]
|
|
11
|
-
**api_keys** | **Array<string>** | api_keys API Key 列表,用于 API Key 认证方式 支持配置多个 API Key 用于负载均衡和容错 | [optional] [default to undefined]
|
|
12
|
-
**gcp_auth_list** | [**Array<
|
|
13
|
-
**aws_auth_list** | [**Array<
|
|
9
|
+
**auth_type** | **string** | auth_type 认证类型,例如 \"apikey\" 或 \"google\" Authentication type, e.g., \"apikey\" or \"google\" 可选值: \"apikey\", \"google\" Available values: \"apikey\", \"google\" | [optional] [default to undefined]
|
|
10
|
+
**base_url** | **string** | base_url Provider 的基础 URL 地址 Base URL for the provider\'s API endpoint | [optional] [default to undefined]
|
|
11
|
+
**api_keys** | **Array<string>** | api_keys API Key 列表,用于 API Key 认证方式 List of API keys for API key-based authentication 支持配置多个 API Key 用于负载均衡和容错 Supports multiple API keys for load balancing and failover | [optional] [default to undefined]
|
|
12
|
+
**gcp_auth_list** | [**Array<GCPAuth>**](GCPAuth.md) | gcp_auth_list GCP 认证配置列表,用于 Google Cloud Platform 认证 List of GCP authentication configurations for Google Cloud Platform 支持配置多个 GCP 认证用于负载均衡和容错 Supports multiple GCP auth configs for load balancing and failover | [optional] [default to undefined]
|
|
13
|
+
**aws_auth_list** | [**Array<AWSAuth>**](AWSAuth.md) | aws_auth_list AWS 认证配置列表,用于 Amazon Web Services 认证 | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,29 @@
|
|
|
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,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ProviderCreateResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ProviderCreateResponse 创建 Provider 的响应 Response message for provider creation
|
|
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** | [**Provider**](Provider.md) | data 创建成功后返回的 Provider 信息 Provider information returned after successful creation | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { ProviderCreateResponse } from '@cherryin/api-client';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: ProviderCreateResponse = {
|
|
19
19
|
code,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ProviderDeleteResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ProviderDeleteResponse 删除 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 { ProviderDeleteResponse } from '@cherryin/api-client';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: ProviderDeleteResponse = {
|
|
18
18
|
code,
|
|
19
19
|
message,
|
|
20
20
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ProviderGetResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ProviderGetResponse 获取单个 Provider 的响应 Response message for provider retrieval
|
|
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** | [**Provider**](Provider.md) | data Provider 信息 Provider information | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { ProviderGetResponse } from '@cherryin/api-client';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: ProviderGetResponse = {
|
|
19
19
|
code,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ProviderListResponse
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ProviderListResponse 分页查询 Provider 列表的响应 Response message for provider 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<
|
|
12
|
-
**total** | **string** | total 符合条件的 Provider 总数 | [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
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
import {
|
|
17
|
+
import { ProviderListResponse } from '@cherryin/api-client';
|
|
18
18
|
|
|
19
|
-
const instance:
|
|
19
|
+
const instance: ProviderListResponse = {
|
|
20
20
|
code,
|
|
21
21
|
message,
|
|
22
22
|
list,
|
|
@@ -0,0 +1,37 @@
|
|
|
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)
|