跳转到内容

签名关联类型:ServerCanvas – SettingsEntryView

本页由当前 SDK 声明自动生成。

返回接口索引

ServerCanvas · ServiceConnectionCapability · ServiceConnectionDirectory · ServiceConnectionEndpoint · ServiceConnectionKind · ServiceConnectionManagement · ServiceConnectionProtocol · ServiceConnectionPurpose · ServiceConnectionResolve · ServiceConnectionScope · ServiceConnectionSourceAdapter · ServiceConnectionSourceSnapshot · ServiceConnectionVersion · ServiceConnectionView · ServiceConsumerBinding · SettingBase · SettingDefinition · SettingDescription · SettingExtensionPointProvider · SettingPluginLayer · SettingPluginView · SettingReload · SettingSource · SettingsEntryView

ServerCanvas

export type ServerCanvas<TNodeData extends Woohaa3CanvasJsonObject = CanvasNodeData> = StoredCanvas<TNodeData> & {
assets: StoredAsset[];
jobs: StoredJob[];
};

关联类型:Woohaa3CanvasJsonObject · CanvasNodeData · StoredCanvas · StoredAsset · StoredJob

ServiceConnectionCapability

export type ServiceConnectionCapability = {
purpose: ServiceConnectionPurpose;
protocol: ServiceConnectionProtocol;
modelId: string;
imageInput: boolean;
evidence: "adapter" | "model-directory" | "tested";
reasoning?: AgentReasoningCapability;
};

关联类型:ServiceConnectionPurpose · ServiceConnectionProtocol · AgentReasoningCapability

成员说明:

  • reasoning:与 Agent 目录同一份 reasoning 事实;缺省表示该来源未声明。

ServiceConnectionDirectory

export type ServiceConnectionDirectory = {
connections: ServiceConnectionView[];
duplicates: readonly (readonly [
string,
string
])[];
providers: readonly {
providerId: string;
protocols: readonly ServiceConnectionProtocol[];
models: readonly {
modelId: string;
modelKey: string;
type: string;
}[];
}[];
};

关联类型:ServiceConnectionView · ServiceConnectionProtocol

ServiceConnectionEndpoint

export type ServiceConnectionEndpoint = {
protocol: ServiceConnectionProtocol;
baseUrl: string;
};

关联类型:ServiceConnectionProtocol

ServiceConnectionKind

export type ServiceConnectionKind = "api" | "oauth";

ServiceConnectionManagement

export type ServiceConnectionManagement = {
action: "protocol";
serviceConnectionId: string;
configRevision: number;
credentialEpoch: number;
endpoint: ServiceConnectionEndpoint;
models: readonly string[];
} | {
action: "enabled";
serviceConnectionId: string;
configRevision: number;
credentialEpoch: number;
enabled: boolean;
} | {
action: "assistant";
serviceConnectionId: string;
configRevision: number;
credentialEpoch: number;
enabled: boolean;
} | {
action: "remove";
serviceConnectionId: string;
configRevision: number;
credentialEpoch: number;
} | {
action: "provider";
serviceConnectionId: string;
configRevision: number;
credentialEpoch: number;
providerId: string;
modelId: string;
} | {
action: "merge";
operationId: string;
retainedId: string;
removedId: string;
retained: ServiceConnectionVersion;
removed: ServiceConnectionVersion;
};

关联类型:ServiceConnectionEndpoint · ServiceConnectionVersion

ServiceConnectionProtocol

export type ServiceConnectionProtocol = "responses" | "messages" | "chat-completions" | "gemini" | `provider:${string}`;

ServiceConnectionPurpose

服务连接能力用途。

text 同时表示「可作为文本模型」和「可作为 Agent 模型」:所有文本模型都视为支持工具调用, 不再单独区分 discussion / target-execution。媒体用途仍按模态区分。

export type ServiceConnectionPurpose = "text" | "image" | "video" | "audio" | "candidate";

ServiceConnectionResolve

export type ServiceConnectionResolve = ServiceConnectionVersion & {
serviceConnectionId: string;
bindingId: string;
purpose: ServiceConnectionPurpose;
protocol: string;
modelId: string;
endpoint: string;
};

关联类型:ServiceConnectionVersion · ServiceConnectionPurpose

ServiceConnectionScope

Service source identity is independent of Agent sessions, Task IDs and tool grants. Public views deliberately contain no credential references or readable secrets.

