@super_studio/ecforce-ai-agent-server 1.4.0-canary.0 → 1.4.0-canary.2
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 +91 -2
- package/dist/sdk/__generated__/index.cjs +68 -0
- package/dist/sdk/__generated__/index.d.cts +238 -14
- package/dist/sdk/__generated__/index.d.cts.map +1 -1
- package/dist/sdk/__generated__/index.d.mts +238 -14
- package/dist/sdk/__generated__/index.d.mts.map +1 -1
- package/dist/sdk/__generated__/index.mjs +68 -0
- package/dist/sdk/__generated__/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/sdk/__generated__/index.ts +541 -59
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# `@super_studio/ecforce-ai-agent-server`
|
|
2
2
|
|
|
3
|
-
ecforce AI
|
|
3
|
+
ecforce AIエージェント のサーバー向け SDK です。
|
|
4
4
|
|
|
5
5
|
主に次の 2 つを提供します。
|
|
6
6
|
|
|
@@ -56,7 +56,7 @@ AI_AGENT_API_ENDPOINT=https://dev-agent.ec-force.com
|
|
|
56
56
|
|
|
57
57
|
### `spst()`
|
|
58
58
|
|
|
59
|
-
Vercel AI SDK の `generateText()` / `streamText()` などから、ecforce AI
|
|
59
|
+
Vercel AI SDK の `generateText()` / `streamText()` などから、ecforce AIエージェント の proxy provider を使いたいときに使います。
|
|
60
60
|
|
|
61
61
|
用途:
|
|
62
62
|
|
|
@@ -266,6 +266,95 @@ const result = streamText({
|
|
|
266
266
|
});
|
|
267
267
|
```
|
|
268
268
|
|
|
269
|
+
### エラーハンドリング
|
|
270
|
+
|
|
271
|
+
クレジット上限に達すると、プロキシは **429** を返します。
|
|
272
|
+
|
|
273
|
+
```json
|
|
274
|
+
{
|
|
275
|
+
"error": {
|
|
276
|
+
"message": "Credit limit exceeded.",
|
|
277
|
+
"type": "rate_limit_error",
|
|
278
|
+
"code": "credit_limit_exceeded"
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Vercel AI SDK では、このエラーは `APICallError` として扱われます。`generateText` と `streamText` で受け取り方が異なる点に注意してください。
|
|
284
|
+
|
|
285
|
+
#### `generateText`
|
|
286
|
+
|
|
287
|
+
`generateText()` 自体が throw します。
|
|
288
|
+
|
|
289
|
+
```ts
|
|
290
|
+
import { APICallError, generateText } from "ai";
|
|
291
|
+
import { createSpstProvider } from "@super_studio/ecforce-ai-agent-server/provider";
|
|
292
|
+
|
|
293
|
+
const provider = createSpstProvider({ callerApp: "admin-dashboard" });
|
|
294
|
+
|
|
295
|
+
try {
|
|
296
|
+
await generateText({
|
|
297
|
+
model: provider("openai/gpt-5.4"),
|
|
298
|
+
prompt: "売上の改善案を3つ提案して",
|
|
299
|
+
maxRetries: 0,
|
|
300
|
+
providerOptions: {
|
|
301
|
+
spst: {
|
|
302
|
+
projectId: "project_123",
|
|
303
|
+
email: "user@example.com",
|
|
304
|
+
},
|
|
305
|
+
},
|
|
306
|
+
});
|
|
307
|
+
} catch (error) {
|
|
308
|
+
if (isCreditLimitError(error)) {
|
|
309
|
+
// 例: UI に「クレジット上限に達しました」を表示
|
|
310
|
+
return;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
throw error;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
function isCreditLimitError(error: unknown) {
|
|
317
|
+
return (
|
|
318
|
+
APICallError.isInstance(error) &&
|
|
319
|
+
error.statusCode === 429 &&
|
|
320
|
+
error.responseBody?.includes("credit_limit_exceeded") === true
|
|
321
|
+
);
|
|
322
|
+
}
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
#### `streamText`
|
|
326
|
+
|
|
327
|
+
`streamText()` の HTTP エラーは `onError` で受け取ります。`await result.text` 側で credit limit を判定する必要はありません。
|
|
328
|
+
|
|
329
|
+
```ts
|
|
330
|
+
import { APICallError, streamText } from "ai";
|
|
331
|
+
import { createSpstProvider } from "@super_studio/ecforce-ai-agent-server/provider";
|
|
332
|
+
|
|
333
|
+
const provider = createSpstProvider({ callerApp: "admin-dashboard" });
|
|
334
|
+
|
|
335
|
+
const result = streamText({
|
|
336
|
+
model: provider("openai/gpt-5.4-mini"),
|
|
337
|
+
prompt: "FAQ の草案を作成して",
|
|
338
|
+
maxRetries: 0,
|
|
339
|
+
providerOptions: {
|
|
340
|
+
spst: {
|
|
341
|
+
projectId: "project_123",
|
|
342
|
+
email: "user@example.com",
|
|
343
|
+
},
|
|
344
|
+
},
|
|
345
|
+
onError: ({ error }) => {
|
|
346
|
+
if (isCreditLimitError(error)) {
|
|
347
|
+
// 例: UI に「クレジット上限に達しました」を表示
|
|
348
|
+
return;
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
console.error(error);
|
|
352
|
+
},
|
|
353
|
+
});
|
|
354
|
+
|
|
355
|
+
return result.toUIMessageStreamResponse();
|
|
356
|
+
```
|
|
357
|
+
|
|
269
358
|
### Google Search tool を併用する
|
|
270
359
|
|
|
271
360
|
Google 系モデルでは、AI SDK 側のツールを組み合わせて使えます。
|
|
@@ -305,6 +305,36 @@ var Api = class extends HttpClient {
|
|
|
305
305
|
secure: true,
|
|
306
306
|
type: ContentType.Json,
|
|
307
307
|
format: "json"
|
|
308
|
+
}, params)),
|
|
309
|
+
listGlobalAgentSuggestedPrompts: (agentId, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
310
|
+
path: `/v1/internal/global-agent/${agentId}/suggested-prompts`,
|
|
311
|
+
method: "GET",
|
|
312
|
+
secure: true,
|
|
313
|
+
format: "json"
|
|
314
|
+
}, params)),
|
|
315
|
+
createGlobalAgentSuggestedPrompt: (agentId, data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
316
|
+
path: `/v1/internal/global-agent/${agentId}/suggested-prompts`,
|
|
317
|
+
method: "POST",
|
|
318
|
+
body: data,
|
|
319
|
+
secure: true,
|
|
320
|
+
type: ContentType.Json,
|
|
321
|
+
format: "json"
|
|
322
|
+
}, params)),
|
|
323
|
+
updateGlobalAgentSuggestedPrompt: (id, data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
324
|
+
path: `/v1/internal/global-agent/suggested-prompts/${id}`,
|
|
325
|
+
method: "PUT",
|
|
326
|
+
body: data,
|
|
327
|
+
secure: true,
|
|
328
|
+
type: ContentType.Json,
|
|
329
|
+
format: "json"
|
|
330
|
+
}, params)),
|
|
331
|
+
deleteGlobalAgentSuggestedPrompt: (id, data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
332
|
+
path: `/v1/internal/global-agent/suggested-prompts/${id}`,
|
|
333
|
+
method: "DELETE",
|
|
334
|
+
body: data,
|
|
335
|
+
secure: true,
|
|
336
|
+
type: ContentType.Json,
|
|
337
|
+
format: "json"
|
|
308
338
|
}, params))
|
|
309
339
|
};
|
|
310
340
|
this.internalChat = {
|
|
@@ -449,6 +479,13 @@ var Api = class extends HttpClient {
|
|
|
449
479
|
secure: true,
|
|
450
480
|
type: ContentType.Json,
|
|
451
481
|
format: "json"
|
|
482
|
+
}, params)),
|
|
483
|
+
getRandomSuggestedPrompts: (query, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
484
|
+
path: `/v1/agent/random-suggested-prompts`,
|
|
485
|
+
method: "GET",
|
|
486
|
+
query,
|
|
487
|
+
secure: true,
|
|
488
|
+
format: "json"
|
|
452
489
|
}, params))
|
|
453
490
|
};
|
|
454
491
|
this.apiKeys = {
|
|
@@ -668,6 +705,29 @@ var Api = class extends HttpClient {
|
|
|
668
705
|
format: "json"
|
|
669
706
|
}, params))
|
|
670
707
|
};
|
|
708
|
+
this.mcpOauth = {
|
|
709
|
+
getGrants: (query, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
710
|
+
path: `/v1/mcp-oauth/grants`,
|
|
711
|
+
method: "GET",
|
|
712
|
+
query,
|
|
713
|
+
secure: true,
|
|
714
|
+
format: "json"
|
|
715
|
+
}, params)),
|
|
716
|
+
postGrantsRevokeAll: (params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
717
|
+
path: `/v1/mcp-oauth/grants/revoke-all`,
|
|
718
|
+
method: "POST",
|
|
719
|
+
secure: true,
|
|
720
|
+
format: "json"
|
|
721
|
+
}, params)),
|
|
722
|
+
"postGrants{id}Revoke": (id, data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
723
|
+
path: `/v1/mcp-oauth/grants/${id}/revoke`,
|
|
724
|
+
method: "POST",
|
|
725
|
+
body: data,
|
|
726
|
+
secure: true,
|
|
727
|
+
type: ContentType.Json,
|
|
728
|
+
format: "json"
|
|
729
|
+
}, params))
|
|
730
|
+
};
|
|
671
731
|
this.savedPrompts = {
|
|
672
732
|
list: (params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
673
733
|
path: `/v1/saved-prompts`,
|
|
@@ -749,6 +809,14 @@ var Api = class extends HttpClient {
|
|
|
749
809
|
secure: true,
|
|
750
810
|
format: "json"
|
|
751
811
|
}, params)),
|
|
812
|
+
featureLimitStatus: (data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
813
|
+
path: `/v1/usage/feature-limit-status`,
|
|
814
|
+
method: "POST",
|
|
815
|
+
body: data,
|
|
816
|
+
secure: true,
|
|
817
|
+
type: ContentType.Json,
|
|
818
|
+
format: "json"
|
|
819
|
+
}, params)),
|
|
752
820
|
updateCreditLimit: (data, params = {}) => this.request(require_objectSpread2._objectSpread2({
|
|
753
821
|
path: `/v1/usage/credit-limit`,
|
|
754
822
|
method: "PATCH",
|
|
@@ -412,7 +412,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
412
412
|
* @secure
|
|
413
413
|
*/
|
|
414
414
|
getOverrides: (params?: RequestParams) => Promise<{
|
|
415
|
-
overrides: Record<"adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp", boolean>;
|
|
415
|
+
overrides: Record<"adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "mcp" | "canvas" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp", boolean>;
|
|
416
416
|
}>;
|
|
417
417
|
/**
|
|
418
418
|
* @description 現在のユーザーのフィーチャー上書きを設定または解除
|
|
@@ -424,7 +424,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
424
424
|
* @secure
|
|
425
425
|
*/
|
|
426
426
|
setOverride: (data: {
|
|
427
|
-
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
427
|
+
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "mcp" | "canvas" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
428
428
|
enabled: boolean | null;
|
|
429
429
|
}, params?: RequestParams) => Promise<{
|
|
430
430
|
success: boolean;
|
|
@@ -452,7 +452,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
452
452
|
* @secure
|
|
453
453
|
*/
|
|
454
454
|
updateConditions: (data: {
|
|
455
|
-
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
455
|
+
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "mcp" | "canvas" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
456
456
|
defaultValue: boolean;
|
|
457
457
|
conditions: {
|
|
458
458
|
rules: {
|
|
@@ -475,7 +475,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
475
475
|
* @secure
|
|
476
476
|
*/
|
|
477
477
|
resetConditions: (data: {
|
|
478
|
-
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
478
|
+
featureKey: "adminSettings" | "accountManagement" | "featureOverrides" | "accountSettings" | "spstBillingExclusion" | "reactScan" | "chatDevTool" | "advancedAnalytics" | "betaFeatures" | "adminOptionsUi" | "sharedPrompts" | "mcp" | "canvas" | "langfuseRecordContent" | "modelProviderOpenAI" | "modelProviderGoogle" | "modelProviderAnthropic" | "customMcp";
|
|
479
479
|
}, params?: RequestParams) => Promise<{
|
|
480
480
|
success: boolean;
|
|
481
481
|
}>;
|
|
@@ -490,7 +490,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
490
490
|
*/
|
|
491
491
|
listGroups: (params?: RequestParams) => Promise<{
|
|
492
492
|
userGroups: {
|
|
493
|
-
key: "developers" | "operations" | "testers";
|
|
493
|
+
key: "developers" | "operations" | "customers" | "testers";
|
|
494
494
|
name: string;
|
|
495
495
|
description: string;
|
|
496
496
|
members: {
|
|
@@ -517,7 +517,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
517
517
|
*/
|
|
518
518
|
addGroupMember: (data: {
|
|
519
519
|
type: "user";
|
|
520
|
-
groupKey: "developers" | "operations" | "testers";
|
|
520
|
+
groupKey: "developers" | "operations" | "customers" | "testers";
|
|
521
521
|
/** @minItems 1 */
|
|
522
522
|
userIds: string[];
|
|
523
523
|
} | {
|
|
@@ -540,7 +540,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
540
540
|
*/
|
|
541
541
|
removeGroupMember: (data: {
|
|
542
542
|
type: "user";
|
|
543
|
-
groupKey: "developers" | "operations" | "testers";
|
|
543
|
+
groupKey: "developers" | "operations" | "customers" | "testers";
|
|
544
544
|
/** @minItems 1 */
|
|
545
545
|
userIds: string[];
|
|
546
546
|
} | {
|
|
@@ -705,7 +705,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
705
705
|
/** @maxLength 500 */
|
|
706
706
|
description?: string;
|
|
707
707
|
configJson: {
|
|
708
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
708
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
709
709
|
/** @maxLength 50000 */
|
|
710
710
|
systemPrompt: string;
|
|
711
711
|
nativeTools: {
|
|
@@ -713,12 +713,15 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
713
713
|
generateImage?: boolean;
|
|
714
714
|
ecforceFaq?: boolean;
|
|
715
715
|
webSearch?: boolean;
|
|
716
|
+
executeCode?: boolean;
|
|
717
|
+
canvas?: boolean;
|
|
716
718
|
};
|
|
717
719
|
interfaceFeatures: {
|
|
718
720
|
modelSelection?: boolean;
|
|
719
721
|
attachments?: boolean;
|
|
720
722
|
};
|
|
721
723
|
allowedDomains: string[];
|
|
724
|
+
autoReferenceAIdpFiles?: boolean;
|
|
722
725
|
internalMcps?: {
|
|
723
726
|
ecforce?: boolean | string[];
|
|
724
727
|
ma?: boolean | string[];
|
|
@@ -835,7 +838,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
835
838
|
/** @maxLength 500 */
|
|
836
839
|
description?: string;
|
|
837
840
|
configJson?: {
|
|
838
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
841
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
839
842
|
/** @maxLength 50000 */
|
|
840
843
|
systemPrompt: string;
|
|
841
844
|
nativeTools: {
|
|
@@ -843,12 +846,15 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
843
846
|
generateImage?: boolean;
|
|
844
847
|
ecforceFaq?: boolean;
|
|
845
848
|
webSearch?: boolean;
|
|
849
|
+
executeCode?: boolean;
|
|
850
|
+
canvas?: boolean;
|
|
846
851
|
};
|
|
847
852
|
interfaceFeatures: {
|
|
848
853
|
modelSelection?: boolean;
|
|
849
854
|
attachments?: boolean;
|
|
850
855
|
};
|
|
851
856
|
allowedDomains: string[];
|
|
857
|
+
autoReferenceAIdpFiles?: boolean;
|
|
852
858
|
internalMcps?: {
|
|
853
859
|
ecforce?: boolean | string[];
|
|
854
860
|
ma?: boolean | string[];
|
|
@@ -913,6 +919,91 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
913
919
|
deleteGlobalAgent: (id: string, data?: object, params?: RequestParams) => Promise<{
|
|
914
920
|
success: boolean;
|
|
915
921
|
}>;
|
|
922
|
+
/**
|
|
923
|
+
* @description グローバルエージェントのおすすめの質問一覧を取得する
|
|
924
|
+
*
|
|
925
|
+
* @tags internal, globalAgent, globalAgentSuggestedPrompt
|
|
926
|
+
* @name ListGlobalAgentSuggestedPrompts
|
|
927
|
+
* @summary listGlobalAgentSuggestedPrompts
|
|
928
|
+
* @request GET:/v1/internal/global-agent/{agentId}/suggested-prompts
|
|
929
|
+
* @secure
|
|
930
|
+
*/
|
|
931
|
+
listGlobalAgentSuggestedPrompts: (agentId: string, params?: RequestParams) => Promise<{
|
|
932
|
+
prompts: {
|
|
933
|
+
id: string;
|
|
934
|
+
agentId: string;
|
|
935
|
+
title: string;
|
|
936
|
+
promptText: string;
|
|
937
|
+
}[];
|
|
938
|
+
}>;
|
|
939
|
+
/**
|
|
940
|
+
* @description グローバルエージェントのおすすめの質問を作成する
|
|
941
|
+
*
|
|
942
|
+
* @tags internal, globalAgent, globalAgentSuggestedPrompt
|
|
943
|
+
* @name CreateGlobalAgentSuggestedPrompt
|
|
944
|
+
* @summary createGlobalAgentSuggestedPrompt
|
|
945
|
+
* @request POST:/v1/internal/global-agent/{agentId}/suggested-prompts
|
|
946
|
+
* @secure
|
|
947
|
+
*/
|
|
948
|
+
createGlobalAgentSuggestedPrompt: (agentId: string, data: {
|
|
949
|
+
/**
|
|
950
|
+
* @minLength 1
|
|
951
|
+
* @maxLength 50
|
|
952
|
+
*/
|
|
953
|
+
title: string;
|
|
954
|
+
/**
|
|
955
|
+
* @minLength 1
|
|
956
|
+
* @maxLength 2000
|
|
957
|
+
*/
|
|
958
|
+
promptText: string;
|
|
959
|
+
}, params?: RequestParams) => Promise<{
|
|
960
|
+
prompt: {
|
|
961
|
+
id: string;
|
|
962
|
+
agentId: string;
|
|
963
|
+
title: string;
|
|
964
|
+
promptText: string;
|
|
965
|
+
};
|
|
966
|
+
}>;
|
|
967
|
+
/**
|
|
968
|
+
* @description グローバルエージェントのおすすめの質問を更新する
|
|
969
|
+
*
|
|
970
|
+
* @tags internal, globalAgent, globalAgentSuggestedPrompt
|
|
971
|
+
* @name UpdateGlobalAgentSuggestedPrompt
|
|
972
|
+
* @summary updateGlobalAgentSuggestedPrompt
|
|
973
|
+
* @request PUT:/v1/internal/global-agent/suggested-prompts/{id}
|
|
974
|
+
* @secure
|
|
975
|
+
*/
|
|
976
|
+
updateGlobalAgentSuggestedPrompt: (id: string, data: {
|
|
977
|
+
/**
|
|
978
|
+
* @minLength 1
|
|
979
|
+
* @maxLength 50
|
|
980
|
+
*/
|
|
981
|
+
title: string;
|
|
982
|
+
/**
|
|
983
|
+
* @minLength 1
|
|
984
|
+
* @maxLength 2000
|
|
985
|
+
*/
|
|
986
|
+
promptText: string;
|
|
987
|
+
}, params?: RequestParams) => Promise<{
|
|
988
|
+
prompt: {
|
|
989
|
+
id: string;
|
|
990
|
+
agentId: string;
|
|
991
|
+
title: string;
|
|
992
|
+
promptText: string;
|
|
993
|
+
};
|
|
994
|
+
}>;
|
|
995
|
+
/**
|
|
996
|
+
* @description グローバルエージェントのおすすめの質問を削除する
|
|
997
|
+
*
|
|
998
|
+
* @tags internal, globalAgent, globalAgentSuggestedPrompt
|
|
999
|
+
* @name DeleteGlobalAgentSuggestedPrompt
|
|
1000
|
+
* @summary deleteGlobalAgentSuggestedPrompt
|
|
1001
|
+
* @request DELETE:/v1/internal/global-agent/suggested-prompts/{id}
|
|
1002
|
+
* @secure
|
|
1003
|
+
*/
|
|
1004
|
+
deleteGlobalAgentSuggestedPrompt: (id: string, data?: object, params?: RequestParams) => Promise<{
|
|
1005
|
+
success: boolean;
|
|
1006
|
+
}>;
|
|
916
1007
|
};
|
|
917
1008
|
internalChat: {
|
|
918
1009
|
/**
|
|
@@ -1286,7 +1377,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1286
1377
|
/** @maxLength 500 */
|
|
1287
1378
|
description?: string;
|
|
1288
1379
|
configJson: {
|
|
1289
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
1380
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
1290
1381
|
/** @maxLength 50000 */
|
|
1291
1382
|
systemPrompt: string;
|
|
1292
1383
|
nativeTools: {
|
|
@@ -1294,12 +1385,15 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1294
1385
|
generateImage?: boolean;
|
|
1295
1386
|
ecforceFaq?: boolean;
|
|
1296
1387
|
webSearch?: boolean;
|
|
1388
|
+
executeCode?: boolean;
|
|
1389
|
+
canvas?: boolean;
|
|
1297
1390
|
};
|
|
1298
1391
|
interfaceFeatures: {
|
|
1299
1392
|
modelSelection?: boolean;
|
|
1300
1393
|
attachments?: boolean;
|
|
1301
1394
|
};
|
|
1302
1395
|
allowedDomains: string[];
|
|
1396
|
+
autoReferenceAIdpFiles?: boolean;
|
|
1303
1397
|
internalMcps?: {
|
|
1304
1398
|
ecforce?: boolean | string[];
|
|
1305
1399
|
ma?: boolean | string[];
|
|
@@ -1416,7 +1510,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1416
1510
|
/** @maxLength 500 */
|
|
1417
1511
|
description?: string;
|
|
1418
1512
|
configJson?: {
|
|
1419
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
1513
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
1420
1514
|
/** @maxLength 50000 */
|
|
1421
1515
|
systemPrompt: string;
|
|
1422
1516
|
nativeTools: {
|
|
@@ -1424,12 +1518,15 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1424
1518
|
generateImage?: boolean;
|
|
1425
1519
|
ecforceFaq?: boolean;
|
|
1426
1520
|
webSearch?: boolean;
|
|
1521
|
+
executeCode?: boolean;
|
|
1522
|
+
canvas?: boolean;
|
|
1427
1523
|
};
|
|
1428
1524
|
interfaceFeatures: {
|
|
1429
1525
|
modelSelection?: boolean;
|
|
1430
1526
|
attachments?: boolean;
|
|
1431
1527
|
};
|
|
1432
1528
|
allowedDomains: string[];
|
|
1529
|
+
autoReferenceAIdpFiles?: boolean;
|
|
1433
1530
|
internalMcps?: {
|
|
1434
1531
|
ecforce?: boolean | string[];
|
|
1435
1532
|
ma?: boolean | string[];
|
|
@@ -1510,7 +1607,7 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1510
1607
|
modelSelection?: boolean;
|
|
1511
1608
|
attachments?: boolean;
|
|
1512
1609
|
};
|
|
1513
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
1610
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
1514
1611
|
}>;
|
|
1515
1612
|
/**
|
|
1516
1613
|
* @description エージェントで利用可能なモデル名エイリアス一覧を取得する（公開）
|
|
@@ -1524,9 +1621,9 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1524
1621
|
getAvailableModels: (query?: {
|
|
1525
1622
|
id?: string;
|
|
1526
1623
|
}, params?: RequestParams) => Promise<{
|
|
1527
|
-
defaultModel: "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-4.1-mini" | "gpt-4.1-nano" | "
|
|
1624
|
+
defaultModel: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5" | "gpt-5.2-high" | "gpt-5.2" | "gpt-5.1-high" | "gpt-5.1" | "gpt-5" | "gpt-5-mini" | "gpt-5-nano" | "gpt-4.1-mini" | "gpt-4.1-nano" | "o4-mini" | "o3-mini" | "gemini-3.1-flash-lite" | "gemini-2.5-pro" | "gemini-2.5-flash" | "gemini-3-pro" | "gemini-2.0-flash" | "claude-opus-4-7-thinking" | "claude-opus-4-7" | "claude-opus-4-6-thinking" | "claude-opus-4-6" | "claude-opus-4-5-thinking" | "claude-opus-4-5" | "claude-sonnet-4-5-thinking" | "claude-sonnet-4-5";
|
|
1528
1625
|
models: {
|
|
1529
|
-
key: "gpt-5.
|
|
1626
|
+
key: "gpt-5.5-high" | "gpt-5.5" | "gpt-5.4-high" | "gpt-5.4" | "gpt-5.4-mini" | "gpt-5.4-nano" | "gemini-3.5-flash" | "gemini-3.1-pro" | "gemini-3-flash" | "claude-opus-4-8-thinking" | "claude-opus-4-8" | "claude-sonnet-4-6-thinking" | "claude-sonnet-4-6" | "claude-haiku-4-5-thinking" | "claude-haiku-4-5";
|
|
1530
1627
|
label: string;
|
|
1531
1628
|
}[];
|
|
1532
1629
|
}>;
|
|
@@ -1548,6 +1645,10 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1548
1645
|
type?: "native" | "mcp" | "client";
|
|
1549
1646
|
group?: string;
|
|
1550
1647
|
summary?: string;
|
|
1648
|
+
disabled?: boolean;
|
|
1649
|
+
disabledReason?: string;
|
|
1650
|
+
executionDisabled?: boolean;
|
|
1651
|
+
executionDisabledReason?: string;
|
|
1551
1652
|
}>>;
|
|
1552
1653
|
/**
|
|
1553
1654
|
* @description 指定MCPのツール一覧を取得する
|
|
@@ -1567,7 +1668,36 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
1567
1668
|
type?: "native" | "mcp" | "client";
|
|
1568
1669
|
group?: string;
|
|
1569
1670
|
summary?: string;
|
|
1671
|
+
disabled?: boolean;
|
|
1672
|
+
disabledReason?: string;
|
|
1673
|
+
executionDisabled?: boolean;
|
|
1674
|
+
executionDisabledReason?: string;
|
|
1570
1675
|
}>>;
|
|
1676
|
+
/**
|
|
1677
|
+
* @description エージェントのおすすめの質問をランダム取得する（公開）
|
|
1678
|
+
*
|
|
1679
|
+
* @tags agent
|
|
1680
|
+
* @name GetRandomSuggestedPrompts
|
|
1681
|
+
* @summary getRandomSuggestedPrompts
|
|
1682
|
+
* @request GET:/v1/agent/random-suggested-prompts
|
|
1683
|
+
* @secure
|
|
1684
|
+
*/
|
|
1685
|
+
getRandomSuggestedPrompts: (query?: {
|
|
1686
|
+
agentId?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* @min 1
|
|
1689
|
+
* @max 50
|
|
1690
|
+
* @default 3
|
|
1691
|
+
*/
|
|
1692
|
+
count?: number;
|
|
1693
|
+
}, params?: RequestParams) => Promise<{
|
|
1694
|
+
prompts: {
|
|
1695
|
+
id: string;
|
|
1696
|
+
agentId: string;
|
|
1697
|
+
title: string;
|
|
1698
|
+
promptText: string;
|
|
1699
|
+
}[];
|
|
1700
|
+
}>;
|
|
1571
1701
|
};
|
|
1572
1702
|
apiKeys: {
|
|
1573
1703
|
/**
|
|
@@ -2315,6 +2445,83 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
2315
2445
|
removedCount: number;
|
|
2316
2446
|
}>;
|
|
2317
2447
|
};
|
|
2448
|
+
mcpOauth: {
|
|
2449
|
+
/**
|
|
2450
|
+
* @description 外部アプリのMCP利用許可Grant一覧を取得する
|
|
2451
|
+
*
|
|
2452
|
+
* @tags mcpOAuth
|
|
2453
|
+
* @name GetGrants
|
|
2454
|
+
* @summary list grants
|
|
2455
|
+
* @request GET:/v1/mcp-oauth/grants
|
|
2456
|
+
* @secure
|
|
2457
|
+
*/
|
|
2458
|
+
getGrants: (query?: {
|
|
2459
|
+
q?: string;
|
|
2460
|
+
app?: "ecforce" | "ma" | "bi" | "aidp";
|
|
2461
|
+
status?: "active" | "expiring-soon" | "expired" | "unused" | "no-tools";
|
|
2462
|
+
/**
|
|
2463
|
+
* @min 1
|
|
2464
|
+
* @max 9007199254740991
|
|
2465
|
+
* @default 1
|
|
2466
|
+
*/
|
|
2467
|
+
page?: number;
|
|
2468
|
+
/**
|
|
2469
|
+
* @min 1
|
|
2470
|
+
* @max 100
|
|
2471
|
+
* @default 20
|
|
2472
|
+
*/
|
|
2473
|
+
pageSize?: number;
|
|
2474
|
+
}, params?: RequestParams) => Promise<{
|
|
2475
|
+
items: {
|
|
2476
|
+
id: string;
|
|
2477
|
+
clientId: string;
|
|
2478
|
+
clientName: string | null;
|
|
2479
|
+
clientUri: string | null;
|
|
2480
|
+
redirectUris: string[];
|
|
2481
|
+
projectId: string;
|
|
2482
|
+
app: "ecforce" | "ma" | "bi" | "aidp";
|
|
2483
|
+
toolAllowlist: string[] | null;
|
|
2484
|
+
lastUsedAt: string | null;
|
|
2485
|
+
/** @format date-time */
|
|
2486
|
+
expiresAt: string;
|
|
2487
|
+
/** @format date-time */
|
|
2488
|
+
maxExpiresAt: string;
|
|
2489
|
+
/** @format date-time */
|
|
2490
|
+
createdAt: string;
|
|
2491
|
+
}[];
|
|
2492
|
+
pagination: {
|
|
2493
|
+
page: number;
|
|
2494
|
+
pageSize: number;
|
|
2495
|
+
totalCount: number;
|
|
2496
|
+
totalPages: number;
|
|
2497
|
+
};
|
|
2498
|
+
}>;
|
|
2499
|
+
/**
|
|
2500
|
+
* @description 外部アプリのMCP利用許可Grantをすべて失効する
|
|
2501
|
+
*
|
|
2502
|
+
* @tags mcpOAuth
|
|
2503
|
+
* @name PostGrantsRevokeAll
|
|
2504
|
+
* @summary revoke all grants
|
|
2505
|
+
* @request POST:/v1/mcp-oauth/grants/revoke-all
|
|
2506
|
+
* @secure
|
|
2507
|
+
*/
|
|
2508
|
+
postGrantsRevokeAll: (params?: RequestParams) => Promise<{
|
|
2509
|
+
success: boolean;
|
|
2510
|
+
revokedCount: number;
|
|
2511
|
+
}>;
|
|
2512
|
+
/**
|
|
2513
|
+
* @description 外部アプリのMCP利用許可Grantを失効する
|
|
2514
|
+
*
|
|
2515
|
+
* @tags mcpOAuth
|
|
2516
|
+
* @name PostGrantsIdRevoke
|
|
2517
|
+
* @summary revoke grant
|
|
2518
|
+
* @request POST:/v1/mcp-oauth/grants/{id}/revoke
|
|
2519
|
+
* @secure
|
|
2520
|
+
*/
|
|
2521
|
+
"postGrants{id}Revoke": (id: string, data?: object, params?: RequestParams) => Promise<{
|
|
2522
|
+
success: boolean;
|
|
2523
|
+
}>;
|
|
2524
|
+
};
|
|
2318
2525
|
savedPrompts: {
|
|
2319
2526
|
/**
|
|
2320
2527
|
* @description 保存したプロンプトの一覧を取得
|
|
@@ -2612,6 +2819,23 @@ declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityD
|
|
|
2612
2819
|
messageCount: number;
|
|
2613
2820
|
}[];
|
|
2614
2821
|
}>;
|
|
2822
|
+
/**
|
|
2823
|
+
* @description 無償版向け機能制限の到達状態を取得する
|
|
2824
|
+
*
|
|
2825
|
+
* @tags usage
|
|
2826
|
+
* @name FeatureLimitStatus
|
|
2827
|
+
* @summary featureLimitStatus
|
|
2828
|
+
* @request POST:/v1/usage/feature-limit-status
|
|
2829
|
+
* @secure
|
|
2830
|
+
*/
|
|
2831
|
+
featureLimitStatus: (data: {
|
|
2832
|
+
counterKeys?: string[];
|
|
2833
|
+
}, params?: RequestParams) => Promise<Record<string, {
|
|
2834
|
+
limited: boolean;
|
|
2835
|
+
reached: boolean;
|
|
2836
|
+
used: number;
|
|
2837
|
+
limit: number | null;
|
|
2838
|
+
}>>;
|
|
2615
2839
|
/**
|
|
2616
2840
|
* @description 利用金額の上限を設定する
|
|
2617
2841
|
*
|