prompt_request.py

#
# Copyright (c) 2025 Project CHIP Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from typing import Dict, Optional

from pydantic import BaseModel

from app.constants.shared_constants import MessageTypeEnum

default_timeout_s = 60  # Seconds


class PromptRequest(BaseModel):
    prompt: Optional[str]
    # None means "caller did not specify a timeout"; UserPromptSupport.send_prompt_request
    # resolves it (from the project's th_config, falling back to default_timeout_s) before
    # the request is dispatched.
    timeout: Optional[int] = None

    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.INVALID_MESSAGE


class OptionsSelectPromptRequest(PromptRequest):
    options: Dict[str, int]

    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.OPTIONS_REQUEST


class TextInputPromptRequest(PromptRequest):
    placeholder_text: Optional[str]
    default_value: Optional[str]
    regex_pattern: Optional[str]

    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.PROMPT_REQUEST


class UploadFilePromptRequest(PromptRequest):
    path: str = "api/v1/test_run_execution/file_upload/"

    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.FILE_UPLOAD_REQUEST


class MessagePromptRequest(PromptRequest):
    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.MESSAGE_REQUEST


class StreamVerificationPromptRequest(OptionsSelectPromptRequest):
    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.STREAM_VERIFICATION_REQUEST


class ImageVerificationPromptRequest(OptionsSelectPromptRequest):
    image_hex_str: str

    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.IMAGE_VERIFICATION_REQUEST


class TwoWayTalkVerificationRequest(OptionsSelectPromptRequest):
    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.TWO_WAY_TALK_VERIFICATION_REQUEST


class PushAVStreamVerificationRequest(OptionsSelectPromptRequest):
    @property
    def messageType(self) -> MessageTypeEnum:
        return MessageTypeEnum.PUSH_AV_STREAM_VERIFICATION_REQUEST