@univerjs/protocol 0.1.47 → 0.1.49

package/lib/types/ts/universer/v1/conversation.d.ts

@@ -1,6 +1,7 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { SystemHint } from '../../ai_common/common';
+import { OpenAIMessage, SystemHint } from '../../ai_common/common';
+import { Changeset } from '../../univer/changeset';
 import { Error } from '../../univer/constants/errors';
 import { DataFragmentationType } from './analyse_cmn';
 import { RateDetail } from './entitlement';
@@ -10,6 +11,8 @@ export declare enum CompletionStatus {
     Completion_Completed = 1,
     Completion_UserCancelled = 2,
     Completion_SystemErr = 3,
+    /** Completion_Interrupted - like hunman in the loop, and etc... */
+    Completion_Interrupted = 4,
     UNRECOGNIZED = -1
 }
 export declare enum ConversationRoleType {
@@ -23,6 +26,22 @@ export declare enum ContentBlockType {
     ContentBlockType_Prompt = 1,
     ContentBlockType_Thinking = 2,
     ContentBlockType_Report = 3,
+    /** ContentBlockType_PromptV2 - map to json string of the orig SubmitPromptRequest */
+    ContentBlockType_PromptV2 = 4,
+    /** ContentBlockType_HITL - HITL event */
+    ContentBlockType_HITL = 103,
+    /** ContentBlockType_ToolCallStart - tool call start */
+    ContentBlockType_ToolCallStart = 105,
+    /** ContentBlockType_ToolCallResult - tool call end */
+    ContentBlockType_ToolCallResult = 106,
+    /** ContentBlockType_SubAgentsCallStart - sub-agents calls start */
+    ContentBlockType_SubAgentsCallStart = 107,
+    /** ContentBlockType_SubAgentsCallResult - sub-agents calls end */
+    ContentBlockType_SubAgentsCallResult = 108,
+    /** ContentBlockType_SubAgentRunStarted - sub-agent started event */
+    ContentBlockType_SubAgentRunStarted = 109,
+    /** ContentBlockType_SubAgentRunFinished - sub-agent finished event */
+    ContentBlockType_SubAgentRunFinished = 110,
     UNRECOGNIZED = -1
 }
 export declare enum ContentType {
@@ -36,6 +55,7 @@ export declare enum AttachmentType {
     AttachmentType_Unit = 1,
     AttachmentType_Recommendation = 3,
     AttachmentType_DataSource = 4,
+    AttachmentType_HitlAnswer = 5,
     UNRECOGNIZED = -1
 }
 export declare enum MessageReaction {
@@ -66,6 +86,32 @@ export declare enum ChatSSEBlockType {
     ChatSSEBlockType_ChatThinking = 9,
     /** ChatSSEBlockType_Fragmentation - content data fragmentation */
     ChatSSEBlockType_Fragmentation = 10,
+    /**
+     * ChatSSEBlockType_RawMessage - deprecated, raw message from model, just use tool message body, use ChatSSEBlockType_ToolCall instead
+     *
+     * @deprecated
+     */
+    ChatSSEBlockType_RawMessage = 101,
+    /**
+     * ChatSSEBlockType_EditThinking - deprecated, use ChatSSEBlockType_ChatThinking instead
+     *
+     * @deprecated
+     */
+    ChatSSEBlockType_EditThinking = 102,
+    /** ChatSSEBlockType_HITL - HITL event */
+    ChatSSEBlockType_HITL = 103,
+    /** ChatSSEBlockType_ToolCallStart - tool call start */
+    ChatSSEBlockType_ToolCallStart = 105,
+    /** ChatSSEBlockType_ToolCallResult - tool call end */
+    ChatSSEBlockType_ToolCallResult = 106,
+    /** ChatSSEBlockType_SubAgentsCallStart - sub-agents calls start */
+    ChatSSEBlockType_SubAgentsCallStart = 107,
+    /** ChatSSEBlockType_SubAgentsCallResult - sub-agents calls end */
+    ChatSSEBlockType_SubAgentsCallResult = 108,
+    /** ChatSSEBlockType_SubAgentRunStarted - sub-agent started event */
+    ChatSSEBlockType_SubAgentRunStarted = 109,
+    /** ChatSSEBlockType_SubAgentRunFinished - sub-agent finished event */
+    ChatSSEBlockType_SubAgentRunFinished = 110,
     UNRECOGNIZED = -1
 }
 export declare enum ChatSSEStatus {
@@ -128,8 +174,28 @@ export interface Conversation {
     title: string;
     creatorUid: string;
     expireTime: string;
+    /**
+     * version history:
+     * 2512--不支持unit编辑类会话
+     * 2601--统一分析和编辑会话
+     */
+    agentVersion: number;
+    /** this field is nil for old version conversations */
+    limits: ConversationLimits | undefined;
+    /** this field is nil for old version conversations */
+    settings: ConversationSettings | undefined;
     shared: boolean;
 }
+export interface ConversationLimits {
+    /** cumulative tokens used in this conversation */
+    cumulativeTokens: number;
+    /** max allowed tokens in this conversation */
+    maxAllowedTokens: number;
+}
+export interface ConversationSettings {
+    /** add here if more settings needed in the future. */
+    model: string;
+}
 export interface GetConversationRequest {
     conversationId: string;
 }
@@ -154,6 +220,24 @@ export interface ListConversationsResponse {
     nextBatchId: string;
     error: Error | undefined;
 }
+export interface ListConversationsByUnitRequest {
+    /**
+     * batchId,
+     * set to empty in the 1st scroller request,
+     * then set to nextBatchId(which was returned by the previous request) in the following scroller request.
+     */
+    batchId: string;
+    /** limit, specify how many records needed. */
+    limit: number;
+    /** required */
+    unitId: string;
+}
+export interface ListConversationsByUnitResponse {
+    conversations: Conversation[];
+    hasMore: boolean;
+    nextBatchId: string;
+    error: Error | undefined;
+}
 export interface RenameConversationRequest {
     conversationId: string;
     newTitle: string;
@@ -190,6 +274,7 @@ export interface ConversationMessage {
     completionStatus: CompletionStatus;
     contents: ContentBlock[];
     attachments: Attachment[];
+    respMeta: ChatRespMeta | undefined;
 }
 export interface ContentBlock {
     blockType: ContentBlockType;
@@ -204,8 +289,9 @@ export interface Attachment {
      * id of the Attachment,
      * vary with the AttachmentType,
      * AttachmentType_Unit           -> unitId;
-     * AttachmentType_Recommendation -> no ID;
+     * AttachmentType_Recommendation -> no ID needed;
      * AttachmentType_DataSource     -> dataSourceId;
+     * AttachmentType_HitlAnswer     -> no ID needed;
      */
     id: string;
     /**
@@ -213,7 +299,8 @@ export interface Attachment {
      * vary with the AttachmentType,
      * AttachmentType_Unit           -> empty;
      * AttachmentType_Recommendation -> json string of recommendations(json string array);
-     * AttachmentType_DataSource     -> json string of v1.DataSource
+     * AttachmentType_DataSource     -> json string of v1.DataSource;
+     * AttachmentType_HitlAnswer     -> orig string of the hitl answer;
      */
     content: string;
 }
@@ -257,6 +344,12 @@ export interface SubmitPromptRequest {
     systemHints: SystemHint[];
     /** Locale Code */
     locale?: string | undefined;
+    /** optional, if provided, promptText will be ignored */
+    messages: OpenAIMessage[];
+    /** optional, json string array of SelectedRange, only used when messages is provided */
+    selectedRanges: string[];
+    /** optional, eg. "plan", "ask", "agent", "brainstorm" */
+    mode?: string | undefined;
 }
 /** SSE api: /universer-api/conversation/resume */
 export interface ResumeConversationRequest {
@@ -268,6 +361,8 @@ export interface ResumeConversationRequest {
     /** Locale Code */
     locale?: string | undefined;
     model?: string | undefined;
+    /** the question's owner message id which is answer to. */
+    answerToMessageId: string;
 }
 /** SSE api: /universer-api/conversation/reconnect */
 export interface ReconnectConversationRequest {
@@ -277,18 +372,13 @@ export interface ReconnectConversationRequest {
 export interface ChatSSEBlock {
     blockType: ChatSSEBlockType;
     /**
-     * body,
-     * json string identicated by blockType,
-     * ChatSSEBlockType_EndOfStream     -> empty;
-     * ChatSSEBlockType_StreamErr       -> json string of error reason: univer.constants.Error;
-     * ChatSSEBlockType_Reject          -> json string of reject reason: univer.constants.Error;
-     * ChatSSEBlockType_ModConversation -> json string of Conversation;
-     * ChatSSEBlockType_PromptAck       -> json string of PromptAck;
-     * ChatSSEBlockType_ChatContent     -> json string of ChatContentSSEBlock;
-     * ChatSSEBlockType_Attachment      -> json string of Attachment;
-     * ChatSSEBlockType_RespMeta        -> json string of ChatRespMeta;
-     * ChatSSEBlockType_ChatThinking    -> json string of ChatThinkingSSEBlock;
-     * ChatSSEBlockType_Fragmentation   -> json string of ChatFragmentationSSEBlock;
+     * see ai_common/common.proto
+     * ChatSSEBlockType_ToolCallStart       -> json string of ChatToolCallStartSSEBlock;
+     * ChatSSEBlockType_ToolCallResult      -> json string of ChatToolCallResultSSEBlock;
+     * ChatSSEBlockType_SubAgentsCallStart  -> json string of ChatSubAgentsCallStartSSEBlock;
+     * ChatSSEBlockType_SubAgentsCallResult -> json string of ChatSubAgentsCallResultSSEBlock;
+     * ChatSSEBlockType_SubAgentRunStarted  -> json string of ChatSubAgentRunStartedSSEBlock;
+     * ChatSSEBlockType_SubAgentRunFinished -> json string of ChatSubAgentRunFinishedSSEBlock;
      */
     body: string;
     status: ChatSSEStatus;
@@ -314,6 +404,11 @@ export interface PromptAck {
 }
 export interface ChatRespMeta {
     messageId: string;
+    /** cumulative tokens used in this conversation */
+    cumulativeTokens: number;
+    /** max allowed tokens in this conversation */
+    maxAllowedTokens: number;
+    reportable: boolean;
 }
 export interface ConversationDataFragmentation {
     conversationId: string;
@@ -376,6 +471,14 @@ export interface CreateReportResponse {
     report: Report | undefined;
     error: Error | undefined;
 }
+export interface RedoReportRequest {
+    reportId: string;
+    conversationId: string;
+}
+export interface PollingReportRequest {
+    reportId: string;
+    conversationId: string;
+}
 export interface Report {
     reportId: string;
     conversationId: string;
@@ -388,13 +491,25 @@ export interface Report {
     title: string;
     summary: string;
 }
+export interface ReportList {
+    reports: Report[];
+}
 export interface ListReportsRequest {
     conversationId: string;
 }
 export interface ListReportsResponse {
+    /** @deprecated */
     reports: Report[];
+    /** messageId -> ReportList */
+    reportsMap: {
+        [key: string]: ReportList;
+    };
     error: Error | undefined;
 }
+export interface ListReportsResponse_ReportsMapEntry {
+    key: string;
+    value: ReportList | undefined;
+}
 export interface FinishReportRequest {
     reportId: string;
     status: string;
@@ -405,10 +520,36 @@ export interface FinishReportRequest {
 export interface FinishReportResponse {
     error: Error | undefined;
 }
+export interface GetDashboardRequest {
+    conversationId: string;
+}
+export interface GetDashboardResponse {
+    conversationId: string;
+    dashboardJson: string;
+    error: Error | undefined;
+}
+export interface SaveDashboardRequest {
+    conversationId: string;
+    dashboardJson: string;
+}
+export interface SaveDashboardResponse {
+    error: Error | undefined;
+}
+export interface GetConversationCsRequest {
+    conversationId: string;
+    messageIds: string[];
+}
+export interface GetConversationCsResponse {
+    changesets: Changeset[];
+    startRevision: number;
+    endRevision: number;
+    error: Error | undefined;
+}
 export interface ConversationService {
     GetConversation(request: GetConversationRequest, metadata?: Metadata): Observable<GetConversationResponse>;
     /** the conversation list is order by lastUpdate desc default. */
     ListConversations(request: ListConversationsRequest, metadata?: Metadata): Observable<ListConversationsResponse>;
+    ListConversationsByUnit(request: ListConversationsByUnitRequest, metadata?: Metadata): Observable<ListConversationsByUnitResponse>;
     RenameConversation(request: RenameConversationRequest, metadata?: Metadata): Observable<RenameConversationResponse>;
     ShareConversation(request: ShareConversationRequest, metadata?: Metadata): Observable<ShareConversationResponse>;
     UnshareConversation(request: UnshareConversationRequest, metadata?: Metadata): Observable<UnshareConversationResponse>;
@@ -427,6 +568,11 @@ export interface ConversationService {
     CancelConversation(request: CancelConversationRequest, metadata?: Metadata): Observable<CancelConversationResponse>;
     NeedReconnectConversation(request: NeedReconnectConversationRequest, metadata?: Metadata): Observable<NeedReconnectConversationResponse>;
     CreateReport(request: CreateReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
+    RedoReport(request: RedoReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
+    PollingReport(request: PollingReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
     ListReports(request: ListReportsRequest, metadata?: Metadata): Observable<ListReportsResponse>;
     FinishReport(request: FinishReportRequest, metadata?: Metadata): Observable<FinishReportResponse>;
+    GetDashboard(request: GetDashboardRequest, metadata?: Metadata): Observable<GetDashboardResponse>;
+    SaveDashboard(request: SaveDashboardRequest, metadata?: Metadata): Observable<SaveDashboardResponse>;
+    GetConversationCs(request: GetConversationCsRequest, metadata?: Metadata): Observable<GetConversationCsResponse>;
 }