Skip to content

Latest commit

 

History

History
99 lines (62 loc) · 2.69 KB

File metadata and controls

99 lines (62 loc) · 2.69 KB

API Documentation

This document describes the Python API available in the SDK. The RESTful API exposed by the Data Attribute Recommendation service itself is described in the SAP Help Portal.

The API exposed by the Python SDK either maps directly to a RESTful API of the service or provides a convenient wrapper around the RESTful API.

This document is split into two sections. The Public APIs are classes and methods that we expect to be the most useful. They interface directly with the Data Attribute Recommendation service.

The Internal APIs are classes and methods which are used internally by the SDK. A user of the SDK is less likely to deal with them in their day-to-day work. We still consider documentation for these parts useful to serve as a reference.

This Internal API is still part of the API contract: if there is a breaking change to either the Internal or the Public API, this will warrant a release with an updated major version number as required by the semantic versioning scheme.

Note

Before upgrading to a new major version release of the SDK, carefully check the changelog for any breaking changes that might impact you.

Public API

Workflows

A workflow orchestrates calls over several of the Data Attribute Recommendation microservices.

sap.aibus.dar.client.workflow.model

Data Manager

sap.aibus.dar.client.data_manager_client

sap.aibus.dar.client.data_manager_constants

Model Manager

sap.aibus.dar.client.model_manager_client

sap.aibus.dar.client.model_manager_constants

Inference

sap.aibus.dar.client.inference_client

sap.aibus.dar.client.inference_constants

Internal API

The Credentials Module

sap.aibus.dar.client.util.credentials

Exceptions

sap.aibus.dar.client.exceptions

HTTP Connections

sap.aibus.dar.client.dar_session

sap.aibus.dar.client.util.http_transport

Base Class for Client Classes

sap.aibus.dar.client.base_client

Utilities

sap.aibus.dar.client.util.polling

sap.aibus.dar.client.util.logging

sap.aibus.dar.client.util.lists