@inkeep/agents-sdk 0.0.0-dev-20260117184722 → 0.0.0-dev-20260117201141

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/agent.d.ts CHANGED
@@ -21,100 +21,100 @@ declare class Agent implements AgentInterface {
21
21
  private stopWhen?;
22
22
  constructor(config: AgentConfig);
23
23
  /**
24
- * Set or update the configuration (tenantId, projectId and apiUrl)
25
- * This is used by the CLI to inject configuration from inkeep.config.ts
26
- */
24
+ * Set or update the configuration (tenantId, projectId and apiUrl)
25
+ * This is used by the CLI to inject configuration from inkeep.config.ts
26
+ */
27
27
  setConfig(tenantId: string, projectId: string, apiUrl: string): void;
28
28
  /**
29
- * Convert the Agent to FullAgentDefinition format for the new agent endpoint
30
- */
29
+ * Convert the Agent to FullAgentDefinition format for the new agent endpoint
30
+ */
31
31
  toFullAgentDefinition(): Promise<FullAgentDefinition>;
32
32
  /**
33
- * Initialize all tools in all agents (especially IPCTools that need MCP server URLs)
34
- */
33
+ * Initialize all tools in all agents (especially IPCTools that need MCP server URLs)
34
+ */
35
35
  private initializeAllTools;
36
36
  /**
37
- * Initialize the agent and all agents in the backend using the new agent endpoint
38
- */
37
+ * Initialize the agent and all agents in the backend using the new agent endpoint
38
+ */
39
39
  init(): Promise<void>;
40
40
  /**
41
- * Generate a response using the default agent
42
- */
41
+ * Generate a response using the default agent
42
+ */
43
43
  generate(input: MessageInput, options?: GenerateOptions): Promise<string>;
44
44
  /**
45
- * Stream a response using the default agent
46
- */
45
+ * Stream a response using the default agent
46
+ */
47
47
  stream(input: MessageInput, options?: GenerateOptions): Promise<StreamResponse>;
48
48
  /**
49
- * Alias for stream() method for consistency with naming patterns
50
- */
49
+ * Alias for stream() method for consistency with naming patterns
50
+ */
51
51
  generateStream(input: MessageInput, options?: GenerateOptions): Promise<StreamResponse>;
52
52
  /**
53
- * Run with a specific agent from the agent
54
- */
53
+ * Run with a specific agent from the agent
54
+ */
55
55
  runWith(subAgentId: string, input: MessageInput, options?: GenerateOptions): Promise<RunResult>;
56
56
  /**
57
- * Get an agent by name (unified method for all agent types)
58
- */
57
+ * Get an agent by name (unified method for all agent types)
58
+ */
59
59
  getSubAgent(name: string): SubAgentInterface | undefined;
60
60
  /**
61
- * Add an agent to the agent
62
- */
61
+ * Add an agent to the agent
62
+ */
63
63
  addSubAgent(agent: SubAgentInterface): void;
64
64
  /**
65
- * Remove an agent from the agent
66
- */
65
+ * Remove an agent from the agent
66
+ */
67
67
  removeSubAgent(id: string): boolean;
68
68
  /**
69
- * Get all agents in the agent
70
- */
69
+ * Get all agents in the agent
70
+ */
71
71
  getSubAgents(): SubAgentInterface[];
72
72
  /**
73
- * Get all agent ids (unified method for all agent types)
74
- */
73
+ * Get all agent ids (unified method for all agent types)
74
+ */
75
75
  getSubAgentIds(): string[];
76
76
  /**
77
- * Set the default agent
78
- */
77
+ * Set the default agent
78
+ */
79
79
  setDefaultSubAgent(agent: SubAgentInterface): void;
80
80
  /**
81
- * Get the default agent
82
- */
81
+ * Get the default agent
82
+ */
83
83
  getDefaultSubAgent(): SubAgentInterface | undefined;
84
84
  /**
85
- * Get the agent ID
86
- */
85
+ * Get the agent ID
86
+ */
87
87
  getId(): string;
88
88
  getName(): string;
89
89
  getDescription(): string | undefined;
90
90
  getTenantId(): string;
91
91
  /**
92
- * Get the agent's model settingsuration
93
- */
92
+ * Get the agent's model settingsuration
93
+ */
94
94
  getModels(): typeof this.models;
95
95
  /**
96
- * Set the agent's model settingsuration
97
- */
96
+ * Set the agent's model settingsuration
97
+ */
98
98
  setModels(models: typeof this.models): void;
99
99
  /**
100
- * Get the agent's prompt configuration
101
- */
100
+ * Get the agent's prompt configuration
101
+ */
102
102
  getPrompt(): string | undefined;
103
103
  /**
104
- * Get the agent's stopWhen configuration
105
- */
104
+ * Get the agent's stopWhen configuration
105
+ */
106
106
  getStopWhen(): AgentStopWhen;
107
107
  /**
108
- * Get the agent's status updates configuration
109
- */
108
+ * Get the agent's status updates configuration
109
+ */
110
110
  getStatusUpdateSettings(): StatusUpdateSettings | undefined;
111
111
  /**
112
- * Get the summarizer model from the agent's model settings
113
- */
112
+ * Get the summarizer model from the agent's model settings
113
+ */
114
114
  getSummarizerModel(): ModelSettings | undefined;
115
115
  /**
116
- * Get agent statistics
117
- */
116
+ * Get agent statistics
117
+ */
118
118
  getStats(): {
119
119
  agentCount: number;
120
120
  defaultSubAgent: string | null;
@@ -126,61 +126,61 @@ declare class Agent implements AgentInterface {
126
126
  headers?: Record<string, string>;
127
127
  }): subAgentTeamAgentInterface;
128
128
  /**
129
- * Validate the agent configuration
130
- */
129
+ * Validate the agent configuration
130
+ */
131
131
  validate(): {
132
132
  valid: boolean;
133
133
  errors: string[];
134
134
  };
135
135
  private _init;
136
136
  /**
137
- * Type guard to check if an agent is an internal AgentInterface
138
- */
137
+ * Type guard to check if an agent is an internal AgentInterface
138
+ */
139
139
  isInternalAgent(agent: AllDelegateInputInterface): agent is SubAgentInterface;
140
140
  /**
141
- * Get project-level model settingsuration defaults
142
- */
141
+ * Get project-level model settingsuration defaults
142
+ */
143
143
  private getProjectModelDefaults;
144
144
  /**
145
- * Get project-level stopWhen configuration defaults
146
- */
145
+ * Get project-level stopWhen configuration defaults
146
+ */
147
147
  private getProjectStopWhenDefaults;
148
148
  /**
149
- * Apply model inheritance hierarchy: Project -> Agent -> Agent
150
- */
149
+ * Apply model inheritance hierarchy: Project -> Agent -> Agent
150
+ */
151
151
  private applyModelInheritance;
152
152
  /**
153
- * Apply stopWhen inheritance hierarchy: Project -> Agent -> Agent
154
- */
153
+ * Apply stopWhen inheritance hierarchy: Project -> Agent -> Agent
154
+ */
155
155
  private applyStopWhenInheritance;
156
156
  /**
157
- * Propagate agent-level model settings to agents (supporting partial inheritance)
158
- */
157
+ * Propagate agent-level model settings to agents (supporting partial inheritance)
158
+ */
159
159
  private propagateModelSettingsToAgent;
160
160
  /**
161
- * Immediately propagate agent-level models to all agents during construction
162
- */
161
+ * Immediately propagate agent-level models to all agents during construction
162
+ */
163
163
  private propagateImmediateModelSettings;
164
164
  /**
165
- * Execute agent using the backend system instead of local runner
166
- */
165
+ * Execute agent using the backend system instead of local runner
166
+ */
167
167
  private executeWithBackend;
168
168
  /**
169
- * Parse streaming response in SSE format
170
- */
169
+ * Parse streaming response in SSE format
170
+ */
171
171
  private parseStreamingResponse;
172
172
  /**
173
- * Normalize input messages to the expected format
174
- */
173
+ * Normalize input messages to the expected format
174
+ */
175
175
  private normalizeMessages;
176
176
  }
