Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

2.1 KB
Raw Blame
//
//  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
//  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.
//

package core

import "context"

type IncomingMessage struct {
	Channel   string
	AccountID string
	ChatID    string
	ChatType  string
	MessageID string
	SenderID  string
	Text      string
	Raw       map[string]any
}

type OutgoingMessage struct {
	ChatID           string
	Text             string
	ReplyToMessageID string
}

type MessageHandler func(ctx context.Context, msg IncomingMessage) error

type Channel interface {
	ChannelID() string                                   // ChannelID return channel's name
	AccountID() string                                   // AccountID return channel's channelID
	SetMessageHandler(MessageHandler)                    // SetMessageHandler set channel's Message Handler
	Start(ctx context.Context) error                     // Start the channel
	Stop(ctx context.Context) error                      // Stop cancels channel event
	Send(ctx context.Context, msg OutgoingMessage) error // Send posts an outgoing RAGFlow answer to the channel
}

// StreamingChannel is a channel that can deliver a reply while it is generated.
// SendStream receives the cumulative display text on text; closing text finishes
// the message. An error means streaming did not complete, so the caller sends the
// complete answer through Send.
type StreamingChannel interface {
	StreamEnabled() bool // StreamEnabled reports whether the account asked for streaming replies
	SendStream(ctx context.Context, msg OutgoingMessage, text <-chan string) error
}