agenta 0.31.0__py3-none-any.whl → 0.32.0__py3-none-any.whl

agenta/client/backend/client.py

@@ -10,6 +10,7 @@ from .scopes.client import ScopesClient
 from .apps.client import AppsClient
 from .variants.client import VariantsClient
 from .evaluations.client import EvaluationsClient
+from .human_evaluations.client import HumanEvaluationsClient
 from .evaluators.client import EvaluatorsClient
 from .testsets.client import TestsetsClient
 from .containers.client import ContainersClient
@@ -41,6 +42,7 @@ from .scopes.client import AsyncScopesClient
 from .apps.client import AsyncAppsClient
 from .variants.client import AsyncVariantsClient
 from .evaluations.client import AsyncEvaluationsClient
+from .human_evaluations.client import AsyncHumanEvaluationsClient
 from .evaluators.client import AsyncEvaluatorsClient
 from .testsets.client import AsyncTestsetsClient
 from .containers.client import AsyncContainersClient
@@ -113,6 +115,9 @@ class AgentaApi:
         self.apps = AppsClient(client_wrapper=self._client_wrapper)
         self.variants = VariantsClient(client_wrapper=self._client_wrapper)
         self.evaluations = EvaluationsClient(client_wrapper=self._client_wrapper)
+        self.human_evaluations = HumanEvaluationsClient(
+            client_wrapper=self._client_wrapper
+        )
         self.evaluators = EvaluatorsClient(client_wrapper=self._client_wrapper)
         self.testsets = TestsetsClient(client_wrapper=self._client_wrapper)
         self.containers = ContainersClient(client_wrapper=self._client_wrapper)
@@ -130,10 +135,10 @@ class AgentaApi:
         List all API keys associated with the authenticated user.
 
         Args:
-        request (Request): The incoming request object.
+            request (Request): The incoming request object.
 
         Returns:
-        List[ListAPIKeysResponse]: A list of API Keys associated with the user.
+            List[ListAPIKeysResponse]: A list of API Keys associated with the user.
 
         Parameters
         ----------
@@ -181,10 +186,10 @@ class AgentaApi:
         Creates an API key for a user.
 
         Args:
-        request (Request): The request object containing the user ID in the request state.
+            request (Request): The request object containing the user ID in the request state.
 
         Returns:
-        str: The created API key.
+            str: The created API key.
 
         Parameters
         ----------
@@ -235,14 +240,14 @@ class AgentaApi:
         Delete an API key with the given key prefix for the authenticated user.
 
         Args:
-        key_prefix (str): The prefix of the API key to be deleted.
-        request (Request): The incoming request object.
+            key_prefix (str): The prefix of the API key to be deleted.
+            request (Request): The incoming request object.
 
         Returns:
-        dict: A dictionary containing a success message upon successful deletion.
+            dict: A dictionary containing a success message upon successful deletion.
 
         Raises:
-        HTTPException: If the API key is not found or does not belong to the user.
+            HTTPException: If the API key is not found or does not belong to the user.
 
         Parameters
         ----------
