@ragbits/api-client 0.0.2 → 1.3.0

package/dist/autogen.types.d.ts

@@ -0,0 +1,426 @@
+/**
+ * Auto-generated TypeScript interfaces from Python Pydantic models
+ * Generated by scripts/generate_typescript_from_json_schema.py
+ * DO NOT EDIT MANUALLY
+ */
+import type { RJSFSchema } from '@rjsf/utils';
+export type TypeFrom<T> = T[keyof T];
+/**
+ * Represents the ChatResponseType enum
+ */
+export declare const ChatResponseType: {
+    readonly Text: "text";
+    readonly Reference: "reference";
+    readonly StateUpdate: "state_update";
+    readonly MessageId: "message_id";
+    readonly ConversationId: "conversation_id";
+    readonly LiveUpdate: "live_update";
+    readonly FollowupMessages: "followup_messages";
+    readonly Image: "image";
+    readonly ChunkedContent: "chunked_content";
+    readonly ClearMessage: "clear_message";
+    readonly Usage: "usage";
+};
+export type ChatResponseType = TypeFrom<typeof ChatResponseType>;
+/**
+ * Represents the FeedbackType enum
+ */
+export declare const FeedbackType: {
+    readonly Like: "like";
+    readonly Dislike: "dislike";
+};
+export type FeedbackType = TypeFrom<typeof FeedbackType>;
+/**
+ * Represents the LiveUpdateType enum
+ */
+export declare const LiveUpdateType: {
+    readonly Start: "START";
+    readonly Finish: "FINISH";
+};
+export type LiveUpdateType = TypeFrom<typeof LiveUpdateType>;
+/**
+ * Represents the MessageRole enum
+ */
+export declare const MessageRole: {
+    readonly User: "user";
+    readonly Assistant: "assistant";
+    readonly System: "system";
+};
+export type MessageRole = TypeFrom<typeof MessageRole>;
+/**
+ * Represents the AuthType enum
+ */
+export declare const AuthType: {
+    readonly Credentials: "credentials";
+};
+export type AuthType = TypeFrom<typeof AuthType>;
+/**
+ * Represents the context of a chat conversation.
+ */
+export interface ChatContext {
+    conversation_id: string | null;
+    message_id: string | null;
+    state: {
+        [k: string]: unknown;
+    };
+    user: User | null;
+    session_id: string | null;
+    [k: string]: unknown;
+}
+/**
+ * Represents a chunk of large content being transmitted.
+ */
+export interface ChunkedContent {
+    id: string;
+    content_type: string;
+    chunk_index: number;
+    total_chunks: number;
+    mime_type: string;
+    data: string;
+}
+/**
+ * Represents an live update performed by an agent.
+ */
+export interface LiveUpdate {
+    update_id: string;
+    type: LiveUpdateType;
+    content: LiveUpdateContent;
+}
+/**
+ * Represents content of a live update.
+ */
+export interface LiveUpdateContent {
+    label: string;
+    description: string | null;
+}
+/**
+ * Represents a single message in the conversation history.
+ */
+export interface Message {
+    role: MessageRole;
+    content: string;
+}
+/**
+ * Represents a document used as reference for the response.
+ */
+export interface Reference {
+    title: string;
+    content: string;
+    url: string | null;
+}
+/**
+ * Represents an update to conversation state.
+ */
+export interface ServerState {
+    state: {
+        [k: string]: unknown;
+    };
+    signature: string;
+}
+/**
+ * Individual feedback configuration (like/dislike).
+ */
+export interface FeedbackItem {
+    /**
+     * Whether this feedback type is enabled
+     */
+    enabled: boolean;
+    /**
+     * Form schema for this feedback type
+     */
+    form: RJSFSchema | null;
+}
+/**
+ * Represents an image in the conversation.
+ */
+export interface Image {
+    id: string;
+    url: string;
+}
+/**
+ * Represents usage for a message. Reflects `Usage` computed properties.
+ */
+export interface MessageUsage {
+    n_requests: number;
+    estimated_cost: number;
+    prompt_tokens: number;
+    completion_tokens: number;
+    total_tokens: number;
+}
+/**
+ * Customization for the header section of the UI.
+ */
+export interface HeaderCustomization {
+    /**
+     * Custom title to be displayed instead of 'Ragbits Chat'
+     */
+    title: string | null;
+    /**
+     * Custom subtitle to be displayed instead of 'by deepsense.ai'
+     */
+    subtitle: string | null;
+    /**
+     * Custom logo URL or content. The logo can also be served from 'static' directory inside 'ui-buid'
+     */
+    logo: string | null;
+}
+/**
+ * Customization for the UI.
+ */
+export interface UICustomization {
+    /**
+     * Custom header configuration
+     */
+    header: HeaderCustomization | null;
+    /**
+     * Custom welcome message to be displayed on the UI. It supports Markdown.
+     */
+    welcome_message: string | null;
+    /**
+     * Custom meta properties customization
+     */
+    meta: PageMetaCustomization | null;
+}
+/**
+ * Customization for the meta properites of the UI
+ */
+export interface PageMetaCustomization {
+    /**
+     * Custom favicon URL or content. If `None` logo is used.The favicon can also be serverd from 'static' directory inside 'ui-build'
+     */
+    favicon: string | null;
+    /**
+     * Custom title for the page displayed in the browser's bar. If `None` header title is used.
+     */
+    page_title: string | null;
+}
+/**
+ * Configuration for chat options.
+ */
+export interface UserSettings {
+    /**
+     * The form to use for chat options. Use Pydantic models to define form objects, that would get converted to JSONSchema and rendered in the UI.
+     */
+    form: RJSFSchema | null;
+}
+/**
+ * Feedback configuration containing like and dislike settings.
+ */
+export interface FeedbackConfig {
+    like: FeedbackItem;
+    dislike: FeedbackItem;
+}
+/**
+ * Configuration response from the API.
+ */
+export interface ConfigResponse {
+    feedback: FeedbackConfig;
+    /**
+     * UI customization
+     */
+    customization: UICustomization | null;
+    user_settings: UserSettings;
+    /**
+     * Debug mode flag
+     */
+    debug_mode: boolean;
+    /**
+     * Flag to enable conversation history
+     */
+    conversation_history: boolean;
+    /**
+     * Flag to enable usage statistics
+     */
+    show_usage: boolean;
+    authentication: AuthenticationConfig;
+}
+/**
+ * Response from feedback submission.
+ */
+export interface FeedbackResponse {
+    /**
+     * Status of the feedback submission
+     */
+    status: string;
+}
+/**
+ * Client-side chat request interface.
+ */
+export interface ChatRequest {
+    /**
+     * The current user message
+     */
+    message: string;
+    /**
+     * Previous message history
+     */
+    history: Message[];
+    /**
+     * User context information
+     */
+    context: {
+        [k: string]: unknown;
+    };
+}
+/**
+ * Request body for feedback submission
+ */
+export interface FeedbackRequest {
+    /**
+     * ID of the message receiving feedback
+     */
+    message_id: string;
+    /**
+     * Type of feedback (like or dislike)
+     */
+    feedback: 'like' | 'dislike';
+    /**
+     * Additional feedback details
+     */
+    payload: {
+        [k: string]: unknown;
+    };
+}
+/**
+ * Configuration for authentication.
+ */
+export interface AuthenticationConfig {
+    /**
+     * Enable/disable authentication
+     */
+    enabled: boolean;
+    /**
+     * List of available authentication types
+     */
+    auth_types: AuthType[];
+}
+/**
+ * Request body for user login
+ */
+export interface CredentialsLoginRequest {
+    /**
+     * Username
+     */
+    username: string;
+    /**
+     * Password
+     */
+    password: string;
+}
+/**
+ * Represents a JWT authentication jwt_token.
+ */
+export interface JWTToken {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    refresh_token: string | null;
+    user: User;
+}
+/**
+ * Request body for user login
+ */
+export interface LoginRequest {
+    /**
+     * Username
+     */
+    username: string;
+    /**
+     * Password
+     */
+    password: string;
+}
+/**
+ * Response body for successful login
+ */
+export interface LoginResponse {
+    /**
+     * Whether login was successful
+     */
+    success: boolean;
+    /**
+     * User information
+     */
+    user: User | null;
+    /**
+     * Error message if login failed
+     */
+    error_message: string | null;
+    /**
+     * Access jwt_token
+     */
+    jwt_token: JWTToken | null;
+}
+/**
+ * Request body for user logout
+ */
+export interface LogoutRequest {
+    /**
+     * Session ID to logout
+     */
+    token: string;
+}
+/**
+ * Represents an authenticated user.
+ */
+export interface User {
+    user_id: string;
+    username: string;
+    email: string | null;
+    full_name: string | null;
+    roles: string[];
+    metadata: {
+        [k: string]: unknown;
+    };
+}
+/**
+ * Specific chat response types
+ */
+export interface TextChatResponse {
+    type: 'text';
+    content: string;
+}
+export interface ReferenceChatResponse {
+    type: 'reference';
+    content: Reference;
+}
+export interface MessageIdChatResponse {
+    type: 'message_id';
+    content: string;
+}
+export interface ConversationIdChatResponse {
+    type: 'conversation_id';
+    content: string;
+}
+export interface StateUpdateChatResponse {
+    type: 'state_update';
+    content: ServerState;
+}
+export interface LiveUpdateChatResponse {
+    type: 'live_update';
+    content: LiveUpdate;
+}
+export interface FollowupMessagesChatResponse {
+    type: 'followup_messages';
+    content: string[];
+}
+export interface ImageChatResponse {
+    type: 'image';
+    content: Image;
+}
+export interface ClearMessageResponse {
+    type: 'clear_message';
+    content: never;
+}
+export interface MessageUsageChatResponse {
+    type: 'usage';
+    content: Record<string, MessageUsage>;
+}
+export interface ChunkedChatResponse {
+    type: 'chunked_content';
+    content: ChunkedContent;
+}
+/**
+ * Typed chat response union
+ */
+export type ChatResponse = TextChatResponse | ReferenceChatResponse | MessageIdChatResponse | ConversationIdChatResponse | StateUpdateChatResponse | LiveUpdateChatResponse | FollowupMessagesChatResponse | ImageChatResponse | ClearMessageResponse | MessageUsageChatResponse;