amigo_sdk 0.33.0__py3-none-any.whl → 0.34.0__py3-none-any.whl

amigo_sdk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.33.0"
+__version__ = "0.34.0"
 from .sdk_client import AmigoClient, AsyncAmigoClient
 
 __all__ = ["__version__", "AmigoClient", "AsyncAmigoClient"]

amigo_sdk/generated/model.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  <stdin>
-#   timestamp: 2025-09-24T22:19:53+00:00
+#   timestamp: 2025-10-01T22:49:03+00:00
 
 from __future__ import annotations
 
@@ -240,6 +240,25 @@ class EngageUserDynamicBehaviorOverrideEvent(BaseModel):
     )
 
 
+class EngageUserInvocationMetadataInput(BaseModel):
+    type: Literal['engage-user'] = Field('engage-user', title='Type')
+    current_state_machine_and_version: List = Field(
+        ...,
+        description='The ID and version of the state machine that is currently being executed.',
+        max_length=2,
+        min_length=2,
+        title='Current State Machine And Version',
+    )
+    tool_call_round_index: int = Field(
+        ...,
+        description='The index of the tool call round.',
+        title='Tool Call Round Index',
+    )
+
+
+EngageUserInvocationMetadataOutput = EngageUserInvocationMetadataInput
+
+
 class EngageUserMessageFragmentGeneratedEvent(BaseModel):
     type: Literal['engage-user-message-fragment-generated'] = Field(
         'engage-user-message-fragment-generated', title='Type'
@@ -330,6 +349,49 @@ class ExtractActiveMemoriesAgentActionEvent(BaseModel):
     ] = Field(..., title='Queries And Responses')
 
 
+class FailedInvocationResult(BaseModel):
+    succeeded: Literal['False'] = Field(..., title='Succeeded')
+    exception_message: str = Field(
+        ...,
+        description='The message of the exception during the tool invocation.',
+        title='Exception Message',
+    )
+    exception_type: str = Field(
+        ...,
+        description='The type of the exception during the tool invocation.',
+        title='Exception Type',
+    )
+    exception_stack_trace: List[str] = Field(
+        ...,
+        description='The stack trace of the exception during the tool invocation.',
+        title='Exception Stack Trace',
+    )
+    duration_ms: int = Field(
+        ...,
+        description='The duration of the tool invocation in milliseconds.',
+        title='Duration Ms',
+    )
+
+
+class FailedInvocationStatus(BaseModel):
+    succeeded: Literal['False'] = Field(..., title='Succeeded')
+    exception_message: str = Field(
+        ...,
+        description='The exception message if the tool invocation failed.',
+        title='Exception Message',
+    )
+    exception_type: str = Field(
+        ...,
+        description='The exception type if the tool invocation failed.',
+        title='Exception Type',
+    )
+    exception_stack_trace: List[str] = Field(
+        ...,
+        description='The exception stack trace if the tool invocation failed.',
+        title='Exception Stack Trace',
+    )
+
+
 class Format(Enum):
     text = 'text'
     voice = 'voice'
@@ -8297,6 +8359,22 @@ class InitialUserMessageConfig(BaseModel):
     type: Literal['user-message'] = Field(..., title='Type')
 
 
