console

package
v0.1.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 19, 2025 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DifyVersion = "1.6.0"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client Console API客户端 (管理员API)

func NewClient 

func NewClient(accessToken, baseURL string) *Client

NewClient 创建Console API客户端 注意: Console API通常需要session认证，这里使用Bearer token作为临时方案

func NewClientWithSession 

func NewClientWithSession(sessionCookie, baseURL string) *Client

NewClientWithSession 使用Session Cookie创建Console API客户端

func (*Client) AddToolApiProvider added in v0.1.5 

func (c *Client) AddToolApiProvider(ctx context.Context, provider string, credentials map[string]interface{}, icon map[string]interface{}, schemaType, schema string, labels []string, privacyPolicy *string, customDisclaimer *string) (*models.OperationResponse, error)

添加API工具提供商接口

func (*Client) AppImport added in v0.1.5 

func (c *Client) AppImport(ctx context.Context, mode string, yamlContent string) (*models.AppImportResponse, error)

AppImport 导入应用 POST /apps/import

func (*Client) AuthMCPProvider added in v0.1.5 

func (c *Client) AuthMCPProvider(ctx context.Context, providerID, authorizationCode string) (*models.OperationResponse, error)

AuthMCPProvider MCP Provider 认证

func (*Client) CopyApp 

func (c *Client) CopyApp(ctx context.Context, appID string, req *models.CopyAppRequest) (*models.ConsoleApp, error)

CopyApp 复制应用

func (*Client) CreateApp 

func (c *Client) CreateApp(ctx context.Context, req *models.CreateAppRequest) (*models.ConsoleApp, error)

CreateApp 创建应用

func (*Client) CreateAppAPIKey 

func (c *Client) CreateAppAPIKey(ctx context.Context, appID string) (*models.APIKey, error)

CreateAppAPIKey 创建应用API密钥

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, req *models.CreateDatasetRequest) (*models.Dataset, error)

CreateDataset 创建数据集

func (*Client) CreateDatasetAPIKey 

func (c *Client) CreateDatasetAPIKey(ctx context.Context, datasetID string) (*models.APIKey, error)

CreateDatasetAPIKey 创建数据集API密钥

func (*Client) CreateMCPProvider added in v0.1.5 

func (c *Client) CreateMCPProvider(ctx context.Context, serverURL, name string, icon interface{}, iconType, iconBackground, serverIdentifier string) (*models.ToolProviderEntity, error)

CreateMCPProvider 创建 MCP Provider

func (*Client) CreateWorkspacesCurrentMembersInviteEmail added in v0.1.5 

func (c *Client) CreateWorkspacesCurrentMembersInviteEmail(ctx context.Context, emails []string, role, language string) (*models.WorkspaceInviteEmailApiResponse, error)

邀请成员邮件接口

func (*Client) DeleteApp 

func (c *Client) DeleteApp(ctx context.Context, appID string) error

DeleteApp 删除应用

func (*Client) DeleteAppAPIKey 

func (c *Client) DeleteAppAPIKey(ctx context.Context, appID, keyID string) error

DeleteAppAPIKey 删除应用API密钥

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, datasetID string) error

DeleteDataset 删除数据集

func (*Client) DeleteDatasetAPIKey 

func (c *Client) DeleteDatasetAPIKey(ctx context.Context, datasetID, keyID string) error

DeleteDatasetAPIKey 删除数据集API密钥

func (*Client) DeleteMCPProvider added in v0.1.5 

func (c *Client) DeleteMCPProvider(ctx context.Context, providerID string) (map[string]interface{}, error)

DeleteMCPProvider 删除 MCP Provider

func (*Client) DeleteToolApiProvider added in v0.1.5 

func (c *Client) DeleteToolApiProvider(ctx context.Context, provider string) (*models.OperationResponse, error)

删除API工具提供商接口

func (*Client) DeleteToolBuiltinProvider added in v0.1.5 

func (c *Client) DeleteToolBuiltinProvider(ctx context.Context, provider string) (any, error)

