Skip to main content

[DEPRECATED] AI API Client SDK

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

[DEPRECATED] SAP AI API Client SDK

This package is no longer maintained.

Please use sap-ai-sdk-base instead.


The AI API client SDK is a Python-based SDK that enables you to access the AI API using Python methods and data structures. You can use the Client SDK to test AI API.

The client SDK can be used with any implementation of AI API. Because it is independent of the runtime implementation, it doesn't provide access to runtime-specific APIs. For example, maintaining object store secrets is specific to SAP AI Core and is therefore not included in the AI API client SDK. Check for SDK offerings for your runtime that let you access any runtime-specific APIs. For more information on SAP AI Core SDK see https://pypi.org/project/ai-core-sdk/.

For more information on the AI API specification, SAP AI Core and related topics, please refer to https://help.sap.com/docs/AI_CORE?version=CLOUD.

Example Usage

from ai_api_client_sdk.ai_api_v2_client import AIAPIV2Client

# Instantiate the client
client = AIAPIV2Client(base_url=AI_API_URL,
    auth_url=AUTH_URL,
    client_id=CLIENT_ID,
    client_secret=CLIENT_SECRET, resource_group=RESOURCE_GROUP)

# Make some queries, e.g.
scenarios = client.scenario.query()

for scenario in scenarios.resources:
    print(scenario.id)

# Find a deployable executables in scenario 1111
executables = client.executable.query(scenario_id="1111")
for executable in executables.resources:
    if executable.deployable == False:
        break
print(executable.id)

# Inspect the required parameters for the executable
for parameter in executable.parameters:
    print("Parameter:{}, Type: {}".format(parameter.name, parameter.type))

# Create a configuration
parameter_epochs = ParameterBinding(key="training-epochs", value="1")
myConfiguration = client.configuration.create(name="test", scenario_id="1111" executable_id="argo-mnist-0.2.1", parameter_bindings=[parameter_epochs])

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ai_api_client_sdk-2.6.1-py3-none-any.whl (265.5 kB view details)

Uploaded Python 3

File details

Details for the file ai_api_client_sdk-2.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_api_client_sdk-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f08d3f3c4fa04630767137dbf6f7f29937d9597cd29e453aac53201b60b8fce1
MD5 23d78c5ae961916b025b4674d0296c63
BLAKE2b-256 756c00f615d83bdf183186d3bd33cc838deefdb8a6efcae9dae23089e5c90b81

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page