api

package
v0.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 6, 2023 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Default number of prompt/replies to send to the llm
	DefaultContext = 10
)
View Source 
var (
	// Excludes paths from authentication / logging request-response
	Excludes = []string{
		"/user/signup",
		"/user/login",
		"/user/logout",
		"/user/password/update",
	}
)
View Source 
var (
	Routes = map[string]http.HandlerFunc{

		"/chat/create":      ChatCreate,
		"/chat/read":        ChatRead,
		"/chat/update":      ChatUpdate,
		"/chat/delete":      ChatDelete,
		"/chat/prompt":      ChatPrompt,
		"/chat/index":       ChatIndex,
		"/chat/stream":      ChatStream,
		"/chat/user/add":    ChatUserAdd,
		"/chat/user/remove": ChatUserRemove,

		"/group/create":         GroupCreate,
		"/group/delete":         GroupDelete,
		"/group/read":           GroupRead,
		"/group/update":         GroupUpdate,
		"/group/index":          GroupIndex,
		"/group/members":        GroupMembers,
		"/group/members/add":    GroupMembersAdd,
		"/group/members/remove": GroupMembersRemove,

		"/user/signup":          UserSignup,
		"/user/login":           UserLogin,
		"/user/logout":          UserLogout,
		"/user/read":            UserRead,
		"/user/update":          UserUpdate,
		"/user/session":         UserSession,
		"/user/password/update": UserPasswordUpdate,
	}
)
View Source 
var (
	SessionCookie = "sess"
)

Functions

func AddUserToGroup 

func AddUserToGroup(om *GroupMember) error

func ChatCreate 

func ChatCreate(w http.ResponseWriter, r *http.Request)

CreateChat enables the creation of a new chat

func ChatDelete 

func ChatDelete(w http.ResponseWriter, r *http.Request)

ChatDelete deletes a chat

func ChatIndex 

func ChatIndex(w http.ResponseWriter, r *http.Request)

ChatIndex returns all chats for a user

func ChatPrompt 

func ChatPrompt(w http.ResponseWriter, r *http.Request)

ChatPrompt is for making a request to the ChatGPT platform

func ChatRead 

func ChatRead(w http.ResponseWriter, r *http.Request)

ChatRead returns the messages for a chat

func ChatStream 

func ChatStream(w http.ResponseWriter, r *http.Request)

ChatStream is for streaming SSE events from a chat

func ChatUpdate 

func ChatUpdate(w http.ResponseWriter, r *http.Request)

func ChatUserAdd 

func ChatUserAdd(w http.ResponseWriter, r *http.Request)

func ChatUserRemove 

func ChatUserRemove(w http.ResponseWriter, r *http.Request)

func CreateGroup 

func CreateGroup(group *Group) error

func GroupCreate 

func GroupCreate(w http.ResponseWriter, r *http.Request)

func GroupDelete 

func GroupDelete(w http.ResponseWriter, r *http.Request)

func GroupIndex 

func GroupIndex(w http.ResponseWriter, r *http.Request)

func GroupMembers 

func GroupMembers(w http.ResponseWriter, r *http.Request)

func GroupMembersAdd 

func GroupMembersAdd(w http.ResponseWriter, r *http.Request)

func GroupMembersRemove 

func GroupMembersRemove(w http.ResponseWriter, r *http.Request)

func GroupRead 

func GroupRead(w http.ResponseWriter, r *http.Request)

func GroupUpdate 

func GroupUpdate(w http.ResponseWriter, r *http.Request)

func IsInGroup 

func IsInGroup(groupID, userID string) bool

func LogsHandler 

func LogsHandler(w http.ResponseWriter, r *http.Request)

func SetHeaders 

func SetHeaders(w http.ResponseWriter, r *http.Request)

SetHeaders sets the CORS headers

func UserLogin 

func UserLogin(w http.ResponseWriter, r *http.Request)

UserLogin logs in a user using a username and password

func UserLogout 

func UserLogout(w http.ResponseWriter, r *http.Request)

UserLogout logs out a user using a session token

func UserPasswordUpdate 

func UserPasswordUpdate(w http.ResponseWriter, r *http.Request)

UserPasswordUpdate updates the password of a user

func UserRead 

func UserRead(w http.ResponseWriter, r *http.Request)

func UserSession 

func UserSession(w http.ResponseWriter, r *http.Request)

UserSession reads the current user session and returns the user

func UserSignup 

func UserSignup(w http.ResponseWriter, r *http.Request)

func UserUpdate 

