Skip to main content

SemanticTemplateCreate

Payload used to create Semantic Template. The required field is name.

nameName (string)required
alias object
anyOf
string
collection_id object

Identifier of the containing collection.

anyOf
string

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    templates object[]
  • Array [
    • nameName (string)required

    Stable name of the computation template within its template group.

    description object

    Human-readable explanation of the computation.

    anyOf
    string
    questionsstring[]required

    Example questions used to match requests to this template.

    Possible values: >= 1

    slots object[]

    Input slots shared by every query in the template.

  • Array [
    • nameName (string)required
    kindKind (string)

    Possible values: [string, number, value, list]

    Default value: string
    description object
    anyOf
    string
    requiredRequired (boolean)
    Default value: true
    defaultDefault
  • ]
    • queries object[]required

    Named queries whose results are passed to the computation code.

    Possible values: >= 1

  • Array [
    • nameName (string)required
    table_idTable Id (string)required
    toolTool (string)

    Possible values: [metrics, rows]

    Default value: metrics
    query objectrequired
    property name*any
  • ]
    • codeCode (string)required

    Code that combines the named query results into the template output.

  • ]
    • SemanticTemplateCreate
    {
      "name": "string",
      "alias": "string",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "templates": [
        {
          "name": "string",
          "description": "string",
          "questions": [
            "string"
          ],
          "slots": [
            {
              "name": "string",
              "kind": "string",
              "description": "string",
              "required": true
            }
          ],
          "queries": [
            {
              "name": "string",
              "table_id": "string",
              "tool": "metrics",
              "query": {}
            }
          ],
          "code": "string"
        }
      ]
    }