This project has been archived by its maintainers, and is no longer receiving any updates.
[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])
Metadata
Release files for ai-api-client-sdk 2.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ai_api_client_sdk-2.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Release files / ai_api_client_sdk-2.6.1-py3-none-any.whl
| Download URL | ai_api_client_sdk-2.6.1-py3-none-any.whl |
|---|---|
| Size | 265.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f08d3f3c4fa04630767137dbf6f7f29937d9597cd29e453aac53201b60b8fce1
|
|
BLAKE2b-256 checksum How to use checksums |
756c00f615d83bdf183186d3bd33cc838deefdb8a6efcae9dae23089e5c90b81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.1
|
Security for ai-api-client-sdk 2.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.