+class InputInvocationMode(Enum):
+    regular = 'regular'
+    conversation_simulation = 'conversation-simulation'
+
+
+class Input(BaseModel):
+    input_parameters: Dict[str, Any] = Field(
+        ...,
+        description='The input parameters for the tool invocation.',
+        title='Input Parameters',
+    )
+    invocation_mode: InputInvocationMode = Field(
+        ..., description='The mode of invocation.', title='Invocation Mode'
+    )
+
+
 class InteractionCompleteEvent(BaseModel):
     type: Literal['interaction-complete'] = Field('interaction-complete', title='Type')
     message_id: str = Field(
@@ -8793,6 +8871,24 @@ class ReflectionStateOutputNextState(AnnotationStateOutputNextState):
     pass
 
 
+class RegularConversationInvocationSourceInputConversationId(RootModel[str]):
+    root: str = Field(
+        ...,
+        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.',
+        pattern='^[a-f0-9]{24}$',
+        title='Conversation Id',
+    )
+
+
+class RegularConversationInvocationSourceInputInteractionId(RootModel[str]):
+    root: str = Field(
+        ...,
+        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.',
+        pattern='^[a-f0-9]{24}$',
+        title='Interaction Id',
+    )
+
+
 class RelationshipToDeveloperOutput(BaseModel):
     ownership: str = Field(
         ...,
@@ -8922,6 +9018,18 @@ class SideEffectStateTransitionLog(BaseModel):
     )
 
 
+class SimulationConversationInvocationSourceInputSimulationUnitTestSetRunId(
+    RootModel[str]
+):
+    root: str = Field(
+        ..., pattern='^[a-f0-9]{24}$', title='Simulation Unit Test Set Run Id'
+    )
+
+
+class SimulationConversationInvocationSourceInputUnitTestId(RootModel[str]):
+    root: str = Field(..., pattern='^[a-f0-9]{24}$', title='Unit Test Id')
+
+
 class SimulationEvaluationSource(BaseModel):
     type: Literal['simulation'] = Field('simulation', title='Type')
     simulation_unit_test_set_run_id: str = Field(
@@ -8992,10 +9100,58 @@ class StateOrRefName(RootModel[str]):
     root: str = Field(..., pattern='^[A-Za-z0-9_]+$')
 
 
+class StateTransitionInvocationMetadataInput(BaseModel):
+    type: Literal['state-transition'] = Field('state-transition', title='Type')
+    current_state_machine_and_version: List = Field(
+        ...,
+        description='The ID and version of the state machine that is currently being executed.',
+        max_length=2,
+        min_length=2,
+        title='Current State Machine And Version',
+    )
+    state_name: str = Field(
+        ...,
+        description='The name of the state during which the tool was invoked.',
+        title='State Name',
+    )
+    state_transition_index: int = Field(
+        ...,
+        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.',
+        title='State Transition Index',
+    )
+    tool_call_round_index: int = Field(
+        ...,
+        description='The index of the tool call round.',
+        title='Tool Call Round Index',
+    )
+
+
+StateTransitionInvocationMetadataOutput = StateTransitionInvocationMetadataInput
+
+
 class StrippedNonemptyStringWS(RootModel[str]):
     root: str = Field(..., min_length=1, pattern='^[\\w\\s]+$')
 
 
+class SucceededInvocationResult(BaseModel):
+    succeeded: Literal[True] = Field(True, title='Succeeded')
+    output: str = Field(
+        ..., description='The output of the tool invocation.', title='Output'
+    )
+    duration_ms: int = Field(
+        ...,
+        description='The duration of the tool invocation in milliseconds.',
+        title='Duration Ms',
+    )
+
+
+class SucceededInvocationStatus(BaseModel):
+    succeeded: Literal[True] = Field(True, title='Succeeded')
+    output: str = Field(
+        ..., description='The output produced by the tool invocation.', title='Output'
+    )
+
+
 class Tag(BaseModel):
     key: str = Field(..., title='Key')
     value: Optional[str] = Field(..., title='Value')
@@ -11136,6 +11292,16 @@ class ToolGetToolsResponseFilterValues(BaseModel):
     )
 
 
+class ToolInvokeToolVersionRequest(BaseModel):
+    inputs: List[Input] = Field(
+        ...,
+        description='The list of inputs for the tool invocation.',
+        max_length=10,
+        min_length=1,
+        title='Inputs',
+    )
+
+
 class ToolModifyToolRequest(BaseModel):
     description: Optional[AmigoLibPydanticBaseModelStrippedNonemptyString1] = Field(
         None, description='A description of this tool. Only updates if not-null.'
@@ -12905,6 +13071,24 @@ class GetToolVersionsParametersQuery(BaseModel):
     )
 
 
+class GetToolInvocationsParametersQueryToolIdItem(
+    DynamicBehaviorSetCreateDynamicBehaviorSetRequestAppliedToService
+):
+    pass
+
+
+class GetToolInvocationsParametersQueryConversationIdItem(
+    DynamicBehaviorSetCreateDynamicBehaviorSetRequestAppliedToService
+):
+    pass
+
+
+class GetToolInvocationsParametersQuerySimulationUnitTestSetRunIdItem(
+    DynamicBehaviorSetCreateDynamicBehaviorSetRequestAppliedToService
+):
+    pass
+
+
 class APIKey(BaseModel):
     field_id: str = Field(
         ..., alias='_id', description='The ID of the document.', title='Id'
@@ -13399,6 +13583,54 @@ class ReflectionStateTransitionLog(BaseModel):
     )
 
 
+class RegularConversationInvocationSourceInput(BaseModel):
+    type: Literal['regular-conversation'] = Field('regular-conversation', title='Type')
+    user_id: str = Field(
+        ...,
+        description='The ID of the user whose conversation invoked the tool.',
+        title='User Id',
+    )
+    conversation_id: Optional[
+        RegularConversationInvocationSourceInputConversationId
+    ] = Field(
+        ...,
+        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.',
+        title='Conversation Id',
+    )
+    interaction_id: Optional[RegularConversationInvocationSourceInputInteractionId] = (
+        Field(
+            ...,
+            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.',
+            title='Interaction Id',
+        )
+    )
+    invocation_metadata: Union[
+        StateTransitionInvocationMetadataInput, EngageUserInvocationMetadataInput
+    ] = Field(..., description='Metadata about the invocation.', discriminator='type')
+
+
+class RegularConversationInvocationSourceOutput(BaseModel):
+    type: Literal['regular-conversation'] = Field('regular-conversation', title='Type')
+    user_id: str = Field(
+        ...,
+        description='The ID of the user whose conversation invoked the tool.',
+        title='User Id',
+    )
+    conversation_id: Optional[str] = Field(
+        ...,
+        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.',
+        title='Conversation Id',
+    )
+    interaction_id: Optional[str] = Field(
+        ...,
+        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.',
+        title='Interaction Id',
+    )
+    invocation_metadata: Union[
+        StateTransitionInvocationMetadataOutput, EngageUserInvocationMetadataOutput
+    ] = Field(..., description='Metadata about the invocation.', discriminator='type')
+
+
 class RelationshipToDeveloperInput(BaseModel):
     ownership: str = Field(..., min_length=1)
     type: str = Field(..., min_length=1)
@@ -13433,6 +13665,36 @@ class RoleInstance(BaseModel):
     )
 
 
