graphlit-client 1.0.20251217001 → 1.0.20251220001
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/client.d.ts +1681 -0
- package/dist/client.js +1681 -0
- package/dist/generated/graphql-types.d.ts +6 -0
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -107,383 +107,2064 @@ declare class Graphlit {
|
|
|
107
107
|
*/
|
|
108
108
|
setRetryConfig(retryConfig: RetryConfig): void;
|
|
109
109
|
private generateToken;
|
|
110
|
+
/**
|
|
111
|
+
* Fetch current project.
|
|
112
|
+
* @returns The project.
|
|
113
|
+
*/
|
|
110
114
|
getProject(): Promise<Types.GetProjectQuery>;
|
|
115
|
+
/**
|
|
116
|
+
* Updates a project.
|
|
117
|
+
* @param project - The project to update.
|
|
118
|
+
* @returns The updated project.
|
|
119
|
+
*/
|
|
111
120
|
updateProject(project: Types.ProjectUpdateInput): Promise<Types.UpdateProjectMutation>;
|
|
121
|
+
/**
|
|
122
|
+
* Lookup usage records given tenant correlation identifier.
|
|
123
|
+
* @param correlationId - The tenant correlation identifier.
|
|
124
|
+
* @param startDate - The start date of records to be returned, optional. Defaults to last 30 days.
|
|
125
|
+
* @param duration - The duration of records to be returned, optional. Defaults to last 30 days.
|
|
126
|
+
* @returns The project usage records.
|
|
127
|
+
*/
|
|
112
128
|
lookupProjectUsage(correlationId: string, startDate?: Types.Scalars["DateTime"]["input"], duration?: Types.Scalars["TimeSpan"]["input"]): Promise<Types.LookupUsageQuery>;
|
|
129
|
+
/**
|
|
130
|
+
* Lookup credit usage given tenant correlation identifier.
|
|
131
|
+
* @param correlationId - The tenant correlation identifier.
|
|
132
|
+
* @param startDate - The start date of records to be returned, optional. Defaults to last 30 days.
|
|
133
|
+
* @param duration - The duration of records to be returned, optional. Defaults to last 30 days.
|
|
134
|
+
* @returns The project credits.
|
|
135
|
+
*/
|
|
113
136
|
lookupProjectCredits(correlationId: string, startDate?: Types.Scalars["DateTime"]["input"], duration?: Types.Scalars["TimeSpan"]["input"]): Promise<Types.LookupCreditsQuery>;
|
|
137
|
+
/**
|
|
138
|
+
* Retrieves project tokens.
|
|
139
|
+
* @param startDate - The start date of tokens to be returned.
|
|
140
|
+
* @param duration - The duration of tokens to be returned.
|
|
141
|
+
* @returns The project tokens.
|
|
142
|
+
*/
|
|
114
143
|
queryProjectTokens(startDate: Types.Scalars["DateTime"]["input"], duration: Types.Scalars["TimeSpan"]["input"]): Promise<Types.QueryTokensQuery>;
|
|
144
|
+
/**
|
|
145
|
+
* Retrieves project usage.
|
|
146
|
+
* @param startDate - The start date of records to be returned.
|
|
147
|
+
* @param duration - The duration of records to be returned.
|
|
148
|
+
* @param names - Filter by allowed usage record names, defaults to 'GraphQL'.
|
|
149
|
+
* @param excludedNames - Filter by excluded usage record names.
|
|
150
|
+
* @param offset - The offset to the records to be returned, defaults to 0.
|
|
151
|
+
* @param limit - The number of records to be returned, defaults to 1000.
|
|
152
|
+
* @returns The project usage records.
|
|
153
|
+
*/
|
|
115
154
|
queryProjectUsage(startDate: Types.Scalars["DateTime"]["input"], duration: Types.Scalars["TimeSpan"]["input"], names?: string[], excludedNames?: string[], offset?: Types.Scalars["Int"]["input"], limit?: Types.Scalars["Int"]["input"]): Promise<Types.QueryUsageQuery>;
|
|
155
|
+
/**
|
|
156
|
+
* Retrieves project credits.
|
|
157
|
+
* @param startDate - The start date of credits to be returned.
|
|
158
|
+
* @param duration - The duration of credits to be returned.
|
|
159
|
+
* @returns The project credits.
|
|
160
|
+
*/
|
|
116
161
|
queryProjectCredits(startDate: Types.Scalars["DateTime"]["input"], duration: Types.Scalars["TimeSpan"]["input"]): Promise<Types.QueryCreditsQuery>;
|
|
162
|
+
/**
|
|
163
|
+
* Sends a notification.
|
|
164
|
+
* @param connector - The integration connector used to send the notification.
|
|
165
|
+
* @param text - The notification text.
|
|
166
|
+
* @param textType - The text type, optional.
|
|
167
|
+
* @returns The result of the notification.
|
|
168
|
+
*/
|
|
117
169
|
sendNotification(connector: Types.IntegrationConnectorInput, text: string, textType?: Types.TextTypes): Promise<Types.SendNotificationMutation>;
|
|
170
|
+
/**
|
|
171
|
+
* Enumerates the web pages at or beneath the provided URL using web sitemap.
|
|
172
|
+
* @param uri - The URI of the web page to be mapped.
|
|
173
|
+
* @param allowedPaths - The list of regular expressions for URL paths to be crawled, i.e. "^\/public\/blogs\/.*".
|
|
174
|
+
* @param excludedPaths - The list of regular expressions for URL paths to not be crawled, i.e. "^\/internal\/private\/.*".
|
|
175
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
176
|
+
* @returns The mapped URIs.
|
|
177
|
+
*/
|
|
118
178
|
mapWeb(uri: string, allowedPaths?: string[], excludedPaths?: string[], correlationId?: string): Promise<Types.MapWebQuery>;
|
|
179
|
+
/**
|
|
180
|
+
* Searches the web based on the provided properties.
|
|
181
|
+
* @param text - The web search text.
|
|
182
|
+
* @param service - The web search service type, defaults to Tavily.
|
|
183
|
+
* @param limit - The number of web search results to be returned, defaults to 10.
|
|
184
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
185
|
+
* @returns The web search results.
|
|
186
|
+
*/
|
|
119
187
|
searchWeb(text: string, service?: Types.SearchServiceTypes, limit?: number, correlationId?: string): Promise<Types.SearchWebQuery>;
|
|
188
|
+
/**
|
|
189
|
+
* Creates an alert.
|
|
190
|
+
* @param alert - The alert to create.
|
|
191
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
192
|
+
* @returns The created alert.
|
|
193
|
+
*/
|
|
120
194
|
createAlert(alert: Types.AlertInput, correlationId?: string): Promise<Types.CreateAlertMutation>;
|
|
195
|
+
/**
|
|
196
|
+
* Updates an alert.
|
|
197
|
+
* @param alert - The alert to update.
|
|
198
|
+
* @returns The updated alert.
|
|
199
|
+
*/
|
|
121
200
|
updateAlert(alert: Types.AlertUpdateInput): Promise<Types.UpdateAlertMutation>;
|
|
201
|
+
/**
|
|
202
|
+
* Creates or updates an alert.
|
|
203
|
+
* @param alert - The alert to create or update.
|
|
204
|
+
* @returns The created or updated alert.
|
|
205
|
+
*/
|
|
122
206
|
upsertAlert(alert: Types.AlertInput): Promise<Types.UpsertAlertMutation>;
|
|
207
|
+
/**
|
|
208
|
+
* Deletes an alert.
|
|
209
|
+
* @param id - The ID of the alert to delete.
|
|
210
|
+
* @returns The deleted alert.
|
|
211
|
+
*/
|
|
123
212
|
deleteAlert(id: string): Promise<Types.DeleteAlertMutation>;
|
|
213
|
+
/**
|
|
214
|
+
* Deletes multiple alerts.
|
|
215
|
+
* @param ids - The IDs of the alerts to delete.
|
|
216
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
217
|
+
* @returns The deleted alerts.
|
|
218
|
+
*/
|
|
124
219
|
deleteAlerts(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteAlertsMutation>;
|
|
220
|
+
/**
|
|
221
|
+
* Deletes all alerts based on the provided filter criteria.
|
|
222
|
+
* @param filter - The filter criteria to apply when deleting alerts.
|
|
223
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
224
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
225
|
+
* @returns The result of the deletion.
|
|
226
|
+
*/
|
|
125
227
|
deleteAllAlerts(filter?: Types.AlertFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllAlertsMutation>;
|
|
228
|
+
/**
|
|
229
|
+
* Enables an alert.
|
|
230
|
+
* @param id - The ID of the alert to enable.
|
|
231
|
+
* @returns The enabled alert.
|
|
232
|
+
*/
|
|
126
233
|
enableAlert(id: string): Promise<Types.EnableAlertMutation>;
|
|
234
|
+
/**
|
|
235
|
+
* Disables an alert.
|
|
236
|
+
* @param id - The ID of the alert to disable.
|
|
237
|
+
* @returns The disabled alert.
|
|
238
|
+
*/
|
|
127
239
|
disableAlert(id: string): Promise<Types.DisableAlertMutation>;
|
|
240
|
+
/**
|
|
241
|
+
* Lookup an alert given its ID.
|
|
242
|
+
* @param id - ID of the alert.
|
|
243
|
+
* @returns The alert.
|
|
244
|
+
*/
|
|
128
245
|
getAlert(id: string): Promise<Types.GetAlertQuery>;
|
|
246
|
+
/**
|
|
247
|
+
* Retrieves alerts based on the provided filter criteria.
|
|
248
|
+
* @param filter - The filter criteria to apply when retrieving alerts.
|
|
249
|
+
* @returns The alerts.
|
|
250
|
+
*/
|
|
129
251
|
queryAlerts(filter?: Types.AlertFilter): Promise<Types.QueryAlertsQuery>;
|
|
252
|
+
/**
|
|
253
|
+
* Counts alerts based on the provided filter criteria.
|
|
254
|
+
* @param filter - The filter criteria to apply when counting alerts.
|
|
255
|
+
* @returns The count of alerts.
|
|
256
|
+
*/
|
|
130
257
|
countAlerts(filter?: Types.AlertFilter): Promise<Types.CountAlertsQuery>;
|
|
258
|
+
/**
|
|
259
|
+
* Creates a collection.
|
|
260
|
+
* @param collection - The collection to create.
|
|
261
|
+
* @returns The created collection.
|
|
262
|
+
*/
|
|
131
263
|
createCollection(collection: Types.CollectionInput): Promise<Types.CreateCollectionMutation>;
|
|
264
|
+
/**
|
|
265
|
+
* Updates a collection.
|
|
266
|
+
* @param collection - The collection to update.
|
|
267
|
+
* @returns The updated collection.
|
|
268
|
+
*/
|
|
132
269
|
updateCollection(collection: Types.CollectionUpdateInput): Promise<Types.UpdateCollectionMutation>;
|
|
270
|
+
/**
|
|
271
|
+
* Deletes a collection.
|
|
272
|
+
* @param id - The ID of the collection to delete.
|
|
273
|
+
* @returns The deleted collection.
|
|
274
|
+
*/
|
|
133
275
|
deleteCollection(id: string): Promise<Types.DeleteCollectionMutation>;
|
|
276
|
+
/**
|
|
277
|
+
* Deletes multiple collections.
|
|
278
|
+
* @param ids - The IDs of the collections to delete.
|
|
279
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
280
|
+
* @returns The deleted collections.
|
|
281
|
+
*/
|
|
134
282
|
deleteCollections(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteCollectionsMutation>;
|
|
283
|
+
/**
|
|
284
|
+
* Deletes all collections based on the provided filter criteria.
|
|
285
|
+
* @param filter - The filter criteria to apply when deleting collections.
|
|
286
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
287
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
288
|
+
* @returns The result of the deletion.
|
|
289
|
+
*/
|
|
135
290
|
deleteAllCollections(filter?: Types.CollectionFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllCollectionsMutation>;
|
|
291
|
+
/**
|
|
292
|
+
* Adds contents to collections.
|
|
293
|
+
* @param contents - The contents to add.
|
|
294
|
+
* @param collections - The collections to add the contents to.
|
|
295
|
+
* @returns The result of the operation.
|
|
296
|
+
*/
|
|
136
297
|
addContentsToCollections(contents: Types.EntityReferenceInput[], collections: Types.EntityReferenceInput[]): Promise<Types.AddContentsToCollectionsMutation>;
|
|
298
|
+
/**
|
|
299
|
+
* Removes contents from a collection.
|
|
300
|
+
* @param contents - The contents to remove.
|
|
301
|
+
* @param collection - The collection to remove the contents from.
|
|
302
|
+
* @returns The result of the operation.
|
|
303
|
+
*/
|
|
137
304
|
removeContentsFromCollection(contents: Types.EntityReferenceInput[], collection: Types.EntityReferenceInput): Promise<Types.RemoveContentsFromCollectionMutation>;
|
|
305
|
+
/**
|
|
306
|
+
* Lookup a collection given its ID.
|
|
307
|
+
* @param id - ID of the collection.
|
|
308
|
+
* @returns The collection.
|
|
309
|
+
*/
|
|
138
310
|
getCollection(id: string): Promise<Types.GetCollectionQuery>;
|
|
311
|
+
/**
|
|
312
|
+
* Retrieves collections based on the provided filter criteria.
|
|
313
|
+
* @param filter - The filter criteria to apply when retrieving collections.
|
|
314
|
+
* @returns The collections.
|
|
315
|
+
*/
|
|
139
316
|
queryCollections(filter?: Types.CollectionFilter): Promise<Types.QueryCollectionsQuery>;
|
|
317
|
+
/**
|
|
318
|
+
* Counts collections based on the provided filter criteria.
|
|
319
|
+
* @param filter - The filter criteria to apply when counting collections.
|
|
320
|
+
* @returns The count of collections.
|
|
321
|
+
*/
|
|
140
322
|
countCollections(filter?: Types.CollectionFilter): Promise<Types.CountCollectionsQuery>;
|
|
323
|
+
/**
|
|
324
|
+
* Describes an image using a multimodal LLM.
|
|
325
|
+
* @param prompt - The prompt to use for describing the image.
|
|
326
|
+
* @param uri - The URI of the image to describe.
|
|
327
|
+
* @param specification - The LLM specification to use, optional.
|
|
328
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
329
|
+
* @returns The image description.
|
|
330
|
+
*/
|
|
141
331
|
describeImage(prompt: string, uri: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.DescribeImageMutation>;
|
|
332
|
+
/**
|
|
333
|
+
* Describes a base64-encoded image using a multimodal LLM.
|
|
334
|
+
* @param prompt - The prompt to use for describing the image.
|
|
335
|
+
* @param mimeType - The MIME type of the image.
|
|
336
|
+
* @param data - The base64-encoded image data.
|
|
337
|
+
* @param specification - The LLM specification to use, optional.
|
|
338
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
339
|
+
* @returns The image description.
|
|
340
|
+
*/
|
|
142
341
|
describeEncodedImage(prompt: string, mimeType: string, data: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.DescribeEncodedImageMutation>;
|
|
342
|
+
/**
|
|
343
|
+
* Takes a screenshot of a web page.
|
|
344
|
+
* @param uri - The URI of the web page to screenshot.
|
|
345
|
+
* @param maximumHeight - The maximum height of the screenshot, optional.
|
|
346
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
347
|
+
* @param workflow - The workflow to use for processing, optional.
|
|
348
|
+
* @param collections - The collections to add the content to, optional.
|
|
349
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
350
|
+
* @returns The screenshot content.
|
|
351
|
+
*/
|
|
143
352
|
screenshotPage(uri: string, maximumHeight?: number, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.ScreenshotPageMutation>;
|
|
353
|
+
/**
|
|
354
|
+
* Ingests a batch of text contents.
|
|
355
|
+
* @param batch - The batch of text contents to ingest.
|
|
356
|
+
* @param textType - The type of text (plain, markdown, HTML).
|
|
357
|
+
* @param collections - The collections to add the contents to, optional.
|
|
358
|
+
* @param observations - The observations to assign to the contents, optional.
|
|
359
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
360
|
+
* @returns The ingested contents.
|
|
361
|
+
*/
|
|
144
362
|
ingestTextBatch(batch: Types.TextContentInput[], textType: Types.TextTypes, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestTextBatchMutation>;
|
|
363
|
+
/**
|
|
364
|
+
* Ingests a batch of URIs.
|
|
365
|
+
* @param uris - The URIs to ingest.
|
|
366
|
+
* @param workflow - The workflow to use for processing, optional.
|
|
367
|
+
* @param collections - The collections to add the contents to, optional.
|
|
368
|
+
* @param observations - The observations to assign to the contents, optional.
|
|
369
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
370
|
+
* @returns The ingested contents.
|
|
371
|
+
*/
|
|
145
372
|
ingestBatch(uris: string[], workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestBatchMutation>;
|
|
373
|
+
/**
|
|
374
|
+
* Ingests content from a URI.
|
|
375
|
+
* @param uri - The URI of the content to ingest.
|
|
376
|
+
* @param name - The name of the content, optional.
|
|
377
|
+
* @param id - The ID to assign to the content, optional.
|
|
378
|
+
* @param identifier - The external identifier for the content, optional.
|
|
379
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
380
|
+
* @param workflow - The workflow to use for processing, optional.
|
|
381
|
+
* @param collections - The collections to add the content to, optional.
|
|
382
|
+
* @param observations - The observations to assign to the content, optional.
|
|
383
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
384
|
+
* @returns The ingested content.
|
|
385
|
+
*/
|
|
146
386
|
ingestUri(uri: string, name?: string, id?: string, identifier?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestUriMutation>;
|
|
387
|
+
/**
|
|
388
|
+
* Ingests text content.
|
|
389
|
+
* @param text - The text to ingest.
|
|
390
|
+
* @param name - The name of the content, optional.
|
|
391
|
+
* @param textType - The type of text (plain, markdown, HTML), optional.
|
|
392
|
+
* @param uri - The URI associated with the content, optional.
|
|
393
|
+
* @param id - The ID to assign to the content, optional.
|
|
394
|
+
* @param identifier - The external identifier for the content, optional.
|
|
395
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
396
|
+
* @param workflow - The workflow to use for processing, optional.
|
|
397
|
+
* @param collections - The collections to add the content to, optional.
|
|
398
|
+
* @param observations - The observations to assign to the content, optional.
|
|
399
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
400
|
+
* @returns The ingested content.
|
|
401
|
+
*/
|
|
147
402
|
ingestText(text: string, name?: string, textType?: Types.TextTypes, uri?: string, id?: string, identifier?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestTextMutation>;
|
|
403
|
+
/**
|
|
404
|
+
* Ingests a memory (ephemeral text content).
|
|
405
|
+
* @param text - The text to ingest as memory.
|
|
406
|
+
* @param name - The name of the memory, optional.
|
|
407
|
+
* @param textType - The type of text (plain, markdown, HTML), optional.
|
|
408
|
+
* @param id - The ID to assign to the memory, optional.
|
|
409
|
+
* @param identifier - The external identifier for the memory, optional.
|
|
410
|
+
* @param collections - The collections to add the memory to, optional.
|
|
411
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
412
|
+
* @returns The ingested memory.
|
|
413
|
+
*/
|
|
148
414
|
ingestMemory(text: string, name?: string, textType?: Types.TextTypes, id?: string, identifier?: string, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestMemoryMutation>;
|
|
415
|
+
/**
|
|
416
|
+
* Ingests an event.
|
|
417
|
+
* @param markdown - The markdown content of the event.
|
|
418
|
+
* @param name - The name of the event, optional.
|
|
419
|
+
* @param description - The description of the event, optional.
|
|
420
|
+
* @param eventDate - The date of the event, optional.
|
|
421
|
+
* @param id - The ID to assign to the event, optional.
|
|
422
|
+
* @param identifier - The external identifier for the event, optional.
|
|
423
|
+
* @param collections - The collections to add the event to, optional.
|
|
424
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
425
|
+
* @returns The ingested event.
|
|
426
|
+
*/
|
|
149
427
|
ingestEvent(markdown: string, name?: string, description?: string, eventDate?: Types.Scalars["DateTime"]["input"], id?: string, identifier?: string, collections?: Types.EntityReferenceInput[], correlationId?: string): Promise<Types.IngestEventMutation>;
|
|
428
|
+
/**
|
|
429
|
+
* Ingests a base64-encoded file.
|
|
430
|
+
* @param name - The name of the file.
|
|
431
|
+
* @param data - The base64-encoded file data.
|
|
432
|
+
* @param mimeType - The MIME type of the file.
|
|
433
|
+
* @param fileCreationDate - The file creation date, optional.
|
|
434
|
+
* @param fileModifiedDate - The file modified date, optional.
|
|
435
|
+
* @param id - The ID to assign to the content, optional.
|
|
436
|
+
* @param identifier - The external identifier for the content, optional.
|
|
437
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
438
|
+
* @param workflow - The workflow to use for processing, optional.
|
|
439
|
+
* @param collections - The collections to add the content to, optional.
|
|
440
|
+
* @param observations - The observations to assign to the content, optional.
|
|
441
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
442
|
+
* @returns The ingested content.
|
|
443
|
+
*/
|
|
150
444
|
ingestEncodedFile(name: string, data: string, mimeType: string, fileCreationDate?: Types.Scalars["DateTime"]["input"], fileModifiedDate?: Types.Scalars["DateTime"]["input"], id?: string, identifier?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput, collections?: Types.EntityReferenceInput[], observations?: Types.ObservationReferenceInput[], correlationId?: string): Promise<Types.IngestEncodedFileMutation>;
|
|
445
|
+
/**
|
|
446
|
+
* Updates content.
|
|
447
|
+
* @param content - The content to update.
|
|
448
|
+
* @returns The updated content.
|
|
449
|
+
*/
|
|
151
450
|
updateContent(content: Types.ContentUpdateInput): Promise<Types.UpdateContentMutation>;
|
|
451
|
+
/**
|
|
452
|
+
* Deletes content.
|
|
453
|
+
* @param id - The ID of the content to delete.
|
|
454
|
+
* @returns The deleted content.
|
|
455
|
+
*/
|
|
152
456
|
deleteContent(id: string): Promise<Types.DeleteContentMutation>;
|
|
457
|
+
/**
|
|
458
|
+
* Deletes multiple contents.
|
|
459
|
+
* @param ids - The IDs of the contents to delete.
|
|
460
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
461
|
+
* @returns The deleted contents.
|
|
462
|
+
*/
|
|
153
463
|
deleteContents(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteContentsMutation>;
|
|
464
|
+
/**
|
|
465
|
+
* Deletes all contents based on the provided filter criteria.
|
|
466
|
+
* @param filter - The filter criteria to apply when deleting contents.
|
|
467
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
468
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
469
|
+
* @returns The result of the deletion.
|
|
470
|
+
*/
|
|
154
471
|
deleteAllContents(filter?: Types.ContentFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllContentsMutation>;
|
|
472
|
+
/**
|
|
473
|
+
* Summarizes text using the specified summarization strategy.
|
|
474
|
+
* @param summarization - The summarization strategy to use.
|
|
475
|
+
* @param text - The text to summarize.
|
|
476
|
+
* @param textType - The type of text (plain, markdown, HTML), optional.
|
|
477
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
478
|
+
* @returns The summarized text.
|
|
479
|
+
*/
|
|
155
480
|
summarizeText(summarization: Types.SummarizationStrategyInput, text: string, textType?: Types.TextTypes, correlationId?: string): Promise<Types.SummarizeTextMutation>;
|
|
481
|
+
/**
|
|
482
|
+
* Summarizes contents using the specified summarization strategies.
|
|
483
|
+
* @param summarizations - The summarization strategies to use.
|
|
484
|
+
* @param filter - The filter criteria to apply when retrieving contents to summarize.
|
|
485
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
486
|
+
* @returns The summarized contents.
|
|
487
|
+
*/
|
|
156
488
|
summarizeContents(summarizations: Types.SummarizationStrategyInput[], filter?: Types.ContentFilter, correlationId?: string): Promise<Types.SummarizeContentsMutation>;
|
|
489
|
+
/**
|
|
490
|
+
* Extracts structured data from text using tool definitions.
|
|
491
|
+
* @param prompt - The prompt to guide extraction.
|
|
492
|
+
* @param text - The text to extract from.
|
|
493
|
+
* @param tools - The tool definitions for extraction.
|
|
494
|
+
* @param specification - The LLM specification to use, optional.
|
|
495
|
+
* @param textType - The type of text (plain, markdown, HTML), optional.
|
|
496
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
497
|
+
* @returns The extracted data.
|
|
498
|
+
*/
|
|
157
499
|
extractText(prompt: string, text: string, tools: Types.ToolDefinitionInput[], specification?: Types.EntityReferenceInput, textType?: Types.TextTypes, correlationId?: string): Promise<Types.ExtractTextMutation>;
|
|
500
|
+
/**
|
|
501
|
+
* Extracts structured data from contents using tool definitions.
|
|
502
|
+
* @param prompt - The prompt to guide extraction.
|
|
503
|
+
* @param tools - The tool definitions for extraction.
|
|
504
|
+
* @param specification - The LLM specification to use, optional.
|
|
505
|
+
* @param filter - The filter criteria to apply when retrieving contents.
|
|
506
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
507
|
+
* @returns The extracted data.
|
|
508
|
+
*/
|
|
158
509
|
extractContents(prompt: string, tools: Types.ToolDefinitionInput[], specification?: Types.EntityReferenceInput, filter?: Types.ContentFilter, correlationId?: string): Promise<Types.ExtractContentsMutation>;
|
|
510
|
+
/**
|
|
511
|
+
* Extracts observables (entities) from text.
|
|
512
|
+
* @param text - The text to extract observables from.
|
|
513
|
+
* @param textType - The type of text (plain, markdown, HTML), optional.
|
|
514
|
+
* @param specification - The LLM specification to use, optional.
|
|
515
|
+
* @param observableTypes - The types of observables to extract, optional.
|
|
516
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
517
|
+
* @returns The extracted observables.
|
|
518
|
+
*/
|
|
159
519
|
extractObservables(text: string, textType?: Types.TextTypes, specification?: Types.EntityReferenceInput, observableTypes?: Types.ObservableTypes[], correlationId?: string): Promise<Types.ExtractObservablesMutation>;
|
|
520
|
+
/**
|
|
521
|
+
* Publishes contents to an external connector.
|
|
522
|
+
* @param publishPrompt - The prompt for publishing.
|
|
523
|
+
* @param connector - The publishing connector to use.
|
|
524
|
+
* @param summaryPrompt - The prompt for summarizing each content, optional.
|
|
525
|
+
* @param summarySpecification - The LLM specification for summarization, optional.
|
|
526
|
+
* @param publishSpecification - The LLM specification for publishing, optional.
|
|
527
|
+
* @param name - The name of the published content, optional.
|
|
528
|
+
* @param filter - The filter criteria for selecting contents, optional.
|
|
529
|
+
* @param workflow - The workflow to use, optional.
|
|
530
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
531
|
+
* @param includeDetails - Whether to include details in publishing, optional.
|
|
532
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
533
|
+
* @returns The published content.
|
|
534
|
+
*/
|
|
160
535
|
publishContents(publishPrompt: string, connector: Types.ContentPublishingConnectorInput, summaryPrompt?: string, summarySpecification?: Types.EntityReferenceInput, publishSpecification?: Types.EntityReferenceInput, name?: string, filter?: Types.ContentFilter, workflow?: Types.EntityReferenceInput, isSynchronous?: boolean, includeDetails?: boolean, correlationId?: string): Promise<Types.PublishContentsMutation>;
|
|
536
|
+
/**
|
|
537
|
+
* Publishes text to an external connector.
|
|
538
|
+
* @param text - The text to publish.
|
|
539
|
+
* @param textType - The type of text (plain, markdown, HTML).
|
|
540
|
+
* @param connector - The publishing connector to use.
|
|
541
|
+
* @param name - The name of the published content, optional.
|
|
542
|
+
* @param workflow - The workflow to use, optional.
|
|
543
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
544
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
545
|
+
* @returns The published content.
|
|
546
|
+
*/
|
|
161
547
|
publishText(text: string, textType: Types.TextTypes, connector: Types.ContentPublishingConnectorInput, name?: string, workflow?: Types.EntityReferenceInput, isSynchronous?: boolean, correlationId?: string): Promise<Types.PublishTextMutation>;
|
|
548
|
+
/**
|
|
549
|
+
* Researches contents and publishes the results.
|
|
550
|
+
* @param connector - The publishing connector to use.
|
|
551
|
+
* @param filter - The filter criteria for selecting contents, optional.
|
|
552
|
+
* @param name - The name of the research output, optional.
|
|
553
|
+
* @param summarySpecification - The LLM specification for summarization, optional.
|
|
554
|
+
* @param publishSpecification - The LLM specification for publishing, optional.
|
|
555
|
+
* @param workflow - The workflow to use, optional.
|
|
556
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
557
|
+
* @returns The research results.
|
|
558
|
+
*/
|
|
162
559
|
researchContents(connector: Types.ContentPublishingConnectorInput, filter?: Types.ContentFilter, name?: string, summarySpecification?: Types.EntityReferenceInput, publishSpecification?: Types.EntityReferenceInput, workflow?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ResearchContentsMutation>;
|
|
560
|
+
/**
|
|
561
|
+
* Lookup content given its ID.
|
|
562
|
+
* @param id - ID of the content.
|
|
563
|
+
* @returns The content.
|
|
564
|
+
*/
|
|
163
565
|
getContent(id: string): Promise<Types.GetContentQuery>;
|
|
566
|
+
/**
|
|
567
|
+
* Lookup multiple contents given their IDs.
|
|
568
|
+
* @param ids - IDs of the contents.
|
|
569
|
+
* @returns The contents.
|
|
570
|
+
*/
|
|
164
571
|
lookupContents(ids: string[]): Promise<Types.LookupContentsQuery>;
|
|
572
|
+
/**
|
|
573
|
+
* Retrieves observables based on the provided filter criteria.
|
|
574
|
+
* @param filter - The filter criteria to apply when retrieving observables.
|
|
575
|
+
* @returns The observables.
|
|
576
|
+
*/
|
|
165
577
|
queryObservables(filter?: Types.ContentFilter): Promise<Types.QueryObservablesQuery>;
|
|
578
|
+
/**
|
|
579
|
+
* Retrieves contents based on the provided filter criteria.
|
|
580
|
+
* @param filter - The filter criteria to apply when retrieving contents.
|
|
581
|
+
* @returns The contents.
|
|
582
|
+
*/
|
|
166
583
|
queryContents(filter?: Types.ContentFilter): Promise<Types.QueryContentsQuery>;
|
|
584
|
+
/**
|
|
585
|
+
* Retrieves contents with their observations based on the provided filter criteria.
|
|
586
|
+
* @param filter - The filter criteria to apply when retrieving contents.
|
|
587
|
+
* @returns The contents with observations.
|
|
588
|
+
*/
|
|
167
589
|
queryContentsObservations(filter?: Types.ContentFilter): Promise<Types.QueryContentsObservationsQuery>;
|
|
590
|
+
/**
|
|
591
|
+
* Retrieves content facets based on the provided filter criteria.
|
|
592
|
+
* @param filter - The filter criteria to apply when retrieving facets.
|
|
593
|
+
* @returns The content facets.
|
|
594
|
+
*/
|
|
168
595
|
queryContentsFacets(filter?: Types.ContentFilter): Promise<Types.QueryContentsFacetsQuery>;
|
|
596
|
+
/**
|
|
597
|
+
* Retrieves the content knowledge graph based on the provided filter criteria.
|
|
598
|
+
* @param filter - The filter criteria to apply when retrieving the graph.
|
|
599
|
+
* @returns The content knowledge graph.
|
|
600
|
+
*/
|
|
169
601
|
queryContentsGraph(filter?: Types.ContentFilter): Promise<Types.QueryContentsGraphQuery>;
|
|
602
|
+
/**
|
|
603
|
+
* Retrieves the knowledge graph based on the provided filter criteria.
|
|
604
|
+
* @param filter - The filter criteria to apply when retrieving the graph.
|
|
605
|
+
* @param graph - The graph configuration, optional.
|
|
606
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
607
|
+
* @returns The knowledge graph.
|
|
608
|
+
*/
|
|
170
609
|
queryGraph(filter?: Types.GraphFilter, graph?: Types.GraphInput, correlationId?: string): Promise<Types.QueryGraphQuery>;
|
|
610
|
+
/**
|
|
611
|
+
* Lookup an entity and its relationships.
|
|
612
|
+
* @param filter - The filter criteria for entity relationships.
|
|
613
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
614
|
+
* @returns The entity with relationships.
|
|
615
|
+
*/
|
|
171
616
|
lookupEntity(filter: Types.EntityRelationshipsFilter, correlationId?: string): Promise<Types.LookupEntityQuery>;
|
|
617
|
+
/**
|
|
618
|
+
* Counts contents based on the provided filter criteria.
|
|
619
|
+
* @param filter - The filter criteria to apply when counting contents.
|
|
620
|
+
* @returns The count of contents.
|
|
621
|
+
*/
|
|
172
622
|
countContents(filter?: Types.ContentFilter): Promise<Types.CountContentsQuery>;
|
|
623
|
+
/**
|
|
624
|
+
* Checks if content processing is complete.
|
|
625
|
+
* @param id - ID of the content.
|
|
626
|
+
* @returns Whether the content is done processing.
|
|
627
|
+
*/
|
|
173
628
|
isContentDone(id: string): Promise<Types.IsContentDoneQuery>;
|
|
629
|
+
/**
|
|
630
|
+
* Creates a conversation.
|
|
631
|
+
* @param conversation - The conversation to create.
|
|
632
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
633
|
+
* @returns The created conversation.
|
|
634
|
+
*/
|
|
174
635
|
createConversation(conversation: Types.ConversationInput, correlationId?: string): Promise<Types.CreateConversationMutation>;
|
|
636
|
+
/**
|
|
637
|
+
* Updates a conversation.
|
|
638
|
+
* @param conversation - The conversation to update.
|
|
639
|
+
* @returns The updated conversation.
|
|
640
|
+
*/
|
|
175
641
|
updateConversation(conversation: Types.ConversationUpdateInput): Promise<Types.UpdateConversationMutation>;
|
|
642
|
+
/**
|
|
643
|
+
* Deletes a conversation.
|
|
644
|
+
* @param id - The ID of the conversation to delete.
|
|
645
|
+
* @returns The deleted conversation.
|
|
646
|
+
*/
|
|
176
647
|
deleteConversation(id: string): Promise<Types.DeleteConversationMutation>;
|
|
648
|
+
/**
|
|
649
|
+
* Deletes multiple conversations.
|
|
650
|
+
* @param ids - The IDs of the conversations to delete.
|
|
651
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
652
|
+
* @returns The deleted conversations.
|
|
653
|
+
*/
|
|
177
654
|
deleteConversations(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteConversationsMutation>;
|
|
655
|
+
/**
|
|
656
|
+
* Deletes all conversations based on the provided filter criteria.
|
|
657
|
+
* @param filter - The filter criteria to apply when deleting conversations.
|
|
658
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
659
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
660
|
+
* @returns The result of the deletion.
|
|
661
|
+
*/
|
|
178
662
|
deleteAllConversations(filter?: Types.ConversationFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllConversationsMutation>;
|
|
663
|
+
/**
|
|
664
|
+
* Clears all messages from a conversation.
|
|
665
|
+
* @param id - The ID of the conversation to clear.
|
|
666
|
+
* @returns The cleared conversation.
|
|
667
|
+
*/
|
|
179
668
|
clearConversation(id: string): Promise<Types.ClearConversationMutation>;
|
|
669
|
+
/**
|
|
670
|
+
* Closes a conversation.
|
|
671
|
+
* @param id - The ID of the conversation to close.
|
|
672
|
+
* @returns The closed conversation.
|
|
673
|
+
*/
|
|
180
674
|
closeConversation(id: string): Promise<Types.CloseConversationMutation>;
|
|
675
|
+
/**
|
|
676
|
+
* Lookup a conversation given its ID.
|
|
677
|
+
* @param id - ID of the conversation.
|
|
678
|
+
* @returns The conversation.
|
|
679
|
+
*/
|
|
181
680
|
getConversation(id: string): Promise<Types.GetConversationQuery>;
|
|
681
|
+
/**
|
|
682
|
+
* Retrieves conversations based on the provided filter criteria.
|
|
683
|
+
* @param filter - The filter criteria to apply when retrieving conversations.
|
|
684
|
+
* @returns The conversations.
|
|
685
|
+
*/
|
|
182
686
|
queryConversations(filter?: Types.ConversationFilter): Promise<Types.QueryConversationsQuery>;
|
|
687
|
+
/**
|
|
688
|
+
* Counts conversations based on the provided filter criteria.
|
|
689
|
+
* @param filter - The filter criteria to apply when counting conversations.
|
|
690
|
+
* @returns The count of conversations.
|
|
691
|
+
*/
|
|
183
692
|
countConversations(filter?: Types.ConversationFilter): Promise<Types.CountConversationsQuery>;
|
|
693
|
+
/**
|
|
694
|
+
* Revises an image in an existing conversation using a multimodal LLM.
|
|
695
|
+
* @param prompt - The prompt to use for revision.
|
|
696
|
+
* @param uri - The URI of the image to revise.
|
|
697
|
+
* @param id - The conversation ID, optional.
|
|
698
|
+
* @param specification - The LLM specification to use, optional.
|
|
699
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
700
|
+
* @returns The revised conversation message.
|
|
701
|
+
*/
|
|
184
702
|
reviseImage(prompt: string, uri: string, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseImageMutation>;
|
|
703
|
+
/**
|
|
704
|
+
* Revises a base64-encoded image in an existing conversation using a multimodal LLM.
|
|
705
|
+
* @param prompt - The prompt to use for revision.
|
|
706
|
+
* @param mimeType - The MIME type of the image.
|
|
707
|
+
* @param data - The base64-encoded image data.
|
|
708
|
+
* @param id - The conversation ID, optional.
|
|
709
|
+
* @param specification - The LLM specification to use, optional.
|
|
710
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
711
|
+
* @returns The revised conversation message.
|
|
712
|
+
*/
|
|
185
713
|
reviseEncodedImage(prompt: string, mimeType: string, data: string, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseEncodedImageMutation>;
|
|
714
|
+
/**
|
|
715
|
+
* Revises text in an existing conversation.
|
|
716
|
+
* @param prompt - The prompt to use for revision.
|
|
717
|
+
* @param text - The text to revise.
|
|
718
|
+
* @param id - The conversation ID, optional.
|
|
719
|
+
* @param specification - The LLM specification to use, optional.
|
|
720
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
721
|
+
* @returns The revised conversation message.
|
|
722
|
+
*/
|
|
186
723
|
reviseText(prompt: string, text: string, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseTextMutation>;
|
|
724
|
+
/**
|
|
725
|
+
* Revises content in an existing conversation.
|
|
726
|
+
* @param prompt - The prompt to use for revision.
|
|
727
|
+
* @param content - The content to revise.
|
|
728
|
+
* @param id - The conversation ID, optional.
|
|
729
|
+
* @param specification - The LLM specification to use, optional.
|
|
730
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
731
|
+
* @returns The revised conversation message.
|
|
732
|
+
*/
|
|
187
733
|
reviseContent(prompt: string, content: Types.EntityReferenceInput, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseContentMutation>;
|
|
734
|
+
/**
|
|
735
|
+
* Prompts an LLM without a conversation context.
|
|
736
|
+
* @param prompt - The prompt text, optional.
|
|
737
|
+
* @param mimeType - The MIME type for multimodal input, optional.
|
|
738
|
+
* @param data - The base64-encoded data for multimodal input, optional.
|
|
739
|
+
* @param specification - The LLM specification to use, optional.
|
|
740
|
+
* @param messages - Previous messages for context, optional.
|
|
741
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
742
|
+
* @returns The LLM response.
|
|
743
|
+
*/
|
|
188
744
|
prompt(prompt?: string, mimeType?: string, data?: string, specification?: Types.EntityReferenceInput, messages?: Types.ConversationMessageInput[], correlationId?: string): Promise<Types.PromptMutation>;
|
|
745
|
+
/**
|
|
746
|
+
* Retrieves relevant sources from a view for RAG.
|
|
747
|
+
* @param prompt - The prompt to use for retrieval.
|
|
748
|
+
* @param id - The view ID.
|
|
749
|
+
* @param retrievalStrategy - The retrieval strategy, optional.
|
|
750
|
+
* @param rerankingStrategy - The reranking strategy, optional.
|
|
751
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
752
|
+
* @returns The retrieved sources.
|
|
753
|
+
*/
|
|
189
754
|
retrieveView(prompt: string, id: string, retrievalStrategy?: Types.RetrievalStrategyInput, rerankingStrategy?: Types.RerankingStrategyInput, correlationId?: string): Promise<Types.RetrieveViewMutation>;
|
|
755
|
+
/**
|
|
756
|
+
* Retrieves relevant sources for RAG.
|
|
757
|
+
* @param prompt - The prompt to use for retrieval.
|
|
758
|
+
* @param filter - The filter criteria for selecting contents, optional.
|
|
759
|
+
* @param augmentedFilter - Additional filter for augmented retrieval, optional.
|
|
760
|
+
* @param retrievalStrategy - The retrieval strategy, optional.
|
|
761
|
+
* @param rerankingStrategy - The reranking strategy, optional.
|
|
762
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
763
|
+
* @returns The retrieved sources.
|
|
764
|
+
*/
|
|
190
765
|
retrieveSources(prompt: string, filter?: Types.ContentFilter, augmentedFilter?: Types.ContentFilter, retrievalStrategy?: Types.RetrievalStrategyInput, rerankingStrategy?: Types.RerankingStrategyInput, correlationId?: string): Promise<Types.RetrieveSourcesMutation>;
|
|
766
|
+
/**
|
|
767
|
+
* Formats a conversation for external LLM completion.
|
|
768
|
+
* @param prompt - The prompt to format.
|
|
769
|
+
* @param id - The conversation ID, optional.
|
|
770
|
+
* @param specification - The LLM specification to use, optional.
|
|
771
|
+
* @param tools - Tool definitions for function calling, optional.
|
|
772
|
+
* @param systemPrompt - The system prompt, optional.
|
|
773
|
+
* @param includeDetails - Whether to include details, optional.
|
|
774
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
775
|
+
* @returns The formatted conversation.
|
|
776
|
+
*/
|
|
191
777
|
formatConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, tools?: Types.ToolDefinitionInput[], systemPrompt?: string, includeDetails?: boolean, correlationId?: string): Promise<Types.FormatConversationMutation>;
|
|
778
|
+
/**
|
|
779
|
+
* Completes a conversation with an external LLM response.
|
|
780
|
+
* @param completion - The completion text from the external LLM.
|
|
781
|
+
* @param id - The conversation ID.
|
|
782
|
+
* @param completionTime - The time taken for completion, optional.
|
|
783
|
+
* @param ttft - Time to first token, optional.
|
|
784
|
+
* @param throughput - Tokens per second throughput, optional.
|
|
785
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
786
|
+
* @returns The completed conversation.
|
|
787
|
+
*/
|
|
192
788
|
completeConversation(completion: string, id: string, completionTime?: Types.Scalars["TimeSpan"]["input"], ttft?: Types.Scalars["TimeSpan"]["input"], throughput?: Types.Scalars["Float"]["input"], correlationId?: string): Promise<Types.CompleteConversationMutation>;
|
|
789
|
+
/**
|
|
790
|
+
* Asks a question about Graphlit SDK usage.
|
|
791
|
+
* @param prompt - The question about Graphlit.
|
|
792
|
+
* @param type - The SDK type (Node.js, Python, .NET), optional.
|
|
793
|
+
* @param id - The conversation ID, optional.
|
|
794
|
+
* @param specification - The LLM specification to use, optional.
|
|
795
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
796
|
+
* @returns The Graphlit answer.
|
|
797
|
+
*/
|
|
193
798
|
askGraphlit(prompt: string, type?: Types.SdkTypes, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.AskGraphlitMutation>;
|
|
799
|
+
/**
|
|
800
|
+
* Creates a branch of an existing conversation.
|
|
801
|
+
* @param id - The conversation ID to branch from.
|
|
802
|
+
* @returns The branched conversation.
|
|
803
|
+
*/
|
|
194
804
|
branchConversation(id: string): Promise<Types.BranchConversationMutation>;
|
|
805
|
+
/**
|
|
806
|
+
* Prompts a conversation with an LLM.
|
|
807
|
+
* @param prompt - The prompt text.
|
|
808
|
+
* @param id - The conversation ID, optional. If not provided, creates a new conversation.
|
|
809
|
+
* @param specification - The LLM specification to use, optional.
|
|
810
|
+
* @param mimeType - The MIME type for multimodal input, optional.
|
|
811
|
+
* @param data - The base64-encoded data for multimodal input, optional.
|
|
812
|
+
* @param tools - Tool definitions for function calling, optional.
|
|
813
|
+
* @param requireTool - Whether to require a tool call, optional.
|
|
814
|
+
* @param systemPrompt - The system prompt, optional.
|
|
815
|
+
* @param includeDetails - Whether to include details, optional.
|
|
816
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
817
|
+
* @returns The conversation response.
|
|
818
|
+
*/
|
|
195
819
|
promptConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, mimeType?: string, data?: string, tools?: Types.ToolDefinitionInput[], requireTool?: boolean, systemPrompt?: string, includeDetails?: boolean, correlationId?: string): Promise<Types.PromptConversationMutation>;
|
|
820
|
+
/**
|
|
821
|
+
* Continues a conversation with tool responses.
|
|
822
|
+
* @param id - The conversation ID.
|
|
823
|
+
* @param responses - The tool call responses.
|
|
824
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
825
|
+
* @returns The continued conversation.
|
|
826
|
+
*/
|
|
196
827
|
continueConversation(id: string, responses: Types.ConversationToolResponseInput[], correlationId?: string): Promise<Types.ContinueConversationMutation>;
|
|
828
|
+
/**
|
|
829
|
+
* Publishes a conversation to an external connector.
|
|
830
|
+
* @param id - The conversation ID.
|
|
831
|
+
* @param connector - The publishing connector to use.
|
|
832
|
+
* @param name - The name of the published conversation, optional.
|
|
833
|
+
* @param workflow - The workflow to use, optional.
|
|
834
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
835
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
836
|
+
* @returns The published conversation.
|
|
837
|
+
*/
|
|
197
838
|
publishConversation(id: string, connector: Types.ContentPublishingConnectorInput, name?: string, workflow?: Types.EntityReferenceInput, isSynchronous?: boolean, correlationId?: string): Promise<Types.PublishConversationMutation>;
|
|
839
|
+
/**
|
|
840
|
+
* Suggests follow-up prompts for a conversation.
|
|
841
|
+
* @param id - The conversation ID.
|
|
842
|
+
* @param count - The number of suggestions to generate, optional.
|
|
843
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
844
|
+
* @returns The suggested prompts.
|
|
845
|
+
*/
|
|
198
846
|
suggestConversation(id: string, count?: number, correlationId?: string): Promise<Types.SuggestConversationMutation>;
|
|
847
|
+
/**
|
|
848
|
+
* Queries Microsoft calendars.
|
|
849
|
+
* @param properties - The Microsoft calendar query properties.
|
|
850
|
+
* @returns The Microsoft calendars.
|
|
851
|
+
*/
|
|
199
852
|
queryMicrosoftCalendars(properties: Types.MicrosoftCalendarsInput): Promise<Types.QueryMicrosoftCalendarsQuery>;
|
|
853
|
+
/**
|
|
854
|
+
* Queries Google calendars.
|
|
855
|
+
* @param properties - The Google calendar query properties.
|
|
856
|
+
* @returns The Google calendars.
|
|
857
|
+
*/
|
|
200
858
|
queryGoogleCalendars(properties: Types.GoogleCalendarsInput): Promise<Types.QueryGoogleCalendarsQuery>;
|
|
859
|
+
/**
|
|
860
|
+
* Queries Box folders.
|
|
861
|
+
* @param properties - The Box folder query properties.
|
|
862
|
+
* @param folderId - The parent folder ID, optional.
|
|
863
|
+
* @returns The Box folders.
|
|
864
|
+
*/
|
|
201
865
|
queryBoxFolders(properties: Types.BoxFoldersInput, folderId?: string): Promise<Types.QueryBoxFoldersQuery>;
|
|
866
|
+
/**
|
|
867
|
+
* Queries Dropbox folders.
|
|
868
|
+
* @param properties - The Dropbox folder query properties.
|
|
869
|
+
* @param folderPath - The folder path, optional.
|
|
870
|
+
* @returns The Dropbox folders.
|
|
871
|
+
*/
|
|
202
872
|
queryDropboxFolders(properties: Types.DropboxFoldersInput, folderPath?: string): Promise<Types.QueryDropboxFoldersQuery>;
|
|
873
|
+
/**
|
|
874
|
+
* Queries Google Drive folders.
|
|
875
|
+
* @param properties - The Google Drive folder query properties.
|
|
876
|
+
* @param folderId - The parent folder ID, optional.
|
|
877
|
+
* @returns The Google Drive folders.
|
|
878
|
+
*/
|
|
203
879
|
queryGoogleDriveFolders(properties: Types.GoogleDriveFoldersInput, folderId?: string): Promise<Types.QueryGoogleDriveFoldersQuery>;
|
|
880
|
+
/**
|
|
881
|
+
* Queries OneDrive folders.
|
|
882
|
+
* @param properties - The OneDrive folder query properties.
|
|
883
|
+
* @param folderId - The parent folder ID, optional.
|
|
884
|
+
* @returns The OneDrive folders.
|
|
885
|
+
*/
|
|
204
886
|
queryOneDriveFolders(properties: Types.OneDriveFoldersInput, folderId?: string): Promise<Types.QueryOneDriveFoldersQuery>;
|
|
887
|
+
/**
|
|
888
|
+
* Queries SharePoint folders.
|
|
889
|
+
* @param properties - The SharePoint folder query properties.
|
|
890
|
+
* @param libraryId - The library ID.
|
|
891
|
+
* @param folderId - The parent folder ID, optional.
|
|
892
|
+
* @returns The SharePoint folders.
|
|
893
|
+
*/
|
|
205
894
|
querySharePointFolders(properties: Types.SharePointFoldersInput, libraryId: string, folderId?: string): Promise<Types.QuerySharePointFoldersQuery>;
|
|
895
|
+
/**
|
|
896
|
+
* Queries SharePoint libraries.
|
|
897
|
+
* @param properties - The SharePoint library query properties.
|
|
898
|
+
* @returns The SharePoint libraries.
|
|
899
|
+
*/
|
|
206
900
|
querySharePointLibraries(properties: Types.SharePointLibrariesInput): Promise<Types.QuerySharePointLibrariesQuery>;
|
|
901
|
+
/**
|
|
902
|
+
* Queries Microsoft Teams teams.
|
|
903
|
+
* @param properties - The Microsoft Teams query properties.
|
|
904
|
+
* @returns The Microsoft Teams teams.
|
|
905
|
+
*/
|
|
207
906
|
queryMicrosoftTeamsTeams(properties: Types.MicrosoftTeamsTeamsInput): Promise<Types.QueryMicrosoftTeamsTeamsQuery>;
|
|
907
|
+
/**
|
|
908
|
+
* Queries Microsoft Teams channels.
|
|
909
|
+
* @param properties - The Microsoft Teams channel query properties.
|
|
910
|
+
* @param teamId - The team ID.
|
|
911
|
+
* @returns The Microsoft Teams channels.
|
|
912
|
+
*/
|
|
208
913
|
queryMicrosoftTeamsChannels(properties: Types.MicrosoftTeamsChannelsInput, teamId: string): Promise<Types.QueryMicrosoftTeamsChannelsQuery>;
|
|
914
|
+
/**
|
|
915
|
+
* Queries Discord guilds (servers).
|
|
916
|
+
* @param properties - The Discord guild query properties.
|
|
917
|
+
* @returns The Discord guilds.
|
|
918
|
+
*/
|
|
209
919
|
queryDiscordGuilds(properties: Types.DiscordGuildsInput): Promise<Types.QueryDiscordGuildsQuery>;
|
|
920
|
+
/**
|
|
921
|
+
* Queries Discord channels.
|
|
922
|
+
* @param properties - The Discord channel query properties.
|
|
923
|
+
* @returns The Discord channels.
|
|
924
|
+
*/
|
|
210
925
|
queryDiscordChannels(properties: Types.DiscordChannelsInput): Promise<Types.QueryDiscordChannelsQuery>;
|
|
926
|
+
/**
|
|
927
|
+
* Queries Slack channels.
|
|
928
|
+
* @param properties - The Slack channel query properties.
|
|
929
|
+
* @returns The Slack channels.
|
|
930
|
+
*/
|
|
211
931
|
querySlackChannels(properties: Types.SlackChannelsInput): Promise<Types.QuerySlackChannelsQuery>;
|
|
932
|
+
/**
|
|
933
|
+
* Queries Linear projects.
|
|
934
|
+
* @param properties - The Linear project query properties.
|
|
935
|
+
* @returns The Linear projects.
|
|
936
|
+
*/
|
|
212
937
|
queryLinearProjects(properties: Types.LinearProjectsInput): Promise<Types.QueryLinearProjectsQuery>;
|
|
938
|
+
/**
|
|
939
|
+
* Queries GitHub repositories.
|
|
940
|
+
* @param properties - The GitHub repository query properties.
|
|
941
|
+
* @param sortBy - The sort order, optional.
|
|
942
|
+
* @returns The GitHub repositories.
|
|
943
|
+
*/
|
|
213
944
|
queryGitHubRepositories(properties: Types.GitHubRepositoriesInput, sortBy?: Types.GitHubRepositorySortTypes): Promise<Types.QueryGitHubRepositoriesQuery>;
|
|
945
|
+
/**
|
|
946
|
+
* Queries Notion databases.
|
|
947
|
+
* @param properties - The Notion database query properties.
|
|
948
|
+
* @returns The Notion databases.
|
|
949
|
+
*/
|
|
214
950
|
queryNotionDatabases(properties: Types.NotionDatabasesInput): Promise<Types.QueryNotionDatabasesQuery>;
|
|
951
|
+
/**
|
|
952
|
+
* Queries Notion pages.
|
|
953
|
+
* @param properties - The Notion page query properties.
|
|
954
|
+
* @param identifier - The Notion database or page identifier.
|
|
955
|
+
* @returns The Notion pages.
|
|
956
|
+
*/
|
|
215
957
|
queryNotionPages(properties: Types.NotionPagesInput, identifier: string): Promise<Types.QueryNotionPagesQuery>;
|
|
958
|
+
/**
|
|
959
|
+
* Creates a feed.
|
|
960
|
+
* @param feed - The feed to create.
|
|
961
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
962
|
+
* @returns The created feed.
|
|
963
|
+
*/
|
|
216
964
|
createFeed(feed: Types.FeedInput, correlationId?: string): Promise<Types.CreateFeedMutation>;
|
|
965
|
+
/**
|
|
966
|
+
* Updates a feed.
|
|
967
|
+
* @param feed - The feed to update.
|
|
968
|
+
* @returns The updated feed.
|
|
969
|
+
*/
|
|
217
970
|
updateFeed(feed: Types.FeedUpdateInput): Promise<Types.UpdateFeedMutation>;
|
|
971
|
+
/**
|
|
972
|
+
* Deletes a feed.
|
|
973
|
+
* @param id - The ID of the feed to delete.
|
|
974
|
+
* @returns The deleted feed.
|
|
975
|
+
*/
|
|
218
976
|
deleteFeed(id: string): Promise<Types.DeleteFeedMutation>;
|
|
977
|
+
/**
|
|
978
|
+
* Deletes multiple feeds.
|
|
979
|
+
* @param ids - The IDs of the feeds to delete.
|
|
980
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
981
|
+
* @returns The deleted feeds.
|
|
982
|
+
*/
|
|
219
983
|
deleteFeeds(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteFeedsMutation>;
|
|
984
|
+
/**
|
|
985
|
+
* Deletes all feeds based on the provided filter criteria.
|
|
986
|
+
* @param filter - The filter criteria to apply when deleting feeds.
|
|
987
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
988
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
989
|
+
* @returns The result of the deletion.
|
|
990
|
+
*/
|
|
220
991
|
deleteAllFeeds(filter?: Types.FeedFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllFeedsMutation>;
|
|
992
|
+
/**
|
|
993
|
+
* Triggers a feed to run immediately.
|
|
994
|
+
* @param id - The ID of the feed to trigger.
|
|
995
|
+
* @returns The triggered feed.
|
|
996
|
+
*/
|
|
221
997
|
triggerFeed(id: string): Promise<Types.TriggerFeedMutation>;
|
|
998
|
+
/**
|
|
999
|
+
* Enables a feed.
|
|
1000
|
+
* @param id - The ID of the feed to enable.
|
|
1001
|
+
* @returns The enabled feed.
|
|
1002
|
+
*/
|
|
222
1003
|
enableFeed(id: string): Promise<Types.EnableFeedMutation>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Disables a feed.
|
|
1006
|
+
* @param id - The ID of the feed to disable.
|
|
1007
|
+
* @returns The disabled feed.
|
|
1008
|
+
*/
|
|
223
1009
|
disableFeed(id: string): Promise<Types.DisableFeedMutation>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Lookup a feed given its ID.
|
|
1012
|
+
* @param id - ID of the feed.
|
|
1013
|
+
* @returns The feed.
|
|
1014
|
+
*/
|
|
224
1015
|
getFeed(id: string): Promise<Types.GetFeedQuery>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Retrieves feeds based on the provided filter criteria.
|
|
1018
|
+
* @param filter - The filter criteria to apply when retrieving feeds.
|
|
1019
|
+
* @returns The feeds.
|
|
1020
|
+
*/
|
|
225
1021
|
queryFeeds(filter?: Types.FeedFilter): Promise<Types.QueryFeedsQuery>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Counts feeds based on the provided filter criteria.
|
|
1024
|
+
* @param filter - The filter criteria to apply when counting feeds.
|
|
1025
|
+
* @returns The count of feeds.
|
|
1026
|
+
*/
|
|
226
1027
|
countFeeds(filter?: Types.FeedFilter): Promise<Types.CountFeedsQuery>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Checks if a feed exists based on the provided filter criteria.
|
|
1030
|
+
* @param filter - The filter criteria to apply.
|
|
1031
|
+
* @returns Whether the feed exists.
|
|
1032
|
+
*/
|
|
227
1033
|
feedExists(filter?: Types.FeedFilter): Promise<Types.FeedExistsQuery>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Checks if feed processing is complete.
|
|
1036
|
+
* @param id - ID of the feed.
|
|
1037
|
+
* @returns Whether the feed is done processing.
|
|
1038
|
+
*/
|
|
228
1039
|
isFeedDone(id: string): Promise<Types.IsFeedDoneQuery>;
|
|
1040
|
+
/**
|
|
1041
|
+
* Prompts multiple specifications and returns the best response.
|
|
1042
|
+
* @param prompt - The prompt to send to each specification.
|
|
1043
|
+
* @param ids - The IDs of the specifications to prompt.
|
|
1044
|
+
* @returns The best response.
|
|
1045
|
+
*/
|
|
229
1046
|
promptSpecifications(prompt: string, ids: string[]): Promise<Types.PromptSpecificationsMutation>;
|
|
1047
|
+
/**
|
|
1048
|
+
* Creates a specification (LLM configuration).
|
|
1049
|
+
* @param specification - The specification to create.
|
|
1050
|
+
* @returns The created specification.
|
|
1051
|
+
*/
|
|
230
1052
|
createSpecification(specification: Types.SpecificationInput): Promise<Types.CreateSpecificationMutation>;
|
|
1053
|
+
/**
|
|
1054
|
+
* Updates a specification.
|
|
1055
|
+
* @param specification - The specification to update.
|
|
1056
|
+
* @returns The updated specification.
|
|
1057
|
+
*/
|
|
231
1058
|
updateSpecification(specification: Types.SpecificationUpdateInput): Promise<Types.UpdateSpecificationMutation>;
|
|
1059
|
+
/**
|
|
1060
|
+
* Creates or updates a specification.
|
|
1061
|
+
* @param specification - The specification to create or update.
|
|
1062
|
+
* @returns The created or updated specification.
|
|
1063
|
+
*/
|
|
232
1064
|
upsertSpecification(specification: Types.SpecificationInput): Promise<Types.UpsertSpecificationMutation>;
|
|
1065
|
+
/**
|
|
1066
|
+
* Deletes a specification.
|
|
1067
|
+
* @param id - The ID of the specification to delete.
|
|
1068
|
+
* @returns The deleted specification.
|
|
1069
|
+
*/
|
|
233
1070
|
deleteSpecification(id: string): Promise<Types.DeleteSpecificationMutation>;
|
|
1071
|
+
/**
|
|
1072
|
+
* Deletes multiple specifications.
|
|
1073
|
+
* @param ids - The IDs of the specifications to delete.
|
|
1074
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1075
|
+
* @returns The deleted specifications.
|
|
1076
|
+
*/
|
|
234
1077
|
deleteSpecifications(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteSpecificationsMutation>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Deletes all specifications based on the provided filter criteria.
|
|
1080
|
+
* @param filter - The filter criteria to apply when deleting specifications.
|
|
1081
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1082
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1083
|
+
* @returns The result of the deletion.
|
|
1084
|
+
*/
|
|
235
1085
|
deleteAllSpecifications(filter?: Types.SpecificationFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllSpecificationsMutation>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Lookup a specification given its ID.
|
|
1088
|
+
* @param id - ID of the specification.
|
|
1089
|
+
* @returns The specification.
|
|
1090
|
+
*/
|
|
236
1091
|
getSpecification(id: string): Promise<Types.GetSpecificationQuery>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Retrieves specifications based on the provided filter criteria.
|
|
1094
|
+
* @param filter - The filter criteria to apply when retrieving specifications.
|
|
1095
|
+
* @returns The specifications.
|
|
1096
|
+
*/
|
|
237
1097
|
querySpecifications(filter?: Types.SpecificationFilter): Promise<Types.QuerySpecificationsQuery>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Counts specifications based on the provided filter criteria.
|
|
1100
|
+
* @param filter - The filter criteria to apply when counting specifications.
|
|
1101
|
+
* @returns The count of specifications.
|
|
1102
|
+
*/
|
|
238
1103
|
countSpecifications(filter?: Types.SpecificationFilter): Promise<Types.CountSpecificationsQuery>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Checks if a specification exists based on the provided filter criteria.
|
|
1106
|
+
* @param filter - The filter criteria to apply.
|
|
1107
|
+
* @returns Whether the specification exists.
|
|
1108
|
+
*/
|
|
239
1109
|
specificationExists(filter?: Types.SpecificationFilter): Promise<Types.SpecificationExistsQuery>;
|
|
1110
|
+
/**
|
|
1111
|
+
* Retrieves available LLM models based on the provided filter criteria.
|
|
1112
|
+
* @param filter - The filter criteria to apply when retrieving models.
|
|
1113
|
+
* @returns The available models.
|
|
1114
|
+
*/
|
|
240
1115
|
queryModels(filter?: Types.ModelFilter): Promise<Types.QueryModelsQuery>;
|
|
1116
|
+
/**
|
|
1117
|
+
* Creates a connector for external integrations.
|
|
1118
|
+
* @param connector - The connector to create.
|
|
1119
|
+
* @returns The created connector.
|
|
1120
|
+
*/
|
|
241
1121
|
createConnector(connector: Types.ConnectorInput): Promise<Types.CreateConnectorMutation>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Updates a connector.
|
|
1124
|
+
* @param connector - The connector to update.
|
|
1125
|
+
* @returns The updated connector.
|
|
1126
|
+
*/
|
|
242
1127
|
updateConnector(connector: Types.ConnectorUpdateInput): Promise<Types.UpdateConnectorMutation>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Deletes a connector.
|
|
1130
|
+
* @param id - The ID of the connector to delete.
|
|
1131
|
+
* @returns The deleted connector.
|
|
1132
|
+
*/
|
|
243
1133
|
deleteConnector(id: string): Promise<Types.DeleteConnectorMutation>;
|
|
1134
|
+
/**
|
|
1135
|
+
* Lookup a connector given its ID.
|
|
1136
|
+
* @param id - ID of the connector.
|
|
1137
|
+
* @returns The connector.
|
|
1138
|
+
*/
|
|
244
1139
|
getConnector(id: string): Promise<Types.GetConnectorQuery>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Retrieves connectors based on the provided filter criteria.
|
|
1142
|
+
* @param filter - The filter criteria to apply when retrieving connectors.
|
|
1143
|
+
* @returns The connectors.
|
|
1144
|
+
*/
|
|
245
1145
|
queryConnectors(filter?: Types.ConnectorFilter): Promise<Types.QueryConnectorsQuery>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Counts connectors based on the provided filter criteria.
|
|
1148
|
+
* @param filter - The filter criteria to apply when counting connectors.
|
|
1149
|
+
* @returns The count of connectors.
|
|
1150
|
+
*/
|
|
246
1151
|
countConnectors(filter?: Types.ConnectorFilter): Promise<Types.CountConnectorsQuery>;
|
|
1152
|
+
/**
|
|
1153
|
+
* Creates a view for content filtering.
|
|
1154
|
+
* @param view - The view to create.
|
|
1155
|
+
* @returns The created view.
|
|
1156
|
+
*/
|
|
247
1157
|
createView(view: Types.ViewInput): Promise<Types.CreateViewMutation>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Updates a view.
|
|
1160
|
+
* @param view - The view to update.
|
|
1161
|
+
* @returns The updated view.
|
|
1162
|
+
*/
|
|
248
1163
|
updateView(view: Types.ViewUpdateInput): Promise<Types.UpdateViewMutation>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Creates or updates a view.
|
|
1166
|
+
* @param view - The view to create or update.
|
|
1167
|
+
* @returns The created or updated view.
|
|
1168
|
+
*/
|
|
249
1169
|
upsertView(view: Types.ViewInput): Promise<Types.UpsertViewMutation>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Deletes a view.
|
|
1172
|
+
* @param id - The ID of the view to delete.
|
|
1173
|
+
* @returns The deleted view.
|
|
1174
|
+
*/
|
|
250
1175
|
deleteView(id: string): Promise<Types.DeleteViewMutation>;
|
|
1176
|
+
/**
|
|
1177
|
+
* Deletes multiple views.
|
|
1178
|
+
* @param ids - The IDs of the views to delete.
|
|
1179
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1180
|
+
* @returns The deleted views.
|
|
1181
|
+
*/
|
|
251
1182
|
deleteViews(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteViewsMutation>;
|
|
1183
|
+
/**
|
|
1184
|
+
* Deletes all views based on the provided filter criteria.
|
|
1185
|
+
* @param filter - The filter criteria to apply when deleting views.
|
|
1186
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1187
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1188
|
+
* @returns The result of the deletion.
|
|
1189
|
+
*/
|
|
252
1190
|
deleteAllViews(filter?: Types.ViewFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllViewsMutation>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Lookup a view given its ID.
|
|
1193
|
+
* @param id - ID of the view.
|
|
1194
|
+
* @returns The view.
|
|
1195
|
+
*/
|
|
253
1196
|
getView(id: string): Promise<Types.GetViewQuery>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Retrieves views based on the provided filter criteria.
|
|
1199
|
+
* @param filter - The filter criteria to apply when retrieving views.
|
|
1200
|
+
* @returns The views.
|
|
1201
|
+
*/
|
|
254
1202
|
queryViews(filter?: Types.ViewFilter): Promise<Types.QueryViewsQuery>;
|
|
1203
|
+
/**
|
|
1204
|
+
* Counts views based on the provided filter criteria.
|
|
1205
|
+
* @param filter - The filter criteria to apply when counting views.
|
|
1206
|
+
* @returns The count of views.
|
|
1207
|
+
*/
|
|
255
1208
|
countViews(filter?: Types.ViewFilter): Promise<Types.CountViewsQuery>;
|
|
1209
|
+
/**
|
|
1210
|
+
* Checks if a view exists based on the provided filter criteria.
|
|
1211
|
+
* @param filter - The filter criteria to apply.
|
|
1212
|
+
* @returns Whether the view exists.
|
|
1213
|
+
*/
|
|
256
1214
|
viewExists(filter?: Types.ViewFilter): Promise<Types.ViewExistsQuery>;
|
|
1215
|
+
/**
|
|
1216
|
+
* Creates a workflow for content processing.
|
|
1217
|
+
* @param workflow - The workflow to create.
|
|
1218
|
+
* @returns The created workflow.
|
|
1219
|
+
*/
|
|
257
1220
|
createWorkflow(workflow: Types.WorkflowInput): Promise<Types.CreateWorkflowMutation>;
|
|
1221
|
+
/**
|
|
1222
|
+
* Updates a workflow.
|
|
1223
|
+
* @param workflow - The workflow to update.
|
|
1224
|
+
* @returns The updated workflow.
|
|
1225
|
+
*/
|
|
258
1226
|
updateWorkflow(workflow: Types.WorkflowUpdateInput): Promise<Types.UpdateWorkflowMutation>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Creates or updates a workflow.
|
|
1229
|
+
* @param workflow - The workflow to create or update.
|
|
1230
|
+
* @returns The created or updated workflow.
|
|
1231
|
+
*/
|
|
259
1232
|
upsertWorkflow(workflow: Types.WorkflowInput): Promise<Types.UpsertWorkflowMutation>;
|
|
1233
|
+
/**
|
|
1234
|
+
* Deletes a workflow.
|
|
1235
|
+
* @param id - The ID of the workflow to delete.
|
|
1236
|
+
* @returns The deleted workflow.
|
|
1237
|
+
*/
|
|
260
1238
|
deleteWorkflow(id: string): Promise<Types.DeleteWorkflowMutation>;
|
|
1239
|
+
/**
|
|
1240
|
+
* Deletes multiple workflows.
|
|
1241
|
+
* @param ids - The IDs of the workflows to delete.
|
|
1242
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1243
|
+
* @returns The deleted workflows.
|
|
1244
|
+
*/
|
|
261
1245
|
deleteWorkflows(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteWorkflowsMutation>;
|
|
1246
|
+
/**
|
|
1247
|
+
* Deletes all workflows based on the provided filter criteria.
|
|
1248
|
+
* @param filter - The filter criteria to apply when deleting workflows.
|
|
1249
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1250
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1251
|
+
* @returns The result of the deletion.
|
|
1252
|
+
*/
|
|
262
1253
|
deleteAllWorkflows(filter?: Types.WorkflowFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllWorkflowsMutation>;
|
|
1254
|
+
/**
|
|
1255
|
+
* Lookup a workflow given its ID.
|
|
1256
|
+
* @param id - ID of the workflow.
|
|
1257
|
+
* @returns The workflow.
|
|
1258
|
+
*/
|
|
263
1259
|
getWorkflow(id: string): Promise<Types.GetWorkflowQuery>;
|
|
1260
|
+
/**
|
|
1261
|
+
* Retrieves workflows based on the provided filter criteria.
|
|
1262
|
+
* @param filter - The filter criteria to apply when retrieving workflows.
|
|
1263
|
+
* @returns The workflows.
|
|
1264
|
+
*/
|
|
264
1265
|
queryWorkflows(filter?: Types.WorkflowFilter): Promise<Types.QueryWorkflowsQuery>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Counts workflows based on the provided filter criteria.
|
|
1268
|
+
* @param filter - The filter criteria to apply when counting workflows.
|
|
1269
|
+
* @returns The count of workflows.
|
|
1270
|
+
*/
|
|
265
1271
|
countWorkflows(filter?: Types.WorkflowFilter): Promise<Types.CountWorkflowsQuery>;
|
|
1272
|
+
/**
|
|
1273
|
+
* Checks if a workflow exists based on the provided filter criteria.
|
|
1274
|
+
* @param filter - The filter criteria to apply.
|
|
1275
|
+
* @returns Whether the workflow exists.
|
|
1276
|
+
*/
|
|
266
1277
|
workflowExists(filter?: Types.WorkflowFilter): Promise<Types.WorkflowExistsQuery>;
|
|
1278
|
+
/**
|
|
1279
|
+
* Creates a user.
|
|
1280
|
+
* @param user - The user to create.
|
|
1281
|
+
* @returns The created user.
|
|
1282
|
+
*/
|
|
267
1283
|
createUser(user: Types.UserInput): Promise<Types.CreateUserMutation>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Updates a user.
|
|
1286
|
+
* @param user - The user to update.
|
|
1287
|
+
* @returns The updated user.
|
|
1288
|
+
*/
|
|
268
1289
|
updateUser(user: Types.UserUpdateInput): Promise<Types.UpdateUserMutation>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Deletes a user.
|
|
1292
|
+
* @param id - The ID of the user to delete.
|
|
1293
|
+
* @returns The deleted user.
|
|
1294
|
+
*/
|
|
269
1295
|
deleteUser(id: string): Promise<Types.DeleteUserMutation>;
|
|
1296
|
+
/**
|
|
1297
|
+
* Lookup a user by their external identifier.
|
|
1298
|
+
* @param identifier - The external identifier.
|
|
1299
|
+
* @returns The user.
|
|
1300
|
+
*/
|
|
270
1301
|
getUserByIdentifier(identifier: string): Promise<Types.GetUserByIdentifierQuery>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Gets the current authenticated user.
|
|
1304
|
+
* @returns The current user.
|
|
1305
|
+
*/
|
|
271
1306
|
getUser(): Promise<Types.GetUserQuery>;
|
|
1307
|
+
/**
|
|
1308
|
+
* Retrieves users based on the provided filter criteria.
|
|
1309
|
+
* @param filter - The filter criteria to apply when retrieving users.
|
|
1310
|
+
* @returns The users.
|
|
1311
|
+
*/
|
|
272
1312
|
queryUsers(filter?: Types.UserFilter): Promise<Types.QueryUsersQuery>;
|
|
1313
|
+
/**
|
|
1314
|
+
* Counts users based on the provided filter criteria.
|
|
1315
|
+
* @param filter - The filter criteria to apply when counting users.
|
|
1316
|
+
* @returns The count of users.
|
|
1317
|
+
*/
|
|
273
1318
|
countUsers(filter?: Types.UserFilter): Promise<Types.CountUsersQuery>;
|
|
1319
|
+
/**
|
|
1320
|
+
* Enables a user.
|
|
1321
|
+
* @param id - The ID of the user to enable.
|
|
1322
|
+
* @returns The enabled user.
|
|
1323
|
+
*/
|
|
274
1324
|
enableUser(id: string): Promise<Types.EnableUserMutation>;
|
|
1325
|
+
/**
|
|
1326
|
+
* Disables a user.
|
|
1327
|
+
* @param id - The ID of the user to disable.
|
|
1328
|
+
* @returns The disabled user.
|
|
1329
|
+
*/
|
|
275
1330
|
disableUser(id: string): Promise<Types.DisableUserMutation>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Creates a category for content classification.
|
|
1333
|
+
* @param category - The category to create.
|
|
1334
|
+
* @returns The created category.
|
|
1335
|
+
*/
|
|
276
1336
|
createCategory(category: Types.CategoryInput): Promise<Types.CreateCategoryMutation>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Updates a category.
|
|
1339
|
+
* @param category - The category to update.
|
|
1340
|
+
* @returns The updated category.
|
|
1341
|
+
*/
|
|
277
1342
|
updateCategory(category: Types.CategoryUpdateInput): Promise<Types.UpdateCategoryMutation>;
|
|
1343
|
+
/**
|
|
1344
|
+
* Creates or updates a category.
|
|
1345
|
+
* @param category - The category to create or update.
|
|
1346
|
+
* @returns The created or updated category.
|
|
1347
|
+
*/
|
|
278
1348
|
upsertCategory(category: Types.CategoryInput): Promise<Types.UpsertCategoryMutation>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Deletes a category.
|
|
1351
|
+
* @param id - The ID of the category to delete.
|
|
1352
|
+
* @returns The deleted category.
|
|
1353
|
+
*/
|
|
279
1354
|
deleteCategory(id: string): Promise<Types.DeleteCategoryMutation>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Deletes multiple categories.
|
|
1357
|
+
* @param ids - The IDs of the categories to delete.
|
|
1358
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1359
|
+
* @returns The deleted categories.
|
|
1360
|
+
*/
|
|
280
1361
|
deleteCategories(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteCategoriesMutation>;
|
|
1362
|
+
/**
|
|
1363
|
+
* Deletes all categories based on the provided filter criteria.
|
|
1364
|
+
* @param filter - The filter criteria to apply when deleting categories.
|
|
1365
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1366
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1367
|
+
* @returns The result of the deletion.
|
|
1368
|
+
*/
|
|
281
1369
|
deleteAllCategories(filter?: Types.CategoryFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllCategoriesMutation>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Lookup a category given its ID.
|
|
1372
|
+
* @param id - ID of the category.
|
|
1373
|
+
* @returns The category.
|
|
1374
|
+
*/
|
|
282
1375
|
getCategory(id: string): Promise<Types.GetCategoryQuery>;
|
|
1376
|
+
/**
|
|
1377
|
+
* Retrieves categories based on the provided filter criteria.
|
|
1378
|
+
* @param filter - The filter criteria to apply when retrieving categories.
|
|
1379
|
+
* @returns The categories.
|
|
1380
|
+
*/
|
|
283
1381
|
queryCategories(filter?: Types.CategoryFilter): Promise<Types.QueryCategoriesQuery>;
|
|
1382
|
+
/**
|
|
1383
|
+
* Counts categories based on the provided filter criteria.
|
|
1384
|
+
* @param filter - The filter criteria to apply when counting categories.
|
|
1385
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1386
|
+
* @returns The count of categories.
|
|
1387
|
+
*/
|
|
284
1388
|
countCategories(filter?: Types.CategoryFilter, correlationId?: string): Promise<Types.CountCategoriesQuery>;
|
|
1389
|
+
/**
|
|
1390
|
+
* Creates a label for content tagging.
|
|
1391
|
+
* @param label - The label to create.
|
|
1392
|
+
* @returns The created label.
|
|
1393
|
+
*/
|
|
285
1394
|
createLabel(label: Types.LabelInput): Promise<Types.CreateLabelMutation>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Updates a label.
|
|
1397
|
+
* @param label - The label to update.
|
|
1398
|
+
* @returns The updated label.
|
|
1399
|
+
*/
|
|
286
1400
|
updateLabel(label: Types.LabelUpdateInput): Promise<Types.UpdateLabelMutation>;
|
|
1401
|
+
/**
|
|
1402
|
+
* Creates or updates a label.
|
|
1403
|
+
* @param label - The label to create or update.
|
|
1404
|
+
* @returns The created or updated label.
|
|
1405
|
+
*/
|
|
287
1406
|
upsertLabel(label: Types.LabelInput): Promise<Types.UpsertLabelMutation>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Deletes a label.
|
|
1409
|
+
* @param id - The ID of the label to delete.
|
|
1410
|
+
* @returns The deleted label.
|
|
1411
|
+
*/
|
|
288
1412
|
deleteLabel(id: string): Promise<Types.DeleteLabelMutation>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Deletes multiple labels.
|
|
1415
|
+
* @param ids - The IDs of the labels to delete.
|
|
1416
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1417
|
+
* @returns The deleted labels.
|
|
1418
|
+
*/
|
|
289
1419
|
deleteLabels(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteLabelsMutation>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Deletes all labels based on the provided filter criteria.
|
|
1422
|
+
* @param filter - The filter criteria to apply when deleting labels.
|
|
1423
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1424
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1425
|
+
* @returns The result of the deletion.
|
|
1426
|
+
*/
|
|
290
1427
|
deleteAllLabels(filter?: Types.LabelFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllLabelsMutation>;
|
|
1428
|
+
/**
|
|
1429
|
+
* Lookup a label given its ID.
|
|
1430
|
+
* @param id - ID of the label.
|
|
1431
|
+
* @returns The label.
|
|
1432
|
+
*/
|
|
291
1433
|
getLabel(id: string): Promise<Types.GetLabelQuery>;
|
|
1434
|
+
/**
|
|
1435
|
+
* Retrieves labels based on the provided filter criteria.
|
|
1436
|
+
* @param filter - The filter criteria to apply when retrieving labels.
|
|
1437
|
+
* @returns The labels.
|
|
1438
|
+
*/
|
|
292
1439
|
queryLabels(filter?: Types.LabelFilter): Promise<Types.QueryLabelsQuery>;
|
|
1440
|
+
/**
|
|
1441
|
+
* Counts labels based on the provided filter criteria.
|
|
1442
|
+
* @param filter - The filter criteria to apply when counting labels.
|
|
1443
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1444
|
+
* @returns The count of labels.
|
|
1445
|
+
*/
|
|
293
1446
|
countLabels(filter?: Types.LabelFilter, correlationId?: string): Promise<Types.CountLabelsQuery>;
|
|
1447
|
+
/**
|
|
1448
|
+
* Creates a person entity.
|
|
1449
|
+
* @param person - The person to create.
|
|
1450
|
+
* @returns The created person.
|
|
1451
|
+
*/
|
|
294
1452
|
createPerson(person: Types.PersonInput): Promise<Types.CreatePersonMutation>;
|
|
1453
|
+
/**
|
|
1454
|
+
* Updates a person entity.
|
|
1455
|
+
* @param person - The person to update.
|
|
1456
|
+
* @returns The updated person.
|
|
1457
|
+
*/
|
|
295
1458
|
updatePerson(person: Types.PersonUpdateInput): Promise<Types.UpdatePersonMutation>;
|
|
1459
|
+
/**
|
|
1460
|
+
* Deletes a person entity.
|
|
1461
|
+
* @param id - The ID of the person to delete.
|
|
1462
|
+
* @returns The deleted person.
|
|
1463
|
+
*/
|
|
296
1464
|
deletePerson(id: string): Promise<Types.DeletePersonMutation>;
|
|
1465
|
+
/**
|
|
1466
|
+
* Deletes multiple person entities.
|
|
1467
|
+
* @param ids - The IDs of the persons to delete.
|
|
1468
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1469
|
+
* @returns The deleted persons.
|
|
1470
|
+
*/
|
|
297
1471
|
deletePersons(ids: string[], isSynchronous?: boolean): Promise<Types.DeletePersonsMutation>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Deletes all persons based on the provided filter criteria.
|
|
1474
|
+
* @param filter - The filter criteria to apply when deleting persons.
|
|
1475
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1476
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1477
|
+
* @returns The result of the deletion.
|
|
1478
|
+
*/
|
|
298
1479
|
deleteAllPersons(filter?: Types.PersonFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllPersonsMutation>;
|
|
1480
|
+
/**
|
|
1481
|
+
* Lookup a person given their ID.
|
|
1482
|
+
* @param id - ID of the person.
|
|
1483
|
+
* @returns The person.
|
|
1484
|
+
*/
|
|
299
1485
|
getPerson(id: string): Promise<Types.GetPersonQuery>;
|
|
1486
|
+
/**
|
|
1487
|
+
* Retrieves persons based on the provided filter criteria.
|
|
1488
|
+
* @param filter - The filter criteria to apply when retrieving persons.
|
|
1489
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1490
|
+
* @returns The persons.
|
|
1491
|
+
*/
|
|
300
1492
|
queryPersons(filter?: Types.PersonFilter, correlationId?: string): Promise<Types.QueryPersonsQuery>;
|
|
1493
|
+
/**
|
|
1494
|
+
* Retrieves persons with clustering information.
|
|
1495
|
+
* @param filter - The filter criteria to apply when retrieving persons.
|
|
1496
|
+
* @param clusters - The clustering configuration.
|
|
1497
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1498
|
+
* @returns The persons with clusters.
|
|
1499
|
+
*/
|
|
301
1500
|
queryPersonsClusters(filter?: Types.PersonFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryPersonsClustersQuery>;
|
|
1501
|
+
/**
|
|
1502
|
+
* Retrieves persons with expanded details.
|
|
1503
|
+
* @param filter - The filter criteria to apply when retrieving persons.
|
|
1504
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1505
|
+
* @returns The persons with expanded details.
|
|
1506
|
+
*/
|
|
302
1507
|
queryPersonsExpanded(filter?: Types.PersonFilter, correlationId?: string): Promise<Types.QueryPersonsExpandedQuery>;
|
|
1508
|
+
/**
|
|
1509
|
+
* Counts persons based on the provided filter criteria.
|
|
1510
|
+
* @param filter - The filter criteria to apply when counting persons.
|
|
1511
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1512
|
+
* @returns The count of persons.
|
|
1513
|
+
*/
|
|
303
1514
|
countPersons(filter?: Types.PersonFilter, correlationId?: string): Promise<Types.CountPersonsQuery>;
|
|
1515
|
+
/**
|
|
1516
|
+
* Enriches persons using an external connector.
|
|
1517
|
+
* @param connector - The enrichment connector configuration.
|
|
1518
|
+
* @param filter - The filter criteria to apply when selecting persons.
|
|
1519
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1520
|
+
* @returns The enrichment result.
|
|
1521
|
+
*/
|
|
304
1522
|
enrichPersons(connector: Types.EntityEnrichmentConnectorInput, filter?: Types.PersonFilter, correlationId?: string): Promise<Types.EnrichPersonsMutation>;
|
|
1523
|
+
/**
|
|
1524
|
+
* Creates an organization entity.
|
|
1525
|
+
* @param organization - The organization to create.
|
|
1526
|
+
* @returns The created organization.
|
|
1527
|
+
*/
|
|
305
1528
|
createOrganization(organization: Types.OrganizationInput): Promise<Types.CreateOrganizationMutation>;
|
|
1529
|
+
/**
|
|
1530
|
+
* Updates an organization entity.
|
|
1531
|
+
* @param organization - The organization to update.
|
|
1532
|
+
* @returns The updated organization.
|
|
1533
|
+
*/
|
|
306
1534
|
updateOrganization(organization: Types.OrganizationUpdateInput): Promise<Types.UpdateOrganizationMutation>;
|
|
1535
|
+
/**
|
|
1536
|
+
* Deletes an organization entity.
|
|
1537
|
+
* @param id - The ID of the organization to delete.
|
|
1538
|
+
* @returns The deleted organization.
|
|
1539
|
+
*/
|
|
307
1540
|
deleteOrganization(id: string): Promise<Types.DeleteOrganizationMutation>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Deletes multiple organization entities.
|
|
1543
|
+
* @param ids - The IDs of the organizations to delete.
|
|
1544
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1545
|
+
* @returns The deleted organizations.
|
|
1546
|
+
*/
|
|
308
1547
|
deleteOrganizations(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteOrganizationsMutation>;
|
|
1548
|
+
/**
|
|
1549
|
+
* Deletes all organizations based on the provided filter criteria.
|
|
1550
|
+
* @param filter - The filter criteria to apply when deleting organizations.
|
|
1551
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1552
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1553
|
+
* @returns The result of the deletion.
|
|
1554
|
+
*/
|
|
309
1555
|
deleteAllOrganizations(filter?: Types.OrganizationFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllOrganizationsMutation>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Lookup an organization given its ID.
|
|
1558
|
+
* @param id - ID of the organization.
|
|
1559
|
+
* @returns The organization.
|
|
1560
|
+
*/
|
|
310
1561
|
getOrganization(id: string): Promise<Types.GetOrganizationQuery>;
|
|
1562
|
+
/**
|
|
1563
|
+
* Retrieves organizations based on the provided filter criteria.
|
|
1564
|
+
* @param filter - The filter criteria to apply when retrieving organizations.
|
|
1565
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1566
|
+
* @returns The organizations.
|
|
1567
|
+
*/
|
|
311
1568
|
queryOrganizations(filter?: Types.OrganizationFilter, correlationId?: string): Promise<Types.QueryOrganizationsQuery>;
|
|
1569
|
+
/**
|
|
1570
|
+
* Retrieves organizations with clustering information.
|
|
1571
|
+
* @param filter - The filter criteria to apply when retrieving organizations.
|
|
1572
|
+
* @param clusters - The clustering configuration.
|
|
1573
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1574
|
+
* @returns The organizations with clusters.
|
|
1575
|
+
*/
|
|
312
1576
|
queryOrganizationsClusters(filter?: Types.OrganizationFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryOrganizationsClustersQuery>;
|
|
1577
|
+
/**
|
|
1578
|
+
* Retrieves organizations with expanded details.
|
|
1579
|
+
* @param filter - The filter criteria to apply when retrieving organizations.
|
|
1580
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1581
|
+
* @returns The organizations with expanded details.
|
|
1582
|
+
*/
|
|
313
1583
|
queryOrganizationsExpanded(filter?: Types.OrganizationFilter, correlationId?: string): Promise<Types.QueryOrganizationsExpandedQuery>;
|
|
1584
|
+
/**
|
|
1585
|
+
* Counts organizations based on the provided filter criteria.
|
|
1586
|
+
* @param filter - The filter criteria to apply when counting organizations.
|
|
1587
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1588
|
+
* @returns The count of organizations.
|
|
1589
|
+
*/
|
|
314
1590
|
countOrganizations(filter?: Types.OrganizationFilter, correlationId?: string): Promise<Types.CountOrganizationsQuery>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Enriches organizations using an external connector.
|
|
1593
|
+
* @param connector - The enrichment connector configuration.
|
|
1594
|
+
* @param filter - The filter criteria to apply when selecting organizations.
|
|
1595
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1596
|
+
* @returns The enrichment result.
|
|
1597
|
+
*/
|
|
315
1598
|
enrichOrganizations(connector: Types.EntityEnrichmentConnectorInput, filter?: Types.OrganizationFilter, correlationId?: string): Promise<Types.EnrichOrganizationsMutation>;
|
|
1599
|
+
/**
|
|
1600
|
+
* Creates a place entity.
|
|
1601
|
+
* @param place - The place to create.
|
|
1602
|
+
* @returns The created place.
|
|
1603
|
+
*/
|
|
316
1604
|
createPlace(place: Types.PlaceInput): Promise<Types.CreatePlaceMutation>;
|
|
1605
|
+
/**
|
|
1606
|
+
* Updates a place entity.
|
|
1607
|
+
* @param place - The place to update.
|
|
1608
|
+
* @returns The updated place.
|
|
1609
|
+
*/
|
|
317
1610
|
updatePlace(place: Types.PlaceUpdateInput): Promise<Types.UpdatePlaceMutation>;
|
|
1611
|
+
/**
|
|
1612
|
+
* Deletes a place entity.
|
|
1613
|
+
* @param id - The ID of the place to delete.
|
|
1614
|
+
* @returns The deleted place.
|
|
1615
|
+
*/
|
|
318
1616
|
deletePlace(id: string): Promise<Types.DeletePlaceMutation>;
|
|
1617
|
+
/**
|
|
1618
|
+
* Deletes multiple place entities.
|
|
1619
|
+
* @param ids - The IDs of the places to delete.
|
|
1620
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1621
|
+
* @returns The deleted places.
|
|
1622
|
+
*/
|
|
319
1623
|
deletePlaces(ids: string[], isSynchronous?: boolean): Promise<Types.DeletePlacesMutation>;
|
|
1624
|
+
/**
|
|
1625
|
+
* Deletes all places based on the provided filter criteria.
|
|
1626
|
+
* @param filter - The filter criteria to apply when deleting places.
|
|
1627
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1628
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1629
|
+
* @returns The result of the deletion.
|
|
1630
|
+
*/
|
|
320
1631
|
deleteAllPlaces(filter?: Types.PlaceFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllPlacesMutation>;
|
|
1632
|
+
/**
|
|
1633
|
+
* Lookup a place given its ID.
|
|
1634
|
+
* @param id - ID of the place.
|
|
1635
|
+
* @returns The place.
|
|
1636
|
+
*/
|
|
321
1637
|
getPlace(id: string): Promise<Types.GetPlaceQuery>;
|
|
1638
|
+
/**
|
|
1639
|
+
* Retrieves places based on the provided filter criteria.
|
|
1640
|
+
* @param filter - The filter criteria to apply when retrieving places.
|
|
1641
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1642
|
+
* @returns The places.
|
|
1643
|
+
*/
|
|
322
1644
|
queryPlaces(filter?: Types.PlaceFilter, correlationId?: string): Promise<Types.QueryPlacesQuery>;
|
|
1645
|
+
/**
|
|
1646
|
+
* Retrieves places with clustering information.
|
|
1647
|
+
* @param filter - The filter criteria to apply when retrieving places.
|
|
1648
|
+
* @param clusters - The clustering configuration.
|
|
1649
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1650
|
+
* @returns The places with clusters.
|
|
1651
|
+
*/
|
|
323
1652
|
queryPlacesClusters(filter?: Types.PlaceFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryPlacesClustersQuery>;
|
|
1653
|
+
/**
|
|
1654
|
+
* Counts places based on the provided filter criteria.
|
|
1655
|
+
* @param filter - The filter criteria to apply when counting places.
|
|
1656
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1657
|
+
* @returns The count of places.
|
|
1658
|
+
*/
|
|
324
1659
|
countPlaces(filter?: Types.PlaceFilter, correlationId?: string): Promise<Types.CountPlacesQuery>;
|
|
1660
|
+
/**
|
|
1661
|
+
* Enriches places using an external connector.
|
|
1662
|
+
* @param connector - The enrichment connector configuration.
|
|
1663
|
+
* @param filter - The filter criteria to apply when selecting places.
|
|
1664
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1665
|
+
* @returns The enrichment result.
|
|
1666
|
+
*/
|
|
325
1667
|
enrichPlaces(connector: Types.EntityEnrichmentConnectorInput, filter?: Types.PlaceFilter, correlationId?: string): Promise<Types.EnrichPlacesMutation>;
|
|
1668
|
+
/**
|
|
1669
|
+
* Creates an event entity.
|
|
1670
|
+
* @param event - The event to create.
|
|
1671
|
+
* @returns The created event.
|
|
1672
|
+
*/
|
|
326
1673
|
createEvent(event: Types.EventInput): Promise<Types.CreateEventMutation>;
|
|
1674
|
+
/**
|
|
1675
|
+
* Updates an event entity.
|
|
1676
|
+
* @param event - The event to update.
|
|
1677
|
+
* @returns The updated event.
|
|
1678
|
+
*/
|
|
327
1679
|
updateEvent(event: Types.EventUpdateInput): Promise<Types.UpdateEventMutation>;
|
|
1680
|
+
/**
|
|
1681
|
+
* Deletes an event entity.
|
|
1682
|
+
* @param id - The ID of the event to delete.
|
|
1683
|
+
* @returns The deleted event.
|
|
1684
|
+
*/
|
|
328
1685
|
deleteEvent(id: string): Promise<Types.DeleteEventMutation>;
|
|
1686
|
+
/**
|
|
1687
|
+
* Deletes multiple event entities.
|
|
1688
|
+
* @param ids - The IDs of the events to delete.
|
|
1689
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1690
|
+
* @returns The deleted events.
|
|
1691
|
+
*/
|
|
329
1692
|
deleteEvents(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteEventsMutation>;
|
|
1693
|
+
/**
|
|
1694
|
+
* Deletes all events based on the provided filter criteria.
|
|
1695
|
+
* @param filter - The filter criteria to apply when deleting events.
|
|
1696
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1697
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1698
|
+
* @returns The result of the deletion.
|
|
1699
|
+
*/
|
|
330
1700
|
deleteAllEvents(filter?: Types.EventFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllEventsMutation>;
|
|
1701
|
+
/**
|
|
1702
|
+
* Lookup an event given its ID.
|
|
1703
|
+
* @param id - ID of the event.
|
|
1704
|
+
* @returns The event.
|
|
1705
|
+
*/
|
|
331
1706
|
getEvent(id: string): Promise<Types.GetEventQuery>;
|
|
1707
|
+
/**
|
|
1708
|
+
* Retrieves events based on the provided filter criteria.
|
|
1709
|
+
* @param filter - The filter criteria to apply when retrieving events.
|
|
1710
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1711
|
+
* @returns The events.
|
|
1712
|
+
*/
|
|
332
1713
|
queryEvents(filter?: Types.EventFilter, correlationId?: string): Promise<Types.QueryEventsQuery>;
|
|
1714
|
+
/**
|
|
1715
|
+
* Retrieves events with clustering information.
|
|
1716
|
+
* @param filter - The filter criteria to apply when retrieving events.
|
|
1717
|
+
* @param clusters - The clustering configuration.
|
|
1718
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1719
|
+
* @returns The events with clusters.
|
|
1720
|
+
*/
|
|
333
1721
|
queryEventsClusters(filter?: Types.EventFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryEventsClustersQuery>;
|
|
1722
|
+
/**
|
|
1723
|
+
* Counts events based on the provided filter criteria.
|
|
1724
|
+
* @param filter - The filter criteria to apply when counting events.
|
|
1725
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1726
|
+
* @returns The count of events.
|
|
1727
|
+
*/
|
|
334
1728
|
countEvents(filter?: Types.EventFilter, correlationId?: string): Promise<Types.CountEventsQuery>;
|
|
1729
|
+
/**
|
|
1730
|
+
* Creates a product entity.
|
|
1731
|
+
* @param product - The product to create.
|
|
1732
|
+
* @returns The created product.
|
|
1733
|
+
*/
|
|
335
1734
|
createProduct(product: Types.ProductInput): Promise<Types.CreateProductMutation>;
|
|
1735
|
+
/**
|
|
1736
|
+
* Updates a product entity.
|
|
1737
|
+
* @param product - The product to update.
|
|
1738
|
+
* @returns The updated product.
|
|
1739
|
+
*/
|
|
336
1740
|
updateProduct(product: Types.ProductUpdateInput): Promise<Types.UpdateProductMutation>;
|
|
1741
|
+
/**
|
|
1742
|
+
* Deletes a product entity.
|
|
1743
|
+
* @param id - The ID of the product to delete.
|
|
1744
|
+
* @returns The deleted product.
|
|
1745
|
+
*/
|
|
337
1746
|
deleteProduct(id: string): Promise<Types.DeleteProductMutation>;
|
|
1747
|
+
/**
|
|
1748
|
+
* Deletes multiple product entities.
|
|
1749
|
+
* @param ids - The IDs of the products to delete.
|
|
1750
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1751
|
+
* @returns The deleted products.
|
|
1752
|
+
*/
|
|
338
1753
|
deleteProducts(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteProductsMutation>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Deletes all products based on the provided filter criteria.
|
|
1756
|
+
* @param filter - The filter criteria to apply when deleting products.
|
|
1757
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1758
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1759
|
+
* @returns The result of the deletion.
|
|
1760
|
+
*/
|
|
339
1761
|
deleteAllProducts(filter?: Types.ProductFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllProductsMutation>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Lookup a product given its ID.
|
|
1764
|
+
* @param id - ID of the product.
|
|
1765
|
+
* @returns The product.
|
|
1766
|
+
*/
|
|
340
1767
|
getProduct(id: string): Promise<Types.GetProductQuery>;
|
|
1768
|
+
/**
|
|
1769
|
+
* Retrieves products based on the provided filter criteria.
|
|
1770
|
+
* @param filter - The filter criteria to apply when retrieving products.
|
|
1771
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1772
|
+
* @returns The products.
|
|
1773
|
+
*/
|
|
341
1774
|
queryProducts(filter?: Types.ProductFilter, correlationId?: string): Promise<Types.QueryProductsQuery>;
|
|
1775
|
+
/**
|
|
1776
|
+
* Retrieves products with clustering information.
|
|
1777
|
+
* @param filter - The filter criteria to apply when retrieving products.
|
|
1778
|
+
* @param clusters - The clustering configuration.
|
|
1779
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1780
|
+
* @returns The products with clusters.
|
|
1781
|
+
*/
|
|
342
1782
|
queryProductsClusters(filter?: Types.ProductFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryProductsClustersQuery>;
|
|
1783
|
+
/**
|
|
1784
|
+
* Counts products based on the provided filter criteria.
|
|
1785
|
+
* @param filter - The filter criteria to apply when counting products.
|
|
1786
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1787
|
+
* @returns The count of products.
|
|
1788
|
+
*/
|
|
343
1789
|
countProducts(filter?: Types.ProductFilter, correlationId?: string): Promise<Types.CountProductsQuery>;
|
|
1790
|
+
/**
|
|
1791
|
+
* Enriches products using an external connector.
|
|
1792
|
+
* @param connector - The enrichment connector configuration.
|
|
1793
|
+
* @param filter - The filter criteria to apply when selecting products.
|
|
1794
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1795
|
+
* @returns The enrichment result.
|
|
1796
|
+
*/
|
|
344
1797
|
enrichProducts(connector: Types.EntityEnrichmentConnectorInput, filter?: Types.ProductFilter, correlationId?: string): Promise<Types.EnrichProductsMutation>;
|
|
1798
|
+
/**
|
|
1799
|
+
* Creates a repo (code repository) entity.
|
|
1800
|
+
* @param repo - The repo to create.
|
|
1801
|
+
* @returns The created repo.
|
|
1802
|
+
*/
|
|
345
1803
|
createRepo(repo: Types.RepoInput): Promise<Types.CreateRepoMutation>;
|
|
1804
|
+
/**
|
|
1805
|
+
* Updates a repo entity.
|
|
1806
|
+
* @param repo - The repo to update.
|
|
1807
|
+
* @returns The updated repo.
|
|
1808
|
+
*/
|
|
346
1809
|
updateRepo(repo: Types.RepoUpdateInput): Promise<Types.UpdateRepoMutation>;
|
|
1810
|
+
/**
|
|
1811
|
+
* Deletes a repo entity.
|
|
1812
|
+
* @param id - The ID of the repo to delete.
|
|
1813
|
+
* @returns The deleted repo.
|
|
1814
|
+
*/
|
|
347
1815
|
deleteRepo(id: string): Promise<Types.DeleteRepoMutation>;
|
|
1816
|
+
/**
|
|
1817
|
+
* Deletes multiple repo entities.
|
|
1818
|
+
* @param ids - The IDs of the repos to delete.
|
|
1819
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1820
|
+
* @returns The deleted repos.
|
|
1821
|
+
*/
|
|
348
1822
|
deleteRepos(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteReposMutation>;
|
|
1823
|
+
/**
|
|
1824
|
+
* Deletes all repos based on the provided filter criteria.
|
|
1825
|
+
* @param filter - The filter criteria to apply when deleting repos.
|
|
1826
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1827
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1828
|
+
* @returns The result of the deletion.
|
|
1829
|
+
*/
|
|
349
1830
|
deleteAllRepos(filter?: Types.RepoFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllReposMutation>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Lookup a repo given its ID.
|
|
1833
|
+
* @param id - ID of the repo.
|
|
1834
|
+
* @returns The repo.
|
|
1835
|
+
*/
|
|
350
1836
|
getRepo(id: string): Promise<Types.GetRepoQuery>;
|
|
1837
|
+
/**
|
|
1838
|
+
* Retrieves repos based on the provided filter criteria.
|
|
1839
|
+
* @param filter - The filter criteria to apply when retrieving repos.
|
|
1840
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1841
|
+
* @returns The repos.
|
|
1842
|
+
*/
|
|
351
1843
|
queryRepos(filter?: Types.RepoFilter, correlationId?: string): Promise<Types.QueryReposQuery>;
|
|
1844
|
+
/**
|
|
1845
|
+
* Retrieves repos with clustering information.
|
|
1846
|
+
* @param filter - The filter criteria to apply when retrieving repos.
|
|
1847
|
+
* @param clusters - The clustering configuration.
|
|
1848
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1849
|
+
* @returns The repos with clusters.
|
|
1850
|
+
*/
|
|
352
1851
|
queryReposClusters(filter?: Types.RepoFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryReposClustersQuery>;
|
|
1852
|
+
/**
|
|
1853
|
+
* Counts repos based on the provided filter criteria.
|
|
1854
|
+
* @param filter - The filter criteria to apply when counting repos.
|
|
1855
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1856
|
+
* @returns The count of repos.
|
|
1857
|
+
*/
|
|
353
1858
|
countRepos(filter?: Types.RepoFilter, correlationId?: string): Promise<Types.CountReposQuery>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Creates a software entity.
|
|
1861
|
+
* @param software - The software to create.
|
|
1862
|
+
* @returns The created software.
|
|
1863
|
+
*/
|
|
354
1864
|
createSoftware(software: Types.SoftwareInput): Promise<Types.CreateSoftwareMutation>;
|
|
1865
|
+
/**
|
|
1866
|
+
* Updates a software entity.
|
|
1867
|
+
* @param software - The software to update.
|
|
1868
|
+
* @returns The updated software.
|
|
1869
|
+
*/
|
|
355
1870
|
updateSoftware(software: Types.SoftwareUpdateInput): Promise<Types.UpdateSoftwareMutation>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Deletes a software entity.
|
|
1873
|
+
* @param id - The ID of the software to delete.
|
|
1874
|
+
* @returns The deleted software.
|
|
1875
|
+
*/
|
|
356
1876
|
deleteSoftware(id: string): Promise<Types.DeleteSoftwareMutation>;
|
|
1877
|
+
/**
|
|
1878
|
+
* Deletes multiple software entities.
|
|
1879
|
+
* @param ids - The IDs of the software to delete.
|
|
1880
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1881
|
+
* @returns The deleted software.
|
|
1882
|
+
*/
|
|
357
1883
|
deleteSoftwares(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteSoftwaresMutation>;
|
|
1884
|
+
/**
|
|
1885
|
+
* Deletes all software based on the provided filter criteria.
|
|
1886
|
+
* @param filter - The filter criteria to apply when deleting software.
|
|
1887
|
+
* @param isSynchronous - Whether this mutation is synchronous.
|
|
1888
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1889
|
+
* @returns The result of the deletion.
|
|
1890
|
+
*/
|
|
358
1891
|
deleteAllSoftwares(filter?: Types.SoftwareFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllSoftwaresMutation>;
|
|
1892
|
+
/**
|
|
1893
|
+
* Lookup a software given its ID.
|
|
1894
|
+
* @param id - ID of the software.
|
|
1895
|
+
* @returns The software.
|
|
1896
|
+
*/
|
|
359
1897
|
getSoftware(id: string): Promise<Types.GetSoftwareQuery>;
|
|
1898
|
+
/**
|
|
1899
|
+
* Retrieves software based on the provided filter criteria.
|
|
1900
|
+
* @param filter - The filter criteria to apply when retrieving software.
|
|
1901
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1902
|
+
* @returns The software.
|
|
1903
|
+
*/
|
|
360
1904
|
querySoftwares(filter?: Types.SoftwareFilter, correlationId?: string): Promise<Types.QuerySoftwaresQuery>;
|
|
1905
|
+
/**
|
|
1906
|
+
* Retrieves software with clustering information.
|
|
1907
|
+
* @param filter - The filter criteria to apply when retrieving software.
|
|
1908
|
+
* @param clusters - The clustering configuration.
|
|
1909
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1910
|
+
* @returns The software with clusters.
|
|
1911
|
+
*/
|
|
361
1912
|
querySoftwaresClusters(filter?: Types.SoftwareFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QuerySoftwaresClustersQuery>;
|
|
1913
|
+
/**
|
|
1914
|
+
* Counts software based on the provided filter criteria.
|
|
1915
|
+
* @param filter - The filter criteria to apply when counting software.
|
|
1916
|
+
* @param correlationId - The tenant correlation identifier, optional.
|
|
1917
|
+
* @returns The count of software.
|
|
1918
|
+
*/
|
|
362
1919
|
countSoftwares(filter?: Types.SoftwareFilter, correlationId?: string): Promise<Types.CountSoftwaresQuery>;
|
|
1920
|
+
/** Creates a medical condition entity. */
|
|
363
1921
|
createMedicalCondition(MedicalCondition: Types.MedicalConditionInput): Promise<Types.CreateMedicalConditionMutation>;
|
|
1922
|
+
/** Updates a medical condition entity. */
|
|
364
1923
|
updateMedicalCondition(MedicalCondition: Types.MedicalConditionUpdateInput): Promise<Types.UpdateMedicalConditionMutation>;
|
|
1924
|
+
/** Deletes a medical condition entity. */
|
|
365
1925
|
deleteMedicalCondition(id: string): Promise<Types.DeleteMedicalConditionMutation>;
|
|
1926
|
+
/** Deletes multiple medical condition entities. */
|
|
366
1927
|
deleteMedicalConditions(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalConditionsMutation>;
|
|
1928
|
+
/** Deletes all medical conditions based on filter criteria. */
|
|
367
1929
|
deleteAllMedicalConditions(filter?: Types.MedicalConditionFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalConditionsMutation>;
|
|
1930
|
+
/** Lookup a medical condition given its ID. */
|
|
368
1931
|
getMedicalCondition(id: string): Promise<Types.GetMedicalConditionQuery>;
|
|
1932
|
+
/** Retrieves medical conditions based on filter criteria. */
|
|
369
1933
|
queryMedicalConditions(filter?: Types.MedicalConditionFilter, correlationId?: string): Promise<Types.QueryMedicalConditionsQuery>;
|
|
1934
|
+
/** Retrieves medical conditions with clustering information. */
|
|
370
1935
|
queryMedicalConditionsClusters(filter?: Types.MedicalConditionFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalConditionsClustersQuery>;
|
|
1936
|
+
/** Counts medical conditions based on filter criteria. */
|
|
371
1937
|
countMedicalConditions(filter?: Types.MedicalConditionFilter, correlationId?: string): Promise<Types.CountMedicalConditionsQuery>;
|
|
1938
|
+
/** Creates a medical guideline entity. */
|
|
372
1939
|
createMedicalGuideline(MedicalGuideline: Types.MedicalGuidelineInput): Promise<Types.CreateMedicalGuidelineMutation>;
|
|
1940
|
+
/** Updates a medical guideline entity. */
|
|
373
1941
|
updateMedicalGuideline(MedicalGuideline: Types.MedicalGuidelineUpdateInput): Promise<Types.UpdateMedicalGuidelineMutation>;
|
|
1942
|
+
/** Deletes a medical guideline entity. */
|
|
374
1943
|
deleteMedicalGuideline(id: string): Promise<Types.DeleteMedicalGuidelineMutation>;
|
|
1944
|
+
/** Deletes multiple medical guideline entities. */
|
|
375
1945
|
deleteMedicalGuidelines(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalGuidelinesMutation>;
|
|
1946
|
+
/** Deletes all medical guidelines based on filter criteria. */
|
|
376
1947
|
deleteAllMedicalGuidelines(filter?: Types.MedicalGuidelineFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalGuidelinesMutation>;
|
|
1948
|
+
/** Lookup a medical guideline given its ID. */
|
|
377
1949
|
getMedicalGuideline(id: string): Promise<Types.GetMedicalGuidelineQuery>;
|
|
1950
|
+
/** Retrieves medical guidelines based on filter criteria. */
|
|
378
1951
|
queryMedicalGuidelines(filter?: Types.MedicalGuidelineFilter, correlationId?: string): Promise<Types.QueryMedicalGuidelinesQuery>;
|
|
1952
|
+
/** Retrieves medical guidelines with clustering information. */
|
|
379
1953
|
queryMedicalGuidelinesClusters(filter?: Types.MedicalGuidelineFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalGuidelinesClustersQuery>;
|
|
380
1954
|
countMedicalGuidelines(filter?: Types.MedicalGuidelineFilter, correlationId?: string): Promise<Types.CountMedicalGuidelinesQuery>;
|
|
1955
|
+
/** Creates a medical drug entity. */
|
|
381
1956
|
createMedicalDrug(MedicalDrug: Types.MedicalDrugInput): Promise<Types.CreateMedicalDrugMutation>;
|
|
1957
|
+
/** Updates a medical drug entity. */
|
|
382
1958
|
updateMedicalDrug(MedicalDrug: Types.MedicalDrugUpdateInput): Promise<Types.UpdateMedicalDrugMutation>;
|
|
1959
|
+
/** Deletes a medical drug entity. */
|
|
383
1960
|
deleteMedicalDrug(id: string): Promise<Types.DeleteMedicalDrugMutation>;
|
|
1961
|
+
/** Deletes multiple medical drug entities. */
|
|
384
1962
|
deleteMedicalDrugs(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalDrugsMutation>;
|
|
1963
|
+
/** Deletes all medical drugs based on filter criteria. */
|
|
385
1964
|
deleteAllMedicalDrugs(filter?: Types.MedicalDrugFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalDrugsMutation>;
|
|
1965
|
+
/** Lookup a medical drug given its ID. */
|
|
386
1966
|
getMedicalDrug(id: string): Promise<Types.GetMedicalDrugQuery>;
|
|
1967
|
+
/** Retrieves medical drugs based on filter criteria. */
|
|
387
1968
|
queryMedicalDrugs(filter?: Types.MedicalDrugFilter, correlationId?: string): Promise<Types.QueryMedicalDrugsQuery>;
|
|
1969
|
+
/** Retrieves medical drugs with clustering information. */
|
|
388
1970
|
queryMedicalDrugsClusters(filter?: Types.MedicalDrugFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalDrugsClustersQuery>;
|
|
1971
|
+
/** Counts medical drugs based on filter criteria. */
|
|
389
1972
|
countMedicalDrugs(filter?: Types.MedicalDrugFilter, correlationId?: string): Promise<Types.CountMedicalDrugsQuery>;
|
|
1973
|
+
/** Creates a medical indication entity. */
|
|
390
1974
|
createMedicalIndication(MedicalIndication: Types.MedicalIndicationInput): Promise<Types.CreateMedicalIndicationMutation>;
|
|
1975
|
+
/** Updates a medical indication entity. */
|
|
391
1976
|
updateMedicalIndication(MedicalIndication: Types.MedicalIndicationUpdateInput): Promise<Types.UpdateMedicalIndicationMutation>;
|
|
1977
|
+
/** Deletes a medical indication entity. */
|
|
392
1978
|
deleteMedicalIndication(id: string): Promise<Types.DeleteMedicalIndicationMutation>;
|
|
1979
|
+
/** Deletes multiple medical indication entities. */
|
|
393
1980
|
deleteMedicalIndications(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalIndicationsMutation>;
|
|
1981
|
+
/** Deletes all medical indications based on filter criteria. */
|
|
394
1982
|
deleteAllMedicalIndications(filter?: Types.MedicalIndicationFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalIndicationsMutation>;
|
|
1983
|
+
/** Lookup a medical indication given its ID. */
|
|
395
1984
|
getMedicalIndication(id: string): Promise<Types.GetMedicalIndicationQuery>;
|
|
1985
|
+
/** Retrieves medical indications based on filter criteria. */
|
|
396
1986
|
queryMedicalIndications(filter?: Types.MedicalIndicationFilter, correlationId?: string): Promise<Types.QueryMedicalIndicationsQuery>;
|
|
1987
|
+
/** Retrieves medical indications with clustering information. */
|
|
397
1988
|
queryMedicalIndicationsClusters(filter?: Types.MedicalIndicationFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalIndicationsClustersQuery>;
|
|
1989
|
+
/** Counts medical indications based on filter criteria. */
|
|
398
1990
|
countMedicalIndications(filter?: Types.MedicalIndicationFilter, correlationId?: string): Promise<Types.CountMedicalIndicationsQuery>;
|
|
1991
|
+
/** Creates a medical contraindication entity. */
|
|
399
1992
|
createMedicalContraindication(MedicalContraindication: Types.MedicalContraindicationInput): Promise<Types.CreateMedicalContraindicationMutation>;
|
|
1993
|
+
/** Updates a medical contraindication entity. */
|
|
400
1994
|
updateMedicalContraindication(MedicalContraindication: Types.MedicalContraindicationUpdateInput): Promise<Types.UpdateMedicalContraindicationMutation>;
|
|
1995
|
+
/** Deletes a medical contraindication entity. */
|
|
401
1996
|
deleteMedicalContraindication(id: string): Promise<Types.DeleteMedicalContraindicationMutation>;
|
|
1997
|
+
/** Deletes multiple medical contraindication entities. */
|
|
402
1998
|
deleteMedicalContraindications(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalContraindicationsMutation>;
|
|
1999
|
+
/** Deletes all medical contraindications based on filter criteria. */
|
|
403
2000
|
deleteAllMedicalContraindications(filter?: Types.MedicalContraindicationFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalContraindicationsMutation>;
|
|
2001
|
+
/** Lookup a medical contraindication given its ID. */
|
|
404
2002
|
getMedicalContraindication(id: string): Promise<Types.GetMedicalContraindicationQuery>;
|
|
2003
|
+
/** Retrieves medical contraindications based on filter criteria. */
|
|
405
2004
|
queryMedicalContraindications(filter?: Types.MedicalContraindicationFilter, correlationId?: string): Promise<Types.QueryMedicalContraindicationsQuery>;
|
|
2005
|
+
/** Retrieves medical contraindications with clustering information. */
|
|
406
2006
|
queryMedicalContraindicationsClusters(filter?: Types.MedicalContraindicationFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalContraindicationsClustersQuery>;
|
|
2007
|
+
/** Counts medical contraindications based on filter criteria. */
|
|
407
2008
|
countMedicalContraindications(filter?: Types.MedicalContraindicationFilter, correlationId?: string): Promise<Types.CountMedicalContraindicationsQuery>;
|
|
2009
|
+
/** Creates a medical test entity. */
|
|
408
2010
|
createMedicalTest(MedicalTest: Types.MedicalTestInput): Promise<Types.CreateMedicalTestMutation>;
|
|
2011
|
+
/** Updates a medical test entity. */
|
|
409
2012
|
updateMedicalTest(MedicalTest: Types.MedicalTestUpdateInput): Promise<Types.UpdateMedicalTestMutation>;
|
|
2013
|
+
/** Deletes a medical test entity. */
|
|
410
2014
|
deleteMedicalTest(id: string): Promise<Types.DeleteMedicalTestMutation>;
|
|
2015
|
+
/** Deletes multiple medical test entities. */
|
|
411
2016
|
deleteMedicalTests(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalTestsMutation>;
|
|
2017
|
+
/** Deletes all medical tests based on filter criteria. */
|
|
412
2018
|
deleteAllMedicalTests(filter?: Types.MedicalTestFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalTestsMutation>;
|
|
2019
|
+
/** Lookup a medical test given its ID. */
|
|
413
2020
|
getMedicalTest(id: string): Promise<Types.GetMedicalTestQuery>;
|
|
2021
|
+
/** Retrieves medical tests based on filter criteria. */
|
|
414
2022
|
queryMedicalTests(filter?: Types.MedicalTestFilter, correlationId?: string): Promise<Types.QueryMedicalTestsQuery>;
|
|
2023
|
+
/** Retrieves medical tests with clustering information. */
|
|
415
2024
|
queryMedicalTestsClusters(filter?: Types.MedicalTestFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalTestsClustersQuery>;
|
|
2025
|
+
/** Counts medical tests based on filter criteria. */
|
|
416
2026
|
countMedicalTests(filter?: Types.MedicalTestFilter, correlationId?: string): Promise<Types.CountMedicalTestsQuery>;
|
|
2027
|
+
/** Creates a medical device entity. */
|
|
417
2028
|
createMedicalDevice(MedicalDevice: Types.MedicalDeviceInput): Promise<Types.CreateMedicalDeviceMutation>;
|
|
2029
|
+
/** Updates a medical device entity. */
|
|
418
2030
|
updateMedicalDevice(MedicalDevice: Types.MedicalDeviceUpdateInput): Promise<Types.UpdateMedicalDeviceMutation>;
|
|
2031
|
+
/** Deletes a medical device entity. */
|
|
419
2032
|
deleteMedicalDevice(id: string): Promise<Types.DeleteMedicalDeviceMutation>;
|
|
2033
|
+
/** Deletes multiple medical device entities. */
|
|
420
2034
|
deleteMedicalDevices(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalDevicesMutation>;
|
|
2035
|
+
/** Deletes all medical devices based on filter criteria. */
|
|
421
2036
|
deleteAllMedicalDevices(filter?: Types.MedicalDeviceFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalDevicesMutation>;
|
|
2037
|
+
/** Lookup a medical device given its ID. */
|
|
422
2038
|
getMedicalDevice(id: string): Promise<Types.GetMedicalDeviceQuery>;
|
|
2039
|
+
/** Retrieves medical devices based on filter criteria. */
|
|
423
2040
|
queryMedicalDevices(filter?: Types.MedicalDeviceFilter, correlationId?: string): Promise<Types.QueryMedicalDevicesQuery>;
|
|
2041
|
+
/** Retrieves medical devices with clustering information. */
|
|
424
2042
|
queryMedicalDevicesClusters(filter?: Types.MedicalDeviceFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalDevicesClustersQuery>;
|
|
2043
|
+
/** Counts medical devices based on filter criteria. */
|
|
425
2044
|
countMedicalDevices(filter?: Types.MedicalDeviceFilter, correlationId?: string): Promise<Types.CountMedicalDevicesQuery>;
|
|
2045
|
+
/** Creates a medical procedure entity. */
|
|
426
2046
|
createMedicalProcedure(MedicalProcedure: Types.MedicalProcedureInput): Promise<Types.CreateMedicalProcedureMutation>;
|
|
2047
|
+
/** Updates a medical procedure entity. */
|
|
427
2048
|
updateMedicalProcedure(MedicalProcedure: Types.MedicalProcedureUpdateInput): Promise<Types.UpdateMedicalProcedureMutation>;
|
|
2049
|
+
/** Deletes a medical procedure entity. */
|
|
428
2050
|
deleteMedicalProcedure(id: string): Promise<Types.DeleteMedicalProcedureMutation>;
|
|
2051
|
+
/** Deletes multiple medical procedure entities. */
|
|
429
2052
|
deleteMedicalProcedures(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalProceduresMutation>;
|
|
2053
|
+
/** Deletes all medical procedures based on filter criteria. */
|
|
430
2054
|
deleteAllMedicalProcedures(filter?: Types.MedicalProcedureFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalProceduresMutation>;
|
|
2055
|
+
/** Lookup a medical procedure given its ID. */
|
|
431
2056
|
getMedicalProcedure(id: string): Promise<Types.GetMedicalProcedureQuery>;
|
|
2057
|
+
/** Retrieves medical procedures based on filter criteria. */
|
|
432
2058
|
queryMedicalProcedures(filter?: Types.MedicalProcedureFilter, correlationId?: string): Promise<Types.QueryMedicalProceduresQuery>;
|
|
2059
|
+
/** Retrieves medical procedures with clustering information. */
|
|
433
2060
|
queryMedicalProceduresClusters(filter?: Types.MedicalProcedureFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalProceduresClustersQuery>;
|
|
2061
|
+
/** Counts medical procedures based on filter criteria. */
|
|
434
2062
|
countMedicalProcedures(filter?: Types.MedicalProcedureFilter, correlationId?: string): Promise<Types.CountMedicalProceduresQuery>;
|
|
2063
|
+
/** Creates a medical study entity. */
|
|
435
2064
|
createMedicalStudy(MedicalStudy: Types.MedicalStudyInput): Promise<Types.CreateMedicalStudyMutation>;
|
|
2065
|
+
/** Updates a medical study entity. */
|
|
436
2066
|
updateMedicalStudy(MedicalStudy: Types.MedicalStudyUpdateInput): Promise<Types.UpdateMedicalStudyMutation>;
|
|
2067
|
+
/** Deletes a medical study entity. */
|
|
437
2068
|
deleteMedicalStudy(id: string): Promise<Types.DeleteMedicalStudyMutation>;
|
|
2069
|
+
/** Deletes multiple medical study entities. */
|
|
438
2070
|
deleteMedicalStudies(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalStudiesMutation>;
|
|
2071
|
+
/** Deletes all medical studies based on filter criteria. */
|
|
439
2072
|
deleteAllMedicalStudies(filter?: Types.MedicalStudyFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalStudiesMutation>;
|
|
2073
|
+
/** Lookup a medical study given its ID. */
|
|
440
2074
|
getMedicalStudy(id: string): Promise<Types.GetMedicalStudyQuery>;
|
|
2075
|
+
/** Retrieves medical studies based on filter criteria. */
|
|
441
2076
|
queryMedicalStudies(filter?: Types.MedicalStudyFilter, correlationId?: string): Promise<Types.QueryMedicalStudiesQuery>;
|
|
2077
|
+
/** Retrieves medical studies with clustering information. */
|
|
442
2078
|
queryMedicalStudiesClusters(filter?: Types.MedicalStudyFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalStudiesClustersQuery>;
|
|
2079
|
+
/** Counts medical studies based on filter criteria. */
|
|
443
2080
|
countMedicalStudies(filter?: Types.MedicalStudyFilter, correlationId?: string): Promise<Types.CountMedicalStudiesQuery>;
|
|
2081
|
+
/** Creates a medical drug class entity. */
|
|
444
2082
|
createMedicalDrugClass(MedicalDrugClass: Types.MedicalDrugClassInput): Promise<Types.CreateMedicalDrugClassMutation>;
|
|
2083
|
+
/** Updates a medical drug class entity. */
|
|
445
2084
|
updateMedicalDrugClass(MedicalDrugClass: Types.MedicalDrugClassUpdateInput): Promise<Types.UpdateMedicalDrugClassMutation>;
|
|
2085
|
+
/** Deletes a medical drug class entity. */
|
|
446
2086
|
deleteMedicalDrugClass(id: string): Promise<Types.DeleteMedicalDrugClassMutation>;
|
|
2087
|
+
/** Deletes multiple medical drug class entities. */
|
|
447
2088
|
deleteMedicalDrugClasses(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalDrugClassesMutation>;
|
|
2089
|
+
/** Deletes all medical drug classes based on filter criteria. */
|
|
448
2090
|
deleteAllMedicalDrugClasses(filter?: Types.MedicalDrugClassFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalDrugClassesMutation>;
|
|
2091
|
+
/** Lookup a medical drug class given its ID. */
|
|
449
2092
|
getMedicalDrugClass(id: string): Promise<Types.GetMedicalDrugClassQuery>;
|
|
2093
|
+
/** Retrieves medical drug classes based on filter criteria. */
|
|
450
2094
|
queryMedicalDrugClasses(filter?: Types.MedicalDrugClassFilter, correlationId?: string): Promise<Types.QueryMedicalDrugClassesQuery>;
|
|
2095
|
+
/** Retrieves medical drug classes with clustering information. */
|
|
451
2096
|
queryMedicalDrugClassesClusters(filter?: Types.MedicalDrugClassFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalDrugClassesClustersQuery>;
|
|
2097
|
+
/** Counts medical drug classes based on filter criteria. */
|
|
452
2098
|
countMedicalDrugClasses(filter?: Types.MedicalDrugClassFilter, correlationId?: string): Promise<Types.CountMedicalDrugClassesQuery>;
|
|
2099
|
+
/** Creates a medical therapy entity. */
|
|
453
2100
|
createMedicalTherapy(MedicalTherapy: Types.MedicalTherapyInput): Promise<Types.CreateMedicalTherapyMutation>;
|
|
2101
|
+
/** Updates a medical therapy entity. */
|
|
454
2102
|
updateMedicalTherapy(MedicalTherapy: Types.MedicalTherapyUpdateInput): Promise<Types.UpdateMedicalTherapyMutation>;
|
|
2103
|
+
/** Deletes a medical therapy entity. */
|
|
455
2104
|
deleteMedicalTherapy(id: string): Promise<Types.DeleteMedicalTherapyMutation>;
|
|
2105
|
+
/** Deletes multiple medical therapy entities. */
|
|
456
2106
|
deleteMedicalTherapies(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteMedicalTherapiesMutation>;
|
|
2107
|
+
/** Deletes all medical therapies based on filter criteria. */
|
|
457
2108
|
deleteAllMedicalTherapies(filter?: Types.MedicalTherapyFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllMedicalTherapiesMutation>;
|
|
2109
|
+
/** Lookup a medical therapy given its ID. */
|
|
458
2110
|
getMedicalTherapy(id: string): Promise<Types.GetMedicalTherapyQuery>;
|
|
2111
|
+
/** Retrieves medical therapies based on filter criteria. */
|
|
459
2112
|
queryMedicalTherapies(filter?: Types.MedicalTherapyFilter, correlationId?: string): Promise<Types.QueryMedicalTherapiesQuery>;
|
|
2113
|
+
/** Retrieves medical therapies with clustering information. */
|
|
460
2114
|
queryMedicalTherapiesClusters(filter?: Types.MedicalTherapyFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryMedicalTherapiesClustersQuery>;
|
|
2115
|
+
/** Counts medical therapies based on filter criteria. */
|
|
461
2116
|
countMedicalTherapies(filter?: Types.MedicalTherapyFilter, correlationId?: string): Promise<Types.CountMedicalTherapiesQuery>;
|
|
2117
|
+
/** Creates an observation entity. */
|
|
462
2118
|
createObservation(observation: Types.ObservationInput): Promise<Types.CreateObservationMutation>;
|
|
2119
|
+
/** Updates an observation entity. */
|
|
463
2120
|
updateObservation(observation: Types.ObservationUpdateInput): Promise<Types.UpdateObservationMutation>;
|
|
2121
|
+
/** Deletes an observation entity. */
|
|
464
2122
|
deleteObservation(id: string): Promise<Types.DeleteObservationMutation>;
|
|
2123
|
+
/** Matches an observable against candidate entities using AI. */
|
|
465
2124
|
matchEntity(observable: Types.ObservableInput, candidates: Types.EntityReferenceInput[], specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.MatchEntityMutation>;
|
|
2125
|
+
/** Resolves multiple entities of a given type using AI similarity matching. */
|
|
466
2126
|
resolveEntities(type: Types.ObservableTypes, entities: Types.EntityReferenceInput[], threshold?: number, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ResolveEntitiesMutation>;
|
|
2127
|
+
/** Resolves a source entity against a target entity using AI similarity matching. */
|
|
467
2128
|
resolveEntity(type: Types.ObservableTypes, source: Types.EntityReferenceInput, target: Types.EntityReferenceInput, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ResolveEntityMutation>;
|
|
2129
|
+
/** Creates an investment entity. */
|
|
468
2130
|
createInvestment(investment: Types.InvestmentInput): Promise<Types.CreateInvestmentMutation>;
|
|
2131
|
+
/** Updates an investment entity. */
|
|
469
2132
|
updateInvestment(investment: Types.InvestmentUpdateInput): Promise<Types.UpdateInvestmentMutation>;
|
|
2133
|
+
/** Deletes an investment entity. */
|
|
470
2134
|
deleteInvestment(id: string): Promise<Types.DeleteInvestmentMutation>;
|
|
2135
|
+
/** Deletes multiple investment entities. */
|
|
471
2136
|
deleteInvestments(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteInvestmentsMutation>;
|
|
2137
|
+
/** Deletes all investments based on filter criteria. */
|
|
472
2138
|
deleteAllInvestments(filter?: Types.InvestmentFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllInvestmentsMutation>;
|
|
2139
|
+
/** Creates an investment fund entity. */
|
|
473
2140
|
createInvestmentFund(investmentFund: Types.InvestmentFundInput): Promise<Types.CreateInvestmentFundMutation>;
|
|
2141
|
+
/** Updates an investment fund entity. */
|
|
474
2142
|
updateInvestmentFund(investmentFund: Types.InvestmentFundUpdateInput): Promise<Types.UpdateInvestmentFundMutation>;
|
|
2143
|
+
/** Deletes an investment fund entity. */
|
|
475
2144
|
deleteInvestmentFund(id: string): Promise<Types.DeleteInvestmentFundMutation>;
|
|
2145
|
+
/** Deletes multiple investment fund entities. */
|
|
476
2146
|
deleteInvestmentFunds(ids: string[], isSynchronous?: boolean): Promise<Types.DeleteInvestmentFundsMutation>;
|
|
2147
|
+
/** Deletes all investment funds based on filter criteria. */
|
|
477
2148
|
deleteAllInvestmentFunds(filter?: Types.InvestmentFundFilter, isSynchronous?: boolean, correlationId?: string): Promise<Types.DeleteAllInvestmentFundsMutation>;
|
|
2149
|
+
/** Lookup an investment given its ID. */
|
|
478
2150
|
getInvestment(id: string, correlationId?: string): Promise<Types.GetInvestmentQuery>;
|
|
2151
|
+
/** Retrieves investments based on filter criteria. */
|
|
479
2152
|
queryInvestments(filter?: Types.InvestmentFilter, correlationId?: string): Promise<Types.QueryInvestmentsQuery>;
|
|
2153
|
+
/** Retrieves investments with clustering information. */
|
|
480
2154
|
queryInvestmentsClusters(filter?: Types.InvestmentFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryInvestmentsClustersQuery>;
|
|
2155
|
+
/** Retrieves investments with expanded relationship data. */
|
|
481
2156
|
queryInvestmentsExpanded(filter?: Types.InvestmentFilter, correlationId?: string): Promise<Types.QueryInvestmentsExpandedQuery>;
|
|
2157
|
+
/** Counts investments based on filter criteria. */
|
|
482
2158
|
countInvestments(filter?: Types.InvestmentFilter, correlationId?: string): Promise<Types.CountInvestmentsQuery>;
|
|
2159
|
+
/** Lookup an investment fund given its ID. */
|
|
483
2160
|
getInvestmentFund(id: string, correlationId?: string): Promise<Types.GetInvestmentFundQuery>;
|
|
2161
|
+
/** Retrieves investment funds based on filter criteria. */
|
|
484
2162
|
queryInvestmentFunds(filter?: Types.InvestmentFundFilter, correlationId?: string): Promise<Types.QueryInvestmentFundsQuery>;
|
|
2163
|
+
/** Retrieves investment funds with clustering information. */
|
|
485
2164
|
queryInvestmentFundsClusters(filter?: Types.InvestmentFundFilter, clusters?: Types.EntityClustersInput, correlationId?: string): Promise<Types.QueryInvestmentFundsClustersQuery>;
|
|
2165
|
+
/** Retrieves investment funds with expanded relationship data. */
|
|
486
2166
|
queryInvestmentFundsExpanded(filter?: Types.InvestmentFundFilter, correlationId?: string): Promise<Types.QueryInvestmentFundsExpandedQuery>;
|
|
2167
|
+
/** Counts investment funds based on filter criteria. */
|
|
487
2168
|
countInvestmentFunds(filter?: Types.InvestmentFundFilter, correlationId?: string): Promise<Types.CountInvestmentFundsQuery>;
|
|
488
2169
|
/**
|
|
489
2170
|
* Creates an event handler that supports UI streaming mode
|