|
| 1 | +"""Feedback collection tool for StackOne.""" |
| 2 | + |
| 3 | +# TODO: Remove when Python 3.9 support is dropped |
| 4 | +from __future__ import annotations |
| 5 | + |
| 6 | +import json |
| 7 | + |
| 8 | +from pydantic import BaseModel, Field, field_validator |
| 9 | + |
| 10 | +from ..models import ( |
| 11 | + ExecuteConfig, |
| 12 | + JsonDict, |
| 13 | + ParameterLocation, |
| 14 | + StackOneError, |
| 15 | + StackOneTool, |
| 16 | + ToolParameters, |
| 17 | +) |
| 18 | + |
| 19 | + |
| 20 | +class FeedbackInput(BaseModel): |
| 21 | + """Input schema for feedback tool.""" |
| 22 | + |
| 23 | + feedback: str = Field(..., min_length=1, description="User feedback text") |
| 24 | + account_id: str = Field(..., min_length=1, description="Account identifier") |
| 25 | + tool_names: list[str] = Field(..., min_length=1, description="List of tool names") |
| 26 | + |
| 27 | + @field_validator("feedback", "account_id") |
| 28 | + @classmethod |
| 29 | + def validate_non_empty_trimmed(cls, v: str) -> str: |
| 30 | + """Validate that string is non-empty after trimming.""" |
| 31 | + trimmed = v.strip() |
| 32 | + if not trimmed: |
| 33 | + raise ValueError("Field must be a non-empty string") |
| 34 | + return trimmed |
| 35 | + |
| 36 | + @field_validator("tool_names") |
| 37 | + @classmethod |
| 38 | + def validate_tool_names(cls, v: list[str]) -> list[str]: |
| 39 | + """Validate and clean tool names.""" |
| 40 | + cleaned = [name.strip() for name in v if name.strip()] |
| 41 | + if not cleaned: |
| 42 | + raise ValueError("At least one tool name is required") |
| 43 | + return cleaned |
| 44 | + |
| 45 | + |
| 46 | +class FeedbackTool(StackOneTool): |
| 47 | + """Extended tool for collecting feedback with enhanced validation.""" |
| 48 | + |
| 49 | + def execute( |
| 50 | + self, arguments: str | JsonDict | None = None, *, options: JsonDict | None = None |
| 51 | + ) -> JsonDict: |
| 52 | + """ |
| 53 | + Execute the feedback tool with enhanced validation. |
| 54 | +
|
| 55 | + Args: |
| 56 | + arguments: Tool arguments as string or dict |
| 57 | + options: Execution options |
| 58 | +
|
| 59 | + Returns: |
| 60 | + Response from the API |
| 61 | +
|
| 62 | + Raises: |
| 63 | + StackOneError: If validation or API call fails |
| 64 | + """ |
| 65 | + try: |
| 66 | + # Parse input |
| 67 | + if isinstance(arguments, str): |
| 68 | + raw_params = json.loads(arguments) |
| 69 | + else: |
| 70 | + raw_params = arguments or {} |
| 71 | + |
| 72 | + # Validate with Pydantic |
| 73 | + parsed_params = FeedbackInput(**raw_params) |
| 74 | + |
| 75 | + # Build validated request body |
| 76 | + validated_arguments = { |
| 77 | + "feedback": parsed_params.feedback, |
| 78 | + "account_id": parsed_params.account_id, |
| 79 | + "tool_names": parsed_params.tool_names, |
| 80 | + } |
| 81 | + |
| 82 | + # Use the parent execute method with validated arguments |
| 83 | + return super().execute(validated_arguments, options=options) |
| 84 | + |
| 85 | + except json.JSONDecodeError as exc: |
| 86 | + raise StackOneError(f"Invalid JSON in arguments: {exc}") from exc |
| 87 | + except ValueError as exc: |
| 88 | + raise StackOneError(f"Validation error: {exc}") from exc |
| 89 | + except Exception as error: |
| 90 | + if isinstance(error, StackOneError): |
| 91 | + raise |
| 92 | + raise StackOneError(f"Error executing feedback tool: {error}") from error |
| 93 | + |
| 94 | + |
| 95 | +def create_feedback_tool( |
| 96 | + api_key: str, |
| 97 | + account_id: str | None = None, |
| 98 | + base_url: str = "https://api.stackone.com", |
| 99 | +) -> FeedbackTool: |
| 100 | + """ |
| 101 | + Create a feedback collection tool. |
| 102 | +
|
| 103 | + Args: |
| 104 | + api_key: API key for authentication |
| 105 | + account_id: Optional account ID |
| 106 | + base_url: Base URL for the API |
| 107 | +
|
| 108 | + Returns: |
| 109 | + FeedbackTool configured for feedback collection |
| 110 | + """ |
| 111 | + name = "meta_collect_tool_feedback" |
| 112 | + description = ( |
| 113 | + "Collects user feedback on StackOne tool performance. " |
| 114 | + "First ask the user, \"Are you ok with sending feedback to StackOne?\" " |
| 115 | + "and mention that the LLM will take care of sending it. " |
| 116 | + "Call this tool only when the user explicitly answers yes." |
| 117 | + ) |
| 118 | + |
| 119 | + parameters = ToolParameters( |
| 120 | + type="object", |
| 121 | + properties={ |
| 122 | + "account_id": { |
| 123 | + "type": "string", |
| 124 | + "description": 'Account identifier (e.g., "acc_123456")', |
| 125 | + }, |
| 126 | + "feedback": { |
| 127 | + "type": "string", |
| 128 | + "description": "Verbatim feedback from the user about their experience with StackOne tools.", |
| 129 | + }, |
| 130 | + "tool_names": { |
| 131 | + "type": "array", |
| 132 | + "items": { |
| 133 | + "type": "string", |
| 134 | + }, |
| 135 | + "description": "Array of tool names being reviewed", |
| 136 | + }, |
| 137 | + }, |
| 138 | + ) |
| 139 | + |
| 140 | + execute_config = ExecuteConfig( |
| 141 | + name=name, |
| 142 | + method="POST", |
| 143 | + url=f"{base_url}/ai/tool-feedback", |
| 144 | + body_type="json", |
| 145 | + parameter_locations={ |
| 146 | + "feedback": ParameterLocation.BODY, |
| 147 | + "account_id": ParameterLocation.BODY, |
| 148 | + "tool_names": ParameterLocation.BODY, |
| 149 | + }, |
| 150 | + ) |
| 151 | + |
| 152 | + # Create instance by calling parent class __init__ directly since FeedbackTool is a subclass |
| 153 | + tool = FeedbackTool.__new__(FeedbackTool) |
| 154 | + StackOneTool.__init__( |
| 155 | + tool, |
| 156 | + description=description, |
| 157 | + parameters=parameters, |
| 158 | + _execute_config=execute_config, |
| 159 | + _api_key=api_key, |
| 160 | + _account_id=account_id, |
| 161 | + ) |
| 162 | + |
| 163 | + return tool |
0 commit comments