删除内置工具提供商接口

func (*Client) DeleteWorkspacesCurrentMembers added in v0.1.5 

func (c *Client) DeleteWorkspacesCurrentMembers(ctx context.Context, memberID string) (*models.WorkspaceOperationResponse, error)

取消成员邀请/移除成员接口

func (*Client) ExportApp 

func (c *Client) ExportApp(ctx context.Context, appID string, includeSecret bool) (*models.AppExportResponse, error)

ExportApp 导出应用

func (*Client) GetAccountProfile added in v0.1.4 

func (c *Client) GetAccountProfile(ctx context.Context, auth_token string) (*models.Account, error)

func (*Client) GetApp 

func (c *Client) GetApp(ctx context.Context, appID string) (*models.ConsoleAppDetail, error)

GetApp 获取应用详情

func (*Client) GetAppAPIKeys 

func (c *Client) GetAppAPIKeys(ctx context.Context, appID string) (*models.APIKeyListResponse, error)

GetAppAPIKeys 获取应用API密钥列表

func (*Client) GetAppTrace 

func (c *Client) GetAppTrace(ctx context.Context, appID string) (*models.AppTraceConfig, error)

GetAppTrace 获取应用追踪配置

func (*Client) GetApps 

func (c *Client) GetApps(ctx context.Context, page, limit int, mode, name string, tagIDs []string, isCreatedByMe *bool) (*models.ConsoleAppListResponse, error)

GetApps 获取应用列表

func (*Client) GetAppsChatMessageList added in v0.1.5 

func (c *Client) GetAppsChatMessageList(ctx context.Context, appID string, conversationID string, firstID, limit *int) (*models.AppsChatMessageListApiResponse, error)

func (*Client) GetAppsMessage added in v0.1.5 

func (c *Client) GetAppsMessage(ctx context.Context, appID string, messageID string) (*models.AppsMessageApiResponse, error)

func (*Client) GetCurrentTenant added in v0.1.4 

func (c *Client) GetCurrentTenant(ctx context.Context) (*models.Tenant, error)

GetCurrentTenant 获取当前租户

func (*Client) GetDataset 

func (c *Client) GetDataset(ctx context.Context, datasetID string) (*models.Dataset, error)

GetDataset 获取数据集详情

func (*Client) GetDatasetAPIKeys 

func (c *Client) GetDatasetAPIKeys(ctx context.Context, datasetID string) (*models.APIKeyListResponse, error)

GetDatasetAPIKeys 获取数据集API密钥列表

func (*Client) GetDatasets 

func (c *Client) GetDatasets(ctx context.Context, page, limit int, keyword string, tagIDs []string, includeAll bool) (*models.DatasetListResponse, error)

GetDatasets 获取数据集列表

func (*Client) GetInitInfo 

func (c *Client) GetInitInfo(ctx context.Context) (*models.StatusResponse, error)

GetInitInfo 获取Dify初始化信息

func (*Client) GetMCPProviderDetail added in v0.1.5 

func (c *Client) GetMCPProviderDetail(ctx context.Context, providerID string) (*models.ToolProviderEntity, error)

GetMCPProviderDetail 获取 MCP Provider 详情

func (*Client) GetModelProviderList added in v0.1.5 

func (c *Client) GetModelProviderList(ctx context.Context, model_type string) (*models.ModelProvidersResponse, error)

model_providers相关接口

func (*Client) GetModelProviderModels added in v0.1.5 

func (c *Client) GetModelProviderModels(ctx context.Context, provider string) (*models.ModelProviderModelsResponse, error)

获取指定 provider 下的所有模型

func (*Client) GetPluginList added in v0.1.5 

func (c *Client) GetPluginList(ctx context.Context, page, pageSize int) (*models.PluginListResponse, error)

PluginList 获取插件列表

func (*Client) GetSetupInfo 

func (c *Client) GetSetupInfo(ctx context.Context) (*models.StatusResponse, error)

GetSetupInfo 获取安装信息