+class SimulationConversationInvocationSourceInput(BaseModel):
+    type: Literal['simulation-conversation'] = Field(
+        'simulation-conversation', title='Type'
+    )
+    simulation_unit_test_set_run_id: Optional[
+        SimulationConversationInvocationSourceInputSimulationUnitTestSetRunId
+    ] = Field(..., title='Simulation Unit Test Set Run Id')
+    unit_test_id: Optional[SimulationConversationInvocationSourceInputUnitTestId] = (
+        Field(..., title='Unit Test Id')
+    )
+    run_index: Optional[int] = Field(..., title='Run Index')
+    invocation_metadata: Union[
+        StateTransitionInvocationMetadataInput, EngageUserInvocationMetadataInput
+    ] = Field(..., description='Metadata about the invocation.', discriminator='type')
+
+
+class SimulationConversationInvocationSourceOutput(BaseModel):
+    type: Literal['simulation-conversation'] = Field(
+        'simulation-conversation', title='Type'
+    )
+    simulation_unit_test_set_run_id: Optional[str] = Field(
+        ..., title='Simulation Unit Test Set Run Id'
+    )
+    unit_test_id: Optional[str] = Field(..., title='Unit Test Id')
+    run_index: Optional[int] = Field(..., title='Run Index')
+    invocation_metadata: Union[
+        StateTransitionInvocationMetadataOutput, EngageUserInvocationMetadataOutput
+    ] = Field(..., description='Metadata about the invocation.', discriminator='type')
+
+
 class SimulationPersonaInstance(BaseModel):
     id: str = Field(..., description='The ID of the simulation persona.', title='Id')
     name: str = Field(
@@ -14550,6 +14812,12 @@ class ToolGetToolsResponse(BaseModel):
     )
 
 
+class ToolInvokeToolVersionResponse(BaseModel):
+    invocation_results: List[
+        Union[SucceededInvocationResult, FailedInvocationResult]
+    ] = Field(..., title='Invocation Results')
+
+
 class ToolModifyToolEnvvarsRequest(BaseModel):
     inserts: Optional[List[InsertRequest]] = Field([], title='Inserts')
     updates: Optional[List[UpdateRequest]] = Field([], title='Updates')