func UserUpdate(w http.ResponseWriter, r *http.Request)

func WithAdmin 

func WithAdmin(user, pass string) func(http.Handler) http.Handler

WithAdmin enables basic auth for an admin system

func WithAuth 

func WithAuth(h http.Handler) http.Handler

WithAuth will enable auth via authorization header, sess cookie or basic auth token

func WithCors 

func WithCors(h http.Handler) http.Handler

WithCors returns cors setting middleware

func WithLogger 

func WithLogger(h http.Handler) http.Handler

WithLogger will log the events

Types

type Chat 

type Chat struct {
	gorm.Model
	ID      string `json:"id" valid:"required" gorm:"index:idx_chat_user,priority:2"`
	Name    string `json:"name" valid:"required"` // name of the chat given by the user
	LLM     string `json:"model" valid:"required"`
	UserID  string `json:"user_id" gorm:"index:idx_chat_user,priority:1"`
	GroupID string `json:"group_id" gorm:"index"` // TODO new composite index with user
}

Chat is the base type for a conversation

func GetChat 

func GetChat(id string) (*Chat, error)

type ChatCreateRequest 

type ChatCreateRequest struct {
	Name    string `json:"name" valid:"required"`
	Model   string `json:"model" valid:"required"`
	GroupID string `json:"group_id"`
}

type ChatCreateResponse 

type ChatCreateResponse struct {
	Chat
}

type ChatDeleteRequest 

type ChatDeleteRequest struct {
	// Unique chat id
	ID string `json:"id" valid:"required"`
}

type ChatDeleteResponse 

type ChatDeleteResponse struct {
}

type ChatIndexRequest 

type ChatIndexRequest struct {
}

type ChatIndexResponse 

type ChatIndexResponse struct {
	Chats []*Chat `json:"chats"`
}

type ChatPromptRequest 

type ChatPromptRequest struct {
	ID      string `json:"id" valid:"required"`
	Prompt  string `json:"prompt" valid:"required"`
	Context int    `json:"context,omitempty"`
	Stream  bool   `json:"stream,omitempty"`
	OTR     bool   `json:"otr,omitempty"`
}

type ChatPromptResponse 

type ChatPromptResponse struct {
	// If stream is specified in request then Reply in response message is nil
	Message Message `json:"message"`
}

type ChatReadRequest 

type ChatReadRequest struct {
	ID string `json:"id" valid:"required"`
}

type ChatReadResponse 

type ChatReadResponse struct {
	Chat     *Chat      `json:"chat"`
	Messages []*Message `json:"messages"`
	Users    []*User    `json:"users"`
}

type ChatStreamRequest 

type ChatStreamRequest struct {
	ID string `json:"id" valid:"required"`
}

type ChatStreamResponse 

type ChatStreamResponse struct {
	Message Message `json:"message"`
	Partial bool    `json:"partial"`
}

type ChatUpdateRequest 

type ChatUpdateRequest struct {
	ID    string `json:"id"`
	Name  string `json:"name" valid:"required"`
	Model string `json:"model" valid:"required"`
}

type ChatUpdateResponse 

type ChatUpdateResponse struct {
	// Unique chat id
	ID    string `json:"id"`
	Name  string `json:"name" valid:"required"`
	Model string `json:"model" valid:"required"`
}

type ChatUser 

type ChatUser struct {
	gorm.Model
	ChatID string `json:"chat_id" gorm:"uniqueIndex:idx_chat_user_member,priority:2"`
	UserID string `json:"user_id" gorm:"uniqueIndex:idx_chat_user_member,priority:1"`
}

func GetChatUser 

func GetChatUser(chatID, userID string) (*ChatUser, error)

func GetChatUsers 

func GetChatUsers(id string) ([]ChatUser, error)

func GetChatsForUser 

func GetChatsForUser(id string) ([]ChatUser, error)

type ChatUserAddRequest 

type ChatUserAddRequest struct {
	ChatID string `json:"chat_id" valid:"required"`
	UserID string `json:"user_id" valid:"required"`
}

type ChatUserAddResponse 

type ChatUserAddResponse struct{}

type ChatUserRemoveRequest 

type ChatUserRemoveRequest struct {
	ChatID string `json:"chat_id"`
	UserID string `json:"user_id"`
}

type ChatUserRemoveResponse 

type ChatUserRemoveResponse struct{}

type Event 

