Package: ondewo-vtsi-client
Ondewo VTSI Client Python LibraryThis library facilitates the interaction between a user and a CAI server. It achieves this by providing a higher-level interface mediator.This higher-level interface mediator is structured around a series of python files generated from protobuf files. These protobuf files specify the details of the interface, and can be used to generate code in 10+ high-level languages. They are found in theONDEWO VTSI APIalong with the older Google protobufs from Dialogueflow that were used at the start. TheONDEWO PROTO-COMPILERwill generate the needed files directly in this library.Python InstallationYou can install the library by installing it directly from the PyPi:pipinstallondewo-vtsi-clientOr, you could clone it and install the requirements:gitclonegit@github.com:ondewo/ondewo-vtsi-client-python.gitcdondewo-vtsi-client-python
makesetup_developer_environment_locallyRepository Structure.
├── examples
│   ├── analysis
│   │   └── analysis.py
│   ├── caller
│   │   ├── caller_deployment_minimal.py
│   │   ├── caller_deployment_mirror_mode.py
│   │   ├── configure_context_parameters.py
│   │   ├── full_config.py
│   │   └── make_multiple_calls.py
│   └── listener
│       ├── listener_deployment.py
│       └── minimal_listener.py
├── ondewo
│   ├── nlu
│   │   ├── agent_pb2_grpc.py
│   │   ├── agent_pb2.py
│   │   ├── agent_pb2.pyi
│   │   ├── aiservices_pb2_grpc.py
│   │   ├── aiservices_pb2.py
│   │   ├── aiservices_pb2.pyi
│   │   ├── ccai_project_pb2_grpc.py
│   │   ├── ccai_project_pb2.py
│   │   ├── ccai_project_pb2.pyi
│   │   ├── common_pb2_grpc.py
│   │   ├── common_pb2.py
│   │   ├── common_pb2.pyi
│   │   ├── context_pb2_grpc.py
│   │   ├── context_pb2.py
│   │   ├── context_pb2.pyi
│   │   ├── entity_type_pb2_grpc.py
│   │   ├── entity_type_pb2.py
│   │   ├── entity_type_pb2.pyi
│   │   ├── __init__.py
│   │   ├── intent_pb2_grpc.py
│   │   ├── intent_pb2.py
│   │   ├── intent_pb2.pyi
│   │   ├── operation_metadata_pb2_grpc.py
│   │   ├── operation_metadata_pb2.py
│   │   ├── operation_metadata_pb2.pyi
│   │   ├── operations_pb2_grpc.py
│   │   ├── operations_pb2.py
│   │   ├── operations_pb2.pyi
│   │   ├── project_role_pb2_grpc.py
│   │   ├── project_role_pb2.py
│   │   ├── project_role_pb2.pyi
│   │   ├── project_statistics_pb2_grpc.py
│   │   ├── project_statistics_pb2.py
│   │   ├── project_statistics_pb2.pyi
│   │   ├── server_statistics_pb2_grpc.py
│   │   ├── server_statistics_pb2.py
│   │   ├── server_statistics_pb2.pyi
│   │   ├── session_pb2_grpc.py
│   │   ├── session_pb2.py
│   │   ├── session_pb2.pyi
│   │   ├── user_pb2_grpc.py
│   │   ├── user_pb2.py
│   │   ├── user_pb2.pyi
│   │   ├── utility_pb2_grpc.py
│   │   ├── utility_pb2.py
│   │   ├── utility_pb2.pyi
│   │   ├── webhook_pb2_grpc.py
│   │   ├── webhook_pb2.py
│   │   └── webhook_pb2.pyi
│   ├── qa
│   │   ├── __init__.py
│   │   ├── qa_pb2_grpc.py
│   │   ├── qa_pb2.py
│   │   └── qa_pb2.pyi
│   ├── s2t
│   │   ├── __init__.py
│   │   ├── speech_to_text_pb2_grpc.py
│   │   ├── speech_to_text_pb2.py
│   │   └── speech_to_text_pb2.pyi
│   ├── sip
│   │   ├── __init__.py
│   │   ├── sip_pb2_grpc.py
│   │   ├── sip_pb2.py
│   │   └── sip_pb2.pyi
│   ├── t2s
│   │   ├── __init__.py
│   │   ├── text_to_speech_pb2_grpc.py
│   │   ├── text_to_speech_pb2.py
│   │   └── text_to_speech_pb2.pyi
│   ├── vtsi
│   │   ├── client.py
│   │   ├── __init__.py
│   │   ├── vtsi_pb2_grpc.py
│   │   ├── vtsi_pb2.py
│   │   └── vtsi_pb2.pyi
│   └── __init__.py
├── ondewo-proto-compiler
├── ondewo-vtsi-api
├── CONTRIBUTING.md
├── Dockerfile.utils
├── LICENSE
├── Makefile
├── MANIFEST.in
├── mypy.ini
├── README.md
├── RELEASE.md
├── requirements-dev.txt
├── requirements.txt
├── setup.cfg
├── setup.py
└── temp.txtBuildThemake buildcommand is dependent on 2repositoriesand their speciefiedversion:ondewo-vtsi-api--VTSI_API_GIT_BRANCHinMakefileondewo-proto-compiler--ONDEWO_PROTO_COMPILER_GIT_BRANCHinMakefileIt will generate a_pb2.py,_pb2.pyiand_pb2_grpc.pyfile for every.protoin the api submodule.:warning: All Files in theondewofolder that dont havepb2in their name are handwritten, and therefor need to be manually adjusted to any changes in the proto-code.ExamplesThe/examplesfolder provides a possible implementation of this library. To run an example, simple execute it like any other python file. To specify the server and credentials, you need to provide an environment file with the following variables:host// The hostname of the Server - e.g. 127.0.0.1port// Port of the Server - e.g. 6600user_name// Username - same as you would use in AIMpassword// Password of the userhttp_token// Token to allow access throughgrpc_cert// gRPC Certificate of the serverAutomatic Release ProcessThe entire process is automated to make development easier. The actual steps are simple:TODO after Pull Request was merged in:Checkout master:gitcheckoutmasterPull the new stuff:gitpull(If not already, run thesetup_developer_environment_locallycommand):makesetup_developer_environment_locallyUpdate theONDEWO_VTSI_VERSIONin theMakefileAdd the new Release Notes inRELEASE.mdin the format:## Release ONDEWO VTSI Python Client X.X.X       <---- Beginning of Notes

   ...<NOTES>...

*****************                      <---- End of NotesRelease:makeondewo_releaseThe release process can be divided into 6 Steps:buildspecified version of theondewo-vtsi-apicommit and pushall changes in code resulting from thebuildCreate and push therelease branche.g.release/1.3.20Create and push therelease tage.g.1.3.20Create a newReleaseon GitHubPublish the builtdistfolder topypi.org:warning: The Release Automation checks if the build has created all the proto-code files, but it does not check the code-integrity. Please build and test the generated code prior to starting the release process.