func (*Client) GetTenantList added in v0.1.7 

func (c *Client) GetTenantList(ctx context.Context, auth_token string) (*models.TenantListResponse, error)

func (*Client) GetToolApiProviderListTools added in v0.1.5 

func (c *Client) GetToolApiProviderListTools(ctx context.Context, provider string) (*models.ApiToolListResponse, error)

获取API工具提供商工具列表接口

func (*Client) GetToolBuiltinProviderCredentials added in v0.1.5 

func (c *Client) GetToolBuiltinProviderCredentials(ctx context.Context, provider string) (map[string]interface{}, error)

获取内置工具提供商凭据接口

func (*Client) GetToolBuiltinProviderCredentialsSchema added in v0.1.5 

func (c *Client) GetToolBuiltinProviderCredentialsSchema(ctx context.Context, provider string) (*models.ToolBuiltinProviderCredentialsSchemaResponse, error)

获取内置工具提供商凭据模式接口

func (*Client) GetToolBuiltinProviderIcon added in v0.1.5 

func (c *Client) GetToolBuiltinProviderIcon(ctx context.Context, provider string) (any, error)

获取内置工具提供商图标接口

func (*Client) GetToolBuiltinProviderInfo added in v0.1.5 

func (c *Client) GetToolBuiltinProviderInfo(ctx context.Context, provider string) (*models.ToolProviderEntity, error)

获取内置工具提供商信息接口

func (*Client) GetToolBuiltinProviderListTools added in v0.1.5 

func (c *Client) GetToolBuiltinProviderListTools(ctx context.Context, provider string) (*models.BuiltinToolListResponse, error)

func (*Client) GetToolProviderList added in v0.1.5 

func (c *Client) GetToolProviderList(ctx context.Context, toolType string) (*models.ToolProviderListDetailResponse, error)

func (*Client) GetVersion 

func (c *Client) GetVersion(ctx context.Context, currentVersion string) (*models.Version, error)

GetVersion 获取Dify版本信息

func (*Client) GetWorkspaces added in v0.1.5 

func (c *Client) GetWorkspaces(ctx context.Context) (*models.WorkspacesApiResponse, error)

func (*Client) GetWorkspacesCurrent added in v0.1.5 

func (c *Client) GetWorkspacesCurrent(ctx context.Context) (*models.Workspace, error)

func (*Client) GetWorkspacesCurrentDatasetOperators added in v0.1.5 

func (c *Client) GetWorkspacesCurrentDatasetOperators(ctx context.Context) (*models.WorkspacesCurrentDatasetOperatorsApiResponse, error)

获取数据集操作员成员列表接口

func (*Client) GetWorkspacesCurrentMembers added in v0.1.5 

func (c *Client) GetWorkspacesCurrentMembers(ctx context.Context) (*models.WorkspacesCurrentMembersApiResponse, error)

func (*Client) Init 

func (c *Client) Init(ctx context.Context, initPassword string) (*models.ResultResponse, error)

Init 初始化Dify

func (*Client) InstallPluginFromPkg added in v0.1.5 

func (c *Client) InstallPluginFromPkg(ctx context.Context, pkgPath string) (*models.PluginInstallResponse, error)

PluginInstallFromPkg 安装插件（本地包）

func (*Client) Login 

func (c *Client) Login(ctx context.Context, req *models.LoginRequest) (*models.LoginResponse, error)

Login 用户登录

func (*Client) Ping 

func (c *Client) Ping(ctx context.Context) (*models.ResultResponse, error)

Ping 检查Dify是否正常运行

func (*Client) PublishApp added in v0.1.10 

func (c *Client) PublishApp(ctx context.Context, appID string) error

func (*Client) Setup 

func (c *Client) Setup(ctx context.Context, setup *models.SetupRequest) (*models.ResultResponse, error)

Setup 安装Dify

func (*Client) SetupAccount added in v0.1.6 

func (c *Client) SetupAccount(ctx context.Context, email string, name string, password string) (*models.OperationResponse, error)

