@aui.io/aui-client 1.2.35 → 1.2.37
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 +23 -15
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/controllerApi/client/Client.d.ts +0 -13
- package/dist/cjs/api/resources/controllerApi/client/Client.js +0 -63
- package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.d.ts +0 -2
- package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.js +0 -2
- package/dist/cjs/api/types/TaskParameter.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +0 -5
- package/dist/cjs/api/types/index.js +0 -5
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/controllerApi/client/Client.d.mts +0 -13
- package/dist/esm/api/resources/controllerApi/client/Client.mjs +0 -63
- package/dist/esm/api/types/OptionsSearchSelfReviewMethod.d.mts +0 -2
- package/dist/esm/api/types/OptionsSearchSelfReviewMethod.mjs +0 -2
- package/dist/esm/api/types/TaskParameter.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +0 -5
- package/dist/esm/api/types/index.mjs +0 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +0 -56
- package/dist/cjs/api/types/TaskParameterObjectNestedParam.d.ts +0 -7
- package/dist/cjs/api/types/TaskParameterObjectNestedParam.js +0 -3
- package/dist/cjs/api/types/TaskParameterObjectValue.d.ts +0 -6
- package/dist/cjs/api/types/TaskParameterObjectValue.js +0 -3
- package/dist/cjs/api/types/TaskParameterObjectValueItem.d.ts +0 -4
- package/dist/cjs/api/types/TaskParameterObjectValueItem.js +0 -3
- package/dist/cjs/api/types/WorkflowMetadata.d.ts +0 -7
- package/dist/cjs/api/types/WorkflowMetadata.js +0 -3
- package/dist/cjs/api/types/WorkflowsMetadataResponse.d.ts +0 -4
- package/dist/cjs/api/types/WorkflowsMetadataResponse.js +0 -3
- package/dist/esm/api/types/TaskParameterObjectNestedParam.d.mts +0 -7
- package/dist/esm/api/types/TaskParameterObjectNestedParam.mjs +0 -2
- package/dist/esm/api/types/TaskParameterObjectValue.d.mts +0 -6
- package/dist/esm/api/types/TaskParameterObjectValue.mjs +0 -2
- package/dist/esm/api/types/TaskParameterObjectValueItem.d.mts +0 -4
- package/dist/esm/api/types/TaskParameterObjectValueItem.mjs +0 -2
- package/dist/esm/api/types/WorkflowMetadata.d.mts +0 -7
- package/dist/esm/api/types/WorkflowMetadata.mjs +0 -2
- package/dist/esm/api/types/WorkflowsMetadataResponse.d.mts +0 -4
- package/dist/esm/api/types/WorkflowsMetadataResponse.mjs +0 -2
package/README.md
CHANGED
|
@@ -272,15 +272,16 @@ Submit a new message to an existing task (non-streaming).
|
|
|
272
272
|
```typescript
|
|
273
273
|
const messageResponse = await client.controllerApi.sendMessage({
|
|
274
274
|
task_id: string, // Task identifier
|
|
275
|
-
text
|
|
275
|
+
text?: string, // Message text (optional in v1.2.36+)
|
|
276
276
|
is_external_api?: boolean, // Optional: mark as external API call
|
|
277
|
-
include_trace_info?: boolean, // Optional: include trace/debug info in response (NEW)
|
|
277
|
+
include_trace_info?: boolean, // Optional: include trace/debug info in response (NEW in v1.2.35)
|
|
278
278
|
context?: { // Optional: additional context
|
|
279
279
|
url?: string,
|
|
280
280
|
lead_details?: Record<string, any>,
|
|
281
281
|
welcome_message?: string
|
|
282
282
|
},
|
|
283
|
-
agent_variables?: Record<string, unknown
|
|
283
|
+
agent_variables?: Record<string, unknown>, // Optional: custom agent variables
|
|
284
|
+
static_context?: Record<string, unknown> // Optional: static context data (NEW in v1.2.36)
|
|
284
285
|
});
|
|
285
286
|
|
|
286
287
|
// Returns: Message - Complete agent response with optional product cards
|
|
@@ -351,23 +352,27 @@ const traceInfo = await client.controllerApi.getTraceInfo('your-task-id', messag
|
|
|
351
352
|
console.log('Trace Info:', traceInfo);
|
|
352
353
|
```
|
|
353
354
|
|
|
354
|
-
#### `getDirectFollowupSuggestions(taskId)` - Get Direct Followup Suggestions
|
|
355
|
-
Retrieve AI-generated followup suggestions for a specific task.
|
|
355
|
+
#### `getDirectFollowupSuggestions(taskId)` - Get Direct Followup Suggestions
|
|
356
|
+
Retrieve AI-generated followup suggestions for a specific task. Returns a response object containing the suggestions array and a metadata ID for tracking.
|
|
356
357
|
|
|
357
358
|
```typescript
|
|
358
|
-
const
|
|
359
|
+
const response = await client.controllerApi.getDirectFollowupSuggestions('your-task-id');
|
|
359
360
|
|
|
360
|
-
// Returns:
|
|
361
|
+
// Returns: DirectFollowupSuggestionsResponse
|
|
362
|
+
// {
|
|
363
|
+
// suggestions?: string[], // Array of suggested followup questions
|
|
364
|
+
// metadata_id?: string // Metadata ID for tracking/analytics (NEW in v1.2.36)
|
|
365
|
+
// }
|
|
361
366
|
```
|
|
362
367
|
|
|
363
368
|
**Example:**
|
|
364
369
|
|
|
365
370
|
```typescript
|
|
366
|
-
|
|
367
|
-
const suggestions: string[] = await client.controllerApi.getDirectFollowupSuggestions('your-task-id');
|
|
371
|
+
const response = await client.controllerApi.getDirectFollowupSuggestions('your-task-id');
|
|
368
372
|
|
|
373
|
+
console.log('Metadata ID:', response.metadata_id);
|
|
369
374
|
console.log('Suggested followups:');
|
|
370
|
-
suggestions
|
|
375
|
+
response.suggestions?.forEach((suggestion, index) => {
|
|
371
376
|
console.log(`${index + 1}. ${suggestion}`);
|
|
372
377
|
});
|
|
373
378
|
```
|
|
@@ -656,7 +661,7 @@ async function debugAgentResponse(taskId: string) {
|
|
|
656
661
|
debugAgentResponse('task-123');
|
|
657
662
|
```
|
|
658
663
|
|
|
659
|
-
### Get Direct Followup Suggestions
|
|
664
|
+
### Get Direct Followup Suggestions
|
|
660
665
|
|
|
661
666
|
```typescript
|
|
662
667
|
import { ApolloClient } from '@aui.io/aui-client';
|
|
@@ -668,15 +673,17 @@ const client = new ApolloClient({
|
|
|
668
673
|
async function getSuggestedQuestions(taskId: string) {
|
|
669
674
|
try {
|
|
670
675
|
// Get AI-generated followup suggestions based on conversation context
|
|
671
|
-
const
|
|
676
|
+
const response = await client.controllerApi.getDirectFollowupSuggestions(taskId);
|
|
677
|
+
|
|
678
|
+
// metadata_id can be used for tracking/analytics
|
|
679
|
+
console.log('Metadata ID:', response.metadata_id);
|
|
672
680
|
|
|
673
681
|
console.log('Suggested followup questions:');
|
|
674
|
-
suggestions
|
|
682
|
+
response.suggestions?.forEach((suggestion, index) => {
|
|
675
683
|
console.log(` ${index + 1}. ${suggestion}`);
|
|
676
684
|
});
|
|
677
685
|
|
|
678
|
-
|
|
679
|
-
return suggestions;
|
|
686
|
+
return response;
|
|
680
687
|
} catch (error) {
|
|
681
688
|
console.error('Error getting suggestions:', error);
|
|
682
689
|
throw error;
|
|
@@ -686,6 +693,7 @@ async function getSuggestedQuestions(taskId: string) {
|
|
|
686
693
|
// Example usage
|
|
687
694
|
getSuggestedQuestions('task-123');
|
|
688
695
|
// Output:
|
|
696
|
+
// Metadata ID: 69e4b4d4359671434fdff849
|
|
689
697
|
// Suggested followup questions:
|
|
690
698
|
// 1. "What colors are available?"
|
|
691
699
|
// 2. "Do you offer financing options?"
|
package/dist/cjs/Client.js
CHANGED
|
@@ -45,8 +45,8 @@ class ApolloClient {
|
|
|
45
45
|
"x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
|
|
46
46
|
"X-Fern-Language": "JavaScript",
|
|
47
47
|
"X-Fern-SDK-Name": "@aui.io/aui-client",
|
|
48
|
-
"X-Fern-SDK-Version": "1.2.
|
|
49
|
-
"User-Agent": "@aui.io/aui-client/1.2.
|
|
48
|
+
"X-Fern-SDK-Version": "1.2.37",
|
|
49
|
+
"User-Agent": "@aui.io/aui-client/1.2.37",
|
|
50
50
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
51
51
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
52
52
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -113,19 +113,6 @@ export declare class ControllerApi {
|
|
|
113
113
|
*/
|
|
114
114
|
getDirectFollowupSuggestions(taskId: string, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.DirectFollowupSuggestionsResponse>;
|
|
115
115
|
private __getDirectFollowupSuggestions;
|
|
116
|
-
/**
|
|
117
|
-
* Get metadata for all workflows available for the authenticated network.
|
|
118
|
-
* Returns a lean version with essential workflow information.
|
|
119
|
-
*
|
|
120
|
-
* @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
|
|
121
|
-
*
|
|
122
|
-
* @throws {@link Apollo.UnprocessableEntityError}
|
|
123
|
-
*
|
|
124
|
-
* @example
|
|
125
|
-
* await client.controllerApi.getWorkflowsMetadata()
|
|
126
|
-
*/
|
|
127
|
-
getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
|
|
128
|
-
private __getWorkflowsMetadata;
|
|
129
116
|
/**
|
|
130
117
|
* @param {string} taskId
|
|
131
118
|
* @param {string} messageId
|
|
@@ -599,69 +599,6 @@ class ControllerApi {
|
|
|
599
599
|
}
|
|
600
600
|
});
|
|
601
601
|
}
|
|
602
|
-
/**
|
|
603
|
-
* Get metadata for all workflows available for the authenticated network.
|
|
604
|
-
* Returns a lean version with essential workflow information.
|
|
605
|
-
*
|
|
606
|
-
* @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
|
|
607
|
-
*
|
|
608
|
-
* @throws {@link Apollo.UnprocessableEntityError}
|
|
609
|
-
*
|
|
610
|
-
* @example
|
|
611
|
-
* await client.controllerApi.getWorkflowsMetadata()
|
|
612
|
-
*/
|
|
613
|
-
getWorkflowsMetadata(requestOptions) {
|
|
614
|
-
return core.HttpResponsePromise.fromPromise(this.__getWorkflowsMetadata(requestOptions));
|
|
615
|
-
}
|
|
616
|
-
__getWorkflowsMetadata(requestOptions) {
|
|
617
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
618
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
619
|
-
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
|
|
620
|
-
"x-network-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.networkApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.networkApiKey,
|
|
621
|
-
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
622
|
-
const _response = yield core.fetcher({
|
|
623
|
-
url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "api/v1/external/workflows/metadata"),
|
|
624
|
-
method: "GET",
|
|
625
|
-
headers: _headers,
|
|
626
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
627
|
-
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
628
|
-
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
629
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
630
|
-
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
631
|
-
logging: this._options.logging,
|
|
632
|
-
});
|
|
633
|
-
if (_response.ok) {
|
|
634
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
635
|
-
}
|
|
636
|
-
if (_response.error.reason === "status-code") {
|
|
637
|
-
switch (_response.error.statusCode) {
|
|
638
|
-
case 422:
|
|
639
|
-
throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
640
|
-
default:
|
|
641
|
-
throw new errors.ApolloError({
|
|
642
|
-
statusCode: _response.error.statusCode,
|
|
643
|
-
body: _response.error.body,
|
|
644
|
-
rawResponse: _response.rawResponse,
|
|
645
|
-
});
|
|
646
|
-
}
|
|
647
|
-
}
|
|
648
|
-
switch (_response.error.reason) {
|
|
649
|
-
case "non-json":
|
|
650
|
-
throw new errors.ApolloError({
|
|
651
|
-
statusCode: _response.error.statusCode,
|
|
652
|
-
body: _response.error.rawBody,
|
|
653
|
-
rawResponse: _response.rawResponse,
|
|
654
|
-
});
|
|
655
|
-
case "timeout":
|
|
656
|
-
throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/workflows/metadata.");
|
|
657
|
-
case "unknown":
|
|
658
|
-
throw new errors.ApolloError({
|
|
659
|
-
message: _response.error.errorMessage,
|
|
660
|
-
rawResponse: _response.rawResponse,
|
|
661
|
-
});
|
|
662
|
-
}
|
|
663
|
-
});
|
|
664
|
-
}
|
|
665
602
|
/**
|
|
666
603
|
* @param {string} taskId
|
|
667
604
|
* @param {string} messageId
|
|
@@ -2,8 +2,6 @@ export declare const OptionsSearchSelfReviewMethod: {
|
|
|
2
2
|
readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
|
|
3
3
|
readonly Llm: "LLM";
|
|
4
4
|
readonly LlmPerOption: "LLM_PER_OPTION";
|
|
5
|
-
readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
|
|
6
|
-
readonly CohereRanker: "COHERE_RANKER";
|
|
7
5
|
readonly ConstantScore: "CONSTANT_SCORE";
|
|
8
6
|
readonly ParamMatching: "PARAM_MATCHING";
|
|
9
7
|
};
|
|
@@ -6,8 +6,6 @@ exports.OptionsSearchSelfReviewMethod = {
|
|
|
6
6
|
InventoryClassification: "INVENTORY_CLASSIFICATION",
|
|
7
7
|
Llm: "LLM",
|
|
8
8
|
LlmPerOption: "LLM_PER_OPTION",
|
|
9
|
-
CrossEncoderRanker: "CROSS_ENCODER_RANKER",
|
|
10
|
-
CohereRanker: "COHERE_RANKER",
|
|
11
9
|
ConstantScore: "CONSTANT_SCORE",
|
|
12
10
|
ParamMatching: "PARAM_MATCHING",
|
|
13
11
|
};
|
|
@@ -14,9 +14,9 @@ export interface TaskParameter {
|
|
|
14
14
|
code?: string;
|
|
15
15
|
}
|
|
16
16
|
export declare namespace TaskParameter {
|
|
17
|
-
type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue
|
|
17
|
+
type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
|
|
18
18
|
type ValueHistory = ValueHistory.Item[];
|
|
19
19
|
namespace ValueHistory {
|
|
20
|
-
type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue
|
|
20
|
+
type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
|
|
21
21
|
}
|
|
22
22
|
}
|
|
@@ -32,9 +32,6 @@ export * from "./TaskInteractionOptionSelfReviewScore.js";
|
|
|
32
32
|
export * from "./TaskInteractionOptionSelfReviewScoreLabel.js";
|
|
33
33
|
export * from "./TaskInteractionOptionSelfReviewType.js";
|
|
34
34
|
export * from "./TaskParameter.js";
|
|
35
|
-
export * from "./TaskParameterObjectNestedParam.js";
|
|
36
|
-
export * from "./TaskParameterObjectValue.js";
|
|
37
|
-
export * from "./TaskParameterObjectValueItem.js";
|
|
38
35
|
export * from "./TaskParameterRangeValue.js";
|
|
39
36
|
export * from "./TaskParameterType.js";
|
|
40
37
|
export * from "./TaskParameterValue.js";
|
|
@@ -90,6 +87,4 @@ export * from "./ValidationError.js";
|
|
|
90
87
|
export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.js";
|
|
91
88
|
export * from "./WidgetRenderResponse.js";
|
|
92
89
|
export * from "./WorkflowCheckStatus.js";
|
|
93
|
-
export * from "./WorkflowMetadata.js";
|
|
94
|
-
export * from "./WorkflowsMetadataResponse.js";
|
|
95
90
|
export * from "./WsActor.js";
|
|
@@ -48,9 +48,6 @@ __exportStar(require("./TaskInteractionOptionSelfReviewScore.js"), exports);
|
|
|
48
48
|
__exportStar(require("./TaskInteractionOptionSelfReviewScoreLabel.js"), exports);
|
|
49
49
|
__exportStar(require("./TaskInteractionOptionSelfReviewType.js"), exports);
|
|
50
50
|
__exportStar(require("./TaskParameter.js"), exports);
|
|
51
|
-
__exportStar(require("./TaskParameterObjectNestedParam.js"), exports);
|
|
52
|
-
__exportStar(require("./TaskParameterObjectValue.js"), exports);
|
|
53
|
-
__exportStar(require("./TaskParameterObjectValueItem.js"), exports);
|
|
54
51
|
__exportStar(require("./TaskParameterRangeValue.js"), exports);
|
|
55
52
|
__exportStar(require("./TaskParameterType.js"), exports);
|
|
56
53
|
__exportStar(require("./TaskParameterValue.js"), exports);
|
|
@@ -106,6 +103,4 @@ __exportStar(require("./ValidationError.js"), exports);
|
|
|
106
103
|
__exportStar(require("./VectorSearchTaskInteractionQaAnswerScoreLabel.js"), exports);
|
|
107
104
|
__exportStar(require("./WidgetRenderResponse.js"), exports);
|
|
108
105
|
__exportStar(require("./WorkflowCheckStatus.js"), exports);
|
|
109
|
-
__exportStar(require("./WorkflowMetadata.js"), exports);
|
|
110
|
-
__exportStar(require("./WorkflowsMetadataResponse.js"), exports);
|
|
111
106
|
__exportStar(require("./WsActor.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.37";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -9,8 +9,8 @@ export class ApolloClient {
|
|
|
9
9
|
"x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
|
|
10
10
|
"X-Fern-Language": "JavaScript",
|
|
11
11
|
"X-Fern-SDK-Name": "@aui.io/aui-client",
|
|
12
|
-
"X-Fern-SDK-Version": "1.2.
|
|
13
|
-
"User-Agent": "@aui.io/aui-client/1.2.
|
|
12
|
+
"X-Fern-SDK-Version": "1.2.37",
|
|
13
|
+
"User-Agent": "@aui.io/aui-client/1.2.37",
|
|
14
14
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
15
15
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
16
16
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -113,19 +113,6 @@ export declare class ControllerApi {
|
|
|
113
113
|
*/
|
|
114
114
|
getDirectFollowupSuggestions(taskId: string, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.DirectFollowupSuggestionsResponse>;
|
|
115
115
|
private __getDirectFollowupSuggestions;
|
|
116
|
-
/**
|
|
117
|
-
* Get metadata for all workflows available for the authenticated network.
|
|
118
|
-
* Returns a lean version with essential workflow information.
|
|
119
|
-
*
|
|
120
|
-
* @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
|
|
121
|
-
*
|
|
122
|
-
* @throws {@link Apollo.UnprocessableEntityError}
|
|
123
|
-
*
|
|
124
|
-
* @example
|
|
125
|
-
* await client.controllerApi.getWorkflowsMetadata()
|
|
126
|
-
*/
|
|
127
|
-
getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
|
|
128
|
-
private __getWorkflowsMetadata;
|
|
129
116
|
/**
|
|
130
117
|
* @param {string} taskId
|
|
131
118
|
* @param {string} messageId
|
|
@@ -563,69 +563,6 @@ export class ControllerApi {
|
|
|
563
563
|
}
|
|
564
564
|
});
|
|
565
565
|
}
|
|
566
|
-
/**
|
|
567
|
-
* Get metadata for all workflows available for the authenticated network.
|
|
568
|
-
* Returns a lean version with essential workflow information.
|
|
569
|
-
*
|
|
570
|
-
* @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
|
|
571
|
-
*
|
|
572
|
-
* @throws {@link Apollo.UnprocessableEntityError}
|
|
573
|
-
*
|
|
574
|
-
* @example
|
|
575
|
-
* await client.controllerApi.getWorkflowsMetadata()
|
|
576
|
-
*/
|
|
577
|
-
getWorkflowsMetadata(requestOptions) {
|
|
578
|
-
return core.HttpResponsePromise.fromPromise(this.__getWorkflowsMetadata(requestOptions));
|
|
579
|
-
}
|
|
580
|
-
__getWorkflowsMetadata(requestOptions) {
|
|
581
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
582
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
583
|
-
const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
|
|
584
|
-
"x-network-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.networkApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.networkApiKey,
|
|
585
|
-
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
586
|
-
const _response = yield core.fetcher({
|
|
587
|
-
url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "api/v1/external/workflows/metadata"),
|
|
588
|
-
method: "GET",
|
|
589
|
-
headers: _headers,
|
|
590
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
591
|
-
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
592
|
-
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
593
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
594
|
-
fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
|
|
595
|
-
logging: this._options.logging,
|
|
596
|
-
});
|
|
597
|
-
if (_response.ok) {
|
|
598
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
599
|
-
}
|
|
600
|
-
if (_response.error.reason === "status-code") {
|
|
601
|
-
switch (_response.error.statusCode) {
|
|
602
|
-
case 422:
|
|
603
|
-
throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
604
|
-
default:
|
|
605
|
-
throw new errors.ApolloError({
|
|
606
|
-
statusCode: _response.error.statusCode,
|
|
607
|
-
body: _response.error.body,
|
|
608
|
-
rawResponse: _response.rawResponse,
|
|
609
|
-
});
|
|
610
|
-
}
|
|
611
|
-
}
|
|
612
|
-
switch (_response.error.reason) {
|
|
613
|
-
case "non-json":
|
|
614
|
-
throw new errors.ApolloError({
|
|
615
|
-
statusCode: _response.error.statusCode,
|
|
616
|
-
body: _response.error.rawBody,
|
|
617
|
-
rawResponse: _response.rawResponse,
|
|
618
|
-
});
|
|
619
|
-
case "timeout":
|
|
620
|
-
throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/workflows/metadata.");
|
|
621
|
-
case "unknown":
|
|
622
|
-
throw new errors.ApolloError({
|
|
623
|
-
message: _response.error.errorMessage,
|
|
624
|
-
rawResponse: _response.rawResponse,
|
|
625
|
-
});
|
|
626
|
-
}
|
|
627
|
-
});
|
|
628
|
-
}
|
|
629
566
|
/**
|
|
630
567
|
* @param {string} taskId
|
|
631
568
|
* @param {string} messageId
|
|
@@ -2,8 +2,6 @@ export declare const OptionsSearchSelfReviewMethod: {
|
|
|
2
2
|
readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
|
|
3
3
|
readonly Llm: "LLM";
|
|
4
4
|
readonly LlmPerOption: "LLM_PER_OPTION";
|
|
5
|
-
readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
|
|
6
|
-
readonly CohereRanker: "COHERE_RANKER";
|
|
7
5
|
readonly ConstantScore: "CONSTANT_SCORE";
|
|
8
6
|
readonly ParamMatching: "PARAM_MATCHING";
|
|
9
7
|
};
|
|
@@ -3,8 +3,6 @@ export const OptionsSearchSelfReviewMethod = {
|
|
|
3
3
|
InventoryClassification: "INVENTORY_CLASSIFICATION",
|
|
4
4
|
Llm: "LLM",
|
|
5
5
|
LlmPerOption: "LLM_PER_OPTION",
|
|
6
|
-
CrossEncoderRanker: "CROSS_ENCODER_RANKER",
|
|
7
|
-
CohereRanker: "COHERE_RANKER",
|
|
8
6
|
ConstantScore: "CONSTANT_SCORE",
|
|
9
7
|
ParamMatching: "PARAM_MATCHING",
|
|
10
8
|
};
|
|
@@ -14,9 +14,9 @@ export interface TaskParameter {
|
|
|
14
14
|
code?: string;
|
|
15
15
|
}
|
|
16
16
|
export declare namespace TaskParameter {
|
|
17
|
-
type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue
|
|
17
|
+
type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
|
|
18
18
|
type ValueHistory = ValueHistory.Item[];
|
|
19
19
|
namespace ValueHistory {
|
|
20
|
-
type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue
|
|
20
|
+
type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
|
|
21
21
|
}
|
|
22
22
|
}
|
|
@@ -32,9 +32,6 @@ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
|
|
|
32
32
|
export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
|
|
33
33
|
export * from "./TaskInteractionOptionSelfReviewType.mjs";
|
|
34
34
|
export * from "./TaskParameter.mjs";
|
|
35
|
-
export * from "./TaskParameterObjectNestedParam.mjs";
|
|
36
|
-
export * from "./TaskParameterObjectValue.mjs";
|
|
37
|
-
export * from "./TaskParameterObjectValueItem.mjs";
|
|
38
35
|
export * from "./TaskParameterRangeValue.mjs";
|
|
39
36
|
export * from "./TaskParameterType.mjs";
|
|
40
37
|
export * from "./TaskParameterValue.mjs";
|
|
@@ -90,6 +87,4 @@ export * from "./ValidationError.mjs";
|
|
|
90
87
|
export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
|
|
91
88
|
export * from "./WidgetRenderResponse.mjs";
|
|
92
89
|
export * from "./WorkflowCheckStatus.mjs";
|
|
93
|
-
export * from "./WorkflowMetadata.mjs";
|
|
94
|
-
export * from "./WorkflowsMetadataResponse.mjs";
|
|
95
90
|
export * from "./WsActor.mjs";
|
|
@@ -32,9 +32,6 @@ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
|
|
|
32
32
|
export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
|
|
33
33
|
export * from "./TaskInteractionOptionSelfReviewType.mjs";
|
|
34
34
|
export * from "./TaskParameter.mjs";
|
|
35
|
-
export * from "./TaskParameterObjectNestedParam.mjs";
|
|
36
|
-
export * from "./TaskParameterObjectValue.mjs";
|
|
37
|
-
export * from "./TaskParameterObjectValueItem.mjs";
|
|
38
35
|
export * from "./TaskParameterRangeValue.mjs";
|
|
39
36
|
export * from "./TaskParameterType.mjs";
|
|
40
37
|
export * from "./TaskParameterValue.mjs";
|
|
@@ -90,6 +87,4 @@ export * from "./ValidationError.mjs";
|
|
|
90
87
|
export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
|
|
91
88
|
export * from "./WidgetRenderResponse.mjs";
|
|
92
89
|
export * from "./WorkflowCheckStatus.mjs";
|
|
93
|
-
export * from "./WorkflowMetadata.mjs";
|
|
94
|
-
export * from "./WorkflowsMetadataResponse.mjs";
|
|
95
90
|
export * from "./WsActor.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.37";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.2.
|
|
1
|
+
export const SDK_VERSION = "1.2.37";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -403,62 +403,6 @@ await client.controllerApi.getDirectFollowupSuggestions("task_id");
|
|
|
403
403
|
</dl>
|
|
404
404
|
|
|
405
405
|
|
|
406
|
-
</dd>
|
|
407
|
-
</dl>
|
|
408
|
-
</details>
|
|
409
|
-
|
|
410
|
-
<details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getWorkflowsMetadata</a>() -> Apollo.WorkflowsMetadataResponse</code></summary>
|
|
411
|
-
<dl>
|
|
412
|
-
<dd>
|
|
413
|
-
|
|
414
|
-
#### 📝 Description
|
|
415
|
-
|
|
416
|
-
<dl>
|
|
417
|
-
<dd>
|
|
418
|
-
|
|
419
|
-
<dl>
|
|
420
|
-
<dd>
|
|
421
|
-
|
|
422
|
-
Get metadata for all workflows available for the authenticated network.
|
|
423
|
-
Returns a lean version with essential workflow information.
|
|
424
|
-
</dd>
|
|
425
|
-
</dl>
|
|
426
|
-
</dd>
|
|
427
|
-
</dl>
|
|
428
|
-
|
|
429
|
-
#### 🔌 Usage
|
|
430
|
-
|
|
431
|
-
<dl>
|
|
432
|
-
<dd>
|
|
433
|
-
|
|
434
|
-
<dl>
|
|
435
|
-
<dd>
|
|
436
|
-
|
|
437
|
-
```typescript
|
|
438
|
-
await client.controllerApi.getWorkflowsMetadata();
|
|
439
|
-
|
|
440
|
-
```
|
|
441
|
-
</dd>
|
|
442
|
-
</dl>
|
|
443
|
-
</dd>
|
|
444
|
-
</dl>
|
|
445
|
-
|
|
446
|
-
#### ⚙️ Parameters
|
|
447
|
-
|
|
448
|
-
<dl>
|
|
449
|
-
<dd>
|
|
450
|
-
|
|
451
|
-
<dl>
|
|
452
|
-
<dd>
|
|
453
|
-
|
|
454
|
-
**requestOptions:** `ControllerApi.RequestOptions`
|
|
455
|
-
|
|
456
|
-
</dd>
|
|
457
|
-
</dl>
|
|
458
|
-
</dd>
|
|
459
|
-
</dl>
|
|
460
|
-
|
|
461
|
-
|
|
462
406
|
</dd>
|
|
463
407
|
</dl>
|
|
464
408
|
</details>
|