@amigo-ai/sdk 0.20.1 → 0.21.0

package/dist/types/generated/api-types.d.ts

@@ -2170,6 +2170,55 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{organization}/tool/invocation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get tool invocations
+         * @description Retrieve tool invocations under the specified filters.
+         *
+         *     #### Permissions
+         *     This endpoint may require the following permission:
+         *     * `Conversation:GetInteractionInsights` for `ToolInvocation`s from a regular conversation.
+         *     * `Simulation:GetSimulationUnitTestSetRun` for `ToolInvocation`s from a simulation conversation.
+         */
+        get: operations["get-tool-invocations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/{organization}/tool/{tool_id}/version/{version}/invoke": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Invoke a tool version
+         * @description Invoke a specified tool version with the given input parameters.
+         *
+         *     #### Permissions
+         *     This endpoint requires the following permissions:
+         *     * `Tool:InvokeTool` for the tool to invoke.
+         */
+        post: operations["invoke-tool-version"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2357,6 +2406,8 @@ export interface components {
              */
             tool_call_logs: components["schemas"]["ToolCallLog"][][];
         };
+        "AgentFrameworkInvocationMetadata-Input": components["schemas"]["StateTransitionInvocationMetadata-Input"] | components["schemas"]["EngageUserInvocationMetadata-Input"];
+        "AgentFrameworkInvocationMetadata-Output": components["schemas"]["StateTransitionInvocationMetadata-Output"] | components["schemas"]["EngageUserInvocationMetadata-Output"];
         /** AnnotationState */
         "AnnotationState-Input": {
             /**
@@ -2928,6 +2979,48 @@ export interface components {
              */
             overriding: boolean;
         };
+        /** EngageUserInvocationMetadata */
+        "EngageUserInvocationMetadata-Input": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "engage-user";
+            /**
+             * Current State Machine And Version
+             * @description The ID and version of the state machine that is currently being executed.
+             */
+            current_state_machine_and_version: [
+                string,
+                number
+            ];
+            /**
+             * Tool Call Round Index
+             * @description The index of the tool call round.
+             */
+            tool_call_round_index: number;
+        };
+        /** EngageUserInvocationMetadata */
+        "EngageUserInvocationMetadata-Output": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "engage-user";
+            /**
+             * Current State Machine And Version
+             * @description The ID and version of the state machine that is currently being executed.
+             */
+            current_state_machine_and_version: [
+                string,
+                number
+            ];
+            /**
+             * Tool Call Round Index
+             * @description The index of the tool call round.
+             */
+            tool_call_round_index: number;
+        };
         /**
          * EngageUserMessageFragmentGeneratedEvent
          * @description Indicating that the agent has generated a fragment of the agent response.
@@ -3039,6 +3132,57 @@ export interface components {
                 string
             ][];
         };
+        /** FailedInvocationResult */
+        FailedInvocationResult: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            succeeded: "False";
+            /**
+             * Exception Message
+             * @description The message of the exception during the tool invocation.
+             */
+            exception_message: string;
+            /**
+             * Exception Type
+             * @description The type of the exception during the tool invocation.
+             */
+            exception_type: string;
+            /**
+             * Exception Stack Trace
+             * @description The stack trace of the exception during the tool invocation.
+             */
+            exception_stack_trace: string[];
+            /**
+             * Duration Ms
+             * @description The duration of the tool invocation in milliseconds.
+             */
+            duration_ms: number;
+        };
+        /** FailedInvocationStatus */
+        FailedInvocationStatus: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            succeeded: "False";
+            /**
+             * Exception Message
+             * @description The exception message if the tool invocation failed.
+             */
+            exception_message: string;
+            /**
+             * Exception Type
+             * @description The exception type if the tool invocation failed.
+             */
+            exception_type: string;
+            /**
+             * Exception Stack Trace
+             * @description The exception stack trace if the tool invocation failed.
+             */
+            exception_stack_trace: string[];
+        };
         /** @enum {string} */
         Format: "text" | "voice";
         /** @enum {string} */
@@ -3138,6 +3282,22 @@ export interface components {
              */
             type: "user-message";
         };