type Event struct {
	// TODO: gorm validation
	gorm.Model
	ID        string        `json:"ID"`
	Timestamp time.Time     `json:"Timestamp"`
	ClientIP  string        `json:"ClientIP"`
	Endpoint  string        `json:"Endpoint"`
	Request   string        `json:"Request"`
	Response  string        `json:"Response"`
	Status    int           `json:"Status"`
	Message   string        `json:"Message"`
	Duration  time.Duration `json:"Duration"`
	Method    string        `json:"Method"`
	Params    string        `json:"Params"`
	UserID    string        `json:"UserID"`
}

Event is a request summary

type Group 

type Group struct {
	gorm.Model
	ID          string `json:"id" valid:"required"`
	Name        string `json:"name" valid:"length(1|30)"`
	Description string `json:"description" valid:"length(1|256)"`
	OwnerID     string `json:"owner_id" gorm:"index"`
}

Group who users are members of

func GetGroup 

func GetGroup(userID string) (*Group, error)

func GetGroupByID 

func GetGroupByID(id string) (*Group, error)

type GroupCreateRequest 

type GroupCreateRequest struct {
	Name        string   `json:"name" valid:"length(1|30)"`
	Description string   `json:"description" valid:"length(1|256)"`
	Members     []string `json:"members"`
}

GroupCreateRequest for group/create

type GroupDeleteRequest 

type GroupDeleteRequest struct {
	ID string `json:"id" valid:"required"`
}

type GroupDeleteResponse 

type GroupDeleteResponse struct {
	Group Group `json:"group"`
}

type GroupIndexRequest 

type GroupIndexRequest struct{}

GroupIndexRequest for group/index Get token for userID and list all groups that user is in This is overkill as users will only have one group to start with but worth building for future

type GroupIndexResponse 

type GroupIndexResponse struct {
	Groups []Group `json:"groups"`
}

GroupIndexResponse for group/index

type GroupMember 

type GroupMember struct {
	gorm.Model
	GroupID string `json:"group_id" gorm:"index:idx_group_member_group_user"`
	UserID  string `json:"user_id" gorm:"index:idx_group_member_group_user"`
}

type GroupMembersAddRequest 

type GroupMembersAddRequest struct {
	ID      string   `json:"id" valid:"required,length(1|254)"`
	UserIDs []string `json:"user_ids"`
}

GroupUsersCreateRequest for group/users/create adds a users to an group. TODO: permissions

type GroupMembersAddResponse 

type GroupMembersAddResponse struct{}

type GroupMembersInviteRequest 

type GroupMembersInviteRequest struct {
	Username string `json:"username" valid:"required,length(6|254)"`
	GroupID  string `json:"group_id" valid:"required,length(1|254)"`
}

type GroupMembersInviteResponse 

type GroupMembersInviteResponse struct{}

type GroupMembersRemoveRequest 

type GroupMembersRemoveRequest struct {
	ID      string   `json:"id" valid:"required,length(1|254)"`
	UserIDs []string `json:"user_ids"`
}

type GroupMembersRemoveResponse 

type GroupMembersRemoveResponse struct{}

type GroupMembersRequest 

type GroupMembersRequest struct {
	ID string `json:"id" valid:"required"`
}

GroupMembersRequest for group/users returns all users in an group

type GroupMembersResponse 

type GroupMembersResponse struct {
	Users []User `json:"users"`
}

GroupUsersResponse for group/users

type GroupReadRequest 

type GroupReadRequest struct {
	ID string `json:"id" valid:"required"`
}

GroupReadRequest for group/read

type GroupReadResponse 

type GroupReadResponse struct {
	Group
}

type GroupUpdateRequest 

type GroupUpdateRequest struct {
	ID          string `json:"id" valid:"required"`
	Name        string `json:"name" valid:"length(1|30)"`
	Description string `json:"description" valid:"length(1|256)"`
}

GroupUpdateRequest for group/update

type GroupUpdateResponse 

type GroupUpdateResponse struct {
	Group
}

GroupUpdateResponse for group/update

type Message 

type Message struct {
	gorm.Model
	ID      string `json:"id" valid:"required"`
	ChatID  string `json:"chat_id" gorm:"index:idx_chat_message,priority:2"`
	UserID  string `json:"user_id" gorm:"index:idx_chat_message,priority:1"`
	GroupID string `json:"group_id" gorm:"index"`
	Prompt  string `json:"prompt"`
	Reply   string `json:"reply"`
	LLM     string `json:"model"`
	OTR     bool   `json:"otr"`
}

Message represents the messages in a Chat

type Options 

type Options struct {
	// key for the url
	Key string
	// url to proxy to
	Url string
}

