StanfordSpezi/SpeziChat

Major feature request: Allow different chat items

Open

#19 opened on Dec 11, 2024

View on GitHubContributor guide
 (0 comments) (3 reactions) (0 assignees)Swift (8 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (11 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Use Case

Currently, the SpeziChat supports text-based interactions. To enhance user experience and functionality, we propose enabling support for sharing media files, including images, videos, voice memos, and other formats. Additionally, the assistant should be capable of responding with outputs beyond text, such as images, audio, or videos.

Problem

Currently, SpeziChat supports only text content, and the view responds exclusively to the specified role. As a result, the addition of photos, videos, and other media types has not yet been implemented.

Solution

Rather than assigning specific roles for each type or view, create a generalized context capable of handling various content types, such as images, videos, memos, or even custom content and views.

Alternatives considered

None

Additional context

The chat should be exportable.

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines

Contributor guide

Research direction
Study the current ChatView and ChatModel to understand how text messages are handled. Then design a generic ChatItem protocol that can represent different media types and modify the view to render them appropriately. Consider adding support for export functionality.
Tech stack
swift
Domain
mobile
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwiftGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40