func (*Client) UninstallPlugin added in v0.1.5 

func (c *Client) UninstallPlugin(ctx context.Context, pluginInstallationID string) (*any, error)

PluginUninstall 卸载插件

func (*Client) UpdateApp 

func (c *Client) UpdateApp(ctx context.Context, appID string, req *models.UpdateAppRequest) (*models.ConsoleApp, error)

UpdateApp 更新应用

func (*Client) UpdateAppAPIStatus 

func (c *Client) UpdateAppAPIStatus(ctx context.Context, appID string, req *models.UpdateAppAPIStatusRequest) (*models.ConsoleApp, error)

UpdateAppAPIStatus 更新应用API状态

func (*Client) UpdateAppIcon 

func (c *Client) UpdateAppIcon(ctx context.Context, appID string, req *models.UpdateAppIconRequest) (*models.ConsoleApp, error)

UpdateAppIcon 更新应用图标

func (*Client) UpdateAppName 

func (c *Client) UpdateAppName(ctx context.Context, appID string, req *models.UpdateAppNameRequest) (*models.ConsoleApp, error)

UpdateAppName 更新应用名称

func (*Client) UpdateAppSiteStatus 

func (c *Client) UpdateAppSiteStatus(ctx context.Context, appID string, req *models.UpdateAppSiteStatusRequest) (*models.ConsoleApp, error)

UpdateAppSiteStatus 更新应用站点状态

func (*Client) UpdateAppTrace 

func (c *Client) UpdateAppTrace(ctx context.Context, appID string, req *models.UpdateAppTraceRequest) error

UpdateAppTrace 更新应用追踪配置

func (*Client) UpdateDataset 

func (c *Client) UpdateDataset(ctx context.Context, datasetID string, req *models.UpdateDatasetRequest) (*models.Dataset, error)

UpdateDataset 更新数据集

func (*Client) UpdateMCPProvider added in v0.1.5 

func (c *Client) UpdateMCPProvider(ctx context.Context, providerID, serverURL, name string, icon any, iconType, iconBackground, serverIdentifier string) (*models.ToolProviderEntity, error)

UpdateMCPProvider 更新 MCP Provider

func (*Client) UpdateMCPProviderTools added in v0.1.5 

func (c *Client) UpdateMCPProviderTools(ctx context.Context, providerID string) (*models.OperationResponse, error)

UpdateMCPProviderTools 拉取 MCP Provider 工具列表

func (*Client) UpdateModelProviderModel added in v0.1.5 

func (c *Client) UpdateModelProviderModel(ctx context.Context, provider, model, modelType string, credentials, loadBalancing map[string]interface{}, configFrom *string) (map[string]interface{}, error)

新增/更新 provider 下的模型

func (*Client) UpdateToolApiProvider added in v0.1.5 

func (c *Client) UpdateToolApiProvider(ctx context.Context, credentials map[string]interface{}, schemaType, schema, provider, originalProvider string, icon map[string]interface{}, privacyPolicy, customDisclaimer string, labels []string) (*models.OperationResponse, error)

更新API工具提供商接口

func (*Client) UpdateToolBuiltinProvider added in v0.1.5 

func (c *Client) UpdateToolBuiltinProvider(ctx context.Context, provider string, credentials map[string]string) (*models.OperationResponse, error)

更新内置工具提供商credentials接口

func (*Client) UpdateWorkspacesCurrentMembersRole added in v0.1.5 

func (c *Client) UpdateWorkspacesCurrentMembersRole(ctx context.Context, memberID, role string) (*models.WorkspaceUpdateRoleResponse, error)

更新成员角色接口

func (*Client) UploadPluginPkg added in v0.1.5 

func (c *Client) UploadPluginPkg(ctx context.Context, filename string, fileData []byte) (string, error)

PluginUploadPkg 上传插件包（pkg文件）

func (*Client) WithWorkspaceID 

func (c *Client) WithWorkspaceID(workspaceID string) *Client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.