@salesforce/lds-adapters-service-einsteinllm 0.1.0-dev1

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.
Files changed (87) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/service-einsteinllm.js +5967 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  4. package/dist/es/es2018/types/src/generated/adapters/createEmbeddings.d.ts +28 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createFeedback.d.ts +16 -0
  6. package/dist/es/es2018/types/src/generated/adapters/createGenerations.d.ts +16 -0
  7. package/dist/es/es2018/types/src/generated/adapters/createGenerationsForPromptTemplate.d.ts +18 -0
  8. package/dist/es/es2018/types/src/generated/adapters/createPromptTemplate.d.ts +23 -0
  9. package/dist/es/es2018/types/src/generated/adapters/createPromptTemplateVersion.d.ts +24 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getDataProviderInstanceConfig.d.ts +31 -0
  11. package/dist/es/es2018/types/src/generated/adapters/getDataProviderTypeConfigs.d.ts +27 -0
  12. package/dist/es/es2018/types/src/generated/adapters/getDataProviders.d.ts +29 -0
  13. package/dist/es/es2018/types/src/generated/adapters/getInputMappedDataProviders.d.ts +30 -0
  14. package/dist/es/es2018/types/src/generated/adapters/getOutputLanguages.d.ts +29 -0
  15. package/dist/es/es2018/types/src/generated/adapters/getPromptTemplate.d.ts +28 -0
  16. package/dist/es/es2018/types/src/generated/adapters/getPromptTemplates.d.ts +34 -0
  17. package/dist/es/es2018/types/src/generated/adapters/putEinsteinPromptTemplateVersionStatus.d.ts +18 -0
  18. package/dist/es/es2018/types/src/generated/adapters/updatePromptTemplateVersion.d.ts +25 -0
  19. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +15 -0
  20. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +24 -0
  21. package/dist/es/es2018/types/src/generated/resources/getEinsteinPromptTemplateOutputLanguagesByPromptTemplateDevName.d.ts +19 -0
  22. package/dist/es/es2018/types/src/generated/resources/getEinsteinPromptTemplates.d.ts +22 -0
  23. package/dist/es/es2018/types/src/generated/resources/getEinsteinPromptTemplatesByPromptTemplateDevName.d.ts +18 -0
  24. package/dist/es/es2018/types/src/generated/resources/getEinsteinPromptTemplatesDataProviderTypesByTemplateType.d.ts +15 -0
  25. package/dist/es/es2018/types/src/generated/resources/getEinsteinPromptTemplatesDataProvidersByTemplateType.d.ts +19 -0
  26. package/dist/es/es2018/types/src/generated/resources/postEinsteinLlmEmbeddings.d.ts +16 -0
  27. package/dist/es/es2018/types/src/generated/resources/postEinsteinLlmFeedback.d.ts +13 -0
  28. package/dist/es/es2018/types/src/generated/resources/postEinsteinLlmPromptGenerations.d.ts +13 -0
  29. package/dist/es/es2018/types/src/generated/resources/postEinsteinPromptTemplates.d.ts +20 -0
  30. package/dist/es/es2018/types/src/generated/resources/postEinsteinPromptTemplatesDataProviderDescribe.d.ts +19 -0
  31. package/dist/es/es2018/types/src/generated/resources/postEinsteinPromptTemplatesDataProvidersMapped.d.ts +18 -0
  32. package/dist/es/es2018/types/src/generated/resources/postEinsteinPromptTemplatesGenerationsByPromptTemplateDevName.d.ts +19 -0
  33. package/dist/es/es2018/types/src/generated/resources/postEinsteinPromptTemplatesVersionsByPromptTemplateDevName.d.ts +23 -0
  34. package/dist/es/es2018/types/src/generated/resources/putEinsteinPromptTemplatesVersionsByPromptTemplateDevNameAndVersionId.d.ts +24 -0
  35. package/dist/es/es2018/types/src/generated/resources/putEinsteinPromptTemplatesVersionsStatusByPromptTemplateDevNameAndVersionId.d.ts +17 -0
  36. package/dist/es/es2018/types/src/generated/types/EinsteinLlmAdditionalConfigInputRepresentation.d.ts +59 -0
  37. package/dist/es/es2018/types/src/generated/types/EinsteinLlmEmbeddingItemRepresentation.d.ts +31 -0
  38. package/dist/es/es2018/types/src/generated/types/EinsteinLlmEmbeddingsAdditionalConfigInputRepresentation.d.ts +41 -0
  39. package/dist/es/es2018/types/src/generated/types/EinsteinLlmEmbeddingsInputRepresentation.d.ts +35 -0
  40. package/dist/es/es2018/types/src/generated/types/EinsteinLlmEmbeddingsRepresentation.d.ts +37 -0
  41. package/dist/es/es2018/types/src/generated/types/EinsteinLlmEmbeddingsWrapperRepresentation.d.ts +28 -0
  42. package/dist/es/es2018/types/src/generated/types/EinsteinLlmFeedbackInputRepresentation.d.ts +44 -0
  43. package/dist/es/es2018/types/src/generated/types/EinsteinLlmFeedbackRepresentation.d.ts +38 -0
  44. package/dist/es/es2018/types/src/generated/types/EinsteinLlmFeedbackWrapperRepresentation.d.ts +28 -0
  45. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationCitationRepresentation.d.ts +29 -0
  46. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationGenAiCitedReferenceRepresentation.d.ts +40 -0
  47. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationItemRepresentation.d.ts +45 -0
  48. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationsContentQualityRepresentation.d.ts +28 -0
  49. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationsInputRepresentation.d.ts +35 -0
  50. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationsInputWrapperRepresentation.d.ts +28 -0
  51. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationsRepresentation.d.ts +49 -0
  52. package/dist/es/es2018/types/src/generated/types/EinsteinLlmGenerationsSafetyScoreRepresentation.d.ts +46 -0
  53. package/dist/es/es2018/types/src/generated/types/EinsteinPromptRecordCollectionOutputRepresentation.d.ts +36 -0
  54. package/dist/es/es2018/types/src/generated/types/EinsteinPromptRecordFieldRepresentation.d.ts +31 -0
  55. package/dist/es/es2018/types/src/generated/types/EinsteinPromptRecordInputRepresentation.d.ts +48 -0
  56. package/dist/es/es2018/types/src/generated/types/EinsteinPromptRecordRepresentation.d.ts +47 -0
  57. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateAttachmentExclusionInfoRepresentation.d.ts +31 -0
  58. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateAttachmentRepresentation.d.ts +43 -0
  59. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateGenerationsErrorRepresentation.d.ts +37 -0
  60. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateGenerationsInputRepresentation.d.ts +45 -0
  61. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateGenerationsInputWrapperRepresentation.d.ts +28 -0
  62. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateGenerationsRepresentation.d.ts +81 -0
  63. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateMaskContentRepresentation.d.ts +35 -0
  64. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateMaskDataRepresentation.d.ts +34 -0
  65. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateMaskSettingsRepresentation.d.ts +28 -0
  66. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateRepresentation.d.ts +62 -0
  67. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateSupportedLanguageErrorRepresentation.d.ts +31 -0
  68. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateSupportedLanguageRepresentation.d.ts +31 -0
  69. package/dist/es/es2018/types/src/generated/types/EinsteinPromptTemplateVersionOutputLanguagesRepresentation.d.ts +43 -0
  70. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderDiscoveryInputRepresentation.d.ts +37 -0
  71. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderInputParamRepresentation.d.ts +37 -0
  72. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderInstanceConfigCollectionRepresentation.d.ts +30 -0
  73. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderInstanceConfigInputRepresentation.d.ts +38 -0
  74. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderInstanceConfigRepresentation.d.ts +77 -0
  75. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderOutputParamRepresentation.d.ts +31 -0
  76. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderTypeConfigCollectionRepresentation.d.ts +30 -0
  77. package/dist/es/es2018/types/src/generated/types/PromptTemplateDataProviderTypeConfigRepresentation.d.ts +46 -0
  78. package/dist/es/es2018/types/src/generated/types/WrappedListString.d.ts +28 -0
  79. package/dist/es/es2018/types/src/generated/types/WrappedMap.d.ts +32 -0
  80. package/dist/es/es2018/types/src/generated/types/WrappedValue.d.ts +28 -0
  81. package/dist/es/es2018/types/src/generated/types/WrappedValueMap.d.ts +32 -0
  82. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  83. package/package.json +76 -0
  84. package/sfdc/index.d.ts +1 -0
  85. package/sfdc/index.js +6102 -0
  86. package/src/raml/api.raml +1228 -0
  87. package/src/raml/luvio.raml +122 -0
