@tbox-dev-js/sdk 0.1.5 → 0.1.6
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/README.md +161 -47
- package/dist/homepage.d.ts +79 -0
- package/dist/http.d.ts +36 -4
- package/dist/index.cjs +182 -21
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.esm.js +182 -22
- package/dist/index.esm.js.map +1 -1
- package/dist/types.d.ts +77 -20
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -14,6 +14,42 @@ export interface SdkResponse<T = unknown> {
|
|
|
14
14
|
/** 错误信息 */
|
|
15
15
|
errorMsg?: string;
|
|
16
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* C端 Session 鉴权信息
|
|
19
|
+
*
|
|
20
|
+
* 通过 TboxAppClient.generateSession() 获取 sessionId 和 channel,
|
|
21
|
+
* 结合 appId 构成 C端请求头。
|
|
22
|
+
*/
|
|
23
|
+
export interface SessionAuth {
|
|
24
|
+
/** 会话 ID(通过 generateSession 获取) */
|
|
25
|
+
sessionId: string;
|
|
26
|
+
/** 登录渠道(通过 generateSession 获取) */
|
|
27
|
+
channel: string;
|
|
28
|
+
/** 百宝箱应用 ID */
|
|
29
|
+
appId: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* B端客户端配置(通过 API Key 鉴权)
|
|
33
|
+
*/
|
|
34
|
+
export interface TboxPluginClientConfig {
|
|
35
|
+
/** API Key(通过 Authorization 头传递) */
|
|
36
|
+
apiKey: string;
|
|
37
|
+
/** 自定义 base URL(可选,默认 https://o.tbox.cn) */
|
|
38
|
+
baseUrl?: string;
|
|
39
|
+
/** 请求超时时间(毫秒,可选) */
|
|
40
|
+
timeout?: number;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* C端客户端配置(通过 Session 鉴权)
|
|
44
|
+
*/
|
|
45
|
+
export interface TboxSessionClientConfig {
|
|
46
|
+
/** C端 Session 鉴权信息 */
|
|
47
|
+
session: SessionAuth;
|
|
48
|
+
/** 自定义 base URL(可选,默认 https://o.tbox.cn) */
|
|
49
|
+
baseUrl?: string;
|
|
50
|
+
/** 请求超时时间(毫秒,可选) */
|
|
51
|
+
timeout?: number;
|
|
52
|
+
}
|
|
17
53
|
/**
|
|
18
54
|
* 文字转语音请求
|
|
19
55
|
*/
|
|
@@ -340,26 +376,6 @@ export interface WebSearchResponse {
|
|
|
340
376
|
/** 搜索结果列表 */
|
|
341
377
|
items?: WebSearchItem[];
|
|
342
378
|
}
|
|
343
|
-
/**
|
|
344
|
-
* TboxPluginClient 初始化配置
|
|
345
|
-
*/
|
|
346
|
-
export interface TboxPluginClientConfig {
|
|
347
|
-
/**
|
|
348
|
-
* API Key(Bearer Token),通过 Authorization 头传递。
|
|
349
|
-
* 格式:直接传 key 字符串,SDK 内部会自动拼接 "Bearer " 前缀。
|
|
350
|
-
*/
|
|
351
|
-
apiKey: string;
|
|
352
|
-
/**
|
|
353
|
-
* 自定义 base URL(可选)。
|
|
354
|
-
* 默认为 https://o.tbox.cn
|
|
355
|
-
*/
|
|
356
|
-
baseUrl?: string;
|
|
357
|
-
/**
|
|
358
|
-
* 请求超时时间(毫秒,可选)。
|
|
359
|
-
* 默认不设置超时。
|
|
360
|
-
*/
|
|
361
|
-
timeout?: number;
|
|
362
|
-
}
|
|
363
379
|
/**
|
|
364
380
|
* AmapClient 初始化配置
|
|
365
381
|
*/
|
|
@@ -1413,3 +1429,44 @@ export interface ChatCompletionChunkChoice {
|
|
|
1413
1429
|
/** 结束原因:stop / length / content_filter 等,正常结束为 stop */
|
|
1414
1430
|
finish_reason?: string | null;
|
|
1415
1431
|
}
|
|
1432
|
+
/**
|
|
1433
|
+
* 首页开场白请求
|
|
1434
|
+
*/
|
|
1435
|
+
export interface HomepageGetRequest {
|
|
1436
|
+
/** 应用 Agent ID(必填) */
|
|
1437
|
+
agentId: string;
|
|
1438
|
+
/** 扩展信息(可选,JSON 字符串) */
|
|
1439
|
+
extInfo?: string;
|
|
1440
|
+
}
|
|
1441
|
+
/**
|
|
1442
|
+
* 创建 C端客户端的便捷参数
|
|
1443
|
+
*
|
|
1444
|
+
* 通过 B端 apiKey 自动调用 generateSession 获取 session 信息
|
|
1445
|
+
*/
|
|
1446
|
+
export interface CreateSessionClientOptions {
|
|
1447
|
+
/** B端 API Key(用于调用 generateSession) */
|
|
1448
|
+
apiKey: string;
|
|
1449
|
+
/** 百宝箱应用 ID */
|
|
1450
|
+
appId: string;
|
|
1451
|
+
/** 用户 ID */
|
|
1452
|
+
userId: string;
|
|
1453
|
+
/** 自定义 base URL(可选) */
|
|
1454
|
+
baseUrl?: string;
|
|
1455
|
+
/** 请求超时时间(毫秒,可选) */
|
|
1456
|
+
timeout?: number;
|
|
1457
|
+
}
|
|
1458
|
+
/**
|
|
1459
|
+
* 首页开场白响应
|
|
1460
|
+
*/
|
|
1461
|
+
export interface HomepageGetResponse {
|
|
1462
|
+
/** 开场白文本 */
|
|
1463
|
+
prologue?: string;
|
|
1464
|
+
/** 推荐问题列表 */
|
|
1465
|
+
suggestQuestions?: string[];
|
|
1466
|
+
/** 应用名称 */
|
|
1467
|
+
agentName?: string;
|
|
1468
|
+
/** 应用头像 URL */
|
|
1469
|
+
agentAvatar?: string;
|
|
1470
|
+
/** 扩展信息 */
|
|
1471
|
+
extInfo?: Record<string, unknown>;
|
|
1472
|
+
}
|