177
177
  /**
178
- * Helper function to create agent - OpenAI style
179
- */
178
+ * Helper function to create agent - OpenAI style
179
+ */
180
180
  declare function agent(config: AgentConfig): Agent;
181
181
  /**
182
- * Factory function to create agent from configuration file
183
- */
182
+ * Factory function to create agent from configuration file
183
+ */
184
184
  declare function generateAgent(configPath: string): Promise<Agent>;
185
185
  //#endregion
186
186
  export { Agent, agent, generateAgent };
@@ -3,20 +3,20 @@ import { FullAgentDefinition } from "@inkeep/agents-core";
3
3
  //#region src/agentFullClient.d.ts
4
4
 
5
5
  /**
6
- * Create a full agent via HTTP API
7
- */
6
+ * Create a full agent via HTTP API
7
+ */
8
8
  declare function createFullAgentViaAPI(tenantId: string, projectId: string, apiUrl: string, agentData: FullAgentDefinition): Promise<FullAgentDefinition>;
9
9
  /**
10
- * Update a full agent via HTTP API (upsert behavior)
11
- */
10
+ * Update a full agent via HTTP API (upsert behavior)
11
+ */
12
12
  declare function updateFullAgentViaAPI(tenantId: string, projectId: string, apiUrl: string, agentId: string, agentData: FullAgentDefinition): Promise<FullAgentDefinition>;