@@ -14991,6 +15259,34 @@ class SuccessCriterionOutput(BaseModel):
     ] = Field(..., discriminator='type')
 
 
+class ToolInvocationInstance(BaseModel):
+    id: str = Field(..., description='The ID of the tool invocation.', title='Id')
+    org_id: str = Field(..., description='The ID of the organization.', title='Org Id')
+    created_at: Optional[AwareDatetime] = Field(None, title='Created At')
+    updated_at: Optional[AwareDatetime] = Field(None, title='Updated At')
+    invocation_status: Union[SucceededInvocationStatus, FailedInvocationStatus] = Field(
+        ..., description='The status of the tool invocation.', discriminator='succeeded'
+    )
+    invocation_source: Union[
+        RegularConversationInvocationSourceOutput,
+        SimulationConversationInvocationSourceOutput,
+    ] = Field(
+        ..., description='The source of the tool invocation.', discriminator='type'
+    )
+    logs: List[str] = Field(..., title='Logs')
+    duration_ms: int = Field(
+        ...,
+        description='The duration of the tool invocation in milliseconds.',
+        title='Duration Ms',
+    )
+    tool_id: str = Field(
+        ..., description='The ID of the tool that was invoked.', title='Tool Id'
+    )
+    tool_version: Version = Field(
+        ..., description='The version of the tool that was invoked.'
+    )
+
+
 class UnitTestRunSpec(BaseModel):
     unit_test_id: str = Field(
         ..., description='ID of the unit test to run.', title='Unit Test Id'
@@ -15412,6 +15708,77 @@ class SimulationUpdateSimulationUnitTestRequest(BaseModel):
     )
 
 
