Einstein Prompt Template Generations

Generates a response based on the specified prompt template and input parameters.

Resource

1/einstein/prompt-templates/promptTemplateDevName/generations

The promptTemplateDevName is the developer name or ID of the prompt template record to generate a response for.

Available version

60.0

HTTP methods

POST

Request body for POST

Einstein Prompt Template Generations Input

Root XML tag

EinsteinPromptTemplateGenerationsInput

JSON example

1{
2  "isPreview": false,
3  "inputParams": {
4    "valueMap": {
5      "Input:String1": {
6        "value": "Value of String1"
7      },
8       "Input:String2": {
9        "value": "Value of String2"
10      },
11      "Input:Account": {
12        "value": {
13          "id": "001SB000004nerfYAA"
14        }
15      }
16    }
17  },
18  "additionalConfig": {
19    "applicationName": "PromptTemplateGenerationsInvocable"
20  }
21}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalConfig`	EinsteinLlmAdditionalConfigInput	Configuration information for the LLM provider.	Required	60.0
`citationMode`	String	Mode of citations for the specified prompt template. Valid values are: `post_generation`—Citations are generated after the generated response for the specified prompt template. `off`—Citations aren't generated for the specified prompt template.	Optional	62.0
`inputParams`	Map<String, Wrapped Value>	Parameters and values to resolve the specified prompt template.	Required	60.0
`isPreview`	Boolean	Specifies whether to only resolve the prompt template (`true`) or to resolve the prompt template and generate an LLM response (`false`).	Required	60.0
`outputLanguage`	String	Language code for the language to generate the LLM response in. See Supported Languages in Prompt Template Responses.	Optional	61.0
`tags`	Wrapped Value	Map of wrapped values, such as free-form user feedback, that can be used to resolve a specified prompt template.	Optional	62.0

Response body for POST: Einstein Prompt Template Generations

Connect REST API Developer Guide

Einstein Prompt Template Generations