Skip to main content

CommsFiltersResponse

filters objectrequired

The enabled registry, keyed by auto-tag id.

property name* CommsFilterEntry
enabledEnabledrequired
valuesstring[]

Empty hides every value of the tag; otherwise only documents whose extracted value is listed.

property name*any
tags object[]required
  • Array [
    • descriptionDescription
    Default value:
    enabledEnabledrequired
    filter_examples object[]
  • Array [
    • added_at object
    anyOf
    string
    added_by object
    anyOf
    string
    document_idDocument Idrequired
    snippetSnippetrequired
    titleTitlerequired
    property name*any
  • ]
    • hidden_countHidden Countrequired

    Documents the filter currently hides.

    idIdrequired
    nameNamerequired
    Example: Spam
    tag_typeTag Typerequired

    content_filter for a manual filter; any other auto-tag type when a semantic tag is linked as a filter.

    Example: content_filter
    valuesstring[]
    property name*any
  • ]
    • property name*any
    CommsFiltersResponse
    {
      "filters": {},
      "tags": [
        {
          "description": "",
          "enabled": true,
          "filter_examples": [
            {
              "added_at": "string",
              "added_by": "string",
              "document_id": "string",
              "snippet": "string",
              "title": "string"
            }
          ],
          "hidden_count": 0,
          "id": "string",
          "name": "Spam",
          "tag_type": "content_filter",
          "values": [
            "string"
          ]
        }
      ]
    }