PostHog · Schema

DocumentSimilarityQuery

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
dateRange	object
distance_func	object
document_types	array
kind	string
limit	integer
model	string
modifiers	object	Modifiers used when performing the query
offset	integer
order_by	object
order_direction	object
origin	object
products	array
renderings	array
response	object
tags	object
threshold	number
version	number	version of the node, used for schema migrations

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DocumentSimilarityQuery",
  "title": "DocumentSimilarityQuery",
  "additionalProperties": false,
  "properties": {
    "dateRange": {
      "$ref": "#/components/schemas/DateRange"
    },
    "distance_func": {
      "$ref": "#/components/schemas/DistanceFunc"
    },
    "document_types": {
      "items": {
        "type": "string"
      },
      "title": "Document Types",
      "type": "array"
    },
    "kind": {
      "default": "DocumentSimilarityQuery",
      "title": "Kind",
      "type": "string",
      "enum": [
        "DocumentSimilarityQuery"
      ]
    },
    "limit": {
      "default": null,
      "title": "Limit",
      "type": "integer",
      "nullable": true
    },
    "model": {
      "title": "Model",
      "type": "string"
    },
    "modifiers": {
      "default": null,
      "description": "Modifiers used when performing the query",
      "allOf": [
        {
          "$ref": "#/components/schemas/HogQLQueryModifiers"
        }
      ],
      "nullable": true
    },
    "offset": {
      "default": null,
      "title": "Offset",
      "type": "integer",
      "nullable": true
    },
    "order_by": {
      "$ref": "#/components/schemas/OrderBy"
    },
    "order_direction": {
      "$ref": "#/components/schemas/OrderDirection1"
    },
    "origin": {
      "$ref": "#/components/schemas/EmbeddedDocument"
    },
    "products": {
      "items": {
        "type": "string"
      },
      "title": "Products",
      "type": "array"
    },
    "renderings": {
      "items": {
        "type": "string"
      },
      "title": "Renderings",
      "type": "array"
    },
    "response": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentSimilarityQueryResponse"
        }
      ],
      "nullable": true
    },
    "tags": {
      "default": null,
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLogTags"
        }
      ],
      "nullable": true
    },
    "threshold": {
      "default": null,
      "title": "Threshold",
      "type": "number",
      "nullable": true
    },
    "version": {
      "default": null,
      "description": "version of the node, used for schema migrations",
      "title": "Version",
      "type": "number",
      "nullable": true
    }
  },
  "required": [
    "dateRange",
    "distance_func",
    "document_types",
    "model",
    "order_by",
    "order_direction",
    "origin",
    "products",
    "renderings"
  ],
  "type": "object"
}