graphlit-client 1.0.20250531004 → 1.0.20250610001

package/dist/client.d.ts

@@ -1,5 +1,43 @@
 import { ApolloClient, NormalizedCacheObject } from "@apollo/client/core";
 import * as Types from "./generated/graphql-types.js";
+import { AgentOptions, AgentResult, StreamAgentOptions, ToolHandler } from "./types/agent.js";
+import { AgentStreamEvent } from "./types/ui-events.js";
+export type StreamEvent = {
+    type: "start";
+    conversationId: string;
+} | {
+    type: "token";
+    token: string;
+} | {
+    type: "message";
+    message: string;
+} | {
+    type: "tool_call_start";
+    toolCall: {
+        id: string;
+        name: string;
+    };
+} | {
+    type: "tool_call_delta";
+    toolCallId: string;
+    argumentDelta: string;
+} | {
+    type: "tool_call_complete";
+    toolCall: {
+        id: string;
+        name: string;
+        arguments: string;
+    };
+} | {
+    type: "complete";
+    messageId?: string;
+    conversationId?: string;
+} | {
+    type: "error";
+    error: string;
+};
+export type { AgentOptions, AgentResult, StreamAgentOptions, ToolCallResult, UsageInfo, AgentError, } from "./types/agent.js";
+export type { AgentStreamEvent } from "./types/ui-events.js";
 declare class Graphlit {
     client: ApolloClient<NormalizedCacheObject> | undefined;
     token: string | undefined;
@@ -9,8 +47,26 @@ declare class Graphlit {
     private ownerId;
     private userId;
     private jwtSecret;
+    private openaiClient?;
+    private anthropicClient?;
+    private googleClient?;
     constructor(organizationId?: string, environmentId?: string, jwtSecret?: string, ownerId?: string, userId?: string, apiUri?: string);
     refreshClient(): void;
+    /**
+     * Set a custom OpenAI client instance for streaming
+     * @param client - OpenAI client instance (e.g., new OpenAI({ apiKey: "..." }))
+     */
+    setOpenAIClient(client: any): void;
+    /**
+     * Set a custom Anthropic client instance for streaming
+     * @param client - Anthropic client instance (e.g., new Anthropic({ apiKey: "..." }))
+     */
+    setAnthropicClient(client: any): void;
+    /**
+     * Set a custom Google Generative AI client instance for streaming
+     * @param client - Google GenerativeAI client instance (e.g., new GoogleGenerativeAI(apiKey))
+     */
+    setGoogleClient(client: any): void;
     private generateToken;
     getProject(): Promise<Types.GetProjectQuery>;
     updateProject(project: Types.ProjectUpdateInput): Promise<Types.UpdateProjectMutation>;
@@ -49,8 +105,8 @@ declare class Graphlit {
     ingestBatch(uris: string[], workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestBatchMutation>;
     ingestUri(uri: string, name?: string, id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestUriMutation>;
     ingestText(text: string, name?: string, textType?: Types.TextTypes, uri?: string, id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestTextMutation>;
-    ingestMemory(text: string, name?: string, textType?: Types.TextTypes, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestMemoryMutation>;
-    ingestEvent(markdown: string, name?: string, description?: string, eventDate?: Types.Scalars["DateTime"]["input"], collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestEventMutation>;
+    ingestMemory(text: string, name?: string, textType?: Types.TextTypes, id?: string, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestMemoryMutation>;
+    ingestEvent(markdown: string, name?: string, description?: string, eventDate?: Types.Scalars["DateTime"]["input"], id?: string, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestEventMutation>;
     ingestEncodedFile(name: string, data: string, mimeType: string, fileCreationDate?: Types.Scalars["DateTime"]["input"], fileModifiedDate?: Types.Scalars["DateTime"]["input"], id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestEncodedFileMutation>;
     updateContent(content: Types.ContentUpdateInput): Promise<Types.UpdateContentMutation>;
     deleteContent(id: string): Promise<Types.DeleteContentMutation>;
@@ -84,7 +140,7 @@ declare class Graphlit {
     reviseContent(prompt: string, content: Types.EntityReferenceInput, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseContentMutation>;
     prompt(prompt?: string, mimeType?: string, data?: string, specification?: Types.EntityReferenceInput, messages?: Types.ConversationMessageInput[], correlationId?: string): Promise<Types.PromptMutation>;
     retrieveSources(prompt: string, filter?: Types.ContentFilter, augmentedFilter?: Types.ContentFilter, retrievalStrategy?: Types.RetrievalStrategyInput, rerankingStrategy?: Types.RerankingStrategyInput, correlationId?: string): Promise<Types.RetrieveSourcesMutation>;
-    formatConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, includeDetails?: boolean, correlationId?: string): Promise<Types.FormatConversationMutation>;
+    formatConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, tools?: Types.ToolDefinitionInput[], includeDetails?: boolean, correlationId?: string): Promise<Types.FormatConversationMutation>;
     completeConversation(completion: string, id: string, correlationId?: string): Promise<Types.CompleteConversationMutation>;
     askGraphlit(prompt: string, type?: Types.SdkTypes, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.AskGraphlitMutation>;
     promptConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, mimeType?: string, data?: string, tools?: Types.ToolDefinitionInput[], requireTool?: boolean, includeDetails?: boolean, correlationId?: string): Promise<Types.PromptConversationMutation>;
@@ -287,9 +343,78 @@ declare class Graphlit {
     createObservation(observation: Types.ObservationInput): Promise<Types.CreateObservationMutation>;
     updateObservation(observation: Types.ObservationUpdateInput): Promise<Types.UpdateObservationMutation>;
     deleteObservation(id: string): Promise<Types.DeleteObservationMutation>;
+    /**
+     * Creates an event handler that supports UI streaming mode
+     * @internal
+     */
+    /**
+     * Check if streaming is supported with the current configuration
+     * @param specification - Optional specification to check compatibility
+     * @returns true if streaming is available, false otherwise
+     */
+    supportsStreaming(specification?: Types.Specification | Types.EntityReferenceInput): boolean;
+    /**
+     * Execute an agent with non-streaming response
+     * @param prompt - The user prompt
+     * @param conversationId - Optional conversation ID to continue
+     * @param specification - Optional specification for the LLM
+     * @param tools - Optional tool definitions
+     * @param toolHandlers - Optional tool handler functions
+     * @param options - Agent options
+     * @returns Complete agent result with message and tool calls
+     */
+    promptAgent(prompt: string, conversationId?: string, specification?: Types.EntityReferenceInput, tools?: Types.ToolDefinitionInput[], toolHandlers?: Record<string, ToolHandler>, options?: AgentOptions, mimeType?: string, data?: string, // base64 encoded
+    correlationId?: string): Promise<AgentResult>;
+    /**
+     * Execute an agent with streaming response
+     * @param prompt - The user prompt
+     * @param onEvent - Event handler for streaming events
+     * @param conversationId - Optional conversation ID to continue
+     * @param specification - Optional specification for the LLM
+     * @param tools - Optional tool definitions
+     * @param toolHandlers - Optional tool handler functions
+     * @param options - Stream agent options
+     * @throws Error if streaming is not supported
+     */
+    streamAgent(prompt: string, onEvent: (event: StreamEvent | AgentStreamEvent) => void, conversationId?: string, specification?: Types.EntityReferenceInput, tools?: Types.ToolDefinitionInput[], toolHandlers?: Record<string, ToolHandler>, options?: StreamAgentOptions, mimeType?: string, data?: string, // base64 encoded
+    correlationId?: string): Promise<void>;
+    /**
+     * Execute the streaming agent workflow with tool calling loop
+     */
+    private executeStreamingAgent;
+    /**
+     * Build message array for LLM from conversation history
+     */
+    private buildMessageArray;
+    /**
+     * Execute tools during streaming with proper event emission
+     */
+    private executeToolsInStream;
+    /**
+     * Format tool results for API
+     */
+    private formatToolResults;
+    /**
+     * Fallback to non-streaming when streaming is not available
+     */
+    private fallbackToNonStreaming;
+    /**
+     * Stream with OpenAI client
+     */
+    private streamWithOpenAI;
+    /**
+     * Stream with Anthropic client
+     */
+    private streamWithAnthropic;
+    /**
+     * Stream with Google client
+     */
+    private streamWithGoogle;
+    private executeToolsForPromptAgent;
     private prettyPrintGraphQLError;
     private mutateAndCheckError;
     private queryAndCheckError;
 }
 export { Graphlit };
 export * as Types from "./generated/graphql-types.js";
+export { StreamEventAggregator, AggregatedEvent, formatSSEEvent, createSSEStream, wrapToolHandlers, enhanceToolCalls, ConversationMetrics, ToolResultEmitter, ServerMapping, } from "./stream-helpers.js";