Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This API allows you to create a field in Hawksearch dashboard and manage the field configurations.

Example use case: Create a Brand field that can be used as a facet filter.

...

Code Block
languagejson
{
    "FieldId": 479976,
    "SyncGuid": "1a0db291-d004-4cfa-a894-1ac8cadbe110",
    "Name": "Brand",
    "FieldType": "facet",
    "Label": "brand",
    "Type": "String",
    "Boost": 1,
    "FacetHandler": 0,
    "IsPrimaryKey": false,
    "IsOutput": true,
    "IsShingle": false,
    "IsBestFragment": false,
    "IsDictionary": false,
    "IsSort": false,
    "IsPrefix": false,
    "IsHidden": false,
    "IsCompare": false,
    "SortOrder": 11,
    "PartialQuery": "",
    "IsKeywordText": false,
    "IsQuery": false,
    "IsQueryText": false,
    "SkipCustom": false,
    "StripHtml": false,
    "MinNGramAnalyzer": 2,
    "MaxNGramAnalyzer": 15,
    "CoordinateType": 0,
    "OmitNorms": false,
    "ItemMapping": "",
    "DefaultValue": "",
    "UseForPrediction": false,
    "CopyTo": "",
    "Analyzer": "",
    "DoNotStore": false,
    "Tags": "",
    "Iterations": [
        1
    ],
    "AnalyzerLanguage": null,
    "PreviewMapping": null,
    "OmitTfAndPos": false,
    "CreateDate": "03-08-2021",
    "ModifyDate": "03-08-2021"
}

Please review : Best Practices to Create Field