@@ -306,7 +311,10 @@ class AgentaApi:
         """
         This Function is called by the CLI and is used to validate an API key provided by a user in agenta init setup.
         Returns:
-        bool: True. If the request reaches this point, the API key is valid.
+
+
+
+            bool: True. If the request reaches this point, the API key is valid.
 
         Parameters
         ----------
@@ -368,13 +376,13 @@ class AgentaApi:
         Returns a list of organizations associated with the user's session.
 
         Args:
-        stoken_session (SessionContainer): The user's session token.
+            stoken_session (SessionContainer): The user's session token.
 
         Returns:
-        list[Organization]: A list of organizations associated with the user's session.
+            list[Organization]: A list of organizations associated with the user's session.
 
         Raises:
-        HTTPException: If there is an error retrieving the organizations from the database.
+            HTTPException: If there is an error retrieving the organizations from the database.
 
         Parameters
         ----------
@@ -545,11 +553,11 @@ class AgentaApi:
         Get an organization's details.
 
         Raises:
-        HTTPException: _description_
-        Permission Denied
+            HTTPException: _description_
+            Permission Denied
 
         Returns:
-        OrganizationDB Instance
+            OrganizationDB Instance
 
         Parameters
         ----------
@@ -773,12 +781,12 @@ class AgentaApi:
         Resend an invitation to a user to an Organization.
 
         Raises:
-        HTTPException: _description_; status_code: 500
-        HTTPException: Invitation not found or has expired; status_code: 400
-        HTTPException: You already belong to this organization; status_code: 400
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
 
         Returns:
-        JSONResponse: Resent invitation to user; status_code: 200
+            JSONResponse: Resent invitation to user; status_code: 200
 
         Parameters
         ----------
@@ -859,12 +867,12 @@ class AgentaApi:
         Accept an invitation to a workspace.
 
         Raises:
-        HTTPException: _description_; status_code: 500
-        HTTPException: Invitation not found or has expired; status_code: 400
-        HTTPException: You already belong to this organization; status_code: 400
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
 
         Returns:
-        JSONResponse: Accepted invitation to workspace; status_code: 200
+            JSONResponse: Accepted invitation to workspace; status_code: 200
 
         Parameters
         ----------
@@ -1108,10 +1116,10 @@ class AgentaApi:
         Returns a list of all available workspace roles.
 
         Returns:
-        List[WorkspaceRoleResponse]: A list of WorkspaceRole objects representing the available workspace roles.
+            List[WorkspaceRoleResponse]: A list of WorkspaceRole objects representing the available workspace roles.
 
         Raises:
-        HTTPException: If an error occurs while retrieving the workspace roles.
+            HTTPException: If an error occurs while retrieving the workspace roles.
 
         Parameters
         ----------
@@ -1161,10 +1169,10 @@ class AgentaApi:
         Returns a list of all available workspace permissions.
 
         Returns:
-        List[Permission]: A list of Permission objects representing the available workspace permissions.
+            List[Permission]: A list of Permission objects representing the available workspace permissions.
 
         Raises:
-        HTTPException: If there is an error retrieving the workspace permissions.
+            HTTPException: If there is an error retrieving the workspace permissions.
 
         Parameters
         ----------
@@ -1218,16 +1226,16 @@ class AgentaApi:
         Assigns a role to a user in a workspace.
 
         Args:
-        payload (UserRole): The payload containing the organization id, user email, and role to assign.
-        workspace_id (str): The ID of the workspace.
-        request (Request): The FastAPI request object.
+            payload (UserRole): The payload containing the organization id, user email, and role to assign.
+            workspace_id (str): The ID of the workspace.
+            request (Request): The FastAPI request object.
 
         Returns:
-        bool: True if the role was successfully assigned, False otherwise.
+            bool: True if the role was successfully assigned, False otherwise.
 
         Raises:
-        HTTPException: If the user does not have permission to perform this action.
-        HTTPException: If there is an error assigning the role to the user.
+            HTTPException: If the user does not have permission to perform this action.
+            HTTPException: If there is an error assigning the role to the user.
 
         Parameters
         ----------
@@ -1312,18 +1320,18 @@ class AgentaApi:
         Delete a role assignment from a user in a workspace.
 
         Args:
-        workspace_id (str): The ID of the workspace.
-        email (str): The email of the user to remove the role from.
-        org_id (str): The ID of the organization.
-        role (str): The role to remove from the user.
-        request (Request): The FastAPI request object.
+            workspace_id (str): The ID of the workspace.
+            email (str): The email of the user to remove the role from.
+            org_id (str): The ID of the organization.
+            role (str): The role to remove from the user.
+            request (Request): The FastAPI request object.
 
         Returns:
-        bool: True if the role assignment was successfully deleted.
+            bool: True if the role assignment was successfully deleted.
 
         Raises:
-        HTTPException: If there is an error in the request or the user does not have permission to perform the action.
-        HTTPException: If there is an error in updating the user's roles.
+            HTTPException: If there is an error in the request or the user does not have permission to perform the action.
+            HTTPException: If there is an error in updating the user's roles.
 
         Parameters
         ----------
@@ -1404,17 +1412,14 @@ class AgentaApi:
         Remove a user from a workspace.
 
         Parameters:
-
         - payload (UserRole): The payload containing the user email and organization ID.
         - workspace_id (str): The ID of the workspace.
         - request (Request): The FastAPI request object.
 
         Returns:
-
         - WorkspaceResponse: The updated workspace.
 
         Raises:
-
         - HTTPException: If the user does not have permission to perform this action.
         - HTTPException: If there is an error during the removal process.
 
@@ -1650,6 +1655,9 @@ class AsyncAgentaApi:
         self.apps = AsyncAppsClient(client_wrapper=self._client_wrapper)
         self.variants = AsyncVariantsClient(client_wrapper=self._client_wrapper)
         self.evaluations = AsyncEvaluationsClient(client_wrapper=self._client_wrapper)
+        self.human_evaluations = AsyncHumanEvaluationsClient(
+            client_wrapper=self._client_wrapper
+        )
         self.evaluators = AsyncEvaluatorsClient(client_wrapper=self._client_wrapper)
         self.testsets = AsyncTestsetsClient(client_wrapper=self._client_wrapper)
         self.containers = AsyncContainersClient(client_wrapper=self._client_wrapper)
@@ -1667,10 +1675,10 @@ class AsyncAgentaApi:
         List all API keys associated with the authenticated user.
 
         Args:
-        request (Request): The incoming request object.
+            request (Request): The incoming request object.
 
         Returns:
-        List[ListAPIKeysResponse]: A list of API Keys associated with the user.
+            List[ListAPIKeysResponse]: A list of API Keys associated with the user.
 
         Parameters
         ----------
@@ -1726,10 +1734,10 @@ class AsyncAgentaApi:
         Creates an API key for a user.
 
         Args:
-        request (Request): The request object containing the user ID in the request state.
+            request (Request): The request object containing the user ID in the request state.
 
         Returns:
-        str: The created API key.
+            str: The created API key.
 
         Parameters
         ----------
@@ -1788,14 +1796,14 @@ class AsyncAgentaApi:
         Delete an API key with the given key prefix for the authenticated user.
 
         Args:
-        key_prefix (str): The prefix of the API key to be deleted.
-        request (Request): The incoming request object.
+            key_prefix (str): The prefix of the API key to be deleted.
+            request (Request): The incoming request object.
 
         Returns:
-        dict: A dictionary containing a success message upon successful deletion.
+            dict: A dictionary containing a success message upon successful deletion.
 
         Raises:
-        HTTPException: If the API key is not found or does not belong to the user.
+            HTTPException: If the API key is not found or does not belong to the user.
 
         Parameters
         ----------
@@ -1867,7 +1875,10 @@ class AsyncAgentaApi:
         """
         This Function is called by the CLI and is used to validate an API key provided by a user in agenta init setup.
         Returns:
