@univerjs/protocol 0.1.49 → 0.21.0-insiders.20260422-d7fcb4d

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

@@ -1,578 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-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';
-export declare const protobufPackage = "universer.v1";
-export declare enum CompletionStatus {
-    Completion_None = 0,
-    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 {
-    RoleType_None = 0,
-    RoleType_User = 1,
-    RoleType_Agent = 2,
-    UNRECOGNIZED = -1
-}
-export declare enum ContentBlockType {
-    ContentBlockType_None = 0,
-    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 {
-    ContentType_None = 0,
-    ContentType_PlainText = 1,
-    ContentType_Markdown = 2,
-    UNRECOGNIZED = -1
-}
-export declare enum AttachmentType {
-    AttachmentType_None = 0,
-    AttachmentType_Unit = 1,
-    AttachmentType_Recommendation = 3,
-    AttachmentType_DataSource = 4,
-    AttachmentType_HitlAnswer = 5,
-    UNRECOGNIZED = -1
-}
-export declare enum MessageReaction {
-    Reaction_NoReact = 0,
-    Reaction_ThumbsUp = 1,
-    Reaction_ThumbsDown = 2,
-    UNRECOGNIZED = -1
-}
-export declare enum ChatSSEBlockType {
-    ChatSSEBlockType_None = 0,
-    /** ChatSSEBlockType_EndOfStream - indicates that SSE stream ended */
-    ChatSSEBlockType_EndOfStream = 1,
-    /** ChatSSEBlockType_Reject - prompt rejected univer.constants.Error */
-    ChatSSEBlockType_Reject = 2,
-    /** ChatSSEBlockType_ModConversation - conversation modified */
-    ChatSSEBlockType_ModConversation = 3,
-    /** ChatSSEBlockType_PromptAck - prompt message ACK */
-    ChatSSEBlockType_PromptAck = 4,
-    /** ChatSSEBlockType_ChatContent - chat answer stream content */
-    ChatSSEBlockType_ChatContent = 5,
-    /** ChatSSEBlockType_Attachment - attachment of chat answer */
-    ChatSSEBlockType_Attachment = 6,
-    /** ChatSSEBlockType_RespMeta - meta data of the response message */
-    ChatSSEBlockType_RespMeta = 7,
-    /** ChatSSEBlockType_StreamErr - stream error */
-    ChatSSEBlockType_StreamErr = 8,
-    /** ChatSSEBlockType_ChatThinking - chat thinking stream content */
-    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 {
-    ChatSSEStatus_None = 0,
-    /** ChatSSEStatus_Appending - streaming still ongoing */
-    ChatSSEStatus_Appending = 1,
-    /** ChatSSEStatus_Success - streaming completed successfully */
-    ChatSSEStatus_Success = 2,
-    UNRECOGNIZED = -1
-}
-export interface ModelDetail {
-    /** use string representation of enum ai_common.UniverAIModel */
-    modelId: string;
-    rateDetails: RateDetail[];
-}
-export interface ListAvailableModelsRequest {
-}
-export interface ListAvailableModelsResponse {
-    models: ModelDetail[];
-    error: Error | undefined;
-}
-export interface GetConversationModelsRequest {
-}
-export interface GetConversationModel {
-    /** model id */
-    id: string;
-    /** show name */
-    name: string;
-}
-export interface GetConversationModelsResponse {
-    models: GetConversationModel[];
-    error: Error | undefined;
-}
-export interface GetPromptRecommendationsRequest {
-    /** must specify the unitIds */
-    unitIds: string[];
-    /**
-     * if not in an existing conversation,
-     * leave conversationId empty.
-     */
-    conversationId: string;
-    /** Locale Code */
-    locale: string;
-    modelId: string;
-    /** how many recommendations needed, default is 3 */
-    count: number;
-    /** use unit or data source. */
-    dataSourceId: string;
-}
-export interface GetPromptRecommendationsResponse {
-    recommendations: string[];
-    error: Error | undefined;
-}
-export interface Conversation {
-    conversationId: string;
-    /** unix timestamp milli seconds */
-    createTime: string;
-    /** unix timestamp milli seconds */
-    lastUpdate: string;
-    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;
-}
-export interface GetConversationResponse {
-    conversation: Conversation | undefined;
-    error: Error | undefined;
-}
-export interface ListConversationsRequest {
-    /**
-     * 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;
-}
-export interface ListConversationsResponse {
-    /** conversations, order by lastUpdate desc default. */
-    conversations: Conversation[];
-    hasMore: boolean;
-    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;
-}
-export interface RenameConversationResponse {
-    error: Error | undefined;
-}
-export interface ShareConversationRequest {
-    conversationId: string;
-}
-export interface ShareConversationResponse {
-    error: Error | undefined;
-}
-export interface UnshareConversationRequest {
-    conversationId: string;
-}
-export interface UnshareConversationResponse {
-    error: Error | undefined;
-}
-export interface DeleteConversationRequest {
-    conversationId: string;
-}
-export interface DeleteConversationResponse {
-    error: Error | undefined;
-}
-export interface ConversationMessage {
-    messageId: string;
-    roleType: ConversationRoleType;
-    /** unix timestamp milli seconds */
-    createTime: string;
-    /** reaction of the owner */
-    reaction: MessageReaction;
-    /** completionStatus, set if message is answer */
-    completionStatus: CompletionStatus;
-    contents: ContentBlock[];
-    attachments: Attachment[];
-    respMeta: ChatRespMeta | undefined;
-}
-export interface ContentBlock {
-    blockType: ContentBlockType;
-    contentType: ContentType;
-    body: string;
-    /** for multi-channel response, default is empty */
-    channelId?: string | undefined;
-}
-export interface Attachment {
-    type: AttachmentType;
-    /**
-     * id of the Attachment,
-     * vary with the AttachmentType,
-     * AttachmentType_Unit           -> unitId;
-     * AttachmentType_Recommendation -> no ID needed;
-     * AttachmentType_DataSource     -> dataSourceId;
-     * AttachmentType_HitlAnswer     -> no ID needed;
-     */
-    id: string;
-    /**
-     * content of the 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_HitlAnswer     -> orig string of the hitl answer;
-     */
-    content: string;
-}
-export interface ListConversationMessagesRequest {
-    conversationId: string;
-    /**
-     * 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;
-}
-export interface ListConversationMessagesResponse {
-    /** messages, order by createTime desc default. */
-    messages: ConversationMessage[];
-    nextBatchId: string;
-    hasMore: boolean;
-    error: Error | undefined;
-}
-export interface ReactMessageRequest {
-    /** conversationId, required */
-    conversationId: string;
-    /** messageId, required */
-    messageId: string;
-    reaction: MessageReaction;
-}
-export interface ReactMessageResponse {
-    error: Error | undefined;
-}
-/** SSE api: /universer-api/conversation/prompt */
-export interface SubmitPromptRequest {
-    /** set to empty when begin a new conversation */
-    conversationId: string;
-    promptText: string;
-    attachedUnitIds: string[];
-    model: string;
-    /** use unit or data source */
-    dataSourceId: string;
-    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 {
-    conversationId: string;
-    /** see HITLType, use string, see ai_common/common.proto, eg. hitl_select_table */
-    type: string;
-    /** json string, see ai_common/common.proto */
-    resumeData: string;
-    /** 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 {
-    conversationId: string;
-}
-/** chat streaming response SSE block */
-export interface ChatSSEBlock {
-    blockType: ChatSSEBlockType;
-    /**
-     * 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;
-    /** for multi-channel response, default is empty */
-    channelId?: string | undefined;
-}
-export interface ChatContentSSEBlock {
-    contentType: ContentType;
-    body: string;
-}
-export interface ChatThinkingSSEBlock {
-    contentType: ContentType;
-    body: string;
-}
-export interface ChatFragmentationSSEBlock {
-    fragmentationId: string;
-    /** json string of CodeFragmentation */
-    content: string;
-}
-export interface PromptAck {
-    /** id of the user prompt message. */
-    messageId: string;
-}
-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;
-    messageId: string;
-    fragmentationId: string;
-    type: DataFragmentationType;
-    title: string;
-    unitId: string;
-    subUnitId: string;
-}
-export interface GetConversationDataFragmentationRequest {
-    conversationId: string;
-    fragmentationId: string;
-}
-export interface GetConversationDataFragmentationResponse {
-    content: string;
-    error: Error | undefined;
-}
-export interface ListConversationDataFragmentationsRequest {
-    conversationId: string;
-}
-export interface ListConversationDataFragmentationsResponse {
-    fragmentations: ConversationDataFragmentation[];
-    error: Error | undefined;
-}
-export interface UpdateConversationDataFragmentationRequest {
-    conversationId: string;
-    fragmentationId: string;
-    newContent: string;
-}
-export interface UpdateConversationDataFragmentationResponse {
-    error: Error | undefined;
-}
-export interface BindUnitWithConversationRequest {
-    unitId: string;
-    conversationId: string;
-    messageId: string;
-}
-export interface BindUnitWithConversationResponse {
-    error: Error | undefined;
-}
-export interface CancelConversationRequest {
-    conversationId: string;
-}
-export interface CancelConversationResponse {
-    error: Error | undefined;
-}
-export interface NeedReconnectConversationRequest {
-    conversationId: string;
-}
-export interface NeedReconnectConversationResponse {
-    needReconnect: boolean;
-    error: Error | undefined;
-}
-export interface CreateReportRequest {
-    conversationId: string;
-    messageId: string;
-}
-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;
-    messageId: string;
-    /** unix timestamp milli seconds */
-    createTime: number;
-    updateTime: number;
-    status: string;
-    fragmentationId: string;
-    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;
-    title: string;
-    summary: string;
-    content: string;
-}
-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>;
-    DeleteConversation(request: DeleteConversationRequest, metadata?: Metadata): Observable<DeleteConversationResponse>;
-    /** the message list is order by createTime desc default. */
-    ListConversationMessages(request: ListConversationMessagesRequest, metadata?: Metadata): Observable<ListConversationMessagesResponse>;
-    ReactMessage(request: ReactMessageRequest, metadata?: Metadata): Observable<ReactMessageResponse>;
-    GetPromptRecommendations(request: GetPromptRecommendationsRequest, metadata?: Metadata): Observable<GetPromptRecommendationsResponse>;
-    /** deprecated, use ListAvailableModels instead */
-    GetConversationModels(request: GetConversationModelsRequest, metadata?: Metadata): Observable<GetConversationModelsResponse>;
-    ListAvailableModels(request: ListAvailableModelsRequest, metadata?: Metadata): Observable<ListAvailableModelsResponse>;
-    GetConversationDataFragmentation(request: GetConversationDataFragmentationRequest, metadata?: Metadata): Observable<GetConversationDataFragmentationResponse>;
-    ListConversationDataFragmentations(request: ListConversationDataFragmentationsRequest, metadata?: Metadata): Observable<ListConversationDataFragmentationsResponse>;
-    UpdateConversationDataFragmentation(request: UpdateConversationDataFragmentationRequest, metadata?: Metadata): Observable<UpdateConversationDataFragmentationResponse>;
-    BindUnitWithConversation(request: BindUnitWithConversationRequest, metadata?: Metadata): Observable<BindUnitWithConversationResponse>;
-    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>;
-}

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

@@ -1,28 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../../univer/constants/errors';
-export declare const protobufPackage = "universer.v1";
-export interface SendRawEmailRequest {
-    recipientEmail: string;
-    data: string;
-    title: string;
-    template: string;
-}
-export interface SendRawEmailResponse {
-    error: Error | undefined;
-}
-export interface SendClipsheetWorkflowEmailRequest {
-    userId: string;
-    recipientEmail: string;
-    unitUrl: string;
-    succeededAt: Date | undefined;
-    userDisplayName: string;
-    workflowName: string;
-}
-export interface SendClipsheetWorkflowEmailResponse {
-    error: Error | undefined;
-}
-export interface EmailService {
-    SendClipsheetWorkflowEmail(request: SendClipsheetWorkflowEmailRequest, metadata?: Metadata): Observable<SendClipsheetWorkflowEmailResponse>;
-    SendRawEmail(request: SendRawEmailRequest, metadata?: Metadata): Observable<SendRawEmailResponse>;
-}