type Proxy 

type Proxy struct {
	// contains filtered or unexported fields
}

Proxy handles all inbound requests

func New 

func New(opts *Options) *Proxy

func (*Proxy) Register 

func (p *Proxy) Register(routes map[string]http.HandlerFunc)

func (*Proxy) Run 

func (p *Proxy) Run(address string, hd http.Handler) error

func (*Proxy) ServeHTTP 

func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Session 

type Session struct {
	gorm.Model
	Token     string    `json:"token" gorm:"index"`
	ExpiresAt time.Time `json:"expires_at"`
	Username  string    `json:"username"`
	UserID    string    `json:"user_id"`
}

The session for a given user

type User 

type User struct {
	// TODO: gorm validation
	gorm.Model
	ID        string  `json:"id" valid:"required"`
	FirstName string  `json:"first_name" valid:"length(1|30)"`
	LastName  string  `json:"last_name" valid:"length(1|30)"`
	Username  string  `json:"username" valid:"required,username,length(6|254)" gorm:"unique_index;not null"`
	Password  string  `json:"-"`
	Groups    []Group `json:"groups" gorm:"many2many:user_groups;"`
}

User who signs up

func CreateUser 

func CreateUser(ur *User) (*User, error)

func GetUser 

func GetUser(username string) (User, error)

func GetUsers 

func GetUsers(ids []string) ([]User, error)

type UserDeleteRequest 

type UserDeleteRequest struct {
	ID string `json:"id" valid:"required"`
}

UserDeleteRequest for deleting

type UserDeleteResponse 

type UserDeleteResponse struct{}

UserDeleteResponse is empty as 200

type UserIndexRequest 

type UserIndexRequest struct {
	GroupID uint `json:"group_id" valid:"length(1|30)"`
}

UserIndexRequest for user/index TODO: worry about pagination later.

type UserIndexResponse 

type UserIndexResponse struct {
	Users []User `json:"users"`
}

UserIndexResponse for user/index

type UserLoginRequest 

type UserLoginRequest struct {
	Username string `json:"username" valid:"required,length(1|254)"` // currently username
	Password string `json:"password" valid:"required"`               // ^[a-z0-9@.-_+]+$ - no validation
}

UserLoginRequest struct for auth/login

type UserLoginResponse 

type UserLoginResponse struct {
	Token string `json:"Token"`
	User  User   `json:"User"`
}

UserLoginResponse struct for auth/login

type UserLogoutRequest 

type UserLogoutRequest struct {
	Token string
}

UserLogoutRequest struct for auth/logout Just need valid header

type UserLogoutResponse 

type UserLogoutResponse struct{}

UserLogoutResponse struct for auth/logout Just need valid header

type UserPasswordUpdateRequest 

type UserPasswordUpdateRequest struct {
	OldPassword string `json:"old_password" valid:"required"`
	NewPassword string `json:"new_password" valid:"required"`
}

UserPasswordUpdateRequest is for updating a password by logged in user

type UserPasswordUpdateResponse 

type UserPasswordUpdateResponse struct{}

type UserReadRequest 

type UserReadRequest struct {
	ID string `json:"id" valid:"required"`
}

UserReadRequest for user/read

type UserReadResponse 

type UserReadResponse struct {
	User User `json:"user"`
}

UserReadResponse full user with id Response for user/create, user/read & user/update

type UserSessionRequest 

type UserSessionRequest struct{}

User session request to get the current user

type UserSessionResponse 

type UserSessionResponse struct {
	User User `json:"user"`
}

type UserSignupRequest 

type UserSignupRequest struct {
	// 	ID created in backend
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
	Username  string `json:"username" valid:"required,length(1|254)" gorm:"unique_index;not null"`
	Password  string `json:"password" valid:"required"`
	GroupName string `json:"group_name,omitempty"`
}

UserSignupRequest for user/register Need to create group from first+last name

type UserSignupResponse 

type UserSignupResponse struct {
	Token string `json:"Token"`
	User  User   `json:"User"`
}

UserSignupResponse for user/register same as authResponse

type UserUpdateRequest 

type UserUpdateRequest struct {
	ID        string `json:"id" valid:"required"`
	FirstName string `json:"first_name" valid:"length(1|30)"`
	LastName  string `json:"last_name" valid:"length(1|30)"`
	Username  string `json:"username" valid:"required,username,length(6|254)"`
}

UserUpdateRequest for user/update TODO: validate username and check is unique

type UserUpdateResponse 

type UserUpdateResponse struct{}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.