This document describes the API specification for the Predictive Server API. The Predictive Server API (PSAPI) exposes the Predictive Server's functionality as a Java API for use by applications that require data mining and predictive analytic capabilities. The PSAPI and the IBM SPSS Modeler predictive analytics workbench share the same underlying technology.

Design Principles

The PSAPI provides a programmer's interface to the underlying Predictive Server technology. To support the ongoing development of the Predictive Server and still provide the stability needed for an API, the major elements of the PSAPI are specified as Java interfaces. Most of these interfaces are implemented via internal classes provided by the PSAPI but which do not form part of the PSAPI specification. This approach aims to protect the PSAPI user from changes made to the Predictive Server technology (such as architectural changes, private client/server protocol changes etc.).

Package Dependencies

The diagram below summarises the PSAPI package dependencies.

PSAPI Package Dependencies