+        /** Input */
+        Input: {
+            /**
+             * Input Parameters
+             * @description The input parameters for the tool invocation.
+             */
+            input_parameters: {
+                [key: string]: unknown;
+            };
+            /**
+             * Invocation Mode
+             * @description The mode of invocation.
+             * @enum {string}
+             */
+            invocation_mode: "regular" | "conversation-simulation";
+        };
         /** InsertRequest */
         InsertRequest: {
             /** @description The name of the environment variable to insert. */
@@ -3184,6 +3344,10 @@ export interface components {
              */
             conversation_completed: boolean;
         };
+        InvocationResult: components["schemas"]["SucceededInvocationResult"] | components["schemas"]["FailedInvocationResult"];
+        "InvocationSource-Input": components["schemas"]["RegularConversationInvocationSource-Input"] | components["schemas"]["SimulationConversationInvocationSource-Input"];
+        "InvocationSource-Output": components["schemas"]["RegularConversationInvocationSource-Output"] | components["schemas"]["SimulationConversationInvocationSource-Output"];
+        InvocationStatus: components["schemas"]["SucceededInvocationStatus"] | components["schemas"]["FailedInvocationStatus"];
         /** JumpbackStateTransitionLog */
         JumpbackStateTransitionLog: {
             /**
@@ -4197,6 +4361,56 @@ export interface components {
              */
             tool_call_logs: components["schemas"]["ToolCallLog"][][];
         };
+        /** RegularConversationInvocationSource */
+        "RegularConversationInvocationSource-Input": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "regular-conversation";
+            /**
+             * User Id
+             * @description The ID of the user whose conversation invoked the tool.
+             */
+            user_id: string;
+            /**
+             * Conversation Id
+             * @description The ID of the conversation where the tool was invoked. This conversation might not actually exist if later in the call the conversation is rolled back.
+             */
+            conversation_id: string | null;
+            /**
+             * Interaction Id
+             * @description The ID of the interaction where the tool was invoked. This interaction might not actually exist if later in the call the interaction is rolled back.
+             */
+            interaction_id: string | null;
+            /** @description Metadata about the invocation. */
+            invocation_metadata: components["schemas"]["AgentFrameworkInvocationMetadata-Input"];
+        };
+        /** RegularConversationInvocationSource */
+        "RegularConversationInvocationSource-Output": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "regular-conversation";
+            /**
+             * User Id
+             * @description The ID of the user whose conversation invoked the tool.
+             */
+            user_id: string;
+            /**
+             * Conversation Id
+             * @description The ID of the conversation where the tool was invoked. This conversation might not actually exist if later in the call the conversation is rolled back.
+             */
+            conversation_id: string | null;
+            /**
+             * Interaction Id
+             * @description The ID of the interaction where the tool was invoked. This interaction might not actually exist if later in the call the interaction is rolled back.
+             */
+            interaction_id: string | null;
+            /** @description Metadata about the invocation. */
+            invocation_metadata: components["schemas"]["AgentFrameworkInvocationMetadata-Output"];
+        };
         /** RelationshipToDeveloper */
         "RelationshipToDeveloper-Input": {
             ownership: components["schemas"]["amigo_lib__pydantic__base_model__StrippedNonemptyString__1"];
@@ -4506,6 +4720,38 @@ export interface components {
              */
             type: "side-effect";
         };
+        /** SimulationConversationInvocationSource */
+        "SimulationConversationInvocationSource-Input": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "simulation-conversation";
+            /** Simulation Unit Test Set Run Id */
+            simulation_unit_test_set_run_id: string | null;
+            /** Unit Test Id */
+            unit_test_id: string | null;
+            /** Run Index */
+            run_index: number | null;
+            /** @description Metadata about the invocation. */
+            invocation_metadata: components["schemas"]["AgentFrameworkInvocationMetadata-Input"];
+        };
+        /** SimulationConversationInvocationSource */
+        "SimulationConversationInvocationSource-Output": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "simulation-conversation";
+            /** Simulation Unit Test Set Run Id */
+            simulation_unit_test_set_run_id: string | null;
+            /** Unit Test Id */
+            unit_test_id: string | null;
+            /** Run Index */
+            run_index: number | null;
+            /** @description Metadata about the invocation. */
+            invocation_metadata: components["schemas"]["AgentFrameworkInvocationMetadata-Output"];
+        };
         /** SimulationEvaluationSource */
         SimulationEvaluationSource: {
             /**
@@ -5044,11 +5290,104 @@ export interface components {
             latest_version: number | null;
         };
         StateOrRefName: string;
+        /** StateTransitionInvocationMetadata */
+        "StateTransitionInvocationMetadata-Input": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "state-transition";
+            /**
+             * Current State Machine And Version
+             * @description The ID and version of the state machine that is currently being executed.
+             */
+            current_state_machine_and_version: [
+                string,
+                number
+            ];
+            /**
+             * State Name
+             * @description The name of the state during which the tool was invoked.
+             */
+            state_name: string;
+            /**
+             * State Transition Index
+             * @description The index of the state transition during which the tool was invoked. As an example, the first state processing that occurs during this state machine navigation process has index 1.
+             */
+            state_transition_index: number;
+            /**
+             * Tool Call Round Index
+             * @description The index of the tool call round.
+             */
+            tool_call_round_index: number;
+        };
+        /** StateTransitionInvocationMetadata */
+        "StateTransitionInvocationMetadata-Output": {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "state-transition";
+            /**
+             * Current State Machine And Version
+             * @description The ID and version of the state machine that is currently being executed.
+             */
+            current_state_machine_and_version: [
+                string,
+                number
+            ];
+            /**
+             * State Name
+             * @description The name of the state during which the tool was invoked.
+             */
+            state_name: string;
+            /**
+             * State Transition Index
+             * @description The index of the state transition during which the tool was invoked. As an example, the first state processing that occurs during this state machine navigation process has index 1.
+             */
+            state_transition_index: number;
+            /**
+             * Tool Call Round Index
+             * @description The index of the tool call round.
+             */
+            tool_call_round_index: number;
+        };
         StateTransitionLog: components["schemas"]["ActionStateTransitionLog"] | components["schemas"]["DecisionStateTransitionLog"] | components["schemas"]["RecallStateTransitionLog"] | components["schemas"]["JumpbackStateTransitionLog"] | components["schemas"]["AnnotationStateTransitionLog"] | components["schemas"]["ReflectionStateTransitionLog"] | components["schemas"]["SideEffectStateTransitionLog"];
         "StrippedNonemptyString_A-Z______": string;
         StrippedNonemptyString___w__s_____: string;
         "StrippedNonemptyString_a-z-______": string;
         "StrippedNonemptyString_a-z0-9______": string;
