ChatGenerationRequest

Artificial IntelligenceComputer VisionCRMMachine LearningNatural Language ProcessingPredictive AnalyticsSalesforce

Properties

Name Type Description
promptTemplateDevName string Developer name of the chat prompt template.
inputParams object
messages array Conversation history for context.
additionalConfig object
View JSON Schema on GitHub

JSON Schema

salesforce-einstein-chatgenerationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatGenerationRequest",
  "title": "ChatGenerationRequest",
  "type": "object",
  "properties": {
    "promptTemplateDevName": {
      "type": "string",
      "description": "Developer name of the chat prompt template."
    },
    "inputParams": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "messages": {
      "type": "array",
      "description": "Conversation history for context.",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "enum": [
              "user",
              "assistant",
              "system"
            ]
          },
          "content": {
            "type": "string"
          }
        }
      }
    },
    "additionalConfig": {
      "type": "object",
      "properties": {
        "maxTokens": {
          "type": "integer"
        },
        "temperature": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "messages"
  ]
}