Method
createPythonFunction POST
Copy POST

Creates a custom Python function that is reusable.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes name str The name to identify the Python function. Must be a valid Python identifier.
No sourceCode str Contents of a valid Python source code file. The source code should contain the transform feature group functions. A list of allowed imports and system libraries for each language is specified in the user functions documentation section.
No functionName str The name of the Python function.
No functionVariableMappings List[PythonFunctionArgument] List of Python function arguments.
No packageRequirements list List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'].
No functionType str Type of Python function to create. Default is FEATURE_GROUP, but can also be PLOTLY_FIG.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result PythonFunction
KEY TYPE Description
notebookId str The unique identifier of the notebook used to spin up the notebook upon creation.
name str The name to identify the algorithm, only uppercase letters, numbers, and underscores allowed (i.e. it must be a valid Python identifier)
createdAt str The ISO-8601 string representing when the Python function was created.
functionVariableMappings dict A description of the function variables.
outputVariableMappings dict A description of the variables returned by the function
functionName str The name of the Python function to be used.
pythonFunctionId str The unique identifier of the Python function.
functionType str The type of the Python function.
packageRequirements list The pip package dependencies required to run the code
codeSource CodeSource Information about the source code of the Python function.
KEY TYPE Description
sourceType str The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR
sourceCode str If the type of the source is TEXT, the raw text of the function
applicationConnectorId str The Application Connector to fetch the code from
applicationConnectorInfo str Args passed to the application connector to fetch the code
packageRequirements list The pip package dependencies required to run the code
status str The status of the code and validations
error str If the status is failed, an error message describing what went wrong
publishingMsg dict Warnings in the source code
moduleDependencies list The list of internal modules dependencies required to run the code

Exceptions:

TYPE WHEN
InvalidEnumParameterError

An invalid value is passed for functionType.
Language:

© Copyright