Fields

InsightMaker.fields(include=None, core=True, entities=True, metadata=True, models=True, raw=False)

Parameters:

NameTypeDescription

include

list

List of any combination of "core", "entities" and "metadata" for inclusion in returned object

core

boolean

Alternative to include, boolean, include core fields in return?

entities

boolean

Alternative to include, boolean, include entities fields in return?

metadata

boolean

Alternative to include, boolean, include metadata fields in return?

models

boolean

Alternative to include, boolean, include data model fields in return?

raw

boolean

meDefault False, if true, returns the raw REST JSON response as a python dictionary.

Response:

A list of available Field objects, methods:

  • Field.id() String, Field ID

  • Field.name() String, Field name

  • Field.data_type() Python type object, the Python type for this field (str, datetime, int or float)

Example:

model_fields = im.fields(core=False, entities=False, metadata=False, models=True)
print("Model Fields:")
for field in model_fields:
    print("{} : {}".format(field.name(), field.data_type()))