@salesforce/lds-adapters-service-einsteinllm 1.288.0 → 1.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -2,11 +2,11 @@
2
2
  securedBy:
3
3
  - OAuth2
4
4
  title: Salesforce Connect API
5
- version: '59.0'
5
+ version: '61.0'
6
6
  mediaType: application/json
7
7
  protocols:
8
8
  - https
9
- baseUri: /services/data/v61.0
9
+ baseUri: /services/data/v62.0
10
10
  securitySchemes:
11
11
  OAuth2:
12
12
  type: OAuth 2.0
@@ -136,16 +136,32 @@ types:
136
136
  description: Output of a einstein llm generation item response
137
137
  type: object
138
138
  properties:
139
+ contentQualityRepresentation:
140
+ description: Generations Content Quality Representation
141
+ type: EinsteinLlmGenerationsContentQualityRepresentation | nil # Hand-rolled union 'nil'
142
+ required: false # TODO Hand-rolled W-9314597
139
143
  parameters:
140
144
  description: Any provider specific attributes will be included as part of
141
145
  this object
142
146
  type: string
147
+ responseId:
148
+ description: Generations Response Id
149
+ type: string
150
+ safetyScoreRepresentation:
151
+ description: 'Generations Safety Score Representation '
152
+ type: EinsteinLlmGenerationsSafetyScoreRepresentation | nil # Hand-rolled union 'nil'
153
+ required: false # TODO Hand-rolled W-9314597
143
154
  text:
144
155
  description: Text
145
156
  type: string
146
- responseId:
147
- description: Id of the generation response
148
- type: string
157
+ EinsteinLlmGenerationsContentQualityRepresentation:
158
+ description: Output of a einstein llm generation content quality representation
159
+ type: object
160
+ properties:
161
+ isToxicityDetected:
162
+ description: Content Quality
163
+ required: false # TODO Hand-rolled W-9314597
164
+ type: boolean | nil # Hand-rolled union 'nil'
149
165
  # TODO Hand-rolled W-8334626
150
166
  # Need to manually wrap the input representation with what the aura controller is expecting
151
167
  EinsteinLlmGenerationsInputWrapperRepresentation:
@@ -198,6 +214,56 @@ types:
198
214
  promptTemplateGenerationsInput:
199
215
  description: Set the parameters for prompt template message generation
200
216
  type: EinsteinPromptTemplateGenerationsInputRepresentation
217
+ EinsteinLlmGenerationsSafetyScoreRepresentation:
218
+ description: Output of a einstein llm generation safety score representation
219
+ type: object
220
+ properties:
221
+ hateScore:
222
+ description: Hate Score
223
+ type: number | nil # Hand-rolled union 'nil'
224
+ required: false # TODO Hand-rolled W-9314597
225
+ physicalScore:
226
+ description: Physical Score
227
+ type: number | nil # Hand-rolled union 'nil'
228
+ required: false # TODO Hand-rolled W-9314597
229
+ profanityScore:
230
+ description: Profanity Score
231
+ type: number | nil # Hand-rolled union 'nil'
232
+ required: false # TODO Hand-rolled W-9314597
233
+ safetyScore:
234
+ description: Safety Score
235
+ type: number | nil # Hand-rolled union 'nil'
236
+ required: false # TODO Hand-rolled W-9314597
237
+ sexualScore:
238
+ description: Sexual Score
239
+ type: number | nil # Hand-rolled union 'nil'
240
+ required: false # TODO Hand-rolled W-9314597
241
+ toxicityScore:
242
+ description: Toxicity Score
243
+ type: number | nil # Hand-rolled union 'nil'
244
+ required: false # TODO Hand-rolled W-9314597
245
+ violenceScore:
246
+ description: Violence Score
247
+ type: number | nil # Hand-rolled union 'nil'
248
+ required: false # TODO Hand-rolled W-9314597
249
+ EinsteinPromptTemplateGenerationsErrorRepresentation:
250
+ description: Error output of a EinsteinPromptTemplateGeneration request
251
+ type: object
252
+ properties:
253
+ errorMessage:
254
+ description: This is the error message meant for client consumption. It may
255
+ differ from the Gateway Error Message
256
+ type: string
257
+ httpErrorCode:
258
+ description: HTTP Error Code classifying the error
259
+ type: string
260
+ localizedErrorMessage:
261
+ description: This is the localized error message.
262
+ type: string
263
+ required: false # TODO Hand-rolled W-9314597
264
+ messageCode:
265
+ description: The message code received from the LLM Gateway
266
+ type: string
201
267
  EinsteinPromptTemplateGenerationsInputRepresentation:
202
268
  description: Input representation for generating prompt template responses with
203
269
  Einstein LLM
@@ -226,6 +292,12 @@ types:
226
292
  description: Output of a einstein llm generations response for given prompt template
227
293
  type: object
228
294
  properties:
295
+ generationErrors:
296
+ description: generated prompt template generationErrors
297
+ type: array
298
+ required: false # TODO Hand-rolled W-9314597
299
+ items:
300
+ type: EinsteinPromptTemplateGenerationsErrorRepresentation
229
301
  generations:
230
302
  description: List of generated text
231
303
  type: array
@@ -282,35 +354,35 @@ types:
282
354
  type: object
283
355
  /einstein:
284
356
  /llm:
285
- # Hand-rolled remove /embeddings endpoint; not in scope for current work
286
- /prompt/generations:
357
+ /feedback:
287
358
  post:
288
- displayName: postEinsteinLlmGenerations
289
- description: Generates a response based on the provided prompt and parameters
359
+ displayName: postEinsteinLlmFeedback
360
+ description: Send feedback for a generations.response object
290
361
  responses:
291
362
  '200':
292
363
  description: Success
293
364
  body:
294
365
  application/json:
295
- type: EinsteinLlmGenerationsRepresentation
366
+ type: EinsteinLlmFeedbackRepresentation
296
367
  body:
297
368
  application/json:
298
- type: EinsteinLlmGenerationsInputWrapperRepresentation
299
- (oas-body-name): generationsInput
300
- /feedback:
369
+ type: EinsteinLlmFeedbackWrapperRepresentation
370
+ (oas-body-name): feedbackInput
371
+ # Hand-rolled remove /embeddings endpoint; not in scope for current work
372
+ /prompt/generations:
301
373
  post:
302
- displayName: postEinsteinLlmFeedback
303
- description: Send feedback for a generations.response object
374
+ displayName: postEinsteinLlmGenerations
375
+ description: Generates a response based on the provided prompt and parameters
304
376
  responses:
305
377
  '200':
306
378
  description: Success
307
379
  body:
308
380
  application/json:
309
- type: EinsteinLlmFeedbackRepresentation
381
+ type: EinsteinLlmGenerationsRepresentation
310
382
  body:
311
383
  application/json:
312
- type: EinsteinLlmFeedbackWrapperRepresentation
313
- (oas-body-name): feedbackInput
384
+ type: EinsteinLlmGenerationsInputWrapperRepresentation
385
+ (oas-body-name): generationsInput
314
386
  /prompt-templates/{promptTemplateDevName}/generations:
315
387
  post:
316
388
  displayName: postEinsteinPromptTemplateGenerations