@squidcloud/freshdesk-client 1.0.514 → 1.0.515
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.
|
@@ -4,12 +4,6 @@ import { AiKnowledgeBaseId, IntegrationId } from './communication.public-types';
|
|
|
4
4
|
* @category AI
|
|
5
5
|
*/
|
|
6
6
|
export type AiOntologyId = string;
|
|
7
|
-
/**
|
|
8
|
-
* Review state of an ontology relationship. Only accepted relationships reach models. Imports and generation save
|
|
9
|
-
* `accepted` rows; a row without `reviewedAt` and with a source other than `human` is unreviewed.
|
|
10
|
-
* @category AI
|
|
11
|
-
*/
|
|
12
|
-
export type AiOntologyRelationshipStatus = 'suggested' | 'accepted' | 'rejected';
|
|
13
7
|
/**
|
|
14
8
|
* Where an ontology relationship came from. `declared` covers declared and manual schema associations.
|
|
15
9
|
* @category AI
|
|
@@ -68,17 +62,18 @@ export interface AiOntologyGenerationRun {
|
|
|
68
62
|
startedAt: number;
|
|
69
63
|
/** End time in epoch milliseconds. */
|
|
70
64
|
endedAt?: number;
|
|
71
|
-
/** How many relationships the run
|
|
65
|
+
/** How many relationships the run proposes to add. */
|
|
72
66
|
relationshipsAdded: number;
|
|
73
|
-
/**
|
|
74
|
-
* How many unreviewed imported relationships labelled with their association name the run gave a business label. It
|
|
75
|
-
* changes nothing else of a stored row.
|
|
76
|
-
*/
|
|
67
|
+
/** How many imported relationships labelled with their association name the run gave a business label. */
|
|
77
68
|
relationshipsRenamed?: number;
|
|
78
|
-
/** How many business entities the run
|
|
69
|
+
/** How many business entities the run proposes to add. */
|
|
79
70
|
entitiesAdded: number;
|
|
80
|
-
/** How many properties the run
|
|
71
|
+
/** How many properties the run proposes to add. */
|
|
81
72
|
propertiesAdded: number;
|
|
73
|
+
/** How many relationships, entities and properties the run proposes to remove. */
|
|
74
|
+
rowsRemoved?: number;
|
|
75
|
+
/** Whether the run left a result to read with {@link GetAiOntologyGenerationResultRequest}. */
|
|
76
|
+
hasResult?: boolean;
|
|
82
77
|
/** Things the run left out. */
|
|
83
78
|
warnings: string[];
|
|
84
79
|
/** The failure, when the run failed. */
|
|
@@ -104,36 +99,17 @@ export interface AiOntology {
|
|
|
104
99
|
* only: generation proposes nothing just because a term exists.
|
|
105
100
|
*/
|
|
106
101
|
glossaryIds: string[];
|
|
107
|
-
/**
|
|
108
|
-
* The rows a regenerate no longer found and proposes to delete. They stay in use until
|
|
109
|
-
* {@link ReviewAiOntologyGenerationRequest} accepts their removal.
|
|
110
|
-
*/
|
|
111
|
-
pendingRemovals?: AiOntologyPendingRemovals;
|
|
112
102
|
/** The last run that generated relationships, business entities or properties. */
|
|
113
103
|
lastGenerationRun?: AiOntologyGenerationRun;
|
|
114
|
-
/** Number of
|
|
115
|
-
|
|
116
|
-
/** Number of
|
|
117
|
-
|
|
104
|
+
/** Number of relationships. Set only on the ontologies of a list. */
|
|
105
|
+
relationshipCount?: number;
|
|
106
|
+
/** Number of business entities. Set only on the ontologies of a list. */
|
|
107
|
+
entityCount?: number;
|
|
118
108
|
/** Creation time in epoch milliseconds. */
|
|
119
109
|
createdAt: number;
|
|
120
110
|
/** Last update time in epoch milliseconds. */
|
|
121
111
|
updatedAt: number;
|
|
122
112
|
}
|
|
123
|
-
/**
|
|
124
|
-
* The rows of an ontology a regenerate proposes to delete: AI-generated rows it did not find again.
|
|
125
|
-
* @category AI
|
|
126
|
-
*/
|
|
127
|
-
export interface AiOntologyPendingRemovals {
|
|
128
|
-
/** Ids of relationships. */
|
|
129
|
-
relationshipIds: string[];
|
|
130
|
-
/** Ids of business entities. */
|
|
131
|
-
entityIds: string[];
|
|
132
|
-
/** Ids of properties. */
|
|
133
|
-
propertyIds: string[];
|
|
134
|
-
/** When the run that proposed them started, in epoch milliseconds; a row changed since is kept on review. */
|
|
135
|
-
proposedAt?: number;
|
|
136
|
-
}
|
|
137
113
|
/**
|
|
138
114
|
* A relationship between two tables of an ontology.
|
|
139
115
|
* @category AI
|
|
@@ -153,9 +129,7 @@ export interface AiOntologyRelationship {
|
|
|
153
129
|
label: string;
|
|
154
130
|
/** What the relationship means. */
|
|
155
131
|
description?: string;
|
|
156
|
-
/**
|
|
157
|
-
status: AiOntologyRelationshipStatus;
|
|
158
|
-
/** Where the relationship came from. */
|
|
132
|
+
/** Where the relationship came from. A person's edit makes it `human`, which imports and runs leave alone. */
|
|
159
133
|
source: AiOntologyRelationshipSource;
|
|
160
134
|
/** From 0 to 1, when inference or a model proposed the relationship. */
|
|
161
135
|
confidence?: number;
|
|
@@ -174,8 +148,8 @@ export interface AiOntologyRelationship {
|
|
|
174
148
|
/**
|
|
175
149
|
* Output only: the entity of the referencing side on this read. The stored choice when it is still eligible, else
|
|
176
150
|
* none; with no choice stored, the only eligible entity that has the table as a member, else the only one that has it
|
|
177
|
-
* as a supporting table. An eligible entity is in the ontology
|
|
178
|
-
*
|
|
151
|
+
* as a supporting table. An eligible entity is in the ontology and has the side's table as a member or a supporting
|
|
152
|
+
* table.
|
|
179
153
|
*/
|
|
180
154
|
resolvedFromEntityId?: string;
|
|
181
155
|
/** Output only: the entity of the referenced side on this read, resolved as `resolvedFromEntityId` is. */
|
|
@@ -186,10 +160,6 @@ export interface AiOntologyRelationship {
|
|
|
186
160
|
createdAt: number;
|
|
187
161
|
/** Last update time in epoch milliseconds. */
|
|
188
162
|
updatedAt: number;
|
|
189
|
-
/** Who accepted or rejected the relationship. The caller's claim, not an authenticated identity. */
|
|
190
|
-
reviewedBy?: string;
|
|
191
|
-
/** When the relationship was reviewed, in epoch milliseconds. */
|
|
192
|
-
reviewedAt?: number;
|
|
193
163
|
}
|
|
194
164
|
/**
|
|
195
165
|
* The editable fields of an ontology relationship.
|
|
@@ -205,8 +175,7 @@ export interface AiOntologyRelationshipInput {
|
|
|
205
175
|
/** What the relationship means. */
|
|
206
176
|
description?: string;
|
|
207
177
|
/**
|
|
208
|
-
* The entity of the referencing side: one of the ontology
|
|
209
|
-
* supporting table. On update an omitted value, or the stored one sent back, is kept without being checked again;
|
|
178
|
+
* The entity of the referencing side: one of the ontology with the side's table as a member or a supporting table. On update an omitted value, or the stored one sent back, is kept without being checked again;
|
|
210
179
|
* `null` clears it. When the update moves the side to another table, a value sent is checked, and an omitted one
|
|
211
180
|
* the new table makes invalid is removed.
|
|
212
181
|
*/
|
|
@@ -251,7 +220,7 @@ export interface GetAiOntologyResponse {
|
|
|
251
220
|
export interface AiOntologyResponse {
|
|
252
221
|
/** The ontology. */
|
|
253
222
|
ontology: AiOntology;
|
|
254
|
-
/** Things the request left out
|
|
223
|
+
/** Things the request left out. */
|
|
255
224
|
warnings: string[];
|
|
256
225
|
}
|
|
257
226
|
/**
|
|
@@ -311,8 +280,6 @@ export interface DeleteAiOntologyRequest {
|
|
|
311
280
|
export interface ListAiOntologyRelationshipsRequest {
|
|
312
281
|
/** Id of the ontology. */
|
|
313
282
|
ontologyId: AiOntologyId;
|
|
314
|
-
/** Returns only relationships in this state. */
|
|
315
|
-
status?: AiOntologyRelationshipStatus;
|
|
316
283
|
}
|
|
317
284
|
/**
|
|
318
285
|
* Response to {@link ListAiOntologyRelationshipsRequest}.
|
|
@@ -447,14 +414,12 @@ export interface FollowAiOntologyRelationshipResponse {
|
|
|
447
414
|
note: string;
|
|
448
415
|
}
|
|
449
416
|
/**
|
|
450
|
-
* Request to create
|
|
417
|
+
* Request to create a relationship by hand. It is saved at once.
|
|
451
418
|
* @category AI
|
|
452
419
|
*/
|
|
453
420
|
export interface CreateAiOntologyRelationshipRequest extends AiOntologyRelationshipInput {
|
|
454
421
|
/** Id of the ontology. */
|
|
455
422
|
ontologyId: AiOntologyId;
|
|
456
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
457
|
-
actor?: string;
|
|
458
423
|
}
|
|
459
424
|
/**
|
|
460
425
|
* Request to update a relationship. It replaces the sides, label and description; an omitted `fromEntityId`,
|
|
@@ -482,21 +447,6 @@ export interface DeleteAiOntologyRelationshipRequest {
|
|
|
482
447
|
/** Id of the relationship. */
|
|
483
448
|
id: string;
|
|
484
449
|
}
|
|
485
|
-
/**
|
|
486
|
-
* Request to accept, reject or reset a relationship.
|
|
487
|
-
* @category AI
|
|
488
|
-
*/
|
|
489
|
-
export interface ReviewAiOntologyRelationshipRequest {
|
|
490
|
-
/** Id of the relationship. */
|
|
491
|
-
id: string;
|
|
492
|
-
/**
|
|
493
|
-
* The decision. `reset` returns the relationship to suggested and clears `reviewedAt`, so the next import may refresh
|
|
494
|
-
* or delete an imported row.
|
|
495
|
-
*/
|
|
496
|
-
decision: 'accept' | 'reject' | 'reset';
|
|
497
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
498
|
-
actor?: string;
|
|
499
|
-
}
|
|
500
450
|
/**
|
|
501
451
|
* Where a business entity came from.
|
|
502
452
|
* @category AI
|
|
@@ -557,9 +507,7 @@ export interface AiOntologyEntity {
|
|
|
557
507
|
* agent that cannot read one of the tables sees the entity without its description.
|
|
558
508
|
*/
|
|
559
509
|
supportingTables?: AiOntologySupportingTable[];
|
|
560
|
-
/**
|
|
561
|
-
status: AiOntologyRelationshipStatus;
|
|
562
|
-
/** Where the entity came from. */
|
|
510
|
+
/** Where the entity came from. A person's edit makes it `human`, which runs leave alone. */
|
|
563
511
|
source: AiOntologyEntitySource;
|
|
564
512
|
/** Why the entity was proposed. */
|
|
565
513
|
reasoning?: string;
|
|
@@ -567,10 +515,6 @@ export interface AiOntologyEntity {
|
|
|
567
515
|
createdAt: number;
|
|
568
516
|
/** Last update time in epoch milliseconds. */
|
|
569
517
|
updatedAt: number;
|
|
570
|
-
/** Who accepted or rejected the entity. The caller's claim, not an authenticated identity. */
|
|
571
|
-
reviewedBy?: string;
|
|
572
|
-
/** When the entity was reviewed, in epoch milliseconds. */
|
|
573
|
-
reviewedAt?: number;
|
|
574
518
|
}
|
|
575
519
|
/**
|
|
576
520
|
* The editable fields of a business entity.
|
|
@@ -593,8 +537,6 @@ export interface AiOntologyEntityInput {
|
|
|
593
537
|
export interface ListAiOntologyEntitiesRequest {
|
|
594
538
|
/** Id of the ontology. */
|
|
595
539
|
ontologyId: AiOntologyId;
|
|
596
|
-
/** Returns only entities in this state. */
|
|
597
|
-
status?: AiOntologyRelationshipStatus;
|
|
598
540
|
}
|
|
599
541
|
/**
|
|
600
542
|
* Response to {@link ListAiOntologyEntitiesRequest}.
|
|
@@ -605,14 +547,12 @@ export interface ListAiOntologyEntitiesResponse {
|
|
|
605
547
|
entities: AiOntologyEntity[];
|
|
606
548
|
}
|
|
607
549
|
/**
|
|
608
|
-
* Request to create
|
|
550
|
+
* Request to create a business entity by hand. It is saved at once.
|
|
609
551
|
* @category AI
|
|
610
552
|
*/
|
|
611
553
|
export interface CreateAiOntologyEntityRequest extends AiOntologyEntityInput {
|
|
612
554
|
/** Id of the ontology. */
|
|
613
555
|
ontologyId: AiOntologyId;
|
|
614
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
615
|
-
actor?: string;
|
|
616
556
|
}
|
|
617
557
|
/**
|
|
618
558
|
* Request to update a business entity. It replaces the name, the description and the members.
|
|
@@ -638,18 +578,6 @@ export interface DeleteAiOntologyEntityRequest {
|
|
|
638
578
|
/** Id of the entity. */
|
|
639
579
|
id: string;
|
|
640
580
|
}
|
|
641
|
-
/**
|
|
642
|
-
* Request to accept, reject or reset a business entity.
|
|
643
|
-
* @category AI
|
|
644
|
-
*/
|
|
645
|
-
export interface ReviewAiOntologyEntityRequest {
|
|
646
|
-
/** Id of the entity. */
|
|
647
|
-
id: string;
|
|
648
|
-
/** The decision. `reset` returns the entity to suggested and clears `reviewedAt`. */
|
|
649
|
-
decision: ReviewAiOntologyRelationshipRequest['decision'];
|
|
650
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
651
|
-
actor?: string;
|
|
652
|
-
}
|
|
653
581
|
/**
|
|
654
582
|
* The value type of an entity property.
|
|
655
583
|
* @category AI
|
|
@@ -697,15 +625,13 @@ export interface AiOntologyProperty {
|
|
|
697
625
|
* the only source (`ONTOLOGY_PROPERTY_SUPPORTING_SOURCE_ALONE`).
|
|
698
626
|
*/
|
|
699
627
|
sources: AiOntologyPropertySource[];
|
|
700
|
-
/** More columns a generation run found for a
|
|
628
|
+
/** More columns a generation run found for a property a person made or edited; unused until an update moves them. */
|
|
701
629
|
suggestedSources?: AiOntologyPropertySource[];
|
|
702
630
|
/** What the values reveal; absent means unclassified, not safe. */
|
|
703
631
|
sensitivity?: AiOntologyPropertySensitivity;
|
|
704
632
|
/** `false` keeps the property from agents and AI queries; absent means visible. */
|
|
705
633
|
agentVisible?: boolean;
|
|
706
|
-
/**
|
|
707
|
-
status: AiOntologyRelationshipStatus;
|
|
708
|
-
/** Where the property came from. */
|
|
634
|
+
/** Where the property came from. A person's edit makes it `human`; runs then only suggest sources for it. */
|
|
709
635
|
source: 'ai' | 'human';
|
|
710
636
|
/** Why the property was proposed. */
|
|
711
637
|
reasoning?: string;
|
|
@@ -713,10 +639,6 @@ export interface AiOntologyProperty {
|
|
|
713
639
|
createdAt: number;
|
|
714
640
|
/** Last update time in epoch milliseconds. */
|
|
715
641
|
updatedAt: number;
|
|
716
|
-
/** Who accepted or rejected the property. The caller's claim, not an authenticated identity. */
|
|
717
|
-
reviewedBy?: string;
|
|
718
|
-
/** When the property was reviewed, in epoch milliseconds. */
|
|
719
|
-
reviewedAt?: number;
|
|
720
642
|
}
|
|
721
643
|
/**
|
|
722
644
|
* Request to list the properties of an ontology.
|
|
@@ -727,8 +649,6 @@ export interface ListAiOntologyPropertiesRequest {
|
|
|
727
649
|
ontologyId: AiOntologyId;
|
|
728
650
|
/** Returns only the properties of this entity. */
|
|
729
651
|
entityId?: string;
|
|
730
|
-
/** Returns only properties in this state. */
|
|
731
|
-
status?: AiOntologyRelationshipStatus;
|
|
732
652
|
}
|
|
733
653
|
/**
|
|
734
654
|
* Response to {@link ListAiOntologyPropertiesRequest}.
|
|
@@ -760,8 +680,6 @@ export interface CreateAiOntologyPropertyRequest {
|
|
|
760
680
|
sensitivity?: AiOntologyPropertySensitivity;
|
|
761
681
|
/** `false` keeps the property from agents and AI queries. */
|
|
762
682
|
agentVisible?: boolean;
|
|
763
|
-
/** Review state. Defaults to `accepted`. An accepted or rejected property is stored as reviewed. */
|
|
764
|
-
status?: AiOntologyRelationshipStatus;
|
|
765
683
|
/** Where the property came from. Defaults to `human`. */
|
|
766
684
|
source?: 'ai' | 'human';
|
|
767
685
|
}
|
|
@@ -808,55 +726,24 @@ export interface DeleteAiOntologyPropertyRequest {
|
|
|
808
726
|
id: string;
|
|
809
727
|
}
|
|
810
728
|
/**
|
|
811
|
-
* Request to
|
|
812
|
-
* @
|
|
813
|
-
|
|
814
|
-
export interface ReviewAiOntologyPropertiesRequest {
|
|
815
|
-
/** Ids of the properties. */
|
|
816
|
-
ids: string[];
|
|
817
|
-
/** The decision. `reset` returns the properties to suggested and clears `reviewedAt`. */
|
|
818
|
-
decision: ReviewAiOntologyRelationshipRequest['decision'];
|
|
819
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
820
|
-
actor?: string;
|
|
821
|
-
}
|
|
822
|
-
/**
|
|
823
|
-
* Response to {@link ReviewAiOntologyPropertiesRequest}.
|
|
824
|
-
* @category AI
|
|
825
|
-
*/
|
|
826
|
-
export interface ReviewAiOntologyPropertiesResponse {
|
|
827
|
-
/** The properties the review changed. */
|
|
828
|
-
changed: AiOntologyProperty[];
|
|
829
|
-
/** The properties left as they were, with the reason. */
|
|
830
|
-
skipped: Array<{
|
|
831
|
-
id: string;
|
|
832
|
-
reason: string;
|
|
833
|
-
}>;
|
|
834
|
-
}
|
|
835
|
-
/**
|
|
836
|
-
* Request to generate the relationships, business entities and properties of an ontology. Answered by
|
|
837
|
-
* {@link AiOntologyResponse}.
|
|
729
|
+
* Request to generate the relationships, business entities and properties of an ontology. The run saves nothing: it
|
|
730
|
+
* proposes the whole content, read with {@link GetAiOntologyGenerationResultRequest} and stored with
|
|
731
|
+
* {@link SaveAiOntologyContentRequest}. Answered by {@link AiOntologyResponse}.
|
|
838
732
|
* @category AI
|
|
839
733
|
*/
|
|
840
734
|
export interface GenerateAiOntologyRequest {
|
|
841
735
|
/** Id of the ontology. */
|
|
842
736
|
ontologyId: AiOntologyId;
|
|
843
|
-
/** The status the run saves what it generates with. Defaults to `accepted`; a regenerate always saves `suggested`. */
|
|
844
|
-
saveAs?: AiOntologyGenerationSaveStatus;
|
|
845
737
|
/**
|
|
846
|
-
* Whether the run
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
* {@link AiOntologyKnowledgeBase} describes. With `false` the run first deletes every relationship, business entity,
|
|
850
|
-
* property and knowledge base record, reviewed and hand-made ones included, and generates everything again. That is
|
|
851
|
-
* refused with `ONTOLOGY_HAS_NO_SOURCES` when nothing is attached, and fails, deleting nothing, when a database has
|
|
852
|
-
* no stored schema or a knowledge base is gone or may not be in an ontology.
|
|
738
|
+
* Whether the run starts from the stored content. Defaults to `true`: it adds to the stored rows, refreshes the
|
|
739
|
+
* imported relationships people did not edit and removes those whose association is gone. With `false` it starts
|
|
740
|
+
* from nothing and generates everything again, refused with `ONTOLOGY_HAS_NO_SOURCES` when nothing is attached.
|
|
853
741
|
*/
|
|
854
742
|
usePreviousOntology?: boolean;
|
|
855
743
|
/**
|
|
856
|
-
* `update` (the default) adds what is missing. `regenerate` reads the sources without the AI-generated rows
|
|
857
|
-
*
|
|
858
|
-
*
|
|
859
|
-
* (`ONTOLOGY_REGENERATE_STARTS_OVER`).
|
|
744
|
+
* `update` (the default) adds what is missing. `regenerate` reads the sources without the AI-generated rows and
|
|
745
|
+
* proposes removing those it does not find again; rows people made or edited stay. It needs `usePreviousOntology`
|
|
746
|
+
* left `true` (`ONTOLOGY_REGENERATE_STARTS_OVER`).
|
|
860
747
|
*/
|
|
861
748
|
mode?: AiOntologyGenerationMode;
|
|
862
749
|
}
|
|
@@ -866,56 +753,113 @@ export interface GenerateAiOntologyRequest {
|
|
|
866
753
|
*/
|
|
867
754
|
export type AiOntologyGenerationMode = 'update' | 'regenerate';
|
|
868
755
|
/**
|
|
869
|
-
* Request to
|
|
870
|
-
* {@link
|
|
756
|
+
* Request to generate only the properties of business entities of an ontology, as a run that saves nothing, see
|
|
757
|
+
* {@link GenerateAiOntologyRequest}. Answered by {@link AiOntologyResponse}.
|
|
871
758
|
* @category AI
|
|
872
759
|
*/
|
|
873
|
-
export interface
|
|
760
|
+
export interface GenerateAiOntologyPropertiesRequest {
|
|
874
761
|
/** Id of the ontology. */
|
|
875
762
|
ontologyId: AiOntologyId;
|
|
876
|
-
/**
|
|
877
|
-
|
|
878
|
-
* generation does not propose them again, and keeps the rows of the pending removals. A row marked for removal that
|
|
879
|
-
* changed after the run proposed it is kept either way.
|
|
880
|
-
*/
|
|
881
|
-
decision: 'accept' | 'reject';
|
|
882
|
-
/**
|
|
883
|
-
* Limits the review to these rows. Default: every suggested row and pending removal, and the suggested topic links of
|
|
884
|
-
* the attached knowledge bases.
|
|
885
|
-
*/
|
|
886
|
-
ids?: string[];
|
|
887
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
888
|
-
actor?: string;
|
|
763
|
+
/** The entities to generate properties for, 1 to 50. Default: the entities that have no property yet. */
|
|
764
|
+
entityIds?: string[];
|
|
889
765
|
}
|
|
890
766
|
/**
|
|
891
|
-
* Request to
|
|
892
|
-
* {@link AiOntologyResponse}.
|
|
767
|
+
* Request to refresh what an ontology knows about its attached knowledge bases, as a run that saves nothing, see
|
|
768
|
+
* {@link GenerateAiOntologyRequest}. Answered by {@link AiOntologyResponse}.
|
|
893
769
|
* @category AI
|
|
894
770
|
*/
|
|
895
|
-
export interface
|
|
771
|
+
export interface RefreshAiOntologyKnowledgeBasesRequest {
|
|
896
772
|
/** Id of the ontology. */
|
|
897
773
|
ontologyId: AiOntologyId;
|
|
898
|
-
/** The entities to generate properties for, 1 to 50. Default: the entities that have no property yet. */
|
|
899
|
-
entityIds?: string[];
|
|
900
|
-
/** The status the run saves the properties with. Defaults to `accepted`. */
|
|
901
|
-
saveAs?: AiOntologyGenerationSaveStatus;
|
|
902
774
|
}
|
|
903
775
|
/**
|
|
904
|
-
*
|
|
905
|
-
* topic links as accepted. Answered by {@link AiOntologyResponse}.
|
|
776
|
+
* The relationships, business entities, properties and knowledge base records of an ontology.
|
|
906
777
|
* @category AI
|
|
907
778
|
*/
|
|
908
|
-
export interface
|
|
779
|
+
export interface AiOntologyContent {
|
|
780
|
+
/** The relationships. */
|
|
781
|
+
relationships: AiOntologyRelationship[];
|
|
782
|
+
/** The business entities. */
|
|
783
|
+
entities: AiOntologyEntity[];
|
|
784
|
+
/** The properties. */
|
|
785
|
+
properties: AiOntologyProperty[];
|
|
786
|
+
/** One record per attached knowledge base a run has read. */
|
|
787
|
+
knowledgeBases: AiOntologyKnowledgeBase[];
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* Request to read the stored content of an ontology.
|
|
791
|
+
* @category AI
|
|
792
|
+
*/
|
|
793
|
+
export interface GetAiOntologyContentRequest {
|
|
909
794
|
/** Id of the ontology. */
|
|
910
795
|
ontologyId: AiOntologyId;
|
|
911
796
|
}
|
|
912
797
|
/**
|
|
913
|
-
*
|
|
914
|
-
* from agents until a review accepts it. The topics and summary of a knowledge base have no status and are refreshed
|
|
915
|
-
* by every run.
|
|
798
|
+
* Response that carries the content of an ontology.
|
|
916
799
|
* @category AI
|
|
917
800
|
*/
|
|
918
|
-
export
|
|
801
|
+
export interface AiOntologyContentResponse {
|
|
802
|
+
/** The content. */
|
|
803
|
+
content: AiOntologyContent;
|
|
804
|
+
/** Identifies the stored content it is or builds on; a save sends it back. */
|
|
805
|
+
revision: string;
|
|
806
|
+
/** Things the request left out. */
|
|
807
|
+
warnings: string[];
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* Request to read the result of the last generation run, once it completed. The result is kept for a day, until a save
|
|
811
|
+
* of the content, a discard or the next run removes it.
|
|
812
|
+
* @category AI
|
|
813
|
+
*/
|
|
814
|
+
export interface GetAiOntologyGenerationResultRequest {
|
|
815
|
+
/** Id of the ontology. */
|
|
816
|
+
ontologyId: AiOntologyId;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* Response to {@link GetAiOntologyGenerationResultRequest}.
|
|
820
|
+
* @category AI
|
|
821
|
+
*/
|
|
822
|
+
export interface GetAiOntologyGenerationResultResponse {
|
|
823
|
+
/**
|
|
824
|
+
* The content the run proposes: the stored content it started from with its changes. Its `revision` is that of the
|
|
825
|
+
* stored content, so a save fails when the content changed since the run started. Absent when there is no result.
|
|
826
|
+
*/
|
|
827
|
+
result?: AiOntologyContentResponse & {
|
|
828
|
+
/** Whether the run started from nothing rather than from the stored content. */
|
|
829
|
+
startedOver: boolean;
|
|
830
|
+
/** When the run started, in epoch milliseconds; a discard sends it to remove only this result. */
|
|
831
|
+
startedAt: number;
|
|
832
|
+
};
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* Request to remove the result of the last finished generation run without saving it.
|
|
836
|
+
* @category AI
|
|
837
|
+
*/
|
|
838
|
+
export interface DiscardAiOntologyGenerationResultRequest {
|
|
839
|
+
/** Id of the ontology. */
|
|
840
|
+
ontologyId: AiOntologyId;
|
|
841
|
+
/** Removes only the result of the run that started at this time, so a newer run's result is kept. */
|
|
842
|
+
startedAt?: number;
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
* Request to replace the stored content of an ontology. New and changed rows are checked as a create or an update
|
|
846
|
+
* would check them; a row sent back unchanged is kept as stored. A row id the ontology does not store gets a new id,
|
|
847
|
+
* and references to it follow. Answered by {@link AiOntologyContentResponse}.
|
|
848
|
+
* @category AI
|
|
849
|
+
*/
|
|
850
|
+
export interface SaveAiOntologyContentRequest {
|
|
851
|
+
/** Id of the ontology. */
|
|
852
|
+
ontologyId: AiOntologyId;
|
|
853
|
+
/** The whole content to store. */
|
|
854
|
+
content: AiOntologyContent;
|
|
855
|
+
/** The revision the content builds on; another one answers `ONTOLOGY_CONTENT_CHANGED` (409). */
|
|
856
|
+
revision: string;
|
|
857
|
+
/**
|
|
858
|
+
* Whether the content comes from a run that started from nothing. Otherwise an AI-made row the save removes is
|
|
859
|
+
* remembered, so runs do not propose it again.
|
|
860
|
+
*/
|
|
861
|
+
startedOver?: boolean;
|
|
862
|
+
}
|
|
919
863
|
/**
|
|
920
864
|
* A root topic of the knowledge graph of an attached knowledge base.
|
|
921
865
|
* @category AI
|
|
@@ -939,16 +883,10 @@ export interface AiOntologyKnowledgeBaseTopicLink {
|
|
|
939
883
|
entityId: string;
|
|
940
884
|
/** Why the model linked them; absent on a link a person added. */
|
|
941
885
|
reasoning?: string;
|
|
942
|
-
/** Review state; agents see only accepted links. A link without `reviewedAt` is unreviewed. */
|
|
943
|
-
status: AiOntologyRelationshipStatus;
|
|
944
|
-
/** Who accepted or rejected the link. The caller's claim, not an authenticated identity. */
|
|
945
|
-
reviewedBy?: string;
|
|
946
|
-
/** When the link was reviewed, in epoch milliseconds. */
|
|
947
|
-
reviewedAt?: number;
|
|
948
886
|
}
|
|
949
887
|
/**
|
|
950
|
-
* What an ontology stores about one attached knowledge base. A run replaces the summary and topics
|
|
951
|
-
*
|
|
888
|
+
* What an ontology stores about one attached knowledge base. A run replaces the summary and topics and adds links,
|
|
889
|
+
* none once a person set the links.
|
|
952
890
|
* @category AI
|
|
953
891
|
*/
|
|
954
892
|
export interface AiOntologyKnowledgeBase {
|
|
@@ -989,8 +927,8 @@ export interface ListAiOntologyKnowledgeBasesResponse {
|
|
|
989
927
|
knowledgeBases: AiOntologyKnowledgeBase[];
|
|
990
928
|
}
|
|
991
929
|
/**
|
|
992
|
-
* Request to set the topic links of an attached knowledge base: the links named
|
|
993
|
-
*
|
|
930
|
+
* Request to set the topic links of an attached knowledge base: the links named replace every other link. Later runs
|
|
931
|
+
* keep these links.
|
|
994
932
|
* @category AI
|
|
995
933
|
*/
|
|
996
934
|
export interface UpdateAiOntologyKnowledgeBaseRequest {
|
|
@@ -1004,26 +942,6 @@ export interface UpdateAiOntologyKnowledgeBaseRequest {
|
|
|
1004
942
|
*/
|
|
1005
943
|
topicLinks: Array<Pick<AiOntologyKnowledgeBaseTopicLink, 'topicName' | 'entityId'>>;
|
|
1006
944
|
}
|
|
1007
|
-
/**
|
|
1008
|
-
* Request to accept, reject or reset topic links of an attached knowledge base. Answered by
|
|
1009
|
-
* {@link AiOntologyKnowledgeBaseResponse}.
|
|
1010
|
-
* @category AI
|
|
1011
|
-
*/
|
|
1012
|
-
export interface ReviewAiOntologyKnowledgeBaseTopicLinksRequest {
|
|
1013
|
-
/** Id of the ontology. */
|
|
1014
|
-
ontologyId: AiOntologyId;
|
|
1015
|
-
/** Id of an attached knowledge base that a run has read. */
|
|
1016
|
-
knowledgeBaseId: AiKnowledgeBaseId;
|
|
1017
|
-
/** The links to review, 1 to `maxKnowledgeBaseTopicLinks`, each one a link of the record. */
|
|
1018
|
-
topicLinks: Array<Pick<AiOntologyKnowledgeBaseTopicLink, 'topicName' | 'entityId'>>;
|
|
1019
|
-
/**
|
|
1020
|
-
* The decision. `reset` returns the links to suggested and clears `reviewedAt`. Only a run that saves as suggested
|
|
1021
|
-
* may then replace them, and none once a person set the links; a run that saves as accepted keeps them suggested.
|
|
1022
|
-
*/
|
|
1023
|
-
decision: ReviewAiOntologyRelationshipRequest['decision'];
|
|
1024
|
-
/** The caller's claim of who they are, not an authenticated identity. */
|
|
1025
|
-
actor?: string;
|
|
1026
|
-
}
|
|
1027
945
|
/**
|
|
1028
946
|
* Response that carries what an ontology stores about one knowledge base.
|
|
1029
947
|
* @category AI
|
|
@@ -1059,7 +977,6 @@ export declare const AI_ONTOLOGY_LIMITS: {
|
|
|
1059
977
|
readonly maxReasoningLength: 2000;
|
|
1060
978
|
readonly maxColumnsPerSide: 16;
|
|
1061
979
|
readonly maxConfirmationColumnPairs: 10;
|
|
1062
|
-
readonly maxActorLength: 200;
|
|
1063
980
|
readonly maxTablesPerPrompt: 200;
|
|
1064
981
|
readonly maxColumnsPerTableInPrompt: 100;
|
|
1065
982
|
readonly maxToolCallsPerRun: 40;
|
|
@@ -1074,7 +991,6 @@ export declare const AI_ONTOLOGY_LIMITS: {
|
|
|
1074
991
|
readonly maxPropertiesPerOntology: 2000;
|
|
1075
992
|
readonly maxPropertySources: 20;
|
|
1076
993
|
readonly maxPropertyDescriptionLength: 500;
|
|
1077
|
-
readonly maxReviewedPropertiesPerCall: 200;
|
|
1078
994
|
readonly maxEntitiesPerPropertyPass: 5;
|
|
1079
995
|
readonly maxGeneratedPropertiesPerEntity: 30;
|
|
1080
996
|
readonly maxEntitiesPerPropertyRun: 50;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squidcloud/freshdesk-client",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.515",
|
|
4
4
|
"description": "Squid Freshdesk Client - SDK for interacting with the Freshdesk connector",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/freshdesk-client/src/index.d.ts",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"author": "",
|
|
23
23
|
"license": "ISC",
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@squidcloud/client": "^1.0.
|
|
25
|
+
"@squidcloud/client": "^1.0.515"
|
|
26
26
|
},
|
|
27
27
|
"engines": {
|
|
28
28
|
"node": ">=20.0.0"
|