+class ToolGetToolInvocationsResponse(BaseModel):
+    tool_invocations: List[ToolInvocationInstance] = Field(
+        ..., description='The list of tool invocations.', title='Tool Invocations'
+    )
+    has_more: bool = Field(
+        ...,
+        description='Whether there are more tool invocations to retrieve.',
+        title='Has More',
+    )
+    continuation_token: Any = Field(
+        ...,
+        description='The continuation token to retrieve the next page of tool invocations, or null if there are no more tool invocations.',
+        title='Continuation Token',
+    )
+
+
+class GetToolInvocationsParametersQuery(BaseModel):
+    tool_id: Optional[List[GetToolInvocationsParametersQueryToolIdItem]] = Field(
+        [], description='The ID of the tool to get invocations for.', title='Tool Id'
+    )
+    version: Optional[List[Optional[str]]] = Field(
+        [],
+        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.',
+        title='Version',
+    )
+    invocation_source_type: Optional[
+        List[
+            Union[
+                RegularConversationInvocationSourceInput,
+                SimulationConversationInvocationSourceInput,
+            ]
+        ]
+    ] = Field(
+        [], description='The source of the invocation', title='Invocation Source Type'
+    )
+    conversation_id: Optional[
+        List[GetToolInvocationsParametersQueryConversationIdItem]
+    ] = Field(
+        [],
+        description="The conversation ID associated with the invocation if it's of invocation source `regular-conversation`",
+        title='Conversation Id',
+    )
+    simulation_unit_test_set_run_id: Optional[
+        List[GetToolInvocationsParametersQuerySimulationUnitTestSetRunIdItem]
+    ] = Field(
+        [],
+        description="The simulation unit test set run ID associated with the invocation if it's of invocation source `simulation-conversation`",
+        title='Simulation Unit Test Set Run Id',
+    )
+    succeeded: Optional[bool] = Field(
+        None, description='Whether the invocation succeeded', title='Succeeded'
+    )
+    limit: Optional[int] = Field(
+        100,
+        description='The maximum number of tool invocations to return.',
+        ge=0,
+        le=100,
+        title='Limit',
+    )
+    continuation_token: Optional[int] = Field(
+        0,
+        description='The continuation token from the previous request used to retrieve the next page of tool invocations.',
+        title='Continuation Token',
+    )
+    sort_by: Optional[List[str]] = Field(
+        [],
+        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.',
+        title='Sort By',
+    )
+
+
 class SimulationUnitTest(BaseModel):
     field_id: str = Field(
         ..., alias='_id', description='The ID of the document.', title='Id'

{amigo_sdk-0.33.0.dist-info → amigo_sdk-0.34.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amigo_sdk
-Version: 0.33.0
+Version: 0.34.0
 Summary: Amigo AI Python SDK
 Author: Amigo AI
 License-File: LICENSE

{amigo_sdk-0.33.0.dist-info → amigo_sdk-0.34.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-amigo_sdk/__init__.py,sha256=YaPOf32M4qK6E2-CQ3Vx9FZFl6xTyyfpmm5qZ4oxWw4,139
+amigo_sdk/__init__.py,sha256=6b0vc2xMMuatKiNz0Bc9-niRmexdV-DnBIfprK5gxag,139
 amigo_sdk/_retry_utils.py,sha256=kFjw9Wqye6MB5-B4rjLxsbSNcfYBIztcollIoncd1hY,2142
 amigo_sdk/auth.py,sha256=WaM9PcEcnaC6CzNsgRKueHkdSAxNbRylzpR_3Q6guQ0,1765
 amigo_sdk/config.py,sha256=0eZIo-hcJ8ODftKAr-mwB-FGJxGO5PT5T4dRpyWPqAg,1491
@@ -6,13 +6,13 @@ amigo_sdk/errors.py,sha256=RkRyF5eAASd8fIOS6YvL9rLDvLAYWqHfpHSCR7jqvl4,4840
 amigo_sdk/http_client.py,sha256=v25UoUbXcMeHTnfJMcrl8RSSwCVkKUL1Jv-0HoXP1B4,13507
 amigo_sdk/models.py,sha256=V-G6iL43_ZNOPDcatCJCSszGWGz-nzp_RSyGNm-rBAc,45
 amigo_sdk/sdk_client.py,sha256=Kr9M9o66pOLu0T2VDvqdYMmPZzgKJyTELu7BSPgGrYQ,6152
-amigo_sdk/generated/model.py,sha256=sfuUyKjKLmj_7Dw_srq4F40SZkR4b-KYvjQsjffnRNA,425222
+amigo_sdk/generated/model.py,sha256=HucLqV3fttJey2SpA03TuuRrrh1vluZrVuaqZQuZKpg,439364
 amigo_sdk/resources/conversation.py,sha256=5PkJOvLKqnriSS9K9hKw2VRPxRLTuABEbCyPy1fz1r0,14817
 amigo_sdk/resources/organization.py,sha256=yX4UlOHNegRzFW4gCJrCxjiLCAGnGegasjviR1yad_Q,1211
 amigo_sdk/resources/service.py,sha256=SiwEHXCQk4r1b_tGv47M08VuB7RALDHJQzWlpuD937g,1571
 amigo_sdk/resources/user.py,sha256=i4t5aVzBI37KwAtLKSDWTMwf4D4KQdSDoUiblFe1u7o,3529
-amigo_sdk-0.33.0.dist-info/METADATA,sha256=xUfXbB3pR7ydu7sBrxCWDWG5nYRDxa3wdJlZWsrtgM0,8350
-amigo_sdk-0.33.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-amigo_sdk-0.33.0.dist-info/entry_points.txt,sha256=ivKZ8S9W6SH796zUDHeM-qHodrwmkmUItophi-jJWK0,82
-amigo_sdk-0.33.0.dist-info/licenses/LICENSE,sha256=tx3FiTVbGxwBUOxQbNh05AAQlC2jd5hGvNpIkSfVbCo,1062
-amigo_sdk-0.33.0.dist-info/RECORD,,
+amigo_sdk-0.34.0.dist-info/METADATA,sha256=_0Tps4mHAKVyQ6QA2VxJi56tJlMlQ8qVn0VzeB9ktm0,8350
+amigo_sdk-0.34.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amigo_sdk-0.34.0.dist-info/entry_points.txt,sha256=ivKZ8S9W6SH796zUDHeM-qHodrwmkmUItophi-jJWK0,82
+amigo_sdk-0.34.0.dist-info/licenses/LICENSE,sha256=tx3FiTVbGxwBUOxQbNh05AAQlC2jd5hGvNpIkSfVbCo,1062
+amigo_sdk-0.34.0.dist-info/RECORD,,