+        /** SucceededInvocationResult */
+        SucceededInvocationResult: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            succeeded: "True";
+            /**
+             * Output
+             * @description The output of the tool invocation.
+             */
+            output: string;
+            /**
+             * Duration Ms
+             * @description The duration of the tool invocation in milliseconds.
+             */
+            duration_ms: number;
+        };
+        /** SucceededInvocationStatus */
+        SucceededInvocationStatus: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            succeeded: "True";
+            /**
+             * Output
+             * @description The output produced by the tool invocation.
+             */
+            output: string;
+        };
         /** SuccessCriterion */
         "SuccessCriterion-Output": {
             /** Name */
@@ -5259,6 +5598,47 @@ export interface components {
              */
             tags: components["schemas"]["Tag"][];
         };
+        /** ToolInvocationInstance */
+        ToolInvocationInstance: {
+            /**
+             * Id
+             * @description The ID of the tool invocation.
+             */
+            id: string;
+            /**
+             * Org Id
+             * @description The ID of the organization.
+             */
+            org_id: string;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at?: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at?: string;
+            /** @description The status of the tool invocation. */
+            invocation_status: components["schemas"]["InvocationStatus"];
+            /** @description The source of the tool invocation. */
+            invocation_source: components["schemas"]["InvocationSource-Output"];
+            /** Logs */
+            logs: string[];
+            /**
+             * Duration Ms
+             * @description The duration of the tool invocation in milliseconds.
+             */
+            duration_ms: number;
+            /**
+             * Tool Id
+             * @description The ID of the tool that was invoked.
+             */
+            tool_id: string;
+            /** @description The version of the tool that was invoked. */
+            tool_version: components["schemas"]["Version"];
+        };
         /** ToolVersionInstance */
         ToolVersionInstance: {
             /**
@@ -7978,6 +8358,24 @@ export interface components {
             id: string;
         };
         /** Response */
+        tool__get_tool_invocations__Response: {
+            /**
+             * Tool Invocations
+             * @description The list of tool invocations.
+             */
+            tool_invocations: components["schemas"]["ToolInvocationInstance"][];
+            /**
+             * Has More
+             * @description Whether there are more tool invocations to retrieve.
+             */
+            has_more: boolean;
+            /**
+             * Continuation Token
+             * @description The continuation token to retrieve the next page of tool invocations, or null if there are no more tool invocations.
+             */
+            continuation_token: unknown | null;
+        };
+        /** Response */
         tool__get_tool_versions__Response: {
             /**
              * Tool Versions
@@ -8040,6 +8438,19 @@ export interface components {
             tags: string[];
         };
         /** Request */
+        tool__invoke_tool_version__Request: {
+            /**
+             * Inputs
+             * @description The list of inputs for the tool invocation.
+             */
+            inputs: components["schemas"]["Input"][];
+        };
+        /** Response */
+        tool__invoke_tool_version__Response: {
+            /** Invocation Results */
+            invocation_results: components["schemas"]["InvocationResult"][];
+        };
+        /** Request */
         tool__modify_tool__Request: {
             /** @description A description of this tool. Only updates if not-null. */
             description?: components["schemas"]["amigo_lib__pydantic__base_model__StrippedNonemptyString__1"] | null;
@@ -16675,4 +17086,181 @@ export interface operations {
             };
         };
     };
+    "get-tool-invocations": {
+        parameters: {
+            query?: {
+                /** @description The ID of the tool to get invocations for. */
+                tool_id?: string[];
+                /** @description A list of semver constraint that specifies the version to retrieve in the [Python packaging specification](https://packaging.python.org/en/latest/specifications/version-specifiers/#id5). This must be the exact same length as `tool_id`, and each entry corresponds to the tool ID at the same index. If an entry is null, all versions of the corresponding tool are retrieved. */
+                version?: (string | null)[];
+                /** @description The source of the invocation */
+                invocation_source_type?: components["schemas"]["InvocationSource-Input"][];
+                /** @description The conversation ID associated with the invocation if it's of invocation source `regular-conversation` */
+                conversation_id?: string[];
+                /** @description The simulation unit test set run ID associated with the invocation if it's of invocation source `simulation-conversation` */
+                simulation_unit_test_set_run_id?: string[];
+                /** @description Whether the invocation succeeded */
+                succeeded?: boolean | null;
+                /** @description The maximum number of tool invocations to return. */
+                limit?: number;
+                /** @description The continuation token from the previous request used to retrieve the next page of tool invocations. */
+                continuation_token?: number;
+                /** @description The fields to sort the versions by. Supported fields are `created_at`, `version.major`, `version.minor`, `version.patch`, `tool_id`, `invocation_source.type`, and `invocation_status.succeeded`. Specify a `+` before the field name to indicate ascending sorting and `-` for descending sorting. Multiple fields can be specified to break ties. */
+                sort_by?: string[];
+            };
+            header?: {
+                /** @description The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database. */
+                "x-mongo-cluster-name"?: string | null;
+                "Sec-WebSocket-Protocol"?: string[];
+            };
+            path: {
+                organization: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["tool__get_tool_invocations__Response"];
+                };
+            };
+            /** @description The `tool_id` and `version` query parameters are not the same length. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid authorization credentials. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Missing required permissions. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Specified organization does not exist. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request path parameter or request query parameter failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The user has exceeded the rate limit of 50 requests per minute for this endpoint. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The service is going through temporary maintenance. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    "invoke-tool-version": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database. */
+                "x-mongo-cluster-name"?: string | null;
+                "Sec-WebSocket-Protocol"?: string[];
+            };
+            path: {
+                organization: string;
+                /** @description The ID of the tool to invoke */
+                tool_id: string;
+                /** @description The version of the tool to invoke */
+                version: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["tool__invoke_tool_version__Request"];
+            };
+        };
+        responses: {
+            /** @description Succeeded */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["tool__invoke_tool_version__Response"];
+                };
+            };
+            /** @description The input parameters do not conform to the tool's input schema. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid authorization credentials. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Missing required permissions. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The specified organization, tool, or tool version does not exist. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Invalid request path parameter or request body failed validation. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The user has exceeded the rate limit of 10 requests per minute for this endpoint. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The service is going through temporary maintenance. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amigo-ai/sdk",
-  "version": "0.20.1",
+  "version": "0.21.0",
   "description": "Amigo TypeScript SDK",
   "publishConfig": {
     "access": "public"