export type ServiceConnectionScope = "personal" | "site";

ServiceConnectionSourceAdapter

export type ServiceConnectionSourceAdapter = {
retainAuthorityOnDispose?: boolean;
id: string;
scope: ServiceConnectionScope;
list(owner: string): Promise<readonly ServiceConnectionSourceSnapshot[]>;
get(owner: string, legacyId: string): Promise<ServiceConnectionSourceSnapshot | null>;
readSecret?(owner: string, legacyId: string, expected: ServiceConnectionVersion): Promise<string | null>;
};

关联类型:ServiceConnectionScope · ServiceConnectionSourceSnapshot · ServiceConnectionVersion

成员说明:

  • retainAuthorityOnDispose:Keep a credential-only legacy bridge when the optional consumer is disabled.
  • readSecret:OAuth adapters omit this: tokens stay inside their original authorization execution path.

ServiceConnectionSourceSnapshot

Backend-only adapter: owner is supplied by an authenticated host operation. Never expose this port over JSON.

export type ServiceConnectionSourceSnapshot = Omit<ServiceConnectionView, "serviceConnectionId" | "managedByAdministrator"> & {
legacyId: string;
credentialFingerprint?: string;
};

关联类型:ServiceConnectionView

成员说明:

  • credentialFingerprint:Opaque internal change evidence. Never returned in public views.

ServiceConnectionVersion

export type ServiceConnectionVersion = {
configRevision: number;
credentialEpoch: number;
};

ServiceConnectionView

export type ServiceConnectionView = ServiceConnectionVersion & {
serviceConnectionId: string;
scope: ServiceConnectionScope;
kind: ServiceConnectionKind;
name: string;
endpoints: readonly ServiceConnectionEndpoint[];
capabilities: readonly ServiceConnectionCapability[];
bindings: readonly ServiceConsumerBinding[];
enabled: boolean;
removed: boolean;
credentialConfigured: boolean;
locked: boolean;
managedByAdministrator: boolean;
};

关联类型:ServiceConnectionVersion · ServiceConnectionScope · ServiceConnectionKind · ServiceConnectionEndpoint · ServiceConnectionCapability · ServiceConsumerBinding

ServiceConsumerBinding

export type ServiceConsumerBinding = {
bindingId: string;
extensionId: string;
consumer: "agent" | "provider" | "oauth";
consumerId: string;
purposes: readonly ServiceConnectionPurpose[];
modelKeys: readonly string[];
};

关联类型:ServiceConnectionPurpose

成员说明:

  • modelKeys:Historical model identity stays with the consumer.

SettingBase

type SettingBase = {
label: string;
description: string;
reload: SettingReload;
secret?: boolean;
legacyEnv?: string;
group?: string;
ownerExtensionId?: string;
};

关联类型:SettingReload

成员说明:

  • label:设置页上的名称。
  • reload:hot:运行中生效;restart:写入后需要重启进程。
  • legacyEnv:过渡期兼容的旧环境变量名;新配置项不要再声明。
  • group:设置页上的分组(插件配置项按插件分组)。
  • ownerExtensionId:声明这段配置的扩展 id(宿主装载器按插件名填入)。设置面据此把「这个配置段的启停」 放到配置旁边,而不是留在插件清单里。

SettingDefinition

export type SettingDefinition = StringSettingDefinition | UrlSettingDefinition | IntegerSettingDefinition | BooleanSettingDefinition;

关联类型:StringSettingDefinition · UrlSettingDefinition · IntegerSettingDefinition · BooleanSettingDefinition

成员说明:

  • label:设置页上的名称。
  • reload:hot:运行中生效;restart:写入后需要重启进程。
  • legacyEnv:过渡期兼容的旧环境变量名;新配置项不要再声明。
  • group:设置页上的分组(插件配置项按插件分组)。
  • ownerExtensionId:声明这段配置的扩展 id(宿主装载器按插件名填入)。设置面据此把「这个配置段的启停」 放到配置旁边,而不是留在插件清单里。

SettingDescription

export type SettingDescription = {
key: string;
kind: SettingDefinition["kind"];
label: string;
description: string;
group?: string;
ownerExtensionId?: string;
protocols?: readonly string[];
reload: SettingReload;
secret: boolean;
source: SettingSource | null;
lockedBy: string | null;
value: string | number | boolean | null;
configured: boolean;
};

关联类型:SettingDefinition · SettingReload · SettingSource

