SAP Conversational AI - SDK Python

SAP Conversational AI official SDK in Python

🚨 Sunset of Open Source SDKs for SAP Conversational AI

SAP Conversational AI provides several SDKs, which are all open-source and hosted on GitHub.
Starting from January 2021, please note that we inform you that the SDKs will not be available anymore and the public repository of the project will be archived from GitHub.

✨ Why are we sunsetting our SDKs?

Firstly, we noticed over the past year that these SDKs were not used much by our users.
This is because our platform usage has become easier, including the APIs.

Secondly, our APIs have undergone major changes. We would need to adapt the SDKs in order to keep them working, which will lead to a significant cost from our side.

Hence, we decided to sunset this open source version starting from January 2021.

✨ What does it mean for me as a user?

Any changes in our API’s will not be reflected in our SDKs. Hence, the code might not work unless you adjust the same.

✨ What are the next steps?

If you are interested in taking the ownership of the project on GitHub, please get in touch with us and we can discuss the process. Otherwise, if there are no objections from anyone, we would archive the project following the open source sunset process.

Please use the platform SAP Answers if you have any other questions related to this topic.

Happy bot building!

The SAP Conversational AI team

Overview

This module is a wrapper around the SAP Conversational AI API, and allows you to:

Installation

Using pip

Install from PyPi using pip, a package manager for Python.

pip install sapcai

Don't have pip installed? Try installing it, by running this from the command line:

$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

With the source code

You can download the source code (ZIP) for SAPConversationalAI-python, and then run:

python setup.py install

You may need to run the above commands with sudo.

This library supports both python 2.7+ and python 3.5+.

You can now use the SDK in your code. All you need is your bot's token. In case you have enabled our versioning feature in the settings of your bot, you can refer to our versioning documentation to learn how to select the appropriate token for you versions and environments.

Usage

Using the entire SDK:

import sapcai

client = sapcai.Client('YOUR_TOKEN')

client.request.analyse_text('Hi')
client.connect.broadcast_message('Hi')

Extracting one single API:

from sapcai import Request, Connect

request = Request('YOUR_TOKEN')
request.analyse_text('Hi')

connect = Connect('YOUR_TOKEN')
connect.broadcast_message('Hi')

You can view the whole API reference at cai.tools.sap/docs/api-reference.

You can follow us on Twitter at @sapcai for updates and releases.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SAP-archive / SDK-python

readme