-        bool: True. If the request reaches this point, the API key is valid.
+
+
+
+            bool: True. If the request reaches this point, the API key is valid.
 
         Parameters
         ----------
@@ -1937,13 +1948,13 @@ class AsyncAgentaApi:
         Returns a list of organizations associated with the user's session.
 
         Args:
-        stoken_session (SessionContainer): The user's session token.
+            stoken_session (SessionContainer): The user's session token.
 
         Returns:
-        list[Organization]: A list of organizations associated with the user's session.
+            list[Organization]: A list of organizations associated with the user's session.
 
         Raises:
-        HTTPException: If there is an error retrieving the organizations from the database.
+            HTTPException: If there is an error retrieving the organizations from the database.
 
         Parameters
         ----------
@@ -2138,11 +2149,11 @@ class AsyncAgentaApi:
         Get an organization's details.
 
         Raises:
-        HTTPException: _description_
-        Permission Denied
+            HTTPException: _description_
+            Permission Denied
 
         Returns:
-        OrganizationDB Instance
+            OrganizationDB Instance
 
         Parameters
         ----------
@@ -2390,12 +2401,12 @@ class AsyncAgentaApi:
         Resend an invitation to a user to an Organization.
 
         Raises:
-        HTTPException: _description_; status_code: 500
-        HTTPException: Invitation not found or has expired; status_code: 400
-        HTTPException: You already belong to this organization; status_code: 400
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
 
         Returns:
-        JSONResponse: Resent invitation to user; status_code: 200
+            JSONResponse: Resent invitation to user; status_code: 200
 
         Parameters
         ----------
@@ -2484,12 +2495,12 @@ class AsyncAgentaApi:
         Accept an invitation to a workspace.
 
         Raises:
-        HTTPException: _description_; status_code: 500
-        HTTPException: Invitation not found or has expired; status_code: 400
-        HTTPException: You already belong to this organization; status_code: 400
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
 
         Returns:
-        JSONResponse: Accepted invitation to workspace; status_code: 200
+            JSONResponse: Accepted invitation to workspace; status_code: 200
 
         Parameters
         ----------
@@ -2757,10 +2768,10 @@ class AsyncAgentaApi:
         Returns a list of all available workspace roles.
 
         Returns:
-        List[WorkspaceRoleResponse]: A list of WorkspaceRole objects representing the available workspace roles.
+            List[WorkspaceRoleResponse]: A list of WorkspaceRole objects representing the available workspace roles.
 
         Raises:
-        HTTPException: If an error occurs while retrieving the workspace roles.
+            HTTPException: If an error occurs while retrieving the workspace roles.
 
         Parameters
         ----------
@@ -2818,10 +2829,10 @@ class AsyncAgentaApi:
         Returns a list of all available workspace permissions.
 
         Returns:
-        List[Permission]: A list of Permission objects representing the available workspace permissions.
+            List[Permission]: A list of Permission objects representing the available workspace permissions.
 
         Raises:
-        HTTPException: If there is an error retrieving the workspace permissions.
+            HTTPException: If there is an error retrieving the workspace permissions.
 
         Parameters
         ----------
@@ -2883,16 +2894,16 @@ class AsyncAgentaApi:
         Assigns a role to a user in a workspace.
 
         Args:
-        payload (UserRole): The payload containing the organization id, user email, and role to assign.
-        workspace_id (str): The ID of the workspace.
-        request (Request): The FastAPI request object.
+            payload (UserRole): The payload containing the organization id, user email, and role to assign.
+            workspace_id (str): The ID of the workspace.
+            request (Request): The FastAPI request object.
 
         Returns:
-        bool: True if the role was successfully assigned, False otherwise.
+            bool: True if the role was successfully assigned, False otherwise.
 
         Raises:
-        HTTPException: If the user does not have permission to perform this action.
-        HTTPException: If there is an error assigning the role to the user.
+            HTTPException: If the user does not have permission to perform this action.
+            HTTPException: If there is an error assigning the role to the user.
 
         Parameters
         ----------
@@ -2985,18 +2996,18 @@ class AsyncAgentaApi:
         Delete a role assignment from a user in a workspace.
 
         Args:
-        workspace_id (str): The ID of the workspace.
-        email (str): The email of the user to remove the role from.
-        org_id (str): The ID of the organization.
-        role (str): The role to remove from the user.
-        request (Request): The FastAPI request object.
+            workspace_id (str): The ID of the workspace.
+            email (str): The email of the user to remove the role from.
+            org_id (str): The ID of the organization.
+            role (str): The role to remove from the user.
+            request (Request): The FastAPI request object.
 
         Returns:
-        bool: True if the role assignment was successfully deleted.
+            bool: True if the role assignment was successfully deleted.
 
         Raises:
-        HTTPException: If there is an error in the request or the user does not have permission to perform the action.
-        HTTPException: If there is an error in updating the user's roles.
+            HTTPException: If there is an error in the request or the user does not have permission to perform the action.
+            HTTPException: If there is an error in updating the user's roles.
 
         Parameters
         ----------
@@ -3085,17 +3096,14 @@ class AsyncAgentaApi:
         Remove a user from a workspace.
 
         Parameters:
-
         - payload (UserRole): The payload containing the user email and organization ID.
         - workspace_id (str): The ID of the workspace.
         - request (Request): The FastAPI request object.
 
         Returns:
-
         - WorkspaceResponse: The updated workspace.
 
         Raises:
-
         - HTTPException: If the user does not have permission to perform this action.
         - HTTPException: If there is an error during the removal process.
 

agenta/client/backend/containers/client.py

@@ -34,13 +34,13 @@ class ContainersClient:
         Builds a Docker image from a tar file containing the application code.
 
         Args:
-        app_id (str): The ID of the application to build the image for.
-        base_name (str): The base name of the image to build.
-        tar_file (UploadFile): The tar file containing the application code.
-        stoken_session (SessionContainer): The session container for the user making the request.
+            app_id (str): The ID of the application to build the image for.
+            base_name (str): The base name of the image to build.
+            tar_file (UploadFile): The tar file containing the application code.
+            stoken_session (SessionContainer): The session container for the user making the request.
 
         Returns:
