Fail to create entity with pattern values

[victorzhao1990]

In the Conversation API, it should be possible to create new entity with pattern values in either workspace creation phase (creat_workspace) or by invoking create_entity. They failed and return Error: Invalid Request Body, Code: 400. A feasible way is by creating the entity with only the name but no values and add entity value separately.

Request payload:

CreateEntity entities = [{
    'entity': 'pattern_entity',
    'values': [{
        'value': 'value0', 'patterns': ['\\d{6}\\w{1}\\d{7}'], 'value_type': [patterns']
     }, 
     {'value': 'value1', 
      'patterns': ['[-9][0-9][0-9][0-9][0-9]~! [1-9][1-9][1-9][1-9][1-9][1-9]'], 
      'value_type': ['patterns']}, 
     {'value': 'value2', 
      'patterns': ['[a-z-9]{17}'], 
      'value_type': ['patterns']}, 
     {'value': 'value3', 
      'patterns': [
           '\\d{3}(\\ |-)\\d{3}(\\ |-)\\d{4}', 
           '\\(\\d{3}\\)(\\ |-)\\d{3}(\\ |-)\\d{4}'], 
      'value_type': 'patterns'}, 
     {'value': 'value4', 
      'patterns': ['\\b\\d{5}\\b'], 
      'value_type': ['patterns']}]
}]

This code works:

conv.create_entity(workspace_id=resp['workspace_id'], entity=entities['entity'])
for idx in range(len(entities['values'])):
        conv.create_value(
              workspace_id=resp['workspace_id'], entity=entities['entity'],
              value=entities['values'][idx]['value'], 
              patterns=entities['values'][idx]['patterns'], value_type='patterns')

These don't work:

conv.create_entity(
       workspace_id=resp['workspace_id'], 
       entity=entities['entity'], values=entities['values']
)

conversation.create_workspace(
    name='API test',
    description='Example workspace created via API',
    entities=entities
)

[victorzhao1990]

I think the page on doc site is not up to date. It should be value instead of value_type under CreateValue and type is string not list.

[ehdsouza]

Hi @victorzhao1990 ,

I understand the document is not upto date. The documentation team would be working on it.

[ehdsouza]

Hi @victorzhao1990 ,

As can be seen, the method interface for create_entity states values param as => :param list[CreateValue] values: An array of entity values.

So, you would need to pass in an array of type CreateValue:

from watson_developer_cloud.conversation_v1 import CreateValue

entities = [{
    'entity': 'pattern_entity',
    'values': [
    CreateValue(value='value0', patterns=['\\d{6}\\w{1}\\d{7}'], value_type='patterns'), 
    CreateValue(value='value1', patterns=['[-9][0-9][0-9][0-9][0-9]~! [1-9][1-9][1-9][1-9][1-9][1-9]'],value_type='patterns'), 
    CreateValue(value='value2', patterns=['[a-z-9]{17}'], value_type='patterns'), 
    CreateValue(value='value3', patterns=[
           '\\d{3}(\\ |-)\\d{3}(\\ |-)\\d{4}', 
           '\\(\\d{3}\\)(\\ |-)\\d{3}(\\ |-)\\d{4}'],value_type='patterns'), 
    CreateValue(value='value4', patterns=['\\b\\d{5}\\b'], value_type='patterns')]}]


    response = conversation.create_entity(workspace_id=workspace_id,
                         entity=entities[0]['entity'],
                         values=entities[0]['values'])

And yes, the documentation needs to be updated for value_type to be a str and not list

[ehdsouza]

In the upcoming release, we would also support the passing of the values in the form of dictionaries directly. This is currently a bug in the current version.

[ehdsouza]

The upcoming release (V1.1.0) has this bug fixed. I have also added this in the examples which works:

entities = [{
    'entity':
    'pattern_entity',
    'values': [{
        'value': 'value0',
        'patterns': ['\\d{6}\\w{1}\\d{7}'],
        'value_type': 'patterns'
    }, {
        'value':
        'value1',
        'patterns':
        ['[-9][0-9][0-9][0-9][0-9]~! [1-9][1-9][1-9][1-9][1-9][1-9]'],
        'value_type':
        'patterns'
    }, {
        'value': 'value2',
        'patterns': ['[a-z-9]{17}'],
        'value_type': 'patterns'
    }, {
        'value':
        'value3',
        'patterns': [
            '\\d{3}(\\ |-)\\d{3}(\\ |-)\\d{4}',
            '\\(\\d{3}\\)(\\ |-)\\d{3}(\\ |-)\\d{4}'
        ],
        'value_type':
        'patterns'
    }, {
        'value': 'value4',
        'patterns': ['\\b\\d{5}\\b'],
        'value_type': 'patterns'
    }]
}]
response = conversation.create_entity(
    workspace_id, entity=entities[0]['entity'], values=entities[0]['values'])
print(json.dumps(response, indent=2))