成员说明:

  • group:设置页上的分组;宿主自己的配置项没有分组。
  • ownerExtensionId:声明这段配置的扩展 id;宿主自己的配置项没有归属扩展。
  • protocols:仅 url 类:允许的协议。
  • lockedBy:生效值来自旧环境变量时,设置面不能修改。
  • value:敏感项不回显,只给出是否已配置。

SettingExtensionPointProvider

扩展点当前可用的提供者。

设置页据此把「选哪个」渲染成可选项,并把选择直接链到提供者插件的配置——扩展点自己的配置 (选谁)与提供者的深配置(桶、密钥、地址)因此能在同一处衔接。

export type SettingExtensionPointProvider = {
id: string;
label: string;
ownerExtensionId: string | null;
temporaryCategory?: TemporaryHostingCategory;
};

关联类型:TemporaryHostingCategory

成员说明:

  • id:设置值里引用的 id(例如存储的 backendId)。
  • label:面向用户的显示名;提供者没声明时回退 id。
  • ownerExtensionId:注册这个能力的插件 id;宿主用它打开对应插件详情。未声明时为 null。
  • temporaryCategory:临时图床类别;缺省表示只能手动选择的普通地址提供者。

SettingPluginLayer

插件所属层:宿主基础层(base/)/ 宿主核心层(core/)/ 扩展层(源码声明 与三方插件)。

宿主内部按此分层登记;前端插件面板只显示磁盘扩展目录。

export type SettingPluginLayer = "base" | "core" | "extension";

SettingPluginView

设置面上的插件条目(宿主随 GET /api/settings 返回)。

插件的配置项仍以 settings 里每项的 ownerExtensionId 归属;这里提供插件本身的身份、 分层与启停范围,让设置页不需要从键名前缀猜插件是谁。

export type SettingPluginView = {
website?: string;
setupOrder?: number;
modelTypes?: readonly CanvasTaskModelType[];
directory?: string;
id: string;
label: string;
description: string;
layer: SettingPluginLayer;
icon?: PluginIcon;
configPrefix?: string;
settingCount: number;
siteManaged: boolean;
provider: boolean;
modelRefresh?: {
path: string;
hint: string;
};
activationFailure?: string;
};

关联类型:CanvasTaskModelType · SettingPluginLayer · PluginIcon

成员说明:

  • website:扩展声明的服务商网站。
  • setupOrder:添加提供商列表的展示顺序;未声明时排在推荐入口之后。
  • modelTypes:扩展声明的 Provider 输出类型,不等同于当前账号可用模型或已验证权限。
  • directory:宿主扫描到的插件绝对目录,仅用于展示。
  • icon:插件声明的图标:语义图形名或 /plugin-icons/ 下的品牌图形;未声明时设置页用通用插件图标兜底。
  • configPrefix:声明配置段的键前缀(providers.ark、storage.local);没有可配置项的插件缺省。
  • settingCount:该插件声明的配置项数。
  • siteManaged:站点插件:可由站点插件服务启停(其余插件随宿主装载)。
  • provider:Provider 类插件:配置段在 providers.<providerId> 下。
  • modelRefresh:插件声明的模型目录刷新入口(ExtensionPlugin.modelRefresh);缺省表示该插件没有这一节。 宿主只透传,不在管理面硬编码具体 Provider。
  • activationFailure:非站点扩展层插件最近一次启动失败的原因(Provider / 存储后端)。 这类插件没有 actualState:不进站点控制面,apply 抛错时宿主只记日志。带上这一项, 设置页才能在「还没有模型」旁边说清「插件没启动起来」以及为什么,而不是让人去翻日志。 站点插件的失败原因走 plugins 的 actualState / diagnostics,不用这个字段。

SettingReload

export type SettingReload = "hot" | "restart";

SettingSource

export type SettingSource = "default" | "file" | "secrets" | "env";

SettingsEntryView

export type SettingsEntryView = SettingDescription & {
pendingRestart: boolean;
};

关联类型:SettingDescription

成员说明:

  • group:设置页上的分组;宿主自己的配置项没有分组。
  • ownerExtensionId:声明这段配置的扩展 id;宿主自己的配置项没有归属扩展。
  • protocols:仅 url 类:允许的协议。
  • lockedBy:生效值来自旧环境变量时,设置面不能修改。
  • value:敏感项不回显,只给出是否已配置。