Snowflake · Schema

SendMessageRequest

The request object for sendMessage requests

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
semantic_model_file string The path to a file stored in a Snowflake Stage holding the semantic model yaml. Must be a fully qualified stage url
semantic_model string A string containing the entire semantic model yaml
semantic_view string The name of the Snowflake native semantic model object
semantic_models array A list of semantic model objects. If set, other semantic model properties are ignored
stream boolean Whether to stream the response or not
operation string Whether to response with SQL or natural language. One of 'sql_generation' or 'answer_generation'
warehouse string Warehouse name to use for result set handling. Only used when 'operation' is 'answer_generation'
messages array
source string an optional field to specify the source of the request. e.g "eval", "prod"
experimental string JSON serialized string of experimental API fields (undocumented).
View JSON Schema on GitHub

JSON Schema

cortex-analyst-send-message-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SendMessageRequest",
  "type": "object",
  "description": "The request object for sendMessage requests",
  "properties": {
    "semantic_model_file": {
      "type": "string",
      "description": "The path to a file stored in a Snowflake Stage holding the semantic model yaml. Must be a fully qualified stage url"
    },
    "semantic_model": {
      "type": "string",
      "description": "A string containing the entire semantic model yaml"
    },
    "semantic_view": {
      "type": "string",
      "description": "The name of the Snowflake native semantic model object"
    },
    "semantic_models": {
      "type": "array",
      "description": "A list of semantic model objects. If set, other semantic model properties are ignored"
    },
    "stream": {
      "type": "boolean",
      "description": "Whether to stream the response or not"
    },
    "operation": {
      "type": "string",
      "description": "Whether to response with SQL or natural language. One of 'sql_generation' or 'answer_generation'"
    },
    "warehouse": {
      "type": "string",
      "description": "Warehouse name to use for result set handling. Only used when 'operation' is 'answer_generation'"
    },
    "messages": {
      "type": "array"
    },
    "source": {
      "type": "string",
      "description": "an optional field to specify the source of the request. e.g \"eval\", \"prod\""
    },
    "experimental": {
      "type": "string",
      "description": "JSON serialized string of experimental API fields (undocumented)."
    }
  }
}