CustomizationData

A JSON object that defines additional requirements for the Ask action. For Fact Bank systems, you can also use this parameter with the Report
action.

The JSON object must include a system_name property. You can use CustomizationData for different functions, depending on the system type.

  • Passage Extractor. You can use CustomizationData to supply a SecurityInfo string to use with your Ask action. This option allows you to use document security with the IDOL Content Data Index, to ensure that users receive answers only from documents that they have access to.

  • Fact Bank. You can use CustomizationData to supply a SecurityInfo string to use with your Ask action. This option allows you to use document security with the facts in your SQL database fact store. To use security with Fact Bank, you must have a SQL database fact store, which includes the sources and security_types tables, with ACL information for your sources. You must also configure the security types in your Answer Server configuration file. For more information, refer to the Answer Server Administration Guide and see Security Configuration Parameters

  • Answer Bank. You can use CustomizationData to supply additional FieldText to the query to your Answer Bank Agentstore. You can use this option to restrict Ask actions to a subset of your Answer Bank data, without having to set up multiple Answer Bank systems and Agentstores. For more information, refer to theAnswer Server Administration Guide. For details of syntax and options that you can use for FieldText, refer to the IDOL Server Administration Guide.

  • Global. You can use CustomizationData to list the questions and answers that have already been used in the current question answering session. This option applies to all systems. In this case, you set the session_data option to a string that represents a JSON array of JSON objects, each with at least one key out of question and answer, which both map to a string. You can use these keys to provide details of the previous questions and answers, which provides additional context for future questions.

You can retrieve the full schema for the customization data object by sending the GetResources action with Type set to Schema.

Actions:

Ask

Report

Type: String
Default:  
Example:

CustomizationData=[{"system_name":"MyPassageExtractor", "security_info": "MTQ0lGDBkNrJvBv0pOi%2BQDBK1z6y/1/09BqL4Vu/18W7JGCy8Pvm4/wixO/pI99/A=="}]

CustomizationData=[{"system_name": "global", "session_data": "[{\"question\":\"How tall is the Eiffel Tower?\", \"answer\": \"300m\"}]"}]

See Also: GetResources action Type parameter