-        Image: The Docker image that was built.
+            Image: The Docker image that was built.
 
         Parameters
         ----------
@@ -124,7 +124,7 @@ class ContainersClient:
         Restart docker container.
 
         Args:
-        payload (RestartAppContainer) -- the required data (app_name and variant_name)
+            payload (RestartAppContainer) -- the required data (app_name and variant_name)
 
         Parameters
         ----------
@@ -159,7 +159,11 @@ class ContainersClient:
             headers={
                 "content-type": "application/json",
             },
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
             omit=OMIT,
         )
         try:
@@ -222,7 +226,11 @@ class ContainersClient:
         _response = self._client_wrapper.httpx_client.request(
             "containers/templates",
             method="GET",
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -249,15 +257,24 @@ class ContainersClient:
         Constructs the URL for an app container based on the provided base_id or variant_id.
 
         Args:
-        base_id (Optional[str]): The ID of the base to use for the app container.
-        variant_id (Optional[str]): The ID of the variant to use for the app container.
-        request (Request): The request object.
+
+
+
+            base_id (Optional[str]): The ID of the base to use for the app container.
+            variant_id (Optional[str]): The ID of the variant to use for the app container.
+            request (Request): The request object.
 
         Returns:
-        URI: The URI for the app container.
+
+
+
+            URI: The URI for the app container.
 
         Raises:
-        HTTPException: If the base or variant cannot be found or the user does not have access.
+
+
+
+            HTTPException: If the base or variant cannot be found or the user does not have access.
 
         Parameters
         ----------
@@ -290,7 +307,11 @@ class ContainersClient:
                 "base_id": base_id,
                 "variant_id": variant_id,
             },
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -333,13 +354,13 @@ class AsyncContainersClient:
         Builds a Docker image from a tar file containing the application code.
 
         Args:
-        app_id (str): The ID of the application to build the image for.
-        base_name (str): The base name of the image to build.
-        tar_file (UploadFile): The tar file containing the application code.
-        stoken_session (SessionContainer): The session container for the user making the request.
+            app_id (str): The ID of the application to build the image for.
+            base_name (str): The base name of the image to build.
+            tar_file (UploadFile): The tar file containing the application code.
+            stoken_session (SessionContainer): The session container for the user making the request.
 
         Returns:
-        Image: The Docker image that was built.
+            Image: The Docker image that was built.
 
         Parameters
         ----------
@@ -431,7 +452,7 @@ class AsyncContainersClient:
         Restart docker container.
 
         Args:
-        payload (RestartAppContainer) -- the required data (app_name and variant_name)
+            payload (RestartAppContainer) -- the required data (app_name and variant_name)
 
         Parameters
         ----------
@@ -474,7 +495,11 @@ class AsyncContainersClient:
             headers={
                 "content-type": "application/json",
             },
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
             omit=OMIT,
         )
         try:
@@ -545,7 +570,11 @@ class AsyncContainersClient:
         _response = await self._client_wrapper.httpx_client.request(
             "containers/templates",
             method="GET",
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -572,15 +601,24 @@ class AsyncContainersClient:
         Constructs the URL for an app container based on the provided base_id or variant_id.
 
         Args:
-        base_id (Optional[str]): The ID of the base to use for the app container.
-        variant_id (Optional[str]): The ID of the variant to use for the app container.
-        request (Request): The request object.
+
+
+
+            base_id (Optional[str]): The ID of the base to use for the app container.
+            variant_id (Optional[str]): The ID of the variant to use for the app container.
+            request (Request): The request object.
 
         Returns:
-        URI: The URI for the app container.
+
+
+
+            URI: The URI for the app container.
 
         Raises:
-        HTTPException: If the base or variant cannot be found or the user does not have access.
+
+
+
+            HTTPException: If the base or variant cannot be found or the user does not have access.
 
         Parameters
         ----------
@@ -621,7 +659,11 @@ class AsyncContainersClient:
                 "base_id": base_id,
                 "variant_id": variant_id,
             },
-            request_options=request_options,
+            request_options=(
+                {**request_options, "timeout_in_seconds": 600}
+                if request_options
+                else {"timeout_in_seconds": 600}
+            ),
         )
         try:
             if 200 <= _response.status_code < 300: