@linkt/sdk 0.2.0 → 0.3.0
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/CHANGELOG.md +14 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/icp.d.mts +54 -1
- package/resources/icp.d.mts.map +1 -1
- package/resources/icp.d.ts +54 -1
- package/resources/icp.d.ts.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/run.d.mts +3 -3
- package/resources/run.d.ts +3 -3
- package/resources/task.d.mts +763 -222
- package/resources/task.d.mts.map +1 -1
- package/resources/task.d.ts +763 -222
- package/resources/task.d.ts.map +1 -1
- package/src/client.ts +10 -12
- package/src/resources/icp.ts +57 -1
- package/src/resources/index.ts +5 -6
- package/src/resources/run.ts +3 -3
- package/src/resources/task.ts +881 -241
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/task.d.ts
CHANGED
|
@@ -84,15 +84,18 @@ export declare class Task extends APIResource {
|
|
|
84
84
|
execute(taskID: string, body: TaskExecuteParams, options?: RequestOptions): APIPromise<TaskExecuteResponse>;
|
|
85
85
|
}
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* CSV enrichment task configuration.
|
|
88
88
|
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
* the ICP hierarchy (e.g., CSV has people, but ICP has company→person).
|
|
89
|
+
* Enriches entities from an uploaded CSV file with additional data discovered by
|
|
90
|
+
* AI agents.
|
|
92
91
|
*
|
|
93
|
-
* Attributes:
|
|
94
|
-
* primary_column: Column containing entity names
|
|
95
|
-
* Entity type
|
|
92
|
+
* Attributes: type: Config type discriminator (always "ingest"). file_id: ID of
|
|
93
|
+
* the uploaded CSV file to process. primary_column: Column containing entity names
|
|
94
|
+
* for matching. csv_entity_type: Entity type in the CSV (e.g., 'person',
|
|
95
|
+
* 'company'). webhook_url: Optional webhook URL for completion notification.
|
|
96
|
+
*
|
|
97
|
+
* Example: >>> config = IngestTaskConfigRequest( ... file_id="abc123", ...
|
|
98
|
+
* primary_column="company_name", ... csv_entity_type="company" ... )
|
|
96
99
|
*/
|
|
97
100
|
export interface IngestTaskConfig {
|
|
98
101
|
/**
|
|
@@ -100,139 +103,141 @@ export interface IngestTaskConfig {
|
|
|
100
103
|
*/
|
|
101
104
|
csv_entity_type: string;
|
|
102
105
|
/**
|
|
103
|
-
*
|
|
106
|
+
* ID of the uploaded CSV file to process
|
|
104
107
|
*/
|
|
105
108
|
file_id: string;
|
|
106
109
|
/**
|
|
107
|
-
* Column containing entity names
|
|
110
|
+
* Column containing entity names for matching
|
|
108
111
|
*/
|
|
109
112
|
primary_column: string;
|
|
110
113
|
/**
|
|
111
|
-
* Config type
|
|
114
|
+
* Config type discriminator
|
|
112
115
|
*/
|
|
113
|
-
|
|
114
|
-
version?: 'v1.0';
|
|
116
|
+
type?: 'ingest';
|
|
115
117
|
/**
|
|
116
|
-
* Optional webhook URL to notify when workflow
|
|
118
|
+
* Optional webhook URL to notify when workflow completes
|
|
117
119
|
*/
|
|
118
120
|
webhook_url?: string | null;
|
|
119
121
|
}
|
|
120
122
|
/**
|
|
121
|
-
*
|
|
123
|
+
* Profile prompt task configuration.
|
|
124
|
+
*
|
|
125
|
+
* Configures a profile workflow with a custom prompt template.
|
|
126
|
+
*
|
|
127
|
+
* Attributes: type: Config type discriminator (always "profile"). prompt: Jinja2
|
|
128
|
+
* template for task instructions. webhook_url: Optional webhook URL for completion
|
|
129
|
+
* notification.
|
|
130
|
+
*
|
|
131
|
+
* Example: >>> config = ProfilePromptConfigRequest( ... prompt="Analyze
|
|
132
|
+
* {{ company_name }} and extract key metrics." ... )
|
|
122
133
|
*/
|
|
123
|
-
export interface
|
|
134
|
+
export interface ProfilePromptConfig {
|
|
124
135
|
/**
|
|
125
|
-
* Jinja2
|
|
126
|
-
*/
|
|
127
|
-
analyst_prompt: string;
|
|
128
|
-
/**
|
|
129
|
-
* Jinja2 discovery agent instructions
|
|
136
|
+
* Jinja2 template for task instructions
|
|
130
137
|
*/
|
|
131
|
-
|
|
138
|
+
prompt: string;
|
|
132
139
|
/**
|
|
133
|
-
* Config type
|
|
140
|
+
* Config type discriminator
|
|
134
141
|
*/
|
|
135
|
-
|
|
136
|
-
version?: 'v2.0';
|
|
142
|
+
type?: 'profile';
|
|
137
143
|
/**
|
|
138
|
-
* Optional webhook URL to notify when workflow
|
|
144
|
+
* Optional webhook URL to notify when workflow completes
|
|
139
145
|
*/
|
|
140
146
|
webhook_url?: string | null;
|
|
141
147
|
}
|
|
142
148
|
/**
|
|
143
|
-
* Search
|
|
149
|
+
* Search task configuration for finding companies and contacts.
|
|
144
150
|
*
|
|
145
|
-
*
|
|
151
|
+
* Creates a v3.0 search workflow that uses AI agents to discover entities matching
|
|
152
|
+
* your ICP criteria.
|
|
146
153
|
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
154
|
+
* Attributes: type: Config type discriminator (always "search").
|
|
155
|
+
* desired_contact_count: Number of contacts to find per company (minimum: 1).
|
|
156
|
+
* user_feedback: Optional feedback to refine search behavior. webhook_url:
|
|
157
|
+
* Optional webhook URL for completion notification.
|
|
158
|
+
*
|
|
159
|
+
* Example: >>> config = SearchTaskConfigRequest(desired_contact_count=5) >>>
|
|
160
|
+
* mongo_config = config.to_mongo_config() >>> mongo_config.version 'v3.0'
|
|
150
161
|
*/
|
|
151
|
-
export interface
|
|
162
|
+
export interface SearchTaskConfig {
|
|
152
163
|
/**
|
|
153
|
-
*
|
|
164
|
+
* Number of contacts to find per company (minimum: 1)
|
|
154
165
|
*/
|
|
155
|
-
|
|
166
|
+
desired_contact_count?: number;
|
|
156
167
|
/**
|
|
157
|
-
*
|
|
168
|
+
* Config type discriminator
|
|
158
169
|
*/
|
|
159
|
-
|
|
170
|
+
type?: 'search';
|
|
160
171
|
/**
|
|
161
|
-
*
|
|
172
|
+
* Optional feedback to refine search behavior
|
|
162
173
|
*/
|
|
163
174
|
user_feedback?: string;
|
|
164
|
-
version?: 'v3.0';
|
|
165
175
|
/**
|
|
166
|
-
* Optional webhook URL to notify when workflow
|
|
176
|
+
* Optional webhook URL to notify when workflow completes
|
|
167
177
|
*/
|
|
168
178
|
webhook_url?: string | null;
|
|
169
179
|
}
|
|
170
180
|
/**
|
|
171
181
|
* CSV-based signal monitoring configuration.
|
|
172
182
|
*
|
|
173
|
-
* Monitors signals for
|
|
183
|
+
* Monitors signals for entities uploaded via CSV file.
|
|
184
|
+
*
|
|
185
|
+
* Attributes: type: Config type discriminator (always "signal-csv"). file_id: ID
|
|
186
|
+
* of the uploaded CSV file. signal_types: Types of signals to monitor.
|
|
187
|
+
* entity_type: Type of entity being monitored (default: company). primary_column:
|
|
188
|
+
* Column containing entity names (default: "name"). monitoring_frequency: How
|
|
189
|
+
* often to check (daily/weekly/monthly). webhook_url: Optional webhook URL for
|
|
190
|
+
* completion notification.
|
|
174
191
|
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* (company, person, etc.) file_id: ID of the uploaded CSV file primary_column:
|
|
178
|
-
* Column containing entity names (defaults to "name") signal_types: Types of
|
|
179
|
-
* signals to monitor for these entities monitoring_frequency: How often to check
|
|
180
|
-
* for signals (daily/weekly/monthly) webhook_url: Optional webhook URL to notify
|
|
181
|
-
* when signal run completes
|
|
192
|
+
* Example: >>> config = SignalCSVConfigRequest( ... file_id="abc123", ...
|
|
193
|
+
* signal_types=[SignalTypeConfig(type="hiring_surge", ...)] ... )
|
|
182
194
|
*/
|
|
183
|
-
export interface
|
|
195
|
+
export interface SignalCsvConfig {
|
|
184
196
|
/**
|
|
185
197
|
* ID of the uploaded CSV file
|
|
186
198
|
*/
|
|
187
199
|
file_id: string;
|
|
188
200
|
/**
|
|
189
|
-
* Types of signals to monitor
|
|
201
|
+
* Types of signals to monitor
|
|
190
202
|
*/
|
|
191
203
|
signal_types: Array<SignalTypeConfig>;
|
|
192
204
|
/**
|
|
193
|
-
*
|
|
194
|
-
*/
|
|
195
|
-
config_type?: 'signal-csv';
|
|
196
|
-
/**
|
|
197
|
-
* Type of entity being monitored (company, school district, person, etc.)
|
|
205
|
+
* Type of entity being monitored
|
|
198
206
|
*/
|
|
199
207
|
entity_type?: SheetAPI.EntityType;
|
|
200
208
|
/**
|
|
201
|
-
* How often to check for new signals
|
|
209
|
+
* How often to check for new signals
|
|
202
210
|
*/
|
|
203
211
|
monitoring_frequency?: 'daily' | 'weekly' | 'monthly';
|
|
204
212
|
/**
|
|
205
|
-
* Column containing entity names
|
|
206
|
-
* from CSV rows during signal workflow.
|
|
213
|
+
* Column containing entity names
|
|
207
214
|
*/
|
|
208
215
|
primary_column?: string;
|
|
209
216
|
/**
|
|
210
|
-
* Config
|
|
217
|
+
* Config type discriminator
|
|
211
218
|
*/
|
|
212
|
-
|
|
219
|
+
type?: 'signal-csv';
|
|
213
220
|
/**
|
|
214
|
-
* Optional webhook URL to notify when
|
|
221
|
+
* Optional webhook URL to notify when workflow completes
|
|
215
222
|
*/
|
|
216
223
|
webhook_url?: string | null;
|
|
217
224
|
}
|
|
218
225
|
/**
|
|
219
226
|
* Sheet-based signal monitoring configuration.
|
|
220
227
|
*
|
|
221
|
-
* Monitors signals for entities from an existing discovery ICP's sheet.
|
|
222
|
-
* mode, signals are deterministically linked to source entities without requiring
|
|
223
|
-
* analyst agent processing.
|
|
228
|
+
* Monitors signals for entities from an existing discovery ICP's sheet.
|
|
224
229
|
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
230
|
+
* Attributes: type: Config type discriminator (always "signal-sheet").
|
|
231
|
+
* source_icp_id: ID of the discovery ICP containing entities to monitor.
|
|
232
|
+
* signal_types: Types of signals to monitor. entity_type: Type of entity being
|
|
233
|
+
* monitored (default: company). entity_filters: Optional MongoDB query to filter
|
|
234
|
+
* entities. monitoring_frequency: How often to check (daily/weekly/monthly).
|
|
235
|
+
* webhook_url: Optional webhook URL for completion notification.
|
|
228
236
|
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
* entity_filters: Optional MongoDB query to filter entities signal_types: Types of
|
|
232
|
-
* signals to monitor monitoring_frequency: How often to check for signals
|
|
233
|
-
* webhook_url: Optional webhook URL to notify when signal run completes
|
|
237
|
+
* Example: >>> config = SignalSheetConfigRequest( ... source_icp_id="icp123", ...
|
|
238
|
+
* signal_types=[SignalTypeConfig(type="leadership_change", ...)] ... )
|
|
234
239
|
*/
|
|
235
|
-
export interface
|
|
240
|
+
export interface SignalSheetConfig {
|
|
236
241
|
/**
|
|
237
242
|
* Types of signals to monitor
|
|
238
243
|
*/
|
|
@@ -242,17 +247,13 @@ export interface SignalSheetConfigInput {
|
|
|
242
247
|
*/
|
|
243
248
|
source_icp_id: string;
|
|
244
249
|
/**
|
|
245
|
-
*
|
|
246
|
-
*/
|
|
247
|
-
config_type?: 'signal-sheet';
|
|
248
|
-
/**
|
|
249
|
-
* Optional MongoDB query to filter entities within the sheet
|
|
250
|
+
* Optional MongoDB query to filter entities
|
|
250
251
|
*/
|
|
251
252
|
entity_filters?: {
|
|
252
253
|
[key: string]: unknown;
|
|
253
254
|
} | null;
|
|
254
255
|
/**
|
|
255
|
-
* Type of entity being monitored
|
|
256
|
+
* Type of entity being monitored
|
|
256
257
|
*/
|
|
257
258
|
entity_type?: SheetAPI.EntityType;
|
|
258
259
|
/**
|
|
@@ -260,31 +261,36 @@ export interface SignalSheetConfigInput {
|
|
|
260
261
|
*/
|
|
261
262
|
monitoring_frequency?: 'daily' | 'weekly' | 'monthly';
|
|
262
263
|
/**
|
|
263
|
-
* Config
|
|
264
|
+
* Config type discriminator
|
|
264
265
|
*/
|
|
265
|
-
|
|
266
|
+
type?: 'signal-sheet';
|
|
266
267
|
/**
|
|
267
|
-
* Optional webhook URL to notify when
|
|
268
|
+
* Optional webhook URL to notify when workflow completes
|
|
268
269
|
*/
|
|
269
270
|
webhook_url?: string | null;
|
|
270
271
|
}
|
|
271
272
|
/**
|
|
272
273
|
* Topic-based signal monitoring configuration.
|
|
273
274
|
*
|
|
274
|
-
* Monitors signals based on criteria without requiring pre-existing
|
|
275
|
+
* Monitors for signals based on topic criteria without requiring pre-existing
|
|
276
|
+
* entities.
|
|
277
|
+
*
|
|
278
|
+
* Attributes: type: Config type discriminator (always "signal-topic").
|
|
279
|
+
* topic_criteria: Natural language description of what to monitor. signal_types:
|
|
280
|
+
* Types of signals to monitor. entity_type: Type of entity being monitored
|
|
281
|
+
* (default: company). monitoring_frequency: How often to check
|
|
282
|
+
* (daily/weekly/monthly). geographic_filters: Optional geographic regions to focus
|
|
283
|
+
* on. industry_filters: Optional industries to focus on. company_size_filters:
|
|
284
|
+
* Optional company size criteria. webhook_url: Optional webhook URL for completion
|
|
285
|
+
* notification.
|
|
275
286
|
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
* of what to monitor signal_types: Types of signals to monitor for this topic
|
|
280
|
-
* monitoring_frequency: How often to check for signals (daily/weekly/monthly)
|
|
281
|
-
* geographic_filters: Optional geographic regions to focus on industry_filters:
|
|
282
|
-
* Optional industries to focus on company_size_filters: Optional company size
|
|
283
|
-
* criteria webhook_url: Optional webhook URL to notify when signal run completes
|
|
287
|
+
* Example: >>> config = SignalTopicConfigRequest( ... topic_criteria="AI startups
|
|
288
|
+
* raising Series A", ... signal_types=[SignalTypeConfig(type="funding", ...)] ...
|
|
289
|
+
* )
|
|
284
290
|
*/
|
|
285
|
-
export interface
|
|
291
|
+
export interface SignalTopicConfig {
|
|
286
292
|
/**
|
|
287
|
-
* Types of signals to monitor
|
|
293
|
+
* Types of signals to monitor
|
|
288
294
|
*/
|
|
289
295
|
signal_types: Array<SignalTypeConfig>;
|
|
290
296
|
/**
|
|
@@ -292,15 +298,11 @@ export interface SignalTopicConfigInput {
|
|
|
292
298
|
*/
|
|
293
299
|
topic_criteria: string;
|
|
294
300
|
/**
|
|
295
|
-
* Company size criteria
|
|
301
|
+
* Company size criteria
|
|
296
302
|
*/
|
|
297
303
|
company_size_filters?: Array<string> | null;
|
|
298
304
|
/**
|
|
299
|
-
*
|
|
300
|
-
*/
|
|
301
|
-
config_type?: 'signal-topic';
|
|
302
|
-
/**
|
|
303
|
-
* Type of entity being monitored (company, school district, person, etc.)
|
|
305
|
+
* Type of entity being monitored
|
|
304
306
|
*/
|
|
305
307
|
entity_type?: SheetAPI.EntityType;
|
|
306
308
|
/**
|
|
@@ -312,15 +314,15 @@ export interface SignalTopicConfigInput {
|
|
|
312
314
|
*/
|
|
313
315
|
industry_filters?: Array<string> | null;
|
|
314
316
|
/**
|
|
315
|
-
* How often to check for new signals
|
|
317
|
+
* How often to check for new signals
|
|
316
318
|
*/
|
|
317
319
|
monitoring_frequency?: 'daily' | 'weekly' | 'monthly';
|
|
318
320
|
/**
|
|
319
|
-
* Config
|
|
321
|
+
* Config type discriminator
|
|
320
322
|
*/
|
|
321
|
-
|
|
323
|
+
type?: 'signal-topic';
|
|
322
324
|
/**
|
|
323
|
-
* Optional webhook URL to notify when
|
|
325
|
+
* Optional webhook URL to notify when workflow completes
|
|
324
326
|
*/
|
|
325
327
|
webhook_url?: string | null;
|
|
326
328
|
}
|
|
@@ -344,35 +346,524 @@ export interface SignalTypeConfig {
|
|
|
344
346
|
type: 'funding' | 'leadership_change' | 'layoff' | 'product_launch' | 'partnership' | 'acquisition' | 'expansion' | 'award' | 'pivot' | 'regulatory' | 'rfp' | 'contract_renewal' | 'hiring_surge' | 'infrastructure' | 'compliance' | 'job_posting' | 'other';
|
|
345
347
|
}
|
|
346
348
|
/**
|
|
347
|
-
*
|
|
348
|
-
* signal, and future single-prompt flows.
|
|
349
|
+
* Response model for task data.
|
|
349
350
|
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
351
|
+
* Uses TaskConfigResponse discriminated union for proper OpenAPI schema generation
|
|
352
|
+
* with type-based discrimination.
|
|
353
|
+
*
|
|
354
|
+
* Attributes: id: Task ID. name: Task name. description: Task description. icp_id:
|
|
355
|
+
* Task ICP ID. flow_name: Prefect flow name. deployment_name: Prefect deployment
|
|
356
|
+
* name. prompt: Template prompt for the task. task_config: Flow-specific task
|
|
357
|
+
* configuration. created_at: Creation timestamp. updated_at: Last update
|
|
358
|
+
* timestamp.
|
|
352
359
|
*/
|
|
353
|
-
export interface
|
|
360
|
+
export interface TaskCreateResponse {
|
|
354
361
|
/**
|
|
355
|
-
*
|
|
362
|
+
* Task ID
|
|
356
363
|
*/
|
|
357
|
-
|
|
364
|
+
id: string;
|
|
358
365
|
/**
|
|
359
|
-
*
|
|
366
|
+
* Creation timestamp
|
|
360
367
|
*/
|
|
361
|
-
|
|
362
|
-
version?: 'v1.0';
|
|
368
|
+
created_at: string;
|
|
363
369
|
/**
|
|
364
|
-
*
|
|
370
|
+
* Prefect deployment name
|
|
365
371
|
*/
|
|
366
|
-
|
|
372
|
+
deployment_name: string;
|
|
373
|
+
/**
|
|
374
|
+
* Task description
|
|
375
|
+
*/
|
|
376
|
+
description: string;
|
|
377
|
+
/**
|
|
378
|
+
* Prefect flow name
|
|
379
|
+
*/
|
|
380
|
+
flow_name: string;
|
|
381
|
+
/**
|
|
382
|
+
* Task name
|
|
383
|
+
*/
|
|
384
|
+
name: string;
|
|
385
|
+
/**
|
|
386
|
+
* Last update timestamp
|
|
387
|
+
*/
|
|
388
|
+
updated_at: string;
|
|
389
|
+
/**
|
|
390
|
+
* Task ICP ID
|
|
391
|
+
*/
|
|
392
|
+
icp_id?: string | null;
|
|
393
|
+
/**
|
|
394
|
+
* Template prompt for the task. Can include placeholders for runtime parameters.
|
|
395
|
+
*/
|
|
396
|
+
prompt?: string | null;
|
|
397
|
+
/**
|
|
398
|
+
* Flow-specific task configuration
|
|
399
|
+
*/
|
|
400
|
+
task_config?: TaskCreateResponse.SearchTaskConfigResponse | TaskCreateResponse.IngestTaskConfigResponse | TaskCreateResponse.ProfilePromptConfigResponse | TaskCreateResponse.SignalTopicConfigResponse | TaskCreateResponse.SignalCsvConfigResponse | TaskCreateResponse.SignalSheetConfigResponse | null;
|
|
401
|
+
}
|
|
402
|
+
export declare namespace TaskCreateResponse {
|
|
403
|
+
/**
|
|
404
|
+
* Search task configuration in API responses.
|
|
405
|
+
*
|
|
406
|
+
* Response model for search task configs that excludes backend-managed fields
|
|
407
|
+
* (version, config_type) from the API surface.
|
|
408
|
+
*
|
|
409
|
+
* Attributes: type: Config type discriminator (always "search").
|
|
410
|
+
* desired_contact_count: Number of contacts to find per company. user_feedback:
|
|
411
|
+
* Feedback to refine search behavior. webhook_url: Webhook URL for completion
|
|
412
|
+
* notification.
|
|
413
|
+
*/
|
|
414
|
+
interface SearchTaskConfigResponse {
|
|
415
|
+
/**
|
|
416
|
+
* Number of contacts to find per company
|
|
417
|
+
*/
|
|
418
|
+
desired_contact_count: number;
|
|
419
|
+
/**
|
|
420
|
+
* Feedback to refine search behavior
|
|
421
|
+
*/
|
|
422
|
+
user_feedback: string;
|
|
423
|
+
type?: 'search';
|
|
424
|
+
/**
|
|
425
|
+
* Webhook URL for completion notification
|
|
426
|
+
*/
|
|
427
|
+
webhook_url?: string | null;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* Ingest task configuration in API responses.
|
|
431
|
+
*
|
|
432
|
+
* Response model for CSV enrichment task configs that excludes backend-managed
|
|
433
|
+
* fields from the API surface.
|
|
434
|
+
*
|
|
435
|
+
* Attributes: type: Config type discriminator (always "ingest"). file_id: ID of
|
|
436
|
+
* the CSV file. primary_column: Column containing entity names. csv_entity_type:
|
|
437
|
+
* Entity type in CSV. webhook_url: Webhook URL for completion notification.
|
|
438
|
+
*/
|
|
439
|
+
interface IngestTaskConfigResponse {
|
|
440
|
+
/**
|
|
441
|
+
* Entity type in CSV
|
|
442
|
+
*/
|
|
443
|
+
csv_entity_type: string;
|
|
444
|
+
/**
|
|
445
|
+
* ID of the CSV file
|
|
446
|
+
*/
|
|
447
|
+
file_id: string;
|
|
448
|
+
/**
|
|
449
|
+
* Column containing entity names
|
|
450
|
+
*/
|
|
451
|
+
primary_column: string;
|
|
452
|
+
type?: 'ingest';
|
|
453
|
+
/**
|
|
454
|
+
* Webhook URL for completion notification
|
|
455
|
+
*/
|
|
456
|
+
webhook_url?: string | null;
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* Profile prompt configuration in API responses.
|
|
460
|
+
*
|
|
461
|
+
* Response model for profile prompt task configs that excludes backend-managed
|
|
462
|
+
* fields from the API surface.
|
|
463
|
+
*
|
|
464
|
+
* Attributes: type: Config type discriminator (always "profile"). prompt: Task
|
|
465
|
+
* prompt template. webhook_url: Webhook URL for completion notification.
|
|
466
|
+
*/
|
|
467
|
+
interface ProfilePromptConfigResponse {
|
|
468
|
+
/**
|
|
469
|
+
* Task prompt template
|
|
470
|
+
*/
|
|
471
|
+
prompt: string;
|
|
472
|
+
type?: 'profile';
|
|
473
|
+
/**
|
|
474
|
+
* Webhook URL for completion notification
|
|
475
|
+
*/
|
|
476
|
+
webhook_url?: string | null;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* Signal topic configuration in API responses.
|
|
480
|
+
*
|
|
481
|
+
* Response model for topic-based signal monitoring configs.
|
|
482
|
+
*
|
|
483
|
+
* Attributes: type: Config type discriminator (always "signal-topic").
|
|
484
|
+
* topic_criteria: Topic criteria for monitoring. signal_types: Types of signals to
|
|
485
|
+
* monitor. entity_type: Type of entity being monitored. monitoring_frequency: How
|
|
486
|
+
* often to check for signals. geographic_filters: Geographic regions to focus on.
|
|
487
|
+
* industry_filters: Industries to focus on. company_size_filters: Company size
|
|
488
|
+
* criteria. webhook_url: Webhook URL for completion notification.
|
|
489
|
+
*/
|
|
490
|
+
interface SignalTopicConfigResponse {
|
|
491
|
+
/**
|
|
492
|
+
* Entity type
|
|
493
|
+
*/
|
|
494
|
+
entity_type: SheetAPI.EntityType;
|
|
495
|
+
/**
|
|
496
|
+
* Monitoring frequency
|
|
497
|
+
*/
|
|
498
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
499
|
+
/**
|
|
500
|
+
* Signal types
|
|
501
|
+
*/
|
|
502
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
503
|
+
/**
|
|
504
|
+
* Topic criteria
|
|
505
|
+
*/
|
|
506
|
+
topic_criteria: string;
|
|
507
|
+
/**
|
|
508
|
+
* Size filters
|
|
509
|
+
*/
|
|
510
|
+
company_size_filters?: Array<string> | null;
|
|
511
|
+
/**
|
|
512
|
+
* Geographic filters
|
|
513
|
+
*/
|
|
514
|
+
geographic_filters?: Array<string> | null;
|
|
515
|
+
/**
|
|
516
|
+
* Industry filters
|
|
517
|
+
*/
|
|
518
|
+
industry_filters?: Array<string> | null;
|
|
519
|
+
type?: 'signal-topic';
|
|
520
|
+
/**
|
|
521
|
+
* Webhook URL for completion notification
|
|
522
|
+
*/
|
|
523
|
+
webhook_url?: string | null;
|
|
524
|
+
}
|
|
525
|
+
/**
|
|
526
|
+
* Signal CSV configuration in API responses.
|
|
527
|
+
*
|
|
528
|
+
* Response model for CSV-based signal monitoring configs.
|
|
529
|
+
*
|
|
530
|
+
* Attributes: type: Config type discriminator (always "signal-csv"). file_id: CSV
|
|
531
|
+
* file ID. signal_types: Types of signals to monitor. entity_type: Type of entity
|
|
532
|
+
* being monitored. primary_column: Primary column for entity names.
|
|
533
|
+
* monitoring_frequency: How often to check for signals. webhook_url: Webhook URL
|
|
534
|
+
* for completion notification.
|
|
535
|
+
*/
|
|
536
|
+
interface SignalCsvConfigResponse {
|
|
537
|
+
/**
|
|
538
|
+
* Entity type
|
|
539
|
+
*/
|
|
540
|
+
entity_type: SheetAPI.EntityType;
|
|
541
|
+
/**
|
|
542
|
+
* CSV file ID
|
|
543
|
+
*/
|
|
544
|
+
file_id: string;
|
|
545
|
+
/**
|
|
546
|
+
* Monitoring frequency
|
|
547
|
+
*/
|
|
548
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
549
|
+
/**
|
|
550
|
+
* Primary column
|
|
551
|
+
*/
|
|
552
|
+
primary_column: string;
|
|
553
|
+
/**
|
|
554
|
+
* Signal types
|
|
555
|
+
*/
|
|
556
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
557
|
+
type?: 'signal-csv';
|
|
558
|
+
/**
|
|
559
|
+
* Webhook URL for completion notification
|
|
560
|
+
*/
|
|
561
|
+
webhook_url?: string | null;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Signal sheet configuration in API responses.
|
|
565
|
+
*
|
|
566
|
+
* Response model for sheet-based signal monitoring configs.
|
|
567
|
+
*
|
|
568
|
+
* Attributes: type: Config type discriminator (always "signal-sheet").
|
|
569
|
+
* source_icp_id: Source ICP ID containing entities to monitor. signal_types: Types
|
|
570
|
+
* of signals to monitor. entity_type: Type of entity being monitored.
|
|
571
|
+
* entity_filters: Optional MongoDB query to filter entities. monitoring_frequency:
|
|
572
|
+
* How often to check for signals. webhook_url: Webhook URL for completion
|
|
573
|
+
* notification.
|
|
574
|
+
*/
|
|
575
|
+
interface SignalSheetConfigResponse {
|
|
576
|
+
/**
|
|
577
|
+
* Entity type
|
|
578
|
+
*/
|
|
579
|
+
entity_type: SheetAPI.EntityType;
|
|
580
|
+
/**
|
|
581
|
+
* Monitoring frequency
|
|
582
|
+
*/
|
|
583
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
584
|
+
/**
|
|
585
|
+
* Signal types
|
|
586
|
+
*/
|
|
587
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
588
|
+
/**
|
|
589
|
+
* Source ICP ID
|
|
590
|
+
*/
|
|
591
|
+
source_icp_id: string;
|
|
592
|
+
/**
|
|
593
|
+
* Entity filters
|
|
594
|
+
*/
|
|
595
|
+
entity_filters?: {
|
|
596
|
+
[key: string]: unknown;
|
|
597
|
+
} | null;
|
|
598
|
+
type?: 'signal-sheet';
|
|
599
|
+
/**
|
|
600
|
+
* Webhook URL for completion notification
|
|
601
|
+
*/
|
|
602
|
+
webhook_url?: string | null;
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
/**
|
|
606
|
+
* Response model for task data.
|
|
607
|
+
*
|
|
608
|
+
* Uses TaskConfigResponse discriminated union for proper OpenAPI schema generation
|
|
609
|
+
* with type-based discrimination.
|
|
610
|
+
*
|
|
611
|
+
* Attributes: id: Task ID. name: Task name. description: Task description. icp_id:
|
|
612
|
+
* Task ICP ID. flow_name: Prefect flow name. deployment_name: Prefect deployment
|
|
613
|
+
* name. prompt: Template prompt for the task. task_config: Flow-specific task
|
|
614
|
+
* configuration. created_at: Creation timestamp. updated_at: Last update
|
|
615
|
+
* timestamp.
|
|
616
|
+
*/
|
|
617
|
+
export interface TaskRetrieveResponse {
|
|
618
|
+
/**
|
|
619
|
+
* Task ID
|
|
620
|
+
*/
|
|
621
|
+
id: string;
|
|
622
|
+
/**
|
|
623
|
+
* Creation timestamp
|
|
624
|
+
*/
|
|
625
|
+
created_at: string;
|
|
626
|
+
/**
|
|
627
|
+
* Prefect deployment name
|
|
628
|
+
*/
|
|
629
|
+
deployment_name: string;
|
|
630
|
+
/**
|
|
631
|
+
* Task description
|
|
632
|
+
*/
|
|
633
|
+
description: string;
|
|
634
|
+
/**
|
|
635
|
+
* Prefect flow name
|
|
636
|
+
*/
|
|
637
|
+
flow_name: string;
|
|
638
|
+
/**
|
|
639
|
+
* Task name
|
|
640
|
+
*/
|
|
641
|
+
name: string;
|
|
642
|
+
/**
|
|
643
|
+
* Last update timestamp
|
|
644
|
+
*/
|
|
645
|
+
updated_at: string;
|
|
646
|
+
/**
|
|
647
|
+
* Task ICP ID
|
|
648
|
+
*/
|
|
649
|
+
icp_id?: string | null;
|
|
650
|
+
/**
|
|
651
|
+
* Template prompt for the task. Can include placeholders for runtime parameters.
|
|
652
|
+
*/
|
|
653
|
+
prompt?: string | null;
|
|
654
|
+
/**
|
|
655
|
+
* Flow-specific task configuration
|
|
656
|
+
*/
|
|
657
|
+
task_config?: TaskRetrieveResponse.SearchTaskConfigResponse | TaskRetrieveResponse.IngestTaskConfigResponse | TaskRetrieveResponse.ProfilePromptConfigResponse | TaskRetrieveResponse.SignalTopicConfigResponse | TaskRetrieveResponse.SignalCsvConfigResponse | TaskRetrieveResponse.SignalSheetConfigResponse | null;
|
|
658
|
+
}
|
|
659
|
+
export declare namespace TaskRetrieveResponse {
|
|
660
|
+
/**
|
|
661
|
+
* Search task configuration in API responses.
|
|
662
|
+
*
|
|
663
|
+
* Response model for search task configs that excludes backend-managed fields
|
|
664
|
+
* (version, config_type) from the API surface.
|
|
665
|
+
*
|
|
666
|
+
* Attributes: type: Config type discriminator (always "search").
|
|
667
|
+
* desired_contact_count: Number of contacts to find per company. user_feedback:
|
|
668
|
+
* Feedback to refine search behavior. webhook_url: Webhook URL for completion
|
|
669
|
+
* notification.
|
|
670
|
+
*/
|
|
671
|
+
interface SearchTaskConfigResponse {
|
|
672
|
+
/**
|
|
673
|
+
* Number of contacts to find per company
|
|
674
|
+
*/
|
|
675
|
+
desired_contact_count: number;
|
|
676
|
+
/**
|
|
677
|
+
* Feedback to refine search behavior
|
|
678
|
+
*/
|
|
679
|
+
user_feedback: string;
|
|
680
|
+
type?: 'search';
|
|
681
|
+
/**
|
|
682
|
+
* Webhook URL for completion notification
|
|
683
|
+
*/
|
|
684
|
+
webhook_url?: string | null;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* Ingest task configuration in API responses.
|
|
688
|
+
*
|
|
689
|
+
* Response model for CSV enrichment task configs that excludes backend-managed
|
|
690
|
+
* fields from the API surface.
|
|
691
|
+
*
|
|
692
|
+
* Attributes: type: Config type discriminator (always "ingest"). file_id: ID of
|
|
693
|
+
* the CSV file. primary_column: Column containing entity names. csv_entity_type:
|
|
694
|
+
* Entity type in CSV. webhook_url: Webhook URL for completion notification.
|
|
695
|
+
*/
|
|
696
|
+
interface IngestTaskConfigResponse {
|
|
697
|
+
/**
|
|
698
|
+
* Entity type in CSV
|
|
699
|
+
*/
|
|
700
|
+
csv_entity_type: string;
|
|
701
|
+
/**
|
|
702
|
+
* ID of the CSV file
|
|
703
|
+
*/
|
|
704
|
+
file_id: string;
|
|
705
|
+
/**
|
|
706
|
+
* Column containing entity names
|
|
707
|
+
*/
|
|
708
|
+
primary_column: string;
|
|
709
|
+
type?: 'ingest';
|
|
710
|
+
/**
|
|
711
|
+
* Webhook URL for completion notification
|
|
712
|
+
*/
|
|
713
|
+
webhook_url?: string | null;
|
|
714
|
+
}
|
|
715
|
+
/**
|
|
716
|
+
* Profile prompt configuration in API responses.
|
|
717
|
+
*
|
|
718
|
+
* Response model for profile prompt task configs that excludes backend-managed
|
|
719
|
+
* fields from the API surface.
|
|
720
|
+
*
|
|
721
|
+
* Attributes: type: Config type discriminator (always "profile"). prompt: Task
|
|
722
|
+
* prompt template. webhook_url: Webhook URL for completion notification.
|
|
723
|
+
*/
|
|
724
|
+
interface ProfilePromptConfigResponse {
|
|
725
|
+
/**
|
|
726
|
+
* Task prompt template
|
|
727
|
+
*/
|
|
728
|
+
prompt: string;
|
|
729
|
+
type?: 'profile';
|
|
730
|
+
/**
|
|
731
|
+
* Webhook URL for completion notification
|
|
732
|
+
*/
|
|
733
|
+
webhook_url?: string | null;
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* Signal topic configuration in API responses.
|
|
737
|
+
*
|
|
738
|
+
* Response model for topic-based signal monitoring configs.
|
|
739
|
+
*
|
|
740
|
+
* Attributes: type: Config type discriminator (always "signal-topic").
|
|
741
|
+
* topic_criteria: Topic criteria for monitoring. signal_types: Types of signals to
|
|
742
|
+
* monitor. entity_type: Type of entity being monitored. monitoring_frequency: How
|
|
743
|
+
* often to check for signals. geographic_filters: Geographic regions to focus on.
|
|
744
|
+
* industry_filters: Industries to focus on. company_size_filters: Company size
|
|
745
|
+
* criteria. webhook_url: Webhook URL for completion notification.
|
|
746
|
+
*/
|
|
747
|
+
interface SignalTopicConfigResponse {
|
|
748
|
+
/**
|
|
749
|
+
* Entity type
|
|
750
|
+
*/
|
|
751
|
+
entity_type: SheetAPI.EntityType;
|
|
752
|
+
/**
|
|
753
|
+
* Monitoring frequency
|
|
754
|
+
*/
|
|
755
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
756
|
+
/**
|
|
757
|
+
* Signal types
|
|
758
|
+
*/
|
|
759
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
760
|
+
/**
|
|
761
|
+
* Topic criteria
|
|
762
|
+
*/
|
|
763
|
+
topic_criteria: string;
|
|
764
|
+
/**
|
|
765
|
+
* Size filters
|
|
766
|
+
*/
|
|
767
|
+
company_size_filters?: Array<string> | null;
|
|
768
|
+
/**
|
|
769
|
+
* Geographic filters
|
|
770
|
+
*/
|
|
771
|
+
geographic_filters?: Array<string> | null;
|
|
772
|
+
/**
|
|
773
|
+
* Industry filters
|
|
774
|
+
*/
|
|
775
|
+
industry_filters?: Array<string> | null;
|
|
776
|
+
type?: 'signal-topic';
|
|
777
|
+
/**
|
|
778
|
+
* Webhook URL for completion notification
|
|
779
|
+
*/
|
|
780
|
+
webhook_url?: string | null;
|
|
781
|
+
}
|
|
782
|
+
/**
|
|
783
|
+
* Signal CSV configuration in API responses.
|
|
784
|
+
*
|
|
785
|
+
* Response model for CSV-based signal monitoring configs.
|
|
786
|
+
*
|
|
787
|
+
* Attributes: type: Config type discriminator (always "signal-csv"). file_id: CSV
|
|
788
|
+
* file ID. signal_types: Types of signals to monitor. entity_type: Type of entity
|
|
789
|
+
* being monitored. primary_column: Primary column for entity names.
|
|
790
|
+
* monitoring_frequency: How often to check for signals. webhook_url: Webhook URL
|
|
791
|
+
* for completion notification.
|
|
792
|
+
*/
|
|
793
|
+
interface SignalCsvConfigResponse {
|
|
794
|
+
/**
|
|
795
|
+
* Entity type
|
|
796
|
+
*/
|
|
797
|
+
entity_type: SheetAPI.EntityType;
|
|
798
|
+
/**
|
|
799
|
+
* CSV file ID
|
|
800
|
+
*/
|
|
801
|
+
file_id: string;
|
|
802
|
+
/**
|
|
803
|
+
* Monitoring frequency
|
|
804
|
+
*/
|
|
805
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
806
|
+
/**
|
|
807
|
+
* Primary column
|
|
808
|
+
*/
|
|
809
|
+
primary_column: string;
|
|
810
|
+
/**
|
|
811
|
+
* Signal types
|
|
812
|
+
*/
|
|
813
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
814
|
+
type?: 'signal-csv';
|
|
815
|
+
/**
|
|
816
|
+
* Webhook URL for completion notification
|
|
817
|
+
*/
|
|
818
|
+
webhook_url?: string | null;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* Signal sheet configuration in API responses.
|
|
822
|
+
*
|
|
823
|
+
* Response model for sheet-based signal monitoring configs.
|
|
824
|
+
*
|
|
825
|
+
* Attributes: type: Config type discriminator (always "signal-sheet").
|
|
826
|
+
* source_icp_id: Source ICP ID containing entities to monitor. signal_types: Types
|
|
827
|
+
* of signals to monitor. entity_type: Type of entity being monitored.
|
|
828
|
+
* entity_filters: Optional MongoDB query to filter entities. monitoring_frequency:
|
|
829
|
+
* How often to check for signals. webhook_url: Webhook URL for completion
|
|
830
|
+
* notification.
|
|
831
|
+
*/
|
|
832
|
+
interface SignalSheetConfigResponse {
|
|
833
|
+
/**
|
|
834
|
+
* Entity type
|
|
835
|
+
*/
|
|
836
|
+
entity_type: SheetAPI.EntityType;
|
|
837
|
+
/**
|
|
838
|
+
* Monitoring frequency
|
|
839
|
+
*/
|
|
840
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
841
|
+
/**
|
|
842
|
+
* Signal types
|
|
843
|
+
*/
|
|
844
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
845
|
+
/**
|
|
846
|
+
* Source ICP ID
|
|
847
|
+
*/
|
|
848
|
+
source_icp_id: string;
|
|
849
|
+
/**
|
|
850
|
+
* Entity filters
|
|
851
|
+
*/
|
|
852
|
+
entity_filters?: {
|
|
853
|
+
[key: string]: unknown;
|
|
854
|
+
} | null;
|
|
855
|
+
type?: 'signal-sheet';
|
|
856
|
+
/**
|
|
857
|
+
* Webhook URL for completion notification
|
|
858
|
+
*/
|
|
859
|
+
webhook_url?: string | null;
|
|
860
|
+
}
|
|
367
861
|
}
|
|
368
|
-
export type TaskCreateResponse = {
|
|
369
|
-
[key: string]: unknown;
|
|
370
|
-
};
|
|
371
|
-
export type TaskRetrieveResponse = {
|
|
372
|
-
[key: string]: unknown;
|
|
373
|
-
};
|
|
374
862
|
/**
|
|
375
863
|
* Response model for paginated task list.
|
|
864
|
+
*
|
|
865
|
+
* Attributes: tasks: List of tasks. total: Total number of tasks matching filters.
|
|
866
|
+
* page: Current page number (1-based). page_size: Number of items per page.
|
|
376
867
|
*/
|
|
377
868
|
export interface TaskListResponse {
|
|
378
869
|
/**
|
|
@@ -395,6 +886,15 @@ export interface TaskListResponse {
|
|
|
395
886
|
export declare namespace TaskListResponse {
|
|
396
887
|
/**
|
|
397
888
|
* Response model for task data.
|
|
889
|
+
*
|
|
890
|
+
* Uses TaskConfigResponse discriminated union for proper OpenAPI schema generation
|
|
891
|
+
* with type-based discrimination.
|
|
892
|
+
*
|
|
893
|
+
* Attributes: id: Task ID. name: Task name. description: Task description. icp_id:
|
|
894
|
+
* Task ICP ID. flow_name: Prefect flow name. deployment_name: Prefect deployment
|
|
895
|
+
* name. prompt: Template prompt for the task. task_config: Flow-specific task
|
|
896
|
+
* configuration. created_at: Creation timestamp. updated_at: Last update
|
|
897
|
+
* timestamp.
|
|
398
898
|
*/
|
|
399
899
|
interface Task {
|
|
400
900
|
/**
|
|
@@ -434,167 +934,209 @@ export declare namespace TaskListResponse {
|
|
|
434
934
|
*/
|
|
435
935
|
prompt?: string | null;
|
|
436
936
|
/**
|
|
437
|
-
* Flow-specific task configuration
|
|
937
|
+
* Flow-specific task configuration
|
|
438
938
|
*/
|
|
439
|
-
task_config?:
|
|
440
|
-
[key: string]: unknown;
|
|
441
|
-
} | TaskAPI.StandardPromptConfig | TaskAPI.SearchV2Config | TaskAPI.SearchV3Config | TaskAPI.IngestTaskConfig | Task.SignalTopicConfigOutput | Task.SignalCsvConfigOutput | Task.SignalSheetConfigOutput | null;
|
|
939
|
+
task_config?: Task.SearchTaskConfigResponse | Task.IngestTaskConfigResponse | Task.ProfilePromptConfigResponse | Task.SignalTopicConfigResponse | Task.SignalCsvConfigResponse | Task.SignalSheetConfigResponse | null;
|
|
442
940
|
}
|
|
443
941
|
namespace Task {
|
|
444
942
|
/**
|
|
445
|
-
*
|
|
943
|
+
* Search task configuration in API responses.
|
|
446
944
|
*
|
|
447
|
-
*
|
|
945
|
+
* Response model for search task configs that excludes backend-managed fields
|
|
946
|
+
* (version, config_type) from the API surface.
|
|
448
947
|
*
|
|
449
|
-
* Attributes:
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
* Optional industries to focus on company_size_filters: Optional company size
|
|
456
|
-
* criteria webhook_url: Optional webhook URL to notify when signal run completes
|
|
457
|
-
*/
|
|
458
|
-
interface SignalTopicConfigOutput {
|
|
459
|
-
/**
|
|
460
|
-
* Types of signals to monitor for this topic
|
|
461
|
-
*/
|
|
462
|
-
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
948
|
+
* Attributes: type: Config type discriminator (always "search").
|
|
949
|
+
* desired_contact_count: Number of contacts to find per company. user_feedback:
|
|
950
|
+
* Feedback to refine search behavior. webhook_url: Webhook URL for completion
|
|
951
|
+
* notification.
|
|
952
|
+
*/
|
|
953
|
+
interface SearchTaskConfigResponse {
|
|
463
954
|
/**
|
|
464
|
-
*
|
|
955
|
+
* Number of contacts to find per company
|
|
465
956
|
*/
|
|
466
|
-
|
|
957
|
+
desired_contact_count: number;
|
|
467
958
|
/**
|
|
468
|
-
*
|
|
959
|
+
* Feedback to refine search behavior
|
|
469
960
|
*/
|
|
470
|
-
|
|
961
|
+
user_feedback: string;
|
|
962
|
+
type?: 'search';
|
|
471
963
|
/**
|
|
472
|
-
*
|
|
964
|
+
* Webhook URL for completion notification
|
|
473
965
|
*/
|
|
474
|
-
|
|
966
|
+
webhook_url?: string | null;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Ingest task configuration in API responses.
|
|
970
|
+
*
|
|
971
|
+
* Response model for CSV enrichment task configs that excludes backend-managed
|
|
972
|
+
* fields from the API surface.
|
|
973
|
+
*
|
|
974
|
+
* Attributes: type: Config type discriminator (always "ingest"). file_id: ID of
|
|
975
|
+
* the CSV file. primary_column: Column containing entity names. csv_entity_type:
|
|
976
|
+
* Entity type in CSV. webhook_url: Webhook URL for completion notification.
|
|
977
|
+
*/
|
|
978
|
+
interface IngestTaskConfigResponse {
|
|
475
979
|
/**
|
|
476
|
-
*
|
|
980
|
+
* Entity type in CSV
|
|
477
981
|
*/
|
|
478
|
-
|
|
982
|
+
csv_entity_type: string;
|
|
479
983
|
/**
|
|
480
|
-
*
|
|
984
|
+
* ID of the CSV file
|
|
481
985
|
*/
|
|
482
|
-
|
|
986
|
+
file_id: string;
|
|
483
987
|
/**
|
|
484
|
-
*
|
|
988
|
+
* Column containing entity names
|
|
485
989
|
*/
|
|
486
|
-
|
|
990
|
+
primary_column: string;
|
|
991
|
+
type?: 'ingest';
|
|
487
992
|
/**
|
|
488
|
-
*
|
|
993
|
+
* Webhook URL for completion notification
|
|
489
994
|
*/
|
|
490
|
-
|
|
995
|
+
webhook_url?: string | null;
|
|
996
|
+
}
|
|
997
|
+
/**
|
|
998
|
+
* Profile prompt configuration in API responses.
|
|
999
|
+
*
|
|
1000
|
+
* Response model for profile prompt task configs that excludes backend-managed
|
|
1001
|
+
* fields from the API surface.
|
|
1002
|
+
*
|
|
1003
|
+
* Attributes: type: Config type discriminator (always "profile"). prompt: Task
|
|
1004
|
+
* prompt template. webhook_url: Webhook URL for completion notification.
|
|
1005
|
+
*/
|
|
1006
|
+
interface ProfilePromptConfigResponse {
|
|
491
1007
|
/**
|
|
492
|
-
*
|
|
1008
|
+
* Task prompt template
|
|
493
1009
|
*/
|
|
494
|
-
|
|
1010
|
+
prompt: string;
|
|
1011
|
+
type?: 'profile';
|
|
495
1012
|
/**
|
|
496
|
-
*
|
|
1013
|
+
* Webhook URL for completion notification
|
|
497
1014
|
*/
|
|
498
1015
|
webhook_url?: string | null;
|
|
499
1016
|
}
|
|
500
1017
|
/**
|
|
501
|
-
*
|
|
1018
|
+
* Signal topic configuration in API responses.
|
|
502
1019
|
*
|
|
503
|
-
*
|
|
1020
|
+
* Response model for topic-based signal monitoring configs.
|
|
504
1021
|
*
|
|
505
|
-
* Attributes:
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
interface SignalCsvConfigOutput {
|
|
1022
|
+
* Attributes: type: Config type discriminator (always "signal-topic").
|
|
1023
|
+
* topic_criteria: Topic criteria for monitoring. signal_types: Types of signals to
|
|
1024
|
+
* monitor. entity_type: Type of entity being monitored. monitoring_frequency: How
|
|
1025
|
+
* often to check for signals. geographic_filters: Geographic regions to focus on.
|
|
1026
|
+
* industry_filters: Industries to focus on. company_size_filters: Company size
|
|
1027
|
+
* criteria. webhook_url: Webhook URL for completion notification.
|
|
1028
|
+
*/
|
|
1029
|
+
interface SignalTopicConfigResponse {
|
|
514
1030
|
/**
|
|
515
|
-
*
|
|
1031
|
+
* Entity type
|
|
516
1032
|
*/
|
|
517
|
-
|
|
1033
|
+
entity_type: SheetAPI.EntityType;
|
|
518
1034
|
/**
|
|
519
|
-
*
|
|
1035
|
+
* Monitoring frequency
|
|
520
1036
|
*/
|
|
521
|
-
|
|
1037
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
522
1038
|
/**
|
|
523
|
-
*
|
|
1039
|
+
* Signal types
|
|
524
1040
|
*/
|
|
525
|
-
|
|
1041
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
526
1042
|
/**
|
|
527
|
-
*
|
|
1043
|
+
* Topic criteria
|
|
528
1044
|
*/
|
|
529
|
-
|
|
1045
|
+
topic_criteria: string;
|
|
530
1046
|
/**
|
|
531
|
-
*
|
|
1047
|
+
* Size filters
|
|
532
1048
|
*/
|
|
533
|
-
|
|
1049
|
+
company_size_filters?: Array<string> | null;
|
|
534
1050
|
/**
|
|
535
|
-
*
|
|
536
|
-
* from CSV rows during signal workflow.
|
|
1051
|
+
* Geographic filters
|
|
537
1052
|
*/
|
|
538
|
-
|
|
1053
|
+
geographic_filters?: Array<string> | null;
|
|
539
1054
|
/**
|
|
540
|
-
*
|
|
1055
|
+
* Industry filters
|
|
541
1056
|
*/
|
|
542
|
-
|
|
1057
|
+
industry_filters?: Array<string> | null;
|
|
1058
|
+
type?: 'signal-topic';
|
|
543
1059
|
/**
|
|
544
|
-
*
|
|
1060
|
+
* Webhook URL for completion notification
|
|
545
1061
|
*/
|
|
546
1062
|
webhook_url?: string | null;
|
|
547
1063
|
}
|
|
548
1064
|
/**
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
* Monitors signals for entities from an existing discovery ICP's sheet. Unlike CSV
|
|
552
|
-
* mode, signals are deterministically linked to source entities without requiring
|
|
553
|
-
* analyst agent processing.
|
|
1065
|
+
* Signal CSV configuration in API responses.
|
|
554
1066
|
*
|
|
555
|
-
*
|
|
556
|
-
* identified by (source_icp_id, entity_type), so source_sheet_id was redundant and
|
|
557
|
-
* never used at runtime.
|
|
1067
|
+
* Response model for CSV-based signal monitoring configs.
|
|
558
1068
|
*
|
|
559
|
-
* Attributes:
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
*
|
|
563
|
-
*
|
|
1069
|
+
* Attributes: type: Config type discriminator (always "signal-csv"). file_id: CSV
|
|
1070
|
+
* file ID. signal_types: Types of signals to monitor. entity_type: Type of entity
|
|
1071
|
+
* being monitored. primary_column: Primary column for entity names.
|
|
1072
|
+
* monitoring_frequency: How often to check for signals. webhook_url: Webhook URL
|
|
1073
|
+
* for completion notification.
|
|
564
1074
|
*/
|
|
565
|
-
interface
|
|
1075
|
+
interface SignalCsvConfigResponse {
|
|
1076
|
+
/**
|
|
1077
|
+
* Entity type
|
|
1078
|
+
*/
|
|
1079
|
+
entity_type: SheetAPI.EntityType;
|
|
1080
|
+
/**
|
|
1081
|
+
* CSV file ID
|
|
1082
|
+
*/
|
|
1083
|
+
file_id: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* Monitoring frequency
|
|
1086
|
+
*/
|
|
1087
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
566
1088
|
/**
|
|
567
|
-
*
|
|
1089
|
+
* Primary column
|
|
1090
|
+
*/
|
|
1091
|
+
primary_column: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* Signal types
|
|
568
1094
|
*/
|
|
569
1095
|
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
1096
|
+
type?: 'signal-csv';
|
|
570
1097
|
/**
|
|
571
|
-
*
|
|
1098
|
+
* Webhook URL for completion notification
|
|
572
1099
|
*/
|
|
573
|
-
|
|
1100
|
+
webhook_url?: string | null;
|
|
1101
|
+
}
|
|
1102
|
+
/**
|
|
1103
|
+
* Signal sheet configuration in API responses.
|
|
1104
|
+
*
|
|
1105
|
+
* Response model for sheet-based signal monitoring configs.
|
|
1106
|
+
*
|
|
1107
|
+
* Attributes: type: Config type discriminator (always "signal-sheet").
|
|
1108
|
+
* source_icp_id: Source ICP ID containing entities to monitor. signal_types: Types
|
|
1109
|
+
* of signals to monitor. entity_type: Type of entity being monitored.
|
|
1110
|
+
* entity_filters: Optional MongoDB query to filter entities. monitoring_frequency:
|
|
1111
|
+
* How often to check for signals. webhook_url: Webhook URL for completion
|
|
1112
|
+
* notification.
|
|
1113
|
+
*/
|
|
1114
|
+
interface SignalSheetConfigResponse {
|
|
574
1115
|
/**
|
|
575
|
-
*
|
|
1116
|
+
* Entity type
|
|
576
1117
|
*/
|
|
577
|
-
|
|
1118
|
+
entity_type: SheetAPI.EntityType;
|
|
578
1119
|
/**
|
|
579
|
-
*
|
|
1120
|
+
* Monitoring frequency
|
|
580
1121
|
*/
|
|
581
|
-
|
|
582
|
-
[key: string]: unknown;
|
|
583
|
-
} | null;
|
|
1122
|
+
monitoring_frequency: 'daily' | 'weekly' | 'monthly';
|
|
584
1123
|
/**
|
|
585
|
-
*
|
|
1124
|
+
* Signal types
|
|
586
1125
|
*/
|
|
587
|
-
|
|
1126
|
+
signal_types: Array<TaskAPI.SignalTypeConfig>;
|
|
588
1127
|
/**
|
|
589
|
-
*
|
|
1128
|
+
* Source ICP ID
|
|
590
1129
|
*/
|
|
591
|
-
|
|
1130
|
+
source_icp_id: string;
|
|
592
1131
|
/**
|
|
593
|
-
*
|
|
1132
|
+
* Entity filters
|
|
594
1133
|
*/
|
|
595
|
-
|
|
1134
|
+
entity_filters?: {
|
|
1135
|
+
[key: string]: unknown;
|
|
1136
|
+
} | null;
|
|
1137
|
+
type?: 'signal-sheet';
|
|
596
1138
|
/**
|
|
597
|
-
*
|
|
1139
|
+
* Webhook URL for completion notification
|
|
598
1140
|
*/
|
|
599
1141
|
webhook_url?: string | null;
|
|
600
1142
|
}
|
|
@@ -602,6 +1144,9 @@ export declare namespace TaskListResponse {
|
|
|
602
1144
|
}
|
|
603
1145
|
/**
|
|
604
1146
|
* Response model for task execution.
|
|
1147
|
+
*
|
|
1148
|
+
* Attributes: run_id: The ID of the created run. flow_run_id: The Prefect flow run
|
|
1149
|
+
* ID. status: Initial status of the run.
|
|
605
1150
|
*/
|
|
606
1151
|
export interface TaskExecuteResponse {
|
|
607
1152
|
/**
|
|
@@ -643,11 +1188,9 @@ export interface TaskCreateParams {
|
|
|
643
1188
|
*/
|
|
644
1189
|
prompt?: string | null;
|
|
645
1190
|
/**
|
|
646
|
-
* Flow-specific task configuration with
|
|
1191
|
+
* Flow-specific task configuration with type discriminator
|
|
647
1192
|
*/
|
|
648
|
-
task_config?:
|
|
649
|
-
[key: string]: unknown;
|
|
650
|
-
} | StandardPromptConfig | SearchV2Config | SearchV3Config | IngestTaskConfig | SignalTopicConfigInput | SignalCsvConfigInput | SignalSheetConfigInput | null;
|
|
1193
|
+
task_config?: SearchTaskConfig | IngestTaskConfig | ProfilePromptConfig | SignalTopicConfig | SignalCsvConfig | SignalSheetConfig | null;
|
|
651
1194
|
}
|
|
652
1195
|
export interface TaskUpdateParams {
|
|
653
1196
|
/**
|
|
@@ -671,11 +1214,9 @@ export interface TaskUpdateParams {
|
|
|
671
1214
|
*/
|
|
672
1215
|
prompt?: string | null;
|
|
673
1216
|
/**
|
|
674
|
-
* Updated flow-specific task configuration with
|
|
1217
|
+
* Updated flow-specific task configuration with type discriminator
|
|
675
1218
|
*/
|
|
676
|
-
task_config?:
|
|
677
|
-
[key: string]: unknown;
|
|
678
|
-
} | StandardPromptConfig | SearchV2Config | SearchV3Config | IngestTaskConfig | SignalTopicConfigInput | SignalCsvConfigInput | SignalSheetConfigInput | null;
|
|
1219
|
+
task_config?: SearchTaskConfig | IngestTaskConfig | ProfilePromptConfig | SignalTopicConfig | SignalCsvConfig | SignalSheetConfig | null;
|
|
679
1220
|
}
|
|
680
1221
|
export interface TaskListParams {
|
|
681
1222
|
/**
|
|
@@ -712,6 +1253,6 @@ export interface TaskExecuteParams {
|
|
|
712
1253
|
};
|
|
713
1254
|
}
|
|
714
1255
|
export declare namespace Task {
|
|
715
|
-
export { type IngestTaskConfig as IngestTaskConfig, type
|
|
1256
|
+
export { type IngestTaskConfig as IngestTaskConfig, type ProfilePromptConfig as ProfilePromptConfig, type SearchTaskConfig as SearchTaskConfig, type SignalCsvConfig as SignalCsvConfig, type SignalSheetConfig as SignalSheetConfig, type SignalTopicConfig as SignalTopicConfig, type SignalTypeConfig as SignalTypeConfig, type TaskCreateResponse as TaskCreateResponse, type TaskRetrieveResponse as TaskRetrieveResponse, type TaskListResponse as TaskListResponse, type TaskExecuteResponse as TaskExecuteResponse, type TaskCreateParams as TaskCreateParams, type TaskUpdateParams as TaskUpdateParams, type TaskListParams as TaskListParams, type TaskExecuteParams as TaskExecuteParams, };
|
|
716
1257
|
}
|
|
717
1258
|
//# sourceMappingURL=task.d.ts.map
|