@@ -0,0 +1,1228 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '62.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ EinsteinLlmAdditionalConfigInputRepresentation:
29
+ description: Input representation for additional configurations for Einstein LLM
30
+ generations
31
+ type: object
32
+ properties:
33
+ additionalParameters:
34
+ description: Dictionary of any other parameters that are required by the specific
35
+ provider. The values will be passed as is to the provider. This is to allow
36
+ parameters that are unique to each provider to be specified as part of the
37
+ request.
38
+ type: object
39
+ required: false # TODO Hand-rolled W-9314597
40
+ properties:
41
+ //:
42
+ type: object
43
+ applicationName:
44
+ description: 'Salesforce Hawking Application Name '
45
+ type: string
46
+ required: false # TODO Hand-rolled W-9314597
47
+ enablePiiMasking:
48
+ description: Whether to mask PII for this request. Defaults is provider specific.
49
+ type: boolean
50
+ required: false # TODO Hand-rolled W-9314597
51
+ frequencyPenalty:
52
+ description: Defaults to 0.0, min value of 0.0, max value of 1.0. Can be used
53
+ to reduce repetitiveness of generated tokens. The higher the value, the
54
+ stronger a penalty is applied to previously present tokens, proportional
55
+ to how many times they have already appeared in the prompt or prior generation.
56
+ format: double
57
+ type: number
58
+ required: false # TODO Hand-rolled W-9314597
59
+ maxTokens:
60
+ description: Maximum number of tokens to be generated
61
+ type: integer
62
+ required: false # TODO Hand-rolled W-9314597
63
+ model:
64
+ description: The model to be used for the generations request. Defaults to
65
+ provider specific model.
66
+ type: string
67
+ required: false # TODO Hand-rolled W-9314597
68
+ numGenerations:
69
+ description: Number of completions to be generated for this prompt
70
+ type: integer
71
+ required: false # TODO Hand-rolled W-9314597
72
+ presencePenalty:
73
+ description: Defaults to 0.0, min value of 0.0, max value of 1.0. Can be used
74
+ to reduce repetitiveness of generated tokens. Similar to frequency_penalty,
75
+ except that this penalty is applied equally to all tokens that have already
76
+ appeared, regardless of their exact frequencies.
77
+ format: double
78
+ type: number
79
+ required: false # TODO Hand-rolled W-9314597
80
+ stopSequences:
81
+ description: The generated text will be cut at the end of the earliest occurence
82
+ of a stop sequence.
83
+ type: array
84
+ required: false # TODO Hand-rolled W-9314597
85
+ items:
86
+ type: string
87
+ temperature:
88
+ description: Sampling temperature to be used. Higher values means the model
89
+ will take more risks. Lower temperatures mean less random generations. Min
90
+ value of 0 and max value of 1.0
91
+ format: double
92
+ type: number
93
+ required: false # TODO Hand-rolled W-9314597
94
+ EinsteinLlmEmbeddingItemRepresentation:
95
+ description: Output of a einstein llm embedding item response
96
+ type: object
97
+ properties:
98
+ embedding:
99
+ description: Embedding of the text
100
+ type: array
101
+ items:
102
+ format: double
103
+ type: number
104
+ index:
105
+ description: Index of the input text to which this embedding belongs
106
+ type: integer
107
+ EinsteinLlmEmbeddingsAdditionalConfigInputRepresentation:
108
+ description: Input representation for additional configurations for Einstein LLM
109
+ generations
110
+ type: object
111
+ properties:
112
+ additionalParameters:
113
+ description: Dictionary of any other parameters that are required by the specific
114
+ provider. The values will be passed as is to the provider. This is to allow
115
+ parameters that are unique to each provider to be specified as part of the
116
+ request.
117
+ type: object
118
+ required: false # TODO Hand-rolled W-9314597
119
+ properties:
120
+ //:
121
+ type: any
122
+ applicationName:
123
+ description: 'Salesforce Einstein Application Name '
124
+ type: string
125
+ enablePiiMasking:
126
+ description: Whether to mask PII for this request. Defaults is provider specific.
127
+ type: boolean
128
+ required: false # TODO Hand-rolled W-9314597
129
+ model:
130
+ description: The model to be used for the generations request. Defaults to
131
+ provider specific model.
132
+ type: string
133
+ required: false # TODO Hand-rolled W-9314597
134
+ # TODO Hand-rolled W-8334626
135
+ # Need to manually wrap the input representation with what the aura controller is expecting
136
+ EinsteinLlmEmbeddingsWrapperRepresentation:
137
+ description: Input wrapper for embeddings representation
138
+ type: object
139
+ properties:
140
+ embeddingsInput:
141
+ description: Set the parameters for embeddings request
142
+ type: EinsteinLlmEmbeddingsInputRepresentation
143
+ EinsteinLlmEmbeddingsInputRepresentation:
144
+ description: Input representation for creating embedding vector with Einstein
145
+ LLM
146
+ type: object
147
+ properties:
148
+ additionalConfig:
149
+ description: Additional configuration to fine tune model parameters
150
+ type: EinsteinLlmEmbeddingsAdditionalConfigInputRepresentation
151
+ prompts:
152
+ description: Input texts to get embeddings for, encoded as an array of strings
153
+ type: WrappedListString
154
+ provider:
155
+ description: Provider to be used. Should be one of OpenAI|Cohere
156
+ type: string
157
+ required: false # TODO Hand-rolled W-9314597
158
+ EinsteinLlmEmbeddingsRepresentation:
159
+ description: Output of a einstein llm embeddings response
160
+ type: object
161
+ properties:
162
+ embeddings:
163
+ description: Embeddings of the text
164
+ type: array
165
+ items:
166
+ type: EinsteinLlmEmbeddingItemRepresentation
167
+ parameters:
168
+ description: Any provider specific attributes will be included as part of
169
+ this object
170
+ type: object
171
+ properties:
172
+ //:
173
+ type: any
174
+ # TODO Hand-rolled W-8334626
175
+ # Need to manually wrap the input representation with what the aura controller is expecting
176
+ EinsteinLlmFeedbackWrapperRepresentation:
177
+ description: Input wrapper for feedback representation
178
+ type: object
179
+ properties:
180
+ feedbackInput:
181
+ description: Set the parameters for feedback
182
+ type: EinsteinLlmFeedbackInputRepresentation
183
+ EinsteinLlmFeedbackInputRepresentation:
184
+ description: Input representation for Feedback with Einstein LLM
185
+ type: object
186
+ properties:
187
+ appFeedback:
188
+ description: app feedback map
189
+ type: object
190
+ required: false # TODO Hand-rolled W-9314597
191
+ properties:
192
+ //:
193
+ type: object
194
+ feedback:
195
+ description: feedback
196
+ type: string
197
+ required: false # TODO Hand-rolled W-9314597
198
+ feedbackText:
199
+ description: Feedback Text
200
+ type: string
201
+ generationId:
202
+ description: Generation Id - Generations.response.id
203
+ type: string
204
+ id:
205
+ description: Feedback id
206
+ type: string
207
+ EinsteinLlmFeedbackRepresentation:
208
+ description: Output of a einstein llm feedback call
209
+ type: object
210
+ properties:
211
+ message:
212
+ description: Response text of the feedback API
213
+ type: string
214
+ # Hand-rolled remove all EinsteinLlmEmbedding*Representation types; not in scope for current work
215
+ EinsteinLlmGenerationItemRepresentation:
216
+ description: Output of a einstein llm generation item response
217
+ type: object
218
+ properties:
219
+ contentQualityRepresentation:
220
+ description: Generations Content Quality Representation
221
+ type: EinsteinLlmGenerationsContentQualityRepresentation | nil # Hand-rolled union 'nil'
222
+ required: false # TODO Hand-rolled W-9314597
223
+ isSummarized:
224
+ description: Flag indicating summarization was done
225
+ type: boolean
226
+ required: false # TODO Hand-rolled W-15576505
227
+ parameters:
228
+ description: Any provider specific attributes will be included as part of
229
+ this object
230
+ type: string
231
+ responseId:
232
+ description: Generations Response Id
233
+ type: string
234
+ safetyScoreRepresentation:
235
+ description: 'Generations Safety Score Representation '
236
+ type: EinsteinLlmGenerationsSafetyScoreRepresentation | nil # Hand-rolled union 'nil'
237
+ required: false # TODO Hand-rolled W-9314597
238
+ text:
239
+ description: Text
240
+ type: string
241
+ EinsteinLlmGenerationsContentQualityRepresentation:
242
+ description: Output of a einstein llm generation content quality representation
243
+ type: object
244
+ properties:
245
+ isToxicityDetected:
246
+ description: Content Quality
247
+ required: false # TODO Hand-rolled W-9314597
248
+ type: boolean | nil # Hand-rolled union 'nil'
249
+ # TODO Hand-rolled W-8334626
250
+ # Need to manually wrap the input representation with what the aura controller is expecting
251
+ EinsteinLlmGenerationsInputWrapperRepresentation:
252
+ description: Input wrapper for generations input representation
253
+ type: object
254
+ properties:
255
+ generationsInput:
256
+ description: Set the parameters for message generation
257
+ type: EinsteinLlmGenerationsInputRepresentation
258
+ EinsteinLlmGenerationsInputRepresentation:
259
+ description: Input representation for generating responses with Einstein LLM
260
+ type: object
261
+ properties:
262
+ additionalConfig:
263
+ description: Additional configuration to fine tune model parameters
264
+ type: EinsteinLlmAdditionalConfigInputRepresentation # Hand-rolled update from 'object'
265
+ required: false # TODO Hand-rolled W-9314597
266
+ promptTextorId:
267
+ description: Represents the promptTextorId or text to be completed.
268
+ type: string
269
+ provider:
270
+ description: LLM Provider
271
+ type: string
272
+ required: false # TODO Hand-rolled W-9314597
273
+ EinsteinLlmGenerationsRepresentation:
274
+ description: Output of a einstein llm generations response
275
+ type: object
276
+ properties:
277
+ generations:
278
+ description: List of generated text
279
+ type: array
280
+ items:
281
+ type: EinsteinLlmGenerationItemRepresentation
282
+ parameters:
283
+ description: Any provider specific attributes will be included as part of
284
+ this object
285
+ type: WrappedMap | nil # Hand-rolled union 'nil'
286
+ prompt:
287
+ description: Prompt used for the generation
288
+ type: string | nil # Hand-rolled union 'nil'
289
+ requestId:
290
+ description: ID of the generation request
291
+ type: string
292
+ # TODO Hand-rolled W-8334626
293
+ # Need to manually wrap the input representation with what the aura controller is expecting
294
+ EinsteinPromptTemplateGenerationsInputWrapperRepresentation:
295
+ description: Input wrapper for prompt template generations input representation
296
+ type: object
297
+ properties:
298
+ promptTemplateGenerationsInput:
299
+ description: Set the parameters for prompt template message generation
300
+ type: EinsteinPromptTemplateGenerationsInputRepresentation
301
+ EinsteinLlmGenerationsSafetyScoreRepresentation:
302
+ description: Output of a einstein llm generation safety score representation
303
+ type: object
304
+ properties:
305
+ hateScore:
306
+ description: Hate Score
307
+ type: number | nil # Hand-rolled union 'nil'
308
+ required: false # TODO Hand-rolled W-9314597
309
+ physicalScore:
310
+ description: Physical Score
311
+ type: number | nil # Hand-rolled union 'nil'
312
+ required: false # TODO Hand-rolled W-9314597
313
+ profanityScore:
314
+ description: Profanity Score
315
+ type: number | nil # Hand-rolled union 'nil'
316
+ required: false # TODO Hand-rolled W-9314597
317
+ safetyScore:
318
+ description: Safety Score
319
+ type: number | nil # Hand-rolled union 'nil'
320
+ required: false # TODO Hand-rolled W-9314597
321
+ sexualScore:
322
+ description: Sexual Score
323
+ type: number | nil # Hand-rolled union 'nil'
324
+ required: false # TODO Hand-rolled W-9314597
325
+ toxicityScore:
326
+ description: Toxicity Score
327
+ type: number | nil # Hand-rolled union 'nil'
328
+ required: false # TODO Hand-rolled W-9314597
329
+ violenceScore:
330
+ description: Violence Score
331
+ type: number | nil # Hand-rolled union 'nil'
332
+ required: false # TODO Hand-rolled W-9314597
333
+ EinsteinPromptRecordCollectionOutputRepresentation:
334
+ description: Output of Prompt Records Collection
335
+ type: object
336
+ properties:
337
+ hasMoreRecords:
338
+ description: hasMoreRecords
339
+ type: boolean
340
+ promptRecords:
341
+ description: List of prompt templates that are available for selection.
342
+ type: array
343
+ required: false
344
+ items:
345
+ type: EinsteinPromptRecordRepresentation
346
+ totalPromptRecords:
347
+ description: totalPromptRecords
348
+ type: integer
349
+ EinsteinPromptRecordFieldRepresentation:
350
+ description: Contains both the raw and displayable field values for a field in
351
+ a Record.
352
+ type: object
353
+ properties:
354
+ displayValue:
355
+ description: The displayable value for a field
356
+ type: string
357
+ value:
358
+ description: The value of a field in its raw data form.
359
+ type: boolean | integer | string | nil
360
+ EinsteinPromptRecordInputRepresentation:
361
+ description: Input representation for creating a prompt template
362
+ type: object
363
+ properties:
364
+ apiName:
365
+ description: apiName
366
+ type: string
367
+ childRelationships:
368
+ description: Prompt Record ChildRelationships
369
+ type: object
370
+ properties:
371
+ //:
372
+ type: any # TODO Hand-rolled W-18886332
373
+ fields:
374
+ description: GenAiPromptTemplate Fields
375
+ type: array
376
+ items:
377
+ type: object
378
+ properties:
379
+ //:
380
+ type: any # TODO Hand-rolled W-18886332
381
+ id:
382
+ description: The ID of the prompt template
383
+ type: string
384
+ required: false # TODO Hand-rolled W-18886332
385
+ isStandard:
386
+ description: isStandard
387
+ type: boolean
388
+ EinsteinPromptRecordRepresentation:
389
+ description: Representation of a single Prompt Template
390
+ type: object
391
+ properties:
392
+ apiName:
393
+ description: apiName
394
+ type: string
395
+ required: false
396
+ childRelationships:
397
+ description: Prompt Record ChildRelationships
398
+ type: object
399
+ required: false
400
+ properties:
401
+ //:
402
+ type: array
403
+ items:
404
+ type: EinsteinPromptRecordRepresentation
405
+ fields:
406
+ description: GenAiPromptTemplate Fields
407
+ type: object
408
+ required: false
409
+ properties:
410
+ //:
411
+ type: EinsteinPromptRecordFieldRepresentation
412
+ id:
413
+ description: The ID of the prompt template
414
+ type: string
415
+ required: false
416
+ EinsteinPromptTemplateGenerationsErrorRepresentation:
417
+ description: Error output of a EinsteinPromptTemplateGeneration request
418
+ type: object
419
+ properties:
420
+ errorMessage:
421
+ description: This is the error message meant for client consumption. It may
422
+ differ from the Gateway Error Message
423
+ type: string
424
+ httpErrorCode:
425
+ description: HTTP Error Code classifying the error
426
+ type: string
427
+ localizedErrorMessage:
428
+ description: This is the localized error message.
429
+ type: string
430
+ required: false # TODO Hand-rolled W-9314597
431
+ messageCode:
432
+ description: The message code received from the LLM Gateway
433
+ type: string
434
+ EinsteinPromptTemplateGenerationsInputRepresentation:
435
+ description: Input representation for generating prompt template responses with
436
+ Einstein LLM
437
+ type: object
438
+ properties:
439
+ additionalConfig:
440
+ description: Additional configuration to fine tune model parameters
441
+ type: EinsteinLlmAdditionalConfigInputRepresentation # Hand-rolled update from 'object'
442
+ required: false # TODO Hand-rolled W-9314597
443
+ inputParams:
444
+ description: Dictionary of input parameters to generate prompt from prompt
445
+ template.
446
+ type: WrappedValueMap # Hand-rolled update from 'object'
447
+ properties:
448
+ //:
449
+ type: object
450
+ isPreview:
451
+ description: Whether to generate prompt template preview by resolving merge
452
+ fields
453
+ type: boolean
454
+ outputLanguage:
455
+ description: Output Language
456
+ type: string
457
+ required: false # TODO Hand-rolled W-15576505
458
+ provider:
459
+ description: LLM Provider
460
+ type: string
461
+ required: false # TODO Hand-rolled W-9314597
462
+ showGroundingMetadataInResolvedPrompt:
463
+ description: When this flag is true, mergeFieldInformation will be added to the LLM Generations Response output, which will be used to show annotations in the resolved prompt.
464
+ type: boolean
465
+ required: false # TODO Hand-rolled W-18853661
466
+ EinsteinPromptTemplateGenerationsRepresentation:
467
+ description: Output of a einstein llm generations response for given prompt template
468
+ type: object
469
+ properties:
470
+ citations:
471
+ description: Generation Citations Mapping
472
+ required: false # TODO Hand-rolled W-19304625
473
+ type: EinsteinLlmGenerationCitationRepresentation
474
+ generationErrors:
475
+ description: generated prompt template generationErrors
476
+ type: array
477
+ required: false # TODO Hand-rolled W-9314597
478
+ items:
479
+ type: EinsteinPromptTemplateGenerationsErrorRepresentation
480
+ generations:
481
+ description: List of generated text
482
+ type: array
483
+ items:
484
+ type: EinsteinLlmGenerationItemRepresentation
485
+ parameters:
486
+ description: Any provider specific attributes will be included as part of
487
+ this object
488
+ type: WrappedMap | nil # Hand-rolled union 'nil'
489
+ prompt:
490
+ description: Prompt used for the generation
491
+ type: string | nil # Hand-rolled union 'nil'
492
+ promptTemplateDevName:
493
+ description: generated prompt template promptTemplateDevName
494
+ type: string
495
+ requestId:
496
+ description: ID of the generation request
497
+ type: string
498
+ requestMessages?: # TODO Hand-rolled W-15709657
499
+ description: generated prompt template RequestMessages
500
+ type: array
501
+ items:
502
+ type: EinsteinPromptTemplateMaskContentRepresentation
503
+ responseMessages?: # TODO Hand-rolled W-15709657
504
+ description: generated prompt template ResponseMessages
505
+ type: array
506
+ items:
507
+ type: EinsteinPromptTemplateMaskContentRepresentation
508
+ slotsMaskingInformation?: # TODO Hand-rolled W-15709657
509
+ description: generated prompt template slotsMaskingInformation
510
+ type: array
511
+ items:
512
+ type: EinsteinPromptTemplateMaskDataRepresentation
513
+ mergeFieldInformation?: # TODO Hand-rolled W-18853661
514
+ description: merge field information mapping used for annotations in the resolved prompt
515
+ type: object
516
+ properties:
517
+ //:
518
+ type: any
519
+ fileData:
520
+ description: file info of the input files used in generation
521
+ type: array
522
+ required: false # TODO Hand-rolled W-17552098
523
+ items:
524
+ type: EinsteinPromptTemplateAttachmentRepresentation
525
+ EinsteinLlmGenerationCitationRepresentation:
526
+ description: Output of a Einstein LLM Generation Citation output
527
+ type: object
528
+ properties:
529
+ citedReferences:
530
+ description: Cited References
531
+ required: false # TODO Hand-rolled W-19304625
532
+ type: array
533
+ items:
534
+ type: EinsteinLlmGenerationGenAiCitedReferenceRepresentation
535
+ EinsteinLlmGenerationGenAiCitedReferenceRepresentation:
536
+ description: Output of a Einstein LLM Generation Gen AI Citation output
537
+ type: object
538
+ properties:
539
+ citationLocations:
540
+ description: Array of locations where that particular citation needs to appear
541
+ in the input text
542
+ type: array
543
+ required: false # TODO Hand-rolled W-19304625
544
+ items:
545
+ type: integer
546
+ claims:
547
+ description: Matching chunk from the input text
548
+ type: array
549
+ required: false # TODO Hand-rolled W-19304625
550
+ items:
551
+ type: string
552
+ link:
553
+ description: Link
554
+ type: string
555
+ required: false # TODO Hand-rolled W-19304625
556
+ sourceObjectApiName:
557
+ description: SourceObjectApiName
558
+ type: string
559
+ required: false # TODO Hand-rolled W-19304625
560
+ sourceObjectRecordId:
561
+ description: SourceObjectRecordId
562
+ type: string
563
+ required: false # TODO Hand-rolled W-19304625
564
+ EinsteinPromptTemplateAttachmentRepresentation:
565
+ description: Representation of file data for prompt template attachments
566
+ type: object
567
+ properties:
568
+ exclusionInfo:
569
+ description: data for file exclusion from LLM request
570
+ type: EinsteinPromptTemplateAttachmentExclusionInfoRepresentation
571
+ required: false # TODO Hand-rolled W-18581584
572
+ id:
573
+ description: ContentDocument Id of file attached to prompt template
574
+ type: string
575
+ title:
576
+ description: title of the attachment file
577
+ type: string
578
+ fileExtension:
579
+ description: extension of the file attachment
580
+ type: string
581
+ latestPublishedVersion:
582
+ description: ContentVersion of the latest published version of the file attachment
583
+ type: string
584
+ parentName:
585
+ description: ParentName of the file attachment
586
+ type: string
587
+ required: false # TODO Hand-rolled W-17793327
588
+ EinsteinPromptTemplateAttachmentExclusionInfoRepresentation:
589
+ description: Representation for info of file exclusion from LLM requests
590
+ type: object
591
+ properties:
592
+ exclusionReason:
593
+ description: Reason for file exclusion from LLM request
594
+ type: string
595
+ isExcluded:
596
+ description: true if the file is excluded from LLM request, false otherwise
597
+ type: boolean
598
+ EinsteinPromptTemplateRepresentation:
599
+ description: Comprehensive representation for prompt template operations including
600
+ creation, updates, and activation
601
+ type: object
602
+ properties:
603
+ additionalData?: # TODO Hand-rolled W-18886332
604
+ description: Additional data, such as references
605
+ type: WrappedMap
606
+ errorMessages:
607
+ description: Error Messages
608
+ type: array
609
+ items:
610
+ type: string
611
+ hasWarning:
612
+ description: has warning messages
613
+ type: boolean
614
+ isSuccessful:
615
+ description: IsSuccessful
616
+ type: boolean
617
+ statusCode:
618
+ description: Status Code of connect api
619
+ type: string
620
+ required: false # TODO Hand-rolled W-18886332
621
+ templateId:
622
+ description: Template Id
623
+ type: string
624
+ templateType:
625
+ description: Template Type
626
+ type: string
627
+ required: false # TODO Hand-rolled W-18886332
628
+ versionId:
629
+ description: Version Id
630
+ type: string
631
+ warningMessages:
632
+ description: Warning Messages
633
+ type: array
634
+ items:
635
+ type: string
636
+ EinsteinPromptTemplateMaskContentRepresentation:
637
+ description: Output of a einstein mask data request and response for given prompt template
638
+ type: object
639
+ properties:
640
+ content:
641
+ description: content value
642
+ type: string
643
+ moderationSettings?:
644
+ description: moderationSettings value
645
+ type: EinsteinPromptTemplateMaskSettingsRepresentation | nil # TODO Hand-rolled W-15709657
646
+ role?:
647
+ description: RoleEnum value
648
+ type: string
649
+ EinsteinPromptTemplateMaskDataRepresentation:
650
+ description: Output of a einstein mask data response for given prompt template
651
+ type: object
652
+ properties:
653
+ originalValue:
654
+ description: original field value
655
+ type: string
656
+ placeHolder:
657
+ description: placeholder value
658
+ type: string
659
+ recognizers:
660
+ description: recognizers
661
+ type: array
662
+ items:
663
+ type: string
664
+ EinsteinPromptTemplateMaskSettingsRepresentation:
665
+ description: Output of a einstein mask data moderation setting for given prompt template
666
+ type: object
667
+ properties:
668
+ enableModeration:
669
+ description: enable moderation value
670
+ type: boolean
671
+ EinsteinPromptTemplateSupportedLanguageErrorRepresentation:
672
+ description: Representation of an error encountered when returning the Prompt Template Version Supported Languages.
673
+ type: object
674
+ properties:
675
+ errorMessage:
676
+ description: Error message for this error
677
+ type: string
678
+ messageCode:
679
+ description: Message Code for this error.
680
+ type: string
681
+ EinsteinPromptTemplateSupportedLanguageRepresentation:
682
+ description: Representation of a single Prompt Template Version Supported Language
683
+ type: object
684
+ properties:
685
+ languageCode:
686
+ description: Language Code
687
+ type: string
688
+ languageDisplayName:
689
+ description: Language Display Name
690
+ type: string
691
+ PromptTemplateDataProviderDiscoveryInputRepresentation:
692
+ description: Input for data provider discovery API to find available data providers
693
+ based on criteria
694
+ type: object
695
+ properties:
696
+ groupName:
697
+ description: The expression group name for the data provider
698
+ type: string
699
+ required: false # TODO Hand-rolled W-18968514
700
+ target:
701
+ description: The scoped target for data provider discovery
702
+ type: string
703
+ required: false # TODO Hand-rolled W-18968514
704
+ templateInputs:
705
+ description: List of template input parameters for data provider discovery
706
+ type: array
707
+ items:
708
+ type: any #TODO Hand-rolled W-18968514
709
+ templateTypeName:
710
+ description: The template type name to filter data providers by
711
+ type: string
712
+ PromptTemplateDataProviderInputParamRepresentation:
713
+ description: Represents an input parameter for a data provider instance
714
+ type: object
715
+ properties:
716
+ apiName:
717
+ description: The api name of the input parameter
718
+ type: string
719
+ label:
720
+ description: The label of the input parameter
721
+ type: string
722
+ required:
723
+ description: The flag to identify if input is mandatory
724
+ type: boolean
725
+ type:
726
+ description: The data type of the input parameter
727
+ type: string
728
+ PromptTemplateDataProviderInstanceConfigCollectionRepresentation:
729
+ description: Collection of data provider instance configurations for a prompt
730
+ template version
731
+ type: object
732
+ properties:
733
+ dataProviderInstanceConfigs:
734
+ description: List of data provider instance configurations
735
+ type: array
736
+ items:
737
+ type: PromptTemplateDataProviderInstanceConfigRepresentation
738
+ PromptTemplateDataProviderInstanceConfigInputRepresentation:
739
+ description: Input for data provider instance configuration generation
740
+ type: object
741
+ properties:
742
+ additionalParam:
743
+ description: Additional parameters for the data provider configuration
744
+ type: object
745
+ required: false # TODO Hand-rolled W-18968514
746
+ properties:
747
+ //:
748
+ type: any #TODO Hand-rolled W-18968514
749
+ definition:
750
+ description: The definition of the data provider instance
751
+ type: string
752
+ groupName:
753
+ description: The expression group name for the data provider
754
+ type: string
755
+ PromptTemplateDataProviderInstanceConfigRepresentation:
756
+ description: Configuration for a specific instance of a data provider that drives
757
+ PB UI capabilities
758
+ type: object
759
+ properties:
760
+ apiName:
761
+ description: The API name of the discovered data provider
762
+ type: string
763
+ dataProviderBundle:
764
+ description: The data provider bundle containing configuration and schema
765
+ information
766
+ type: object
767
+ required: false # TODO Hand-rolled W-18968514
768
+ properties:
769
+ //:
770
+ type: any # TODO Hand-rolled W-18968514
771
+ defaultOutputParam:
772
+ description: The default output parameter for the data provider instance
773
+ type: PromptTemplateDataProviderOutputParamRepresentation
774
+ required: false # TODO Hand-rolled W-18968514
775
+ definition:
776
+ description: The definition field for the data provider instance
777
+ type: string
778
+ description:
779
+ description: The description of data provider
780
+ type: string | nil
781
+ required: false # TODO Hand-rolled W-18968514
782
+ groupName:
783
+ description: The expression group name for the data provider instance
784
+ type: string
785
+ inputParams:
786
+ description: The list of all input parameters for the data provider instance
787
+ type: array
788
+ required: false # TODO Hand-rolled W-18968514
789
+ items:
790
+ type: PromptTemplateDataProviderInputParamRepresentation
791
+ label:
792
+ description: The display label for the data provider instance
793
+ type: string
794
+ mappedInputs:
795
+ description: The mapped inputs for data provider
796
+ type: object
797
+ required: false # TODO Hand-rolled W-18968514
798
+ properties:
799
+ //:
800
+ type: any # TODO Hand-rolled W-18968514
801
+ nodeIcon:
802
+ description: The icon identifier for the data provider instance
803
+ type: string | nil
804
+ required: false # TODO Hand-rolled W-18968514
805
+ outputParams:
806
+ description: The list of all output parameters for the data provider instance
807
+ type: array
808
+ required: false # TODO Hand-rolled W-18968514
809
+ items:
810
+ type: PromptTemplateDataProviderOutputParamRepresentation
811
+ referenceName:
812
+ description: The reference name for the data provider instance
813
+ type: string
814
+ scopedToTarget:
815
+ description: The target scope for non-top level providers scoped to a specific
816
+ target
817
+ type: string | nil
818
+ required: false # TODO Hand-rolled W-18968514
819
+ subGroup:
820
+ description: The sub-group used to categorize data providers in the resource
821
+ picker
822
+ type: string | nil
823
+ required: false # TODO Hand-rolled W-18968514
824
+ PromptTemplateDataProviderOutputParamRepresentation:
825
+ description: Represents an output parameter for a data provider instance
826
+ type: object
827
+ properties:
828
+ apiName:
829
+ description: The value of the output parameter
830
+ type: string
831
+ label:
832
+ description: The label of the output parameter
833
+ type: string
834
+ PromptTemplateDataProviderTypeConfigCollectionRepresentation:
835
+ description: Collection of data provider type configurations for a prompt template
836
+ type
837
+ type: object
838
+ properties:
839
+ dataProviderTypeConfigs:
840
+ description: List of data provider type configs
841
+ type: array
842
+ items:
843
+ type: PromptTemplateDataProviderTypeConfigRepresentation
844
+ PromptTemplateDataProviderTypeConfigRepresentation:
845
+ description: Output representation of a data provider type configuration
846
+ type: object
847
+ properties:
848
+ description:
849
+ description: The localized description of the data provider type
850
+ type: string
851
+ required: false # TODO Hand-rolled W-19333313
852
+ groupName:
853
+ description: The group name of the data provider type
854
+ type: string
855
+ icon:
856
+ description: The icon identifier for the data provider type
857
+ type: string
858
+ isTopLevel:
859
+ description: Indicates whether this is a top level data provider type
860
+ type: boolean
861
+ label:
862
+ description: The localized label of the data provider type
863
+ type: string
864
+ parentNode:
865
+ description: The parent node identifier for hierarchical data provider types
866
+ type: string
867
+ required: false # TODO Hand-rolled W-19333313
868
+ scope:
869
+ description: The scope configuration for the data provider type (can be 'ALL'
870
+ or list of specific scopes)
871
+ type: any # TODO Hand-rolled W-19333313, scope can be a string, list of string, or just "ALL"
872
+ required: false # TODO Hand-rolled W-19333313
873
+ EinsteinPromptTemplateVersionOutputLanguagesRepresentation:
874
+ description: Representation of all supported output languages for a given Prompt
875
+ Template Version
876
+ type: object
877
+ properties:
878
+ errors:
879
+ description: Supported Language Errors
880
+ type: array
881
+ items:
882
+ type: EinsteinPromptTemplateSupportedLanguageErrorRepresentation
883
+ isSuccess:
884
+ description: Did this call succeed or not.
885
+ type: boolean
886
+ promptTemplateDevName:
887
+ description: Prompt Template Developer Name
888
+ type: string
889
+ supportedLanguages:
890
+ description: Supported Languages
891
+ type: array
892
+ items:
893
+ type: EinsteinPromptTemplateSupportedLanguageRepresentation
894
+ versionId:
895
+ description: Prompt Template Version Id
896
+ type: string
897
+ WrappedListString:
898
+ description: Wrapped list of String for use in Apex.
899
+ type: object
900
+ properties:
901
+ wrappedListString:
902
+ description: wrappedListString
903
+ type: array
904
+ items:
905
+ type: string
906
+ WrappedMap:
907
+ description: Wrapped map for use in Connect API.
908
+ type: object
909
+ properties:
910
+ wrappedMap:
911
+ description: wrapped map
912
+ type: object
913
+ properties:
914
+ //:
915
+ type: any
916
+ WrappedValue:
917
+ description: Wrapped Object for use in Einstein LLM.
918
+ type: object
919
+ properties:
920
+ value:
921
+ description: Value
922
+ type: object
923
+ WrappedValueMap:
924
+ description: Wrapped Map of Object for use in Apex.
925
+ type: object
926
+ properties:
927
+ valueMap:
928
+ description: Wrapped Value Map
929
+ type: object
930
+ properties:
931
+ //:
932
+ type: object
933
+ /einstein:
934
+ /llm:
935
+ /embeddings:
936
+ post:
937
+ displayName: postEinsteinLlmEmbeddings
938
+ description: Creates an embedding vector representing the input text.
939
+ responses:
940
+ '200':
941
+ description: Success
942
+ body:
943
+ application/json:
944
+ type: EinsteinLlmEmbeddingsRepresentation
945
+ body:
946
+ application/json:
947
+ type: EinsteinLlmEmbeddingsWrapperRepresentation
948
+ (oas-body-name): embeddingsInput
949
+ /feedback:
950
+ post:
951
+ displayName: postEinsteinLlmFeedback
952
+ description: Send feedback for a generations.response object
953
+ responses:
954
+ '200':
955
+ description: Success
956
+ body:
957
+ application/json:
958
+ type: EinsteinLlmFeedbackRepresentation
959
+ body:
960
+ application/json:
961
+ type: EinsteinLlmFeedbackWrapperRepresentation
962
+ (oas-body-name): feedbackInput
963
+ # Hand-rolled remove /embeddings endpoint; not in scope for current work
964
+ /prompt/generations:
965
+ post:
966
+ displayName: postEinsteinLlmGenerations
967
+ description: Generates a response based on the provided prompt and parameters
968
+ responses:
969
+ '200':
970
+ description: Success
971
+ body:
972
+ application/json:
973
+ type: EinsteinLlmGenerationsRepresentation
974
+ body:
975
+ application/json:
976
+ type: EinsteinLlmGenerationsInputWrapperRepresentation
977
+ (oas-body-name): generationsInput
978
+ /prompt-templates:
979
+ get:
980
+ displayName: getEinsteinPromptTemplates
981
+ description: Returns Prompt Templates based on the provided prompt template type and related object, other params
982
+ responses:
983
+ '200':
984
+ description: Success
985
+ body:
986
+ application/json:
987
+ type: EinsteinPromptRecordCollectionOutputRepresentation
988
+ queryParameters:
989
+ isActive:
990
+ description: Filter to is active templates
991
+ type: boolean
992
+ required: false
993
+ fields:
994
+ type: array
995
+ required: false
996
+ items:
997
+ type: string
998
+ (oas-collectionFormat): csv
999
+ relatedEntity:
1000
+ description: The Related Entity of prompt template to filter by
1001
+ type: string
1002
+ required: false
1003
+ offset:
1004
+ type: integer
1005
+ required: false
1006
+ pageLimit:
1007
+ type: integer
1008
+ required: false
1009
+ type:
1010
+ description: The type of prompt template to filter by
1011
+ type: string
1012
+ required: false
1013
+ query:
1014
+ type: string
1015
+ required: false
1016
+ sortBy:
1017
+ type: string
1018
+ required: false
1019
+ post:
1020
+ displayName: postEinsteinPromptTemplateCollection
1021
+ description: Create a prompt template
1022
+ responses:
1023
+ '200':
1024
+ description: Success
1025
+ body:
1026
+ application/json:
1027
+ type: EinsteinPromptTemplateRepresentation
1028
+ body:
1029
+ application/json:
1030
+ type: EinsteinPromptRecordInputRepresentation
1031
+ (oas-body-name): templateInput
1032
+ /prompt-templates/data-providers:
1033
+ /mapped:
1034
+ post:
1035
+ displayName: postDataProviderInputMatchDiscovery
1036
+ description: Get Data Provider Discovery Info List
1037
+ responses:
1038
+ '200':
1039
+ description: Success
1040
+ body:
1041
+ application/json:
1042
+ type: PromptTemplateDataProviderInstanceConfigCollectionRepresentation
1043
+ body:
1044
+ application/json:
1045
+ type: PromptTemplateDataProviderDiscoveryInputRepresentation
1046
+ (oas-body-name): dataProviderDiscoveryInput
1047
+ /{templateType}:
1048
+ get:
1049
+ displayName: getPromptTemplateDataProviderDiscovery
1050
+ description: Discover available data providers for prompt templates
1051
+ responses:
1052
+ '200':
1053
+ description: Success
1054
+ body:
1055
+ application/json:
1056
+ type: PromptTemplateDataProviderInstanceConfigCollectionRepresentation
1057
+ queryParameters:
1058
+ groupNames:
1059
+ description: The group names for data provider discovery
1060
+ type: array
1061
+ required: false
1062
+ items:
1063
+ type: string
1064
+ (oas-collectionFormat): csv
1065
+ targets:
1066
+ description: The scoped targets for data provider discovery
1067
+ type: array
1068
+ required: false
1069
+ items:
1070
+ type: string
1071
+ (oas-collectionFormat): csv
1072
+ uriParameters:
1073
+ templateType:
1074
+ type: string
1075
+ required: true
1076
+ /prompt-templates/data-provider/describe:
1077
+ post:
1078
+ displayName: postPromptTemplateDataProviderInstanceConfig
1079
+ description: Get Data Provider Instance Configuration for given definition name
1080
+ responses:
1081
+ '200':
1082
+ description: Success
1083
+ body:
1084
+ application/json:
1085
+ type: PromptTemplateDataProviderInstanceConfigRepresentation
1086
+ body:
1087
+ application/json:
1088
+ type: PromptTemplateDataProviderInstanceConfigInputRepresentation
1089
+ (oas-body-name): dataProviderInstanceConfigInput
1090
+ /prompt-templates/data-provider-types/{templateType}:
1091
+ get:
1092
+ displayName: getPromptTemplateDataProviderTypeConfig
1093
+ description: Get available data provider types for the specified template type
1094
+ responses:
1095
+ '200':
1096
+ description: Success
1097
+ body:
1098
+ application/json:
1099
+ type: PromptTemplateDataProviderTypeConfigCollectionRepresentation
1100
+ uriParameters:
1101
+ templateType:
1102
+ type: string
1103
+ required: true
1104
+ /prompt-templates/{promptTemplateDevName}:
1105
+ get:
1106
+ displayName: getEinsteinPromptTemplate
1107
+ description: Get A Prompt Template by DeveloperName and Version Id
1108
+ responses:
1109
+ '200':
1110
+ description: Success
1111
+ body:
1112
+ application/json:
1113
+ type: EinsteinPromptRecordRepresentation
1114
+ queryParameters:
1115
+ versionId:
1116
+ type: string
1117
+ required: false
1118
+ uriParameters:
1119
+ promptTemplateDevName:
1120
+ type: string
1121
+ required: true
1122
+ /versions:
1123
+ post:
1124
+ displayName: postEinsteinPromptTemplateVersion
1125
+ description: Create a prompt template Version
1126
+ responses:
1127
+ '200':
1128
+ description: Success
1129
+ body:
1130
+ application/json:
1131
+ type: EinsteinPromptTemplateRepresentation
1132
+ body:
1133
+ application/json:
1134
+ type: EinsteinPromptRecordInputRepresentation
1135
+ (oas-body-name): templateInput
1136
+ uriParameters:
1137
+ promptTemplateDevName:
1138
+ type: string
1139
+ required: true
1140
+ /versions/{versionId}:
1141
+ put:
1142
+ displayName: putEinsteinPromptTemplateVersion
1143
+ description: Modify a prompt template Version
1144
+ responses:
1145
+ '200':
1146
+ description: Success
1147
+ body:
1148
+ application/json:
1149
+ type: EinsteinPromptTemplateRepresentation
1150
+ body:
1151
+ application/json:
1152
+ type: EinsteinPromptRecordInputRepresentation
1153
+ (oas-body-name): templateInput
1154
+ uriParameters:
1155
+ promptTemplateDevName:
1156
+ type: string
1157
+ required: true
1158
+ versionId:
1159
+ type: string
1160
+ required: true
1161
+ /versions/{versionId}/status:
1162
+ put:
1163
+ displayName: putEinsteinPromptTemplateVersionStatus
1164
+ description: Update prompt template version status (activate/deactivate)
1165
+ responses:
1166
+ '200':
1167
+ description: Success
1168
+ body:
1169
+ application/json:
1170
+ type: EinsteinPromptTemplateRepresentation
1171
+ queryParameters:
1172
+ action:
1173
+ type: string
1174
+ required: false
1175
+ ignoreWarnings:
1176
+ type: boolean
1177
+ required: false
1178
+ uriParameters:
1179
+ promptTemplateDevName:
1180
+ type: string
1181
+ required: true
1182
+ versionId:
1183
+ type: string
1184
+ required: true
1185
+ /prompt-templates/{promptTemplateDevName}/generations:
1186
+ post:
1187
+ displayName: postEinsteinPromptTemplateGenerations
1188
+ description: Generates a response based on the provided prompt template and
1189
+ parameters
1190
+ responses:
1191
+ '200':
1192
+ description: Success
1193
+ body:
1194
+ application/json:
1195
+ type: EinsteinPromptTemplateGenerationsRepresentation
1196
+ queryParameters:
1197
+ versionId:
1198
+ type: string
1199
+ required: false
1200
+ body:
1201
+ application/json:
1202
+ type: EinsteinPromptTemplateGenerationsInputWrapperRepresentation
1203
+ (oas-body-name): promptTemplateGenerationsInput
1204
+ uriParameters:
1205
+ promptTemplateDevName:
1206
+ type: string
1207
+ required: true
1208
+ /prompt-template/{promptTemplateDevName}/output-languages:
1209
+ get:
1210
+ displayName: getEinsteinPromptTemplateOutputLanguages
1211
+ description: Get A Prompt Template by DeveloperName and Version Id
1212
+ responses:
1213
+ '200':
1214
+ description: Success
1215
+ body:
1216
+ application/json:
1217
+ type: EinsteinPromptTemplateVersionOutputLanguagesRepresentation
1218
+ queryParameters:
1219
+ useStandardVersion:
1220
+ type: boolean
1221
+ required: false
1222
+ versionId:
1223
+ type: string
1224
+ required: false
1225
+ uriParameters:
1226
+ promptTemplateDevName:
1227
+ type: string
1228
+ required: true