export type Events = {
meta: {
content_type: ContentType;
refetch_settings: boolean;
linkify: boolean;
suggested_replies: boolean;
};
text: {
text: string;
};
replace_response: {
text: string;
};
suggested_reply: {
text: string;
};
error: {
allow_retry: boolean;
text?: string;
raw_response?: string;
error_type?: string;
};
done: {};
};
export const events = {
text: (text: string) => ({ event: "text", data: { text } }) as PoeBotServerSentEvent<"text">,
meta: (data: Events["meta"]) => ({ event: "meta", data }) as PoeBotServerSentEvent<"meta">,
replace: (text: string) =>
({ event: "replace_response", data: { text } }) as PoeBotServerSentEvent<"replace_response">,
error: (data: Events["error"]) => ({ event: "error", data }) as PoeBotServerSentEvent<"error">,
done: () => ({ event: "done", data: {} }) as PoeBotServerSentEvent<"done">,
};
export type PoeBotServerSentEvent<Key extends keyof Events = keyof Events> = {
event: Key;
data: Events[Key];
};
export type Identifier = string;
export type FeedbackType = "like" | "dislike";
export type ContentType = "text/markdown" | "text/plain";
export type ErrorType = "user_message_too_long";
export interface MessageFeedback {
type: FeedbackType;
reason?: string;
}
export interface Attachment {
url: string;
content_type: string;
name: string;
parsed_content?: string;
}
export interface ProtocolMessage {
role: "system" | "user" | "bot";
sender_id?: string;
content: string;
content_type: ContentType;
timestamp: number;
message_id: string;
feedback: MessageFeedback[];
attachments: Attachment[];
}
export interface RequestContext {
http_request: Request;
}
export interface BaseRequest {
version: string;
type: "query" | "settings" | "report_feedback" | "report_error";
}
export interface QueryRequest extends BaseRequest {
query: ProtocolMessage[];
user_id: Identifier;
conversation_id: Identifier;
message_id: Identifier;
metadata: Identifier;
api_key: string;
access_key: string;
temperature: number;
skip_system_prompt: boolean;
logit_bias: Record<string, number>;
stop_sequences: string[];
language_code: string;
bot_query_id: Identifier;
}
export interface SettingsRequest extends BaseRequest {}
export interface ReportFeedbackRequest extends BaseRequest {
message_id: Identifier;
user_id: Identifier;
conversation_id: Identifier;