@amigo-ai/sdk 0.36.0 → 0.38.0
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.
|
@@ -2312,7 +2312,7 @@ export interface components {
|
|
|
2312
2312
|
index: number;
|
|
2313
2313
|
};
|
|
2314
2314
|
/** ActionState */
|
|
2315
|
-
|
|
2315
|
+
ActionState: {
|
|
2316
2316
|
/**
|
|
2317
2317
|
* @description discriminator enum property added by openapi-typescript
|
|
2318
2318
|
* @enum {string}
|
|
@@ -2330,8 +2330,6 @@ export interface components {
|
|
|
2330
2330
|
boundary_constraints: components["schemas"]["amigo_lib__pydantic__base_model__StrippedNonemptyString__1"][];
|
|
2331
2331
|
/** Exit Conditions */
|
|
2332
2332
|
exit_conditions: components["schemas"]["ExitCondition-Input"][];
|
|
2333
|
-
/** Message Metadata */
|
|
2334
|
-
message_metadata: components["schemas"]["amigo_lib__pydantic__base_model__StrippedNonemptyString__1"][];
|
|
2335
2333
|
/** Action Tool Call Specs */
|
|
2336
2334
|
action_tool_call_specs: components["schemas"]["ToolCallSpec-Input"][];
|
|
2337
2335
|
/** Exit Condition Tool Call Specs */
|
|
@@ -2342,74 +2340,6 @@ export interface components {
|
|
|
2342
2340
|
*/
|
|
2343
2341
|
skip_active_memory_retrieval: boolean;
|
|
2344
2342
|
};
|
|
2345
|
-
/**
|
|
2346
|
-
* ActionState
|
|
2347
|
-
* @description A state associated with an objective and a list of actions. The `Agent` will perform these actions towards achieving the objective. The session
|
|
2348
|
-
* may transition to a different state if any of the exit conditions are met, in which case the session proceeds to the next state specified in the
|
|
2349
|
-
* exit condition. If no exit conditions are met, the session remains in this state.
|
|
2350
|
-
*/
|
|
2351
|
-
"ActionState-Output": {
|
|
2352
|
-
/**
|
|
2353
|
-
* @description discriminator enum property added by openapi-typescript
|
|
2354
|
-
* @enum {string}
|
|
2355
|
-
*/
|
|
2356
|
-
type: "action";
|
|
2357
|
-
/**
|
|
2358
|
-
* Name
|
|
2359
|
-
* @description The name of this state.
|
|
2360
|
-
*/
|
|
2361
|
-
name: string;
|
|
2362
|
-
/**
|
|
2363
|
-
* Objective
|
|
2364
|
-
* @description The objective that the `Agent` works towards when in this state.
|
|
2365
|
-
*/
|
|
2366
|
-
objective: string;
|
|
2367
|
-
/**
|
|
2368
|
-
* Actions
|
|
2369
|
-
* @description A list of specific actions that the `Agent` performs in this state.
|
|
2370
|
-
*/
|
|
2371
|
-
actions: string[];
|
|
2372
|
-
/**
|
|
2373
|
-
* Intra State Navigation Guidelines
|
|
2374
|
-
* @description A list of guidelines for how the agent will navigate between subgoals and exit conditions within this state.
|
|
2375
|
-
*/
|
|
2376
|
-
intra_state_navigation_guidelines: string[];
|
|
2377
|
-
/**
|
|
2378
|
-
* Action Guidelines
|
|
2379
|
-
* @description A list of guidelines for how the agent will behave when engaging with user.
|
|
2380
|
-
*/
|
|
2381
|
-
action_guidelines: string[];
|
|
2382
|
-
/**
|
|
2383
|
-
* Boundary Constraints
|
|
2384
|
-
* @description A list of guidelines for how the agent will not behave when engaging with user.
|
|
2385
|
-
*/
|
|
2386
|
-
boundary_constraints: string[];
|
|
2387
|
-
/**
|
|
2388
|
-
* Exit Conditions
|
|
2389
|
-
* @description A list of exit conditions for this state that describes under what condition would the session be allowed to transition to another state.
|
|
2390
|
-
*/
|
|
2391
|
-
exit_conditions: components["schemas"]["ExitCondition-Output"][];
|
|
2392
|
-
/**
|
|
2393
|
-
* Message Metadata
|
|
2394
|
-
* @description A list of metadata to include in the agent message if the message is generated in this state.
|
|
2395
|
-
*/
|
|
2396
|
-
message_metadata: string[];
|
|
2397
|
-
/**
|
|
2398
|
-
* Action Tool Call Specs
|
|
2399
|
-
* @description A list of tool calls that the agent can make in this state when executing an action.
|
|
2400
|
-
*/
|
|
2401
|
-
action_tool_call_specs: components["schemas"]["ToolCallSpec-Output"][];
|
|
2402
|
-
/**
|
|
2403
|
-
* Exit Condition Tool Call Specs
|
|
2404
|
-
* @description A list of tool calls that the agent can make in this state when evaluating exit conditions.
|
|
2405
|
-
*/
|
|
2406
|
-
exit_condition_tool_call_specs: components["schemas"]["ToolCallSpec-Output"][];
|
|
2407
|
-
/**
|
|
2408
|
-
* Skip Active Memory Retrieval
|
|
2409
|
-
* @description If `True`, the agent will not perform active memory retrieval at the start of an interaction in this state.
|
|
2410
|
-
*/
|
|
2411
|
-
skip_active_memory_retrieval: boolean;
|
|
2412
|
-
};
|
|
2413
2343
|
/** ActionStateTransitionLog */
|
|
2414
2344
|
ActionStateTransitionLog: {
|
|
2415
2345
|
/**
|
|
@@ -2467,14 +2397,15 @@ export interface components {
|
|
|
2467
2397
|
type: "action-too-long";
|
|
2468
2398
|
/**
|
|
2469
2399
|
* Filler
|
|
2470
|
-
* @description
|
|
2400
|
+
* @description A filler that can be played while waiting for the action to complete. If the audio filler exists, this is monochannel, 16-bit PCM WAV audio (at sample rate 16kHz) encoded in base64 encoding.
|
|
2401
|
+
* Otherwise, this is the text corresponding to the audio filler.
|
|
2471
2402
|
*/
|
|
2472
2403
|
filler: string;
|
|
2473
2404
|
/**
|
|
2474
2405
|
* Previously Started Event
|
|
2475
2406
|
* @description The previously started event that is taking too long.
|
|
2476
2407
|
*/
|
|
2477
|
-
previously_started_event:
|
|
2408
|
+
previously_started_event: components["schemas"]["ToolCallStartedEvent"] | components["schemas"]["NavigateStateMachineDecisionStateDecisionStartedEvent"] | components["schemas"]["NavigateStateMachineReflectionStatePromptRetrievedEvent"];
|
|
2478
2409
|
};
|
|
2479
2410
|
AgentFrameworkInvocationMetadata: components["schemas"]["StateTransitionInvocationMetadata"] | components["schemas"]["EngageUserInvocationMetadata"];
|
|
2480
2411
|
/** AnnotationState */
|
|
@@ -2498,8 +2429,8 @@ export interface components {
|
|
|
2498
2429
|
*/
|
|
2499
2430
|
"AnnotationState-Output": {
|
|
2500
2431
|
/**
|
|
2501
|
-
*
|
|
2502
|
-
* @
|
|
2432
|
+
* Type
|
|
2433
|
+
* @constant
|
|
2503
2434
|
*/
|
|
2504
2435
|
type: "annotation";
|
|
2505
2436
|
/**
|
|
@@ -2797,8 +2728,8 @@ export interface components {
|
|
|
2797
2728
|
*/
|
|
2798
2729
|
"DecisionState-Output": {
|
|
2799
2730
|
/**
|
|
2800
|
-
*
|
|
2801
|
-
* @
|
|
2731
|
+
* Type
|
|
2732
|
+
* @constant
|
|
2802
2733
|
*/
|
|
2803
2734
|
type: "decision";
|
|
2804
2735
|
/**
|
|
@@ -3571,6 +3502,7 @@ export interface components {
|
|
|
3571
3502
|
message_type: components["schemas"]["MessageType"];
|
|
3572
3503
|
/**
|
|
3573
3504
|
* Message Metadata
|
|
3505
|
+
* @deprecated
|
|
3574
3506
|
* @description The metadata associated with the message.
|
|
3575
3507
|
*/
|
|
3576
3508
|
message_metadata: string[];
|
|
@@ -3980,11 +3912,6 @@ export interface components {
|
|
|
3980
3912
|
* PCM16 format.
|
|
3981
3913
|
*/
|
|
3982
3914
|
message: string;
|
|
3983
|
-
/**
|
|
3984
|
-
* Message Metadata
|
|
3985
|
-
* @description Metadata associated with this message.
|
|
3986
|
-
*/
|
|
3987
|
-
message_metadata: string[];
|
|
3988
3915
|
/**
|
|
3989
3916
|
* Transcript Alignment
|
|
3990
3917
|
* @description Transcript of the ongoing audio message and how they align with the audio, if the message is in audio format. Otherwise, it's `None`. This is an array of tuples, where each tuple contains
|
|
@@ -4052,6 +3979,70 @@ export interface components {
|
|
|
4052
3979
|
/** Upper Bound */
|
|
4053
3980
|
upper_bound: number;
|
|
4054
3981
|
};
|
|
3982
|
+
/** OverrideActionState */
|
|
3983
|
+
OverrideActionState: {
|
|
3984
|
+
/**
|
|
3985
|
+
* Type
|
|
3986
|
+
* @constant
|
|
3987
|
+
*/
|
|
3988
|
+
type: "action";
|
|
3989
|
+
/**
|
|
3990
|
+
* Name
|
|
3991
|
+
* @description The name of this state.
|
|
3992
|
+
*/
|
|
3993
|
+
name: string;
|
|
3994
|
+
/**
|
|
3995
|
+
* Objective
|
|
3996
|
+
* @description The objective that the `Agent` works towards when in this state.
|
|
3997
|
+
*/
|
|
3998
|
+
objective: string;
|
|
3999
|
+
/**
|
|
4000
|
+
* Actions
|
|
4001
|
+
* @description A list of specific actions that the `Agent` performs in this state.
|
|
4002
|
+
*/
|
|
4003
|
+
actions: string[];
|
|
4004
|
+
/**
|
|
4005
|
+
* Intra State Navigation Guidelines
|
|
4006
|
+
* @description A list of guidelines for how the agent will navigate between subgoals and exit conditions within this state.
|
|
4007
|
+
*/
|
|
4008
|
+
intra_state_navigation_guidelines: string[];
|
|
4009
|
+
/**
|
|
4010
|
+
* Action Guidelines
|
|
4011
|
+
* @description A list of guidelines for how the agent will behave when engaging with user.
|
|
4012
|
+
*/
|
|
4013
|
+
action_guidelines: string[];
|
|
4014
|
+
/**
|
|
4015
|
+
* Boundary Constraints
|
|
4016
|
+
* @description A list of guidelines for how the agent will not behave when engaging with user.
|
|
4017
|
+
*/
|
|
4018
|
+
boundary_constraints: string[];
|
|
4019
|
+
/**
|
|
4020
|
+
* Exit Conditions
|
|
4021
|
+
* @description A list of exit conditions for this state that describes under what condition would the session be allowed to transition to another state.
|
|
4022
|
+
*/
|
|
4023
|
+
exit_conditions: components["schemas"]["ExitCondition-Output"][];
|
|
4024
|
+
/**
|
|
4025
|
+
* Action Tool Call Specs
|
|
4026
|
+
* @description A list of tool calls that the agent can make in this state when executing an action.
|
|
4027
|
+
*/
|
|
4028
|
+
action_tool_call_specs: components["schemas"]["ToolCallSpec-Output"][];
|
|
4029
|
+
/**
|
|
4030
|
+
* Exit Condition Tool Call Specs
|
|
4031
|
+
* @description A list of tool calls that the agent can make in this state when evaluating exit conditions.
|
|
4032
|
+
*/
|
|
4033
|
+
exit_condition_tool_call_specs: components["schemas"]["ToolCallSpec-Output"][];
|
|
4034
|
+
/**
|
|
4035
|
+
* Skip Active Memory Retrieval
|
|
4036
|
+
* @description If `True`, the agent will not perform active memory retrieval at the start of an interaction in this state.
|
|
4037
|
+
*/
|
|
4038
|
+
skip_active_memory_retrieval: boolean;
|
|
4039
|
+
/**
|
|
4040
|
+
* Message Metadata
|
|
4041
|
+
* @deprecated
|
|
4042
|
+
* @description Metadata associated with messages generated in this action state.
|
|
4043
|
+
*/
|
|
4044
|
+
message_metadata: string[];
|
|
4045
|
+
};
|
|
4055
4046
|
/** PCMUserMessageAudioConfig */
|
|
4056
4047
|
PCMUserMessageAudioConfig: {
|
|
4057
4048
|
/**
|
|
@@ -4224,8 +4215,8 @@ export interface components {
|
|
|
4224
4215
|
*/
|
|
4225
4216
|
"RecallState-Output": {
|
|
4226
4217
|
/**
|
|
4227
|
-
*
|
|
4228
|
-
* @
|
|
4218
|
+
* Type
|
|
4219
|
+
* @constant
|
|
4229
4220
|
*/
|
|
4230
4221
|
type: "recall";
|
|
4231
4222
|
/**
|
|
@@ -4320,8 +4311,8 @@ export interface components {
|
|
|
4320
4311
|
*/
|
|
4321
4312
|
"ReflectionState-Output": {
|
|
4322
4313
|
/**
|
|
4323
|
-
*
|
|
4324
|
-
* @
|
|
4314
|
+
* Type
|
|
4315
|
+
* @constant
|
|
4325
4316
|
*/
|
|
4326
4317
|
type: "reflection";
|
|
4327
4318
|
/**
|
|
@@ -4566,7 +4557,7 @@ export interface components {
|
|
|
4566
4557
|
* States
|
|
4567
4558
|
* @description The states in this state machine.
|
|
4568
4559
|
*/
|
|
4569
|
-
states: components["schemas"]["
|
|
4560
|
+
states: (components["schemas"]["DecisionState-Output"] | components["schemas"]["AnnotationState-Output"] | components["schemas"]["ReflectionState-Output"] | components["schemas"]["RecallState-Output"] | components["schemas"]["OverrideActionState"])[];
|
|
4570
4561
|
/**
|
|
4571
4562
|
* New User Initial State
|
|
4572
4563
|
* @description The state a new user will be in when a session starts. This must be an action state.
|
|
@@ -5182,7 +5173,6 @@ export interface components {
|
|
|
5182
5173
|
/** @description The user who created the unit test set run. */
|
|
5183
5174
|
creator: components["schemas"]["amigo_lib__mongo__collections__simulation_unit_test_set_run__SimulationUnitTestSetRun__UserInfo"];
|
|
5184
5175
|
};
|
|
5185
|
-
State: components["schemas"]["ActionState-Output"] | components["schemas"]["DecisionState-Output"] | components["schemas"]["RecallState-Output"] | components["schemas"]["AnnotationState-Output"] | components["schemas"]["ReflectionState-Output"];
|
|
5186
5176
|
/** StateMachineInstance */
|
|
5187
5177
|
StateMachineInstance: {
|
|
5188
5178
|
/**
|
|
@@ -7047,7 +7037,7 @@ export interface components {
|
|
|
7047
7037
|
* States
|
|
7048
7038
|
* @description The internal states in this service hierarchical state machine.
|
|
7049
7039
|
*/
|
|
7050
|
-
states: (components["schemas"]["ActionState
|
|
7040
|
+
states: (components["schemas"]["ActionState"] | components["schemas"]["DecisionState-Input"] | components["schemas"]["RecallState-Input"] | components["schemas"]["AnnotationState-Input"] | components["schemas"]["ReflectionState-Input"])[];
|
|
7051
7041
|
/** @description The state a new user will be in when a session starts. This must be an action state, and must be an internal state. */
|
|
7052
7042
|
new_user_initial_state: components["schemas"]["StateOrRefName"];
|
|
7053
7043
|
/** @description The state a returning user will be in when a session starts. This must be an action state, and must be an internal state. */
|
|
@@ -20,7 +20,6 @@ export declare class ConversationResource {
|
|
|
20
20
|
} | {
|
|
21
21
|
type: "new-message";
|
|
22
22
|
message: string;
|
|
23
|
-
message_metadata: string[];
|
|
24
23
|
transcript_alignment: [number, string][] | null;
|
|
25
24
|
stop: boolean;
|
|
26
25
|
sequence_number: number;
|
|
@@ -46,7 +45,6 @@ export declare class ConversationResource {
|
|
|
46
45
|
} | {
|
|
47
46
|
type: "new-message";
|
|
48
47
|
message: string;
|
|
49
|
-
message_metadata: string[];
|
|
50
48
|
transcript_alignment: [number, string][] | null;
|
|
51
49
|
stop: boolean;
|
|
52
50
|
sequence_number: number;
|