13
13
  /**
14
- * Get a full agent via HTTP API
15
- */
14
+ * Get a full agent via HTTP API
15
+ */
16
16
  declare function getFullAgentViaAPI(tenantId: string, projectId: string, apiUrl: string, agentId: string): Promise<FullAgentDefinition | null>;
17
17
  /**
18
- * Delete a full agent via HTTP API
19
- */
18
+ * Delete a full agent via HTTP API
19
+ */
20
20
  declare function deleteFullAgentViaAPI(tenantId: string, projectId: string, apiUrl: string, agentId: string): Promise<void>;
21
21
  //#endregion
22
22
  export { createFullAgentViaAPI, deleteFullAgentViaAPI, getFullAgentViaAPI, updateFullAgentViaAPI };
@@ -2,20 +2,20 @@ import { ArtifactComponentInsert } from "@inkeep/agents-core";
2
2
  import { z } from "zod";
3
3
 
4
4
  //#region src/artifact-component.d.ts
5
- type ArtifactComponentConfigWithZod = Omit<ArtifactComponentInsert, 'tenantId' | 'projectId' | 'props'> & {
5
+ type ArtifactComponentConfigWithZod = Omit<ArtifactComponentInsert, "tenantId" | "projectId" | "props"> & {
6
6
  props?: Record<string, unknown> | z.ZodObject<any> | null;
7
7
  };
8
8
  interface ArtifactComponentInterface {
9
- config: Omit<ArtifactComponentInsert, 'tenantId' | 'projectId'>;
9
+ config: Omit<ArtifactComponentInsert, "tenantId" | "projectId">;
10
10
  init(): Promise<void>;
11
- getId(): ArtifactComponentInsert['id'];
12
- getName(): ArtifactComponentInsert['name'];
13
- getDescription(): ArtifactComponentInsert['description'];
14
- getProps(): ArtifactComponentInsert['props'];
11
+ getId(): ArtifactComponentInsert["id"];
12
+ getName(): ArtifactComponentInsert["name"];
13
+ getDescription(): ArtifactComponentInsert["description"];
14
+ getProps(): ArtifactComponentInsert["props"];
15
15
  setContext(tenantId: string, projectId: string, baseURL?: string): void;
16
16
  }
17
17
  declare class ArtifactComponent implements ArtifactComponentInterface {
18
- config: Omit<ArtifactComponentInsert, 'tenantId' | 'projectId'>;
18
+ config: Omit<ArtifactComponentInsert, "tenantId" | "projectId">;
19
19
  private baseURL;
20
20
  private tenantId;
21
21
  private projectId;
@@ -26,7 +26,7 @@ declare class ArtifactComponent implements ArtifactComponentInterface {
26
26
  getId(): string;
27
27
  getName(): string;
28
28
  getDescription(): string;
29
- getProps(): ArtifactComponentInsert['props'];
29
+ getProps(): ArtifactComponentInsert["props"];
30
30
  init(): Promise<void>;
31
31
  private upsertArtifactComponent;
32
32
  }