ManageResources

For an answer bank system, you can use this action to add, modify, and delete questions and question equivalence classes. You can also use it to add and update the state of a question.

For a conversation system, you can use this action to add and delete conversation sessions.

You can also use this action to add and delete question contexts. The context specifies additional information to limit the scope of the question. In Fact Bank the context is a specific entity used in disambiguation, for example, you might set a context to specify that a user is asking questions about Cambridge UK, rather than Cambridge Massachusetts or Ontario. For Answer Bank or Passage Extractor, the context is a string that could, for example, come from a previous question. ManageResources returns a context ID that you can use in subsequent Ask actions.

NOTE: Conversation sessions and question contexts use licensed conversation slots. ManageResources returns an error if you do not have enough capacity. In this case, you must wait until a conversation session or question context expires, or delete one before you can create another.

This action requires a JSON object that specifies the update to request, and most updates also require a system name. You can use the GetResources action to retrieve the JSON schemas that you need to use to make each kind of update.

You update the system by sending a POST request with the JSON update.

For more information, refer to the Answer Server Administration Guide.

NOTE: You must use a POST request method.

Examples

action=ManageResources&SystemName=MyAnswerBank
Data={
   "operation": "add",
   "type":"question",
   "questions":[
      {"text":"Where do I sign up for the monthly newsletter?"}
   ]
}

This action adds the question Where do I sign up for the monthly newsletter? to the MyAnswerBank system.

action=ManageResources&SystemName=MyConversation
Data={
   "operation": "add",
   "type":"conversation_session"
}

This action adds a conversation session to the MyConversation system.

action=ManageResources
Data={ "type": "context", "operation": "add", "context": [{ "system_name": "factbank1", "data": [{ "code_type": "entity", "name": "Cambridge", "codes": ["Q350"] }] }] }

This action creates a Fact Bank context to use with Ask actions.

To update a context it is possible to use a context token which is returned when a valid context ID is provided with an Ask action:

action=ManageResources
Data={ "type": "context", "operation": "update", "id": "13344074142776077059", "context": [ "14091358227749039740" ] }

Required Parameters

The following action parameters are required.

Parameter Description
Data A JSON object that describes the update that you want to make.

Depending on the type of update that you want to make, the following action parameter might also be required.

Parameter Description
SystemName The name of the system that you want to update.

Optional Parameters

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.

Response

You can retrieve the full response XSD by sending the GetResources action with Type set to XSD.