@squidcloud/freshdesk-client 1.0.513 → 1.0.514

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.
@@ -9,6 +9,8 @@ export interface AiAgentDatabaseIntegrationOptions {
9
9
  verboseStatusUpdates?: boolean;
10
10
  /** Full AI query options for advanced configuration of the query execution. */
11
11
  aiQueryOptions?: AiQueryOptions;
12
+ /** Whether the agent's instructions list the database's glossary terms. Default: true. */
13
+ includeGlossary?: boolean;
12
14
  }
13
15
  /**
14
16
  * Configuration options for AI agent API integration.
@@ -5,6 +5,7 @@ import { AiOntologyId } from './ai-ontology.public-types';
5
5
  import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
6
6
  import { AiAgentId, AiContextId, AiKnowledgeBaseId, AppId, IntegrationId } from './communication.public-types';
7
7
  import { DocumentExtractionMethod } from './extraction.public-types';
8
+ import { GlossaryId } from './glossary.public-types';
8
9
  import { IntegrationType } from './integration.public-types';
9
10
  import { JobId } from './job.public-types';
10
11
  import { SecretKey } from './secret.public-types';
@@ -626,10 +627,15 @@ export interface BaseAiChatOptions {
626
627
  */
627
628
  allowSourceDownloads?: boolean;
628
629
  /**
629
- * The ontology whose accepted relationships this agent's answers and database queries follow. Honored ONLY from the
630
+ * The ontologies whose accepted relationships this agent's answers and database queries follow. Honored ONLY from the
630
631
  * agent's stored options; the per-request value is ignored.
631
632
  */
632
- ontologyId?: AiOntologyId;
633
+ ontologyIds?: AiOntologyId[];
634
+ /**
635
+ * Global glossaries whose terms are added to the agent's instructions. Honored ONLY from the agent's stored options;
636
+ * the per-request value is ignored.
637
+ */
638
+ glossaryIds?: GlossaryId[];
633
639
  /**
634
640
  * The format of the response from the AI model. Defaults to 'text'. A `json_schema` format is
635
641
  * refused for a model whose provider has no way to carry a schema — see
@@ -51,7 +51,7 @@ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-
51
51
  * Public Gemini chat model names (active models only).
52
52
  * @category AI
53
53
  */
54
- export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-4-carbon", "gemini-4-argon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite"];
54
+ export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-4-carbon", "gemini-4-argon", "gemini-4-neon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite"];
55
55
  /**
56
56
  * Public Grok chat model names (active models only).
57
57
  * @category AI
@@ -66,7 +66,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5-2", "
66
66
  * The supported AI model names.
67
67
  * @category AI
68
68
  */
69
- export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-luna", "gpt-6.1-terra", "gpt-6.2-astra", "gpt-6.2-sol", "claude-fable-5-2", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-carbon", "gemini-4-argon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
69
+ export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-luna", "gpt-6.1-terra", "gpt-6.2-astra", "gpt-6.2-sol", "claude-fable-5-2", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-carbon", "gemini-4-argon", "gemini-4-neon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
70
70
  /** Checks if the given model name is a global AI chat model name. */
71
71
  export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
72
72
  /**
@@ -99,6 +99,16 @@ export interface AiOntology {
99
99
  integrationIds: IntegrationId[];
100
100
  /** The knowledge bases attached to the ontology, each with a knowledge graph. */
101
101
  knowledgeBaseIds: AiKnowledgeBaseId[];
102
+ /**
103
+ * Global glossaries whose terms guide generation, with the glossaries of the attached databases. They are context
104
+ * only: generation proposes nothing just because a term exists.
105
+ */
106
+ 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;
102
112
  /** The last run that generated relationships, business entities or properties. */
103
113
  lastGenerationRun?: AiOntologyGenerationRun;
104
114
  /** Number of accepted relationships. Set only on the ontologies of a list. */
@@ -110,6 +120,20 @@ export interface AiOntology {
110
120
  /** Last update time in epoch milliseconds. */
111
121
  updatedAt: number;
112
122
  }
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
+ }
113
137
  /**
114
138
  * A relationship between two tables of an ontology.
115
139
  * @category AI
@@ -247,6 +271,8 @@ export interface CreateAiOntologyRequest {
247
271
  * source) and no enforced access control (`ONTOLOGY_KNOWLEDGE_BASE_ACCESS_RESTRICTED`).
248
272
  */
249
273
  knowledgeBaseIds?: AiKnowledgeBaseId[];
274
+ /** Global glossaries whose terms guide generation. Each must exist and be global. */
275
+ glossaryIds?: string[];
250
276
  }
251
277
  /**
252
278
  * Request to update an ontology. It replaces the name, the description, the attached databases and, when given, the
@@ -267,6 +293,8 @@ export interface UpdateAiOntologyRequest {
267
293
  * knowledge base loses what the ontology stored about it.
268
294
  */
269
295
  knowledgeBaseIds?: AiKnowledgeBaseId[];
296
+ /** Global glossaries whose terms guide generation, as in {@link CreateAiOntologyRequest}. Omitted keeps them. */
297
+ glossaryIds?: string[];
270
298
  }
271
299
  /**
272
300
  * Request to delete an ontology with its relationships, entities and properties.
@@ -812,7 +840,7 @@ export interface ReviewAiOntologyPropertiesResponse {
812
840
  export interface GenerateAiOntologyRequest {
813
841
  /** Id of the ontology. */
814
842
  ontologyId: AiOntologyId;
815
- /** The status the run saves what it generates with. Defaults to `accepted`. */
843
+ /** The status the run saves what it generates with. Defaults to `accepted`; a regenerate always saves `suggested`. */
816
844
  saveAs?: AiOntologyGenerationSaveStatus;
817
845
  /**
818
846
  * Whether the run uses the stored ontology as its reference. Defaults to `true`: the model sees the stored rows and
@@ -824,6 +852,40 @@ export interface GenerateAiOntologyRequest {
824
852
  * no stored schema or a knowledge base is gone or may not be in an ontology.
825
853
  */
826
854
  usePreviousOntology?: boolean;
855
+ /**
856
+ * `update` (the default) adds what is missing. `regenerate` reads the sources without the AI-generated rows, saves
857
+ * what it finds as suggested, and lists the AI-generated rows it did not find again in `pendingRemovals`. It deletes
858
+ * nothing; rows people added are left alone. It needs `usePreviousOntology` left `true`
859
+ * (`ONTOLOGY_REGENERATE_STARTS_OVER`).
860
+ */
861
+ mode?: AiOntologyGenerationMode;
862
+ }
863
+ /**
864
+ * How a generation run treats what the ontology already has.
865
+ * @category AI
866
+ */
867
+ export type AiOntologyGenerationMode = 'update' | 'regenerate';
868
+ /**
869
+ * Request to apply or discard what generation proposes: the suggested rows and the pending removals. Answered by
870
+ * {@link AiOntologyResponse}, whose warnings name the rows that could not be applied.
871
+ * @category AI
872
+ */
873
+ export interface ReviewAiOntologyGenerationRequest {
874
+ /** Id of the ontology. */
875
+ ontologyId: AiOntologyId;
876
+ /**
877
+ * `accept` accepts the suggested rows and deletes the pending removals; `reject` rejects the suggested rows, so
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;
827
889
  }
828
890
  /**
829
891
  * Request to generate only the properties of business entities of an ontology. Answered by
@@ -1024,6 +1086,7 @@ export declare const AI_ONTOLOGY_LIMITS: {
1024
1086
  readonly maxFollowAgentRowsChars: 30000;
1025
1087
  readonly maxFollowLinkedReads: 5;
1026
1088
  readonly maxKnowledgeBasesPerOntology: 5;
1089
+ readonly maxGlossaryPromptChars: 30000;
1027
1090
  readonly maxKnowledgeBaseTopics: 20;
1028
1091
  readonly maxKnowledgeBaseTopicDescriptionLength: 250;
1029
1092
  readonly maxKnowledgeBaseSummaryLength: 500;
@@ -27,11 +27,13 @@ export interface AiQueryOptions {
27
27
  /** Whether to enable raw results output. */
28
28
  enableRawResults?: boolean;
29
29
  /**
30
- * Replaces the relationships the query sees in this database with the accepted ones of this ontology, when the
31
- * ontology attaches the database. Honored for any caller the query's security rules allow, since it only reshapes
32
- * the joins of this one database. An agent's database tool uses the agent's own `ontologyId` in place of this value.
30
+ * Replaces the relationships the query sees in this database with the accepted ones of those of these ontologies
31
+ * that attach the database, all of them together. Honored for any caller the query's security rules allow, since it
32
+ * only reshapes the joins of this one database. An agent's database tool uses the agent's own `ontologyIds` instead.
33
33
  */
34
- ontologyId?: AiOntologyId;
34
+ ontologyIds?: AiOntologyId[];
35
+ /** Options for the database's glossary, which guides every stage. */
36
+ semanticLayer?: AiQuerySemanticLayerOptions;
35
37
  /**
36
38
  * When the results are too large to analyze in the answer, skips the analysis and returns the raw results as
37
39
  * files instead, for a caller that processes them itself (e.g. an agent with `executePythonCode`). Default: false.
@@ -94,6 +96,26 @@ export interface AiQueryRequest {
94
96
  /** Additional options for query execution. */
95
97
  options?: AiQueryOptions;
96
98
  }
99
+ /**
100
+ * Options for the database's glossary in an AI query.
101
+ * @category AI
102
+ */
103
+ export interface AiQuerySemanticLayerOptions {
104
+ /** Whether the glossary terms are given to the model. Default: true. */
105
+ enabled?: boolean;
106
+ }
107
+ /**
108
+ * A glossary term an AI query gave the model.
109
+ * @category AI
110
+ */
111
+ export interface AiQueryProvidedDefinition {
112
+ /** What it is: a glossary term. */
113
+ type: 'term';
114
+ /** Id of the term. */
115
+ id: string;
116
+ /** Name of the term. */
117
+ name: string;
118
+ }
97
119
  /**
98
120
  * Options for the collection selection stage.
99
121
  *
@@ -210,6 +232,8 @@ export interface AiQueryResponse {
210
232
  * it cannot generate a valid query without more information.
211
233
  */
212
234
  clarificationQuestion?: string;
235
+ /** The glossary terms given to the model. The model may or may not have used them. */
236
+ providedDefinitions?: AiQueryProvidedDefinition[];
213
237
  }
214
238
  /**
215
239
  * The AI API call response
@@ -0,0 +1,323 @@
1
+ import { AiKnowledgeBaseId, IntegrationId } from './communication.public-types';
2
+ /**
3
+ * The id of a glossary.
4
+ * @category AI
5
+ */
6
+ export type GlossaryId = string;
7
+ /**
8
+ * What a glossary belongs to: one database, or the whole application.
9
+ * @category AI
10
+ */
11
+ export type GlossaryScope = {
12
+ type: 'database';
13
+ integrationId: IntegrationId;
14
+ } | {
15
+ type: 'global';
16
+ };
17
+ /**
18
+ * How a generation run treats the existing terms: `update` changes as little as the sources call for, `regenerate`
19
+ * builds the terms from the sources alone.
20
+ * @category AI
21
+ */
22
+ export type GlossaryGenerationMode = 'update' | 'regenerate';
23
+ /**
24
+ * Business vocabulary in plain language: what words like "Customer" or "Churn" mean.
25
+ * @category AI
26
+ */
27
+ export interface Glossary {
28
+ /** Unique id of the glossary. */
29
+ id: GlossaryId;
30
+ /** Name of the glossary. */
31
+ name: string;
32
+ /** What the glossary covers. */
33
+ description?: string;
34
+ /** The database the glossary belongs to, or the application for a global glossary. */
35
+ scope: GlossaryScope;
36
+ /** Global only: the databases whose glossaries feed generation. */
37
+ integrationIds: IntegrationId[];
38
+ /** Global only: the knowledge bases whose graphs feed generation. */
39
+ knowledgeBaseIds: AiKnowledgeBaseId[];
40
+ /** Guidance for generation, such as "We are a B2B insurer; skip HR terms". */
41
+ instructions?: string;
42
+ /** Incremented on every write; a save that carries an older one fails with a conflict. */
43
+ revision: number;
44
+ /** What the last saved generation read, by source; lets an unchanged update skip the model. */
45
+ generatedFrom?: Record<string, string>;
46
+ /** Number of terms. Set only on the glossaries of a list. */
47
+ termCount?: number;
48
+ /** Creation time in epoch milliseconds. */
49
+ createdAt: number;
50
+ /** Last update time in epoch milliseconds. */
51
+ updatedAt: number;
52
+ }
53
+ /**
54
+ * One term of a glossary.
55
+ * @category AI
56
+ */
57
+ export interface GlossaryTerm {
58
+ /** Unique id of the term within its glossary. */
59
+ id: string;
60
+ /** The term, such as "Customer". Unique within the glossary, ignoring case and spacing. */
61
+ name: string;
62
+ /** Plain-language definition; a database glossary's may say where the term lives in that database. */
63
+ description: string;
64
+ /** Other words people use for the term, such as "Customer" for "Account". */
65
+ synonyms?: string[];
66
+ /** Database glossaries only: the collections the term is relevant to. Empty means the whole database. */
67
+ collections?: string[];
68
+ /**
69
+ * Database glossaries only: a fragment of a query in the database's own language that selects the term, such as
70
+ * `name IS NOT NULL AND start_date IS NULL`. A hint to the model that writes queries, not a rule.
71
+ */
72
+ querySnippet?: string;
73
+ /** Creation time in epoch milliseconds. */
74
+ createdAt: number;
75
+ /** Last update time in epoch milliseconds. */
76
+ updatedAt: number;
77
+ }
78
+ /**
79
+ * A glossary as a caller writes it.
80
+ * @category AI
81
+ */
82
+ export interface GlossaryInput {
83
+ /** Id of the glossary; a new one is assigned when absent. A database glossary is found by its database. */
84
+ id?: GlossaryId;
85
+ /** Name of the glossary. */
86
+ name: string;
87
+ /** What the glossary covers. */
88
+ description?: string;
89
+ /** The database the glossary belongs to, or the application for a global glossary. */
90
+ scope: GlossaryScope;
91
+ /** Global only: the databases whose glossaries feed generation. */
92
+ integrationIds?: IntegrationId[];
93
+ /** Global only: the knowledge bases whose graphs feed generation; each needs a readable graph. */
94
+ knowledgeBaseIds?: AiKnowledgeBaseId[];
95
+ /** Guidance for generation. */
96
+ instructions?: string;
97
+ }
98
+ /**
99
+ * A term as a caller writes it.
100
+ * @category AI
101
+ */
102
+ export interface GlossaryTermInput {
103
+ /** Id of the term; a new one is assigned when absent. */
104
+ id?: string;
105
+ /** The term, such as "Customer". */
106
+ name: string;
107
+ /** Plain-language definition. */
108
+ description: string;
109
+ /** Other words people use for the term, as in {@link GlossaryTerm}. */
110
+ synonyms?: string[];
111
+ /** Database glossaries only: the collections the term is relevant to. Empty means the whole database. */
112
+ collections?: string[];
113
+ /** Database glossaries only: a query fragment that selects the term, as in {@link GlossaryTerm}. Empty means none. */
114
+ querySnippet?: string;
115
+ }
116
+ /**
117
+ * One change a generation run made to the terms it was given, with the model's reason.
118
+ * @category AI
119
+ */
120
+ export interface GlossaryChange {
121
+ /** What happened to the term. */
122
+ type: 'add' | 'update' | 'remove' | 'merge';
123
+ /** Name of the term the change is about; for a merge, the term the others were merged into. */
124
+ name: string;
125
+ /** Id of the existing term, for an update, remove or merge. */
126
+ termId?: string;
127
+ /** For a merge: the ids of the terms folded into `termId`. */
128
+ mergedTermIds?: string[];
129
+ /** Why the model made the change. */
130
+ reason: string;
131
+ }
132
+ /**
133
+ * Request to list the glossaries of the application.
134
+ * @category AI
135
+ */
136
+ export interface ListGlossariesRequest {
137
+ /** Limits the list to database or global glossaries. */
138
+ scope?: GlossaryScope['type'];
139
+ }
140
+ /**
141
+ * Response with the glossaries of the application.
142
+ * @category AI
143
+ */
144
+ export interface ListGlossariesResponse {
145
+ /** The glossaries, each with its term count. */
146
+ glossaries: Glossary[];
147
+ }
148
+ /**
149
+ * Request to get one glossary.
150
+ * @category AI
151
+ */
152
+ export interface GetGlossaryRequest {
153
+ /** Id of the glossary. */
154
+ id: GlossaryId;
155
+ }
156
+ /**
157
+ * Response with one glossary.
158
+ * @category AI
159
+ */
160
+ export interface GetGlossaryResponse {
161
+ /** The glossary, or undefined when it does not exist. */
162
+ glossary?: Glossary;
163
+ }
164
+ /**
165
+ * Request to get the glossary of a database.
166
+ * @category AI
167
+ */
168
+ export interface GetDatabaseGlossaryRequest {
169
+ /** Id of the database integration. */
170
+ integrationId: IntegrationId;
171
+ }
172
+ /**
173
+ * Request to list the terms of a glossary, one page at a time.
174
+ * @category AI
175
+ */
176
+ export interface ListGlossaryTermsRequest {
177
+ /** Id of the glossary. */
178
+ glossaryId: GlossaryId;
179
+ /** The cursor of the previous page. */
180
+ cursor?: string;
181
+ /** Page size; default 500, at most 1000. */
182
+ limit?: number;
183
+ /** Keeps the terms whose name contains this text, ignoring case. */
184
+ search?: string;
185
+ }
186
+ /**
187
+ * Response with one page of terms.
188
+ * @category AI
189
+ */
190
+ export interface ListGlossaryTermsResponse {
191
+ /** The terms of the page, by name. */
192
+ terms: GlossaryTerm[];
193
+ /** The cursor of the next page; absent on the last one. */
194
+ cursor?: string;
195
+ }
196
+ /**
197
+ * Request to save a glossary with all its terms: the stored terms become exactly `terms`.
198
+ * @category AI
199
+ */
200
+ export interface SaveGlossaryRequest {
201
+ /** The glossary. */
202
+ glossary: GlossaryInput;
203
+ /** Every term of the glossary. */
204
+ terms: GlossaryTermInput[];
205
+ /**
206
+ * The revision the terms were read at; a newer stored revision fails the save with a conflict. `0` says none was
207
+ * stored, so a glossary saved since fails it too. Omitted, the save replaces whatever is stored.
208
+ */
209
+ revision?: number;
210
+ /** Names of generated terms the person dropped before saving; generation does not propose them again. */
211
+ droppedNames?: string[];
212
+ /** Whether `terms` came from a `regenerate` run: the remembered names are replaced by `droppedNames`. */
213
+ regenerated?: boolean;
214
+ /** The `generatedFrom` of the generation `terms` came from. */
215
+ generatedFrom?: Record<string, string>;
216
+ }
217
+ /**
218
+ * Response with the saved glossary.
219
+ * @category AI
220
+ */
221
+ export interface SaveGlossaryResponse {
222
+ /** The glossary as stored. */
223
+ glossary: Glossary;
224
+ }
225
+ /**
226
+ * Request to add or change one term.
227
+ * @category AI
228
+ */
229
+ export interface UpdateGlossaryTermRequest {
230
+ /** Id of the glossary. */
231
+ glossaryId: GlossaryId;
232
+ /** The term; one with an unknown or absent id is added. */
233
+ term: GlossaryTermInput;
234
+ }
235
+ /**
236
+ * Response with the stored term.
237
+ * @category AI
238
+ */
239
+ export interface UpdateGlossaryTermResponse {
240
+ /** The term as stored. */
241
+ term: GlossaryTerm;
242
+ }
243
+ /**
244
+ * Request to delete one term. Its name is remembered, so generation does not propose it again.
245
+ * @category AI
246
+ */
247
+ export interface DeleteGlossaryTermRequest {
248
+ /** Id of the glossary. */
249
+ glossaryId: GlossaryId;
250
+ /** Id of the term. */
251
+ termId: string;
252
+ }
253
+ /**
254
+ * Request to delete a glossary and its terms.
255
+ * @category AI
256
+ */
257
+ export interface DeleteGlossaryRequest {
258
+ /** Id of the glossary. */
259
+ id: GlossaryId;
260
+ }
261
+ /**
262
+ * Request to list the names a glossary remembers as removed.
263
+ * @category AI
264
+ */
265
+ export interface ListGlossaryExcludedNamesRequest {
266
+ /** Id of the glossary. */
267
+ glossaryId: GlossaryId;
268
+ }
269
+ /**
270
+ * Response with the names a glossary remembers as removed.
271
+ * @category AI
272
+ */
273
+ export interface ListGlossaryExcludedNamesResponse {
274
+ /** The names, as first removed. */
275
+ names: string[];
276
+ }
277
+ /**
278
+ * Request to forget a removed name, so generation may propose it again.
279
+ * @category AI
280
+ */
281
+ export interface RestoreGlossaryExcludedNameRequest {
282
+ /** Id of the glossary. */
283
+ glossaryId: GlossaryId;
284
+ /** The name to forget. */
285
+ name: string;
286
+ }
287
+ /**
288
+ * Request to generate terms for a glossary draft. Nothing is saved.
289
+ * @category AI
290
+ */
291
+ export interface GenerateGlossaryRequest {
292
+ /** The glossary, saved or not. */
293
+ glossary: GlossaryInput;
294
+ /** The current draft of the terms; defaults to the saved terms. Ignored by `regenerate`. */
295
+ terms?: GlossaryTermInput[];
296
+ /** Default: `update`. */
297
+ mode?: GlossaryGenerationMode;
298
+ /**
299
+ * Extra instructions for this run only, such as "Add terms for our loyalty program". They are not saved; the
300
+ * glossary's own `instructions` still apply. A run with them always calls the model.
301
+ */
302
+ instructions?: string;
303
+ /** Names to skip besides those the glossary remembers, such as terms dropped from the current draft. */
304
+ excludedNames?: string[];
305
+ /** The `generatedFrom` of the draft; an update whose sources match it returns the draft unchanged. */
306
+ generatedFrom?: Record<string, string>;
307
+ }
308
+ /**
309
+ * Response with the generated draft.
310
+ * @category AI
311
+ */
312
+ export interface GenerateGlossaryResponse {
313
+ /** The terms of the new draft. */
314
+ terms: GlossaryTermInput[];
315
+ /** What changed against the terms given, each with a reason. */
316
+ changes: GlossaryChange[];
317
+ /** Sources that were skipped or could not be read. */
318
+ warnings: string[];
319
+ /** What this generation read, to pass to the save. */
320
+ generatedFrom: Record<string, string>;
321
+ /** True when no source changed, so the model was not called. */
322
+ unchanged: boolean;
323
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/freshdesk-client",
3
- "version": "1.0.513",
3
+ "version": "1.0.514",
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.513"
25
+ "@squidcloud/client": "^1.0.514"
26
26
  },
27
27
  "engines": {
28
28
  "node": ">=20.0.0"