@cherryin/api-client 0.0.18 → 0.0.20

package/docs/ProviderModel.md

@@ -1,37 +0,0 @@
-# ProviderModel
-
-ProviderModel represents a specific model offered by a provider (e.g., gpt-4-turbo, claude-3-opus)  ProviderModel 代表供应商提供的特定模型（例如 gpt-4-turbo、claude-3-opus）
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id ProviderModel 的唯一标识符  Unique identifier for the provider model | [optional] [default to undefined]
-**created_at** | **string** | created_at 创建时间戳（Unix 时间戳）  Creation timestamp (Unix timestamp) | [optional] [default to undefined]
-**updated_at** | **string** | updated_at 更新时间戳（Unix 时间戳）  Last update timestamp (Unix timestamp) | [optional] [default to undefined]
-**deleted_at** | **string** | deleted_at 软删除时间戳，0 表示未删除  Soft deletion timestamp, 0 means not deleted | [optional] [default to undefined]
-**provider_id** | **string** | provider_id 关联的 Provider ID  Associated Provider ID | [optional] [default to undefined]
-**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]
-**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]
-**status** | **number** | status 模型状态  Model status  1: 草稿 (Draft)  2: 启用 (Active)  3: 禁用 (Disabled) | [optional] [default to undefined]
-**payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情  Configuration details for the model | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModel } from '@cherryin/api-client';
-
-const instance: ProviderModel = {
-    id,
-    created_at,
-    updated_at,
-    deleted_at,
-    provider_id,
-    name,
-    display_name,
-    status,
-    payload,
-};
-```
-
-[[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/ProviderModelCreateRequest.md

@@ -1,29 +0,0 @@
-# ProviderModelCreateRequest
-
-ProviderModelCreateRequest 创建 ProviderModel 的请求  Request message for creating a new provider model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**provider_id** | **string** | provider_id 关联的 Provider ID  Associated Provider ID | [optional] [default to undefined]
-**name** | **string** | name 模型的唯一名称标识，例如 \"gpt-4-turbo\"  Unique name identifier for the model, e.g., \"gpt-4-turbo\" | [optional] [default to undefined]
-**display_name** | **string** | display_name 模型的显示名称，例如 \"GPT-4 Turbo\"  Display name for the model, e.g., \"GPT-4 Turbo\" | [optional] [default to undefined]
-**status** | **number** | status 模型状态  Model status  1: 草稿 (Draft)  2: 启用 (Active)  3: 禁用 (Disabled) | [optional] [default to undefined]
-**payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情  Configuration details for the model | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelCreateRequest } from '@cherryin/api-client';
-
-const instance: ProviderModelCreateRequest = {
-    provider_id,
-    name,
-    display_name,
-    status,
-    payload,
-};
-```
-
-[[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/ProviderModelCreateResponse.md

@@ -1,25 +0,0 @@
-# ProviderModelCreateResponse
-
-ProviderModelCreateResponse 创建 ProviderModel 的响应  Response message for provider model creation
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**data** | [**ProviderModel**](ProviderModel.md) | data 创建成功后返回的 ProviderModel 信息  ProviderModel information returned after successful creation | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelCreateResponse } from '@cherryin/api-client';
-
-const instance: ProviderModelCreateResponse = {
-    code,
-    message,
-    data,
-};
-```
-
-[[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/ProviderModelGetResponse.md

@@ -1,25 +0,0 @@
-# ProviderModelGetResponse
-
-ProviderModelGetResponse 获取单个 ProviderModel 的响应  Response message for provider model retrieval
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**data** | [**ProviderModel**](ProviderModel.md) | data ProviderModel 信息  ProviderModel information | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelGetResponse } from '@cherryin/api-client';
-
-const instance: ProviderModelGetResponse = {
-    code,
-    message,
-    data,
-};
-```
-
-[[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/ProviderModelPayload.md

@@ -1,23 +0,0 @@
-# ProviderModelPayload
-
-ProviderModelPayload contains the endpoint configuration for a provider model  ProviderModel 的配置详情，包含端点配置
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**endpoints** | [**Array<VersionedAPISchema>**](VersionedAPISchema.md) | endpoints 端点配置列表 - 供应商往往支持多个 API 规范  List of endpoint configurations - providers often support multiple API specifications | [optional] [default to undefined]
-**azure_api_version** | **string** | azure_api_version Azure API 版本，仅当使用 Azure OpenAI 服务时需要配置 | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelPayload } from '@cherryin/api-client';
-
-const instance: ProviderModelPayload = {
-    endpoints,
-    azure_api_version,
-};
-```
-
-[[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/ProviderModelUpdateRequest.md

@@ -1,31 +0,0 @@
-# ProviderModelUpdateRequest
-
-ProviderModelUpdateRequest 更新 ProviderModel 的请求  Request message for updating an existing provider model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id ProviderModel 的唯一标识符  Unique identifier of the provider model to update | [optional] [default to undefined]
-**provider_id** | **string** | provider_id 关联的 Provider ID  Associated Provider ID | [optional] [default to undefined]
-**name** | **string** | name 模型的唯一名称标识  Unique name identifier for the model | [optional] [default to undefined]
-**display_name** | **string** | display_name 模型的显示名称  Display name for the model | [optional] [default to undefined]
-**status** | **number** | status 模型状态  Model status  1: 草稿 (Draft)  2: 启用 (Active)  3: 禁用 (Disabled) | [optional] [default to undefined]
-**payload** | [**ProviderModelPayload**](ProviderModelPayload.md) | payload 模型的配置详情  Configuration details for the model | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelUpdateRequest } from '@cherryin/api-client';
-
-const instance: ProviderModelUpdateRequest = {
-    id,
-    provider_id,
-    name,
-    display_name,
-    status,
-    payload,
-};
-```
-
-[[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/ProviderModelUpdateResponse.md

@@ -1,25 +0,0 @@
-# ProviderModelUpdateResponse
-
-ProviderModelUpdateResponse 更新 ProviderModel 的响应  Response message for provider model update
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**data** | [**ProviderModel**](ProviderModel.md) | data 更新后的 ProviderModel 信息  Updated provider model information | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderModelUpdateResponse } from '@cherryin/api-client';
-
-const instance: ProviderModelUpdateResponse = {
-    code,
-    message,
-    data,
-};
-```
-
-[[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/ProviderPayload.md

@@ -1,21 +0,0 @@
-# ProviderPayload
-
-ProviderPayload 包含 Provider 的认证和配置详情  Provider payload contains authentication and configuration details
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**provider_auth** | [**ProviderAuth**](ProviderAuth.md) | provider_auth 认证配置信息  Authentication configuration for the provider | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderPayload } from '@cherryin/api-client';
-
-const instance: ProviderPayload = {
-    provider_auth,
-};
-```
-
-[[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/ProviderUpdateRequest.md

@@ -1,31 +0,0 @@
-# ProviderUpdateRequest
-
-ProviderUpdateRequest 更新 Provider 的请求  Request message for updating an existing provider
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id Provider 的唯一标识符  Unique identifier of the provider to update | [optional] [default to undefined]
-**name** | **string** | name Provider 的唯一名称标识  Unique name identifier for the provider  如果修改名称，必须确保新名称唯一  If changing name, must ensure new name is unique | [optional] [default to undefined]
-**display_name** | **string** | display_name Provider 的显示名称  Display name for the provider | [optional] [default to undefined]
-**provider_type** | **string** | provider_type Provider 类型  Provider type  可选值: \"openai\", \"anthropic\", \"google\"  Available values: \"openai\", \"anthropic\", \"google\" | [optional] [default to undefined]
-**provider_status** | **number** | provider_status Provider 状态  Provider status  1: 启用 (Active)  2: 禁用 (Disabled) | [optional] [default to undefined]
-**payload** | [**ProviderPayload**](ProviderPayload.md) | payload Provider 的认证和配置详情  Authentication and configuration details for the provider | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderUpdateRequest } from '@cherryin/api-client';
-
-const instance: ProviderUpdateRequest = {
-    id,
-    name,
-    display_name,
-    provider_type,
-    provider_status,
-    payload,
-};
-```
-
-[[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/ProviderUpdateResponse.md

@@ -1,25 +0,0 @@
-# ProviderUpdateResponse
-
-ProviderUpdateResponse 更新 Provider 的响应  Response message for provider update
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | code 响应状态码，200 表示成功 | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**data** | [**Provider**](Provider.md) | data 更新后的 Provider 信息  Updated provider information | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProviderUpdateResponse } from '@cherryin/api-client';
-
-const instance: ProviderUpdateResponse = {
-    code,
-    message,
-    data,
-};
-```
-
-[[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/UserAPIKeyDeleteRequest.md

@@ -1,21 +0,0 @@
-# UserAPIKeyDeleteRequest
-
-UserAPIKeyDeleteRequest 删除 UserAPIKey 的请求  Request message for deleting a UserAPIKey
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id 要删除的 UserAPIKey 的唯一标识符  Unique identifier of the UserAPIKey to delete  @gotags: form:\"id\" binding:\"required\" | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UserAPIKeyDeleteRequest } from '@cherryin/api-client';
-
-const instance: UserAPIKeyDeleteRequest = {
-    id,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)