aristech-nlp-client 1.0.0__tar.gz

aristech_nlp_client-1.0.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: aristech-nlp-client
+Version: 1.0.0
+Summary: A Python client library for the Aristech Natural-Language-Processing API.
+Author-email: Martin Mende <speech@aristech.de>
+License: MIT License
+Project-URL: Homepage, https://github.com/aristech-de/nlp-clients/tree/main/python
+Project-URL: Issues, https://github.com/aristech-de/nlp-clients/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio
+Requires-Dist: protobuf
+Provides-Extra: dev
+Requires-Dist: grpcio-tools; extra == "dev"
+Requires-Dist: mypy-protobuf; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+
+# Aristech NLP-Client for Python
+
+This is the Python client implementation for the Aristech NLP-Server.
+
+## Installation
+
+The package is not published to PyPI yet but will be soon.
+
+<!-- ```bash
+pip install aristech-nlp-client
+``` -->
+
+## Usage
+
+```python
+from aristech_nlp_client import NlpClient
+
+client = NlpClient(host='nlp.example.com')
+data = client.synthesize(SpeechRequest(
+    text='Hello, world!',
+    options=SpeechRequestOption(
+      voice_id='some-voice-id'
+    )
+))
+with open('output.wav', 'wb') as f:
+    f.write(data)
+```
+
+There are several examples in the [examples](.) directory:
+
+- [functions.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/models.py): Demonstrates how to list the available functions.
+- [process.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/process.py): Demonstrates how to perform NLP processing on a text.
+- [projects.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/projects.py): Demonstrates how to list the available projects.
+- [intents.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/intents.py): Demonstrates how to list intents for a project.
+- [scoreLimits.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/scoreLimits.py): Demonstrates how to use score limits to figure out good thresholds for intents.
+- [content.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/content.py): Demonstrates how to search content for a given prompt.
+
+You can run the examples directly using `python` like this:
+
+1. Create a `.env` file in the [python](.) directory:
+
+```sh
+HOST=nlp.example.com
+# The credentials are optional but probably required for most servers:
+TOKEN=your-token
+SECRET=your-secret
+
+# The following are optional:
+# ROOT_CERT=your-root-cert.pem # If the server uses a self-signed certificate
+# PROJECT_ID=some-project-id # Required for some examples
+```
+
+2. Run the examples, e.g.:
+
+```sh
+python examples/functions.py
+```

aristech_nlp_client-1.0.0/README.md

@@ -0,0 +1,57 @@
+# Aristech NLP-Client for Python
+
+This is the Python client implementation for the Aristech NLP-Server.
+
+## Installation
+
+The package is not published to PyPI yet but will be soon.
+
+<!-- ```bash
+pip install aristech-nlp-client
+``` -->
+
+## Usage
+
+```python
+from aristech_nlp_client import NlpClient
+
+client = NlpClient(host='nlp.example.com')
+data = client.synthesize(SpeechRequest(
+    text='Hello, world!',
+    options=SpeechRequestOption(
+      voice_id='some-voice-id'
+    )
+))
+with open('output.wav', 'wb') as f:
+    f.write(data)
+```
+
+There are several examples in the [examples](.) directory:
+
+- [functions.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/models.py): Demonstrates how to list the available functions.
+- [process.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/process.py): Demonstrates how to perform NLP processing on a text.
+- [projects.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/projects.py): Demonstrates how to list the available projects.
+- [intents.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/intents.py): Demonstrates how to list intents for a project.
+- [scoreLimits.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/scoreLimits.py): Demonstrates how to use score limits to figure out good thresholds for intents.
+- [content.py](https://github.com/aristech-de/nlp-clients/blob/main/python/examples/content.py): Demonstrates how to search content for a given prompt.
+
+You can run the examples directly using `python` like this:
+
+1. Create a `.env` file in the [python](.) directory:
+
+```sh
+HOST=nlp.example.com
+# The credentials are optional but probably required for most servers:
+TOKEN=your-token
+SECRET=your-secret
+
+# The following are optional:
+# ROOT_CERT=your-root-cert.pem # If the server uses a self-signed certificate
+# PROJECT_ID=some-project-id # Required for some examples
+```
+
+2. Run the examples, e.g.:
+
+```sh
+python examples/functions.py
+```

aristech_nlp_client-1.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=75.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aristech-nlp-client"
+version = "1.0.0"
+description = "A Python client library for the Aristech Natural-Language-Processing API."
+authors = [{ name = "Martin Mende", email = "speech@aristech.de" }]
+dependencies = ["grpcio", "protobuf"]
+readme = "README.md"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+license = { text = "MIT License" }
+
+[project.optional-dependencies]
+dev = ["grpcio-tools", "mypy-protobuf", "python-dotenv"]
+
+[project.urls]
+Homepage = "https://github.com/aristech-de/nlp-clients/tree/main/python"
+Issues = "https://github.com/aristech-de/nlp-clients/issues"

aristech_nlp_client-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

aristech_nlp_client-1.0.0/src/aristech_nlp_client/__init__.py

@@ -0,0 +1,30 @@
+from .client import NlpClient
+from .proto.nlp_server_pb2_grpc import *
+from .proto.nlp_server_pb2 import *
+from .proto.projects_pb2_grpc import *
+from .proto.projects_pb2 import *
+from .proto.intents_pb2_grpc import *
+from .proto.intents_pb2 import *
+
+__all__ = [
+  "NlpClient",
+  "FunctionRequest",
+  "Function",
+  "GetProjectsRequest",
+  "Project",
+  "GetIntentsRequest",
+  "Intent",
+  "RunFunctionsRequest",
+  "RunFunctionsResponse",
+  "GetScoreLimitsRequest",
+  "GetContentRequest",
+  "GetContentResponse",
+  "UpdateContentRequest",
+  "UpdateContentResponse",
+  "RemoveContentRequest",
+  "RemoveContentResponse",
+  "ContentMetaData",
+  "ContentData",
+  "DescriptionMapping",
+  "Output",
+]

aristech_nlp_client-1.0.0/src/aristech_nlp_client/client.py

@@ -0,0 +1,219 @@
+import grpc
+import re
+
+from typing import Iterable
+
+from .proto.nlp_server_pb2_grpc import *
+from .proto.nlp_server_pb2 import *
+from .proto.projects_pb2_grpc import *
+from .proto.projects_pb2 import *
+from .proto.intents_pb2_grpc import *
+from .proto.intents_pb2 import *
+
+class NlpClient:
+    host: str
+    ssl: bool
+    rootCert: bytes
+    auth_token: str
+    auth_secret: str
+    channel: grpc.Channel
+
+    def __init__(self, host: str, ssl=None, root_cert=b"", auth_token="", auth_secret=""):
+      """
+      Initializes the client with the given connection parameters.
+
+      Args:
+        host (str): The host to connect to. Can include the port, e.g. "localhost:8524".
+        ssl (bool): Whether to use SSL. If not explicitly set, the client will try to guess based on the remaining parameters.
+        root_cert (bytes): The root certificate to use for SSL (e.g. when connecting to a server that uses a self-signed certificate).
+        auth_token (str): The auth token to use for authentication.
+        auth_secret (str): The auth secret to use for authentication.
+      """
+      # When ssl or rootCert are not explicitly set, we check if the host includes the port 9424 or 9423.
+      # If host does not include the port, we assume ssl is True and the port is 9424 therefore.
+      defaultSsl = (ssl is None and len(root_cert) == 0) or (ssl is True or len(root_cert) != 0)
+      (h, p) = self._get_host_port(host, defaultSsl)
+      self.host = h + ":" + p
+      self.ssl = ssl is True or len(root_cert) != 0 or p == "8524"
+      self.rootCert = root_cert
+      self.auth_token = auth_token
+      self.auth_secret = auth_secret
+      if self.ssl or self.rootCert:
+        self.channel = self._create_secure_channel()
+      else:
+        self.channel = grpc.insecure_channel(self.host)
+    
+    def _get_host_port(self, host, defaultSsl):
+      portRe = r"^(?P<host>[^:]+):(?P<port>[0-9]+)$"
+      matches = re.search(portRe, host)
+      defaultPort = defaultSsl and "8524" or "8523"
+      return (host, defaultPort) if matches is None else (matches.group("host"), matches.group("port"))
+    
+    def _metadata_callback(self, context, callback):
+      callback([('token', self.auth_token), ('secret', self.auth_secret)], None)
+
+    def _create_secure_channel(self):
+        if len(self.rootCert) != 0:
+          cert_creds = grpc.ssl_channel_credentials(root_certificates=self.rootCert)
+        else:
+          cert_creds = grpc.ssl_channel_credentials()
+        auth_creds = grpc.metadata_call_credentials(self._metadata_callback)
+        combined_creds = grpc.composite_channel_credentials(cert_creds, auth_creds)
+        channel = grpc.secure_channel(target=self.host, credentials=combined_creds)
+        return channel
+
+    def list_functions(self, request=FunctionRequest()) -> Iterable[Function]:
+        """
+        Lists the available functions.
+
+        Args:
+          request (FunctionRequest): The request to send. Defaults to an empty request.
+        
+        Returns:
+          Iterable[Function]: The functions available.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.GetFunctions(request)
+  
+    def list_projects(self, request=GetProjectsRequest()) -> Iterable[Project]:
+        """
+        Lists the available projects.
+
+        Args:
+          request (GetProjectsRequest): The request to send. Defaults to an empty request.
+        
+        Returns:
+          Iterable[Project]: The projects available.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.GetProjects(request)
+    
+    def list_intents(self, request: GetIntentsRequest) -> Iterable[Intent]:
+        """
+        Lists the available intents for a given project.
+
+        Args:
+          request (GetIntentsRequest): The request to send.
+        
+        Returns:
+          Iterable[GetIntentsResponse]: The intents available.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.GetIntents(request)
+    
+    def list_embedding_models(self, request=GetEmbeddingModelsRequest) -> Iterable[EmbeddingModel]:
+      """
+       Lists the available embedding models.
+
+      Args:
+        request (GetEmbeddingModelsRequest): The request to send.
+
+      Returns:
+        Iterable[EmbeddingModel]: The embedding models available. 
+      """
+      stub = NLPServerStub(self.channel)
+      return stub.RemoveContent(request)
+  
+    def run_functions(self, request: RunFunctionsRequest) -> RunFunctionsResponse:
+        """
+        Processes a raw text.
+
+        Args:
+          request (RunFunctionsRequest): The request to send.
+        
+        Returns:
+          Iterable[RunFunctionsResponse]: The responses with the processed text.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.RunFunctions(request)
+    
+    def score_limits(self, request: GetScoreLimitsRequest) -> GetScoreLimitsResponse:
+        """
+        Gets the score limits for a given project.
+
+        Args:
+          request (GetScoreLimitsRequest): The request to send.
+        
+        Returns:
+          GetScoreLimitsResponse: The score limits.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.GetScoreLimits(request)
+    
+    def get_content(self, request: GetContentRequest) -> Iterable[GetContentResponse]:
+        """
+        Gets the content for a given project.
+
+        Args:
+          request (GetContentRequest): The request to send.
+        
+        Returns:
+          Iterable[GetContentResponse]: The content available.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.GetContent(request)
+    
+    def update_content(self, request: UpdateContentRequest) -> UpdateContentResponse:
+        """
+        Updates the content that matches the given request.
+
+        Args:
+          request (UpdateContentRequest): The request to send.
+        
+        Returns:
+          UpdateContentResponse: The response.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.UpdateContent(request)
+    
+    def remove_content(self, request: RemoveContentRequest) -> RemoveContentResponse:
+        """
+        Removes the content that matches the given request.
+
+        Args:
+          request (RemoveContentRequest): The request to send.
+        
+        Returns:
+          RemoveContentResponse: The response.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.RemoveContent(request)
+    
+    def update_project(self, request: UpdateProjectRequest) -> UpdateProjectResponse:
+        """
+        Updates the project that matches the given request.
+
+        Args:
+          request (UpdateContentRequest): The request to send.
+        
+        Returns:
+          UpdateProjectResponse: The response.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.UpdateProject(request)
+    
+    def remove_project(self, request: RemoveProjectRequest) -> RemoveProjectResponse:
+        """
+        Removes the project that matches the given request.
+
+        Args:
+          request (RemoveProjectRequest): The request to send.
+        
+        Returns:
+          RemoveProjectResponse: The response.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.RemoveProject(request)
+    
+    def add_projects(self, request: AddProjectRequest) -> AddProjectResponse:
+        """
+        Adds a project with the given request.
+
+        Args:
+          request (AddProjectRequest): The request to send.
+        
+        Returns:
+          AddProjectReponse: The response.
+        """
+        stub = NLPServerStub(self.channel)
+        return stub.AddProject(request)

aristech_nlp_client-1.0.0/src/aristech_nlp_client/proto/intents_pb2.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: intents.proto
+# Protobuf Python Version: 5.28.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    28,
+    1,
+    '',
+    'intents.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rintents.proto\x12\x0c\x61ristech.nlp\"\xad\x03\n\x06Intent\x12\n\n\x02id\x18\x01 \x01(\t\x12\x12\n\nproject_id\x18\x02 \x01(\t\x12\x0e\n\x06locale\x18\x03 \x01(\t\x12\r\n\x05topic\x18\x04 \x01(\t\x12)\n\x06inputs\x18\x05 \x03(\x0b\x32\x19.aristech.nlp.IntentInput\x12\x13\n\x0boutput_chat\x18\x06 \x03(\t\x12\x14\n\x0coutput_voice\x18\x07 \x03(\t\x12\x14\n\x0coutput_email\x18\x08 \x03(\t\x12*\n\nrelated_to\x18\t \x03(\x0b\x32\x16.aristech.nlp.Relation\x12\x11\n\tpublished\x18\n \x01(\x08\x12,\n\x04type\x18\x0b \x01(\x0e\x32\x1e.aristech.nlp.Intent.InputType\x12\"\n\x1a\x65xclude_output_from_search\x18\x0c \x01(\x08\x12\'\n\x08keywords\x18\r \x03(\x0b\x32\x15.aristech.nlp.Keyword\x12\x12\n\ncreator_id\x18\x0e \x01(\t\"*\n\tInputType\x12\x08\n\x04\x43HAT\x10\x00\x12\x08\n\x04MAIL\x10\x01\x12\t\n\x05VOICE\x10\x02\"*\n\x0bIntentInput\x12\x0c\n\x04uuid\x18\x01 \x01(\t\x12\r\n\x05input\x18\x02 \x01(\t\"<\n\x08Relation\x12\x0f\n\x07parents\x18\x01 \x03(\t\x12\x10\n\x08\x63hildren\x18\x02 \x03(\t\x12\r\n\x05peers\x18\x03 \x03(\t\",\n\x07Keyword\x12\x0f\n\x07keyword\x18\x01 \x01(\t\x12\x10\n\x08priority\x18\x02 \x01(\x05\"=\n\x14UpdateContentRequest\x12%\n\x07intents\x18\x01 \x03(\x0b\x32\x14.aristech.nlp.Intent\"+\n\x15UpdateContentResponse\x12\x12\n\nintent_ids\x18\x01 \x03(\t\"6\n\x14RemoveContentRequest\x12\n\n\x02id\x18\x01 \x03(\t\x12\x12\n\nproject_id\x18\x02 \x01(\t\"\x17\n\x15RemoveContentResponse\"\x9e\x01\n\x11GetContentRequest\x12\x0e\n\x06prompt\x18\x01 \x01(\t\x12\x12\n\nproject_id\x18\x02 \x01(\t\x12\x13\n\x0bnum_results\x18\x03 \x01(\x05\x12\x11\n\tthreshold\x18\x04 \x01(\x02\x12,\n\x07\x66ilters\x18\x05 \x03(\x0b\x32\x1b.aristech.nlp.ContentFilter\x12\x0f\n\x07\x63hat_id\x18\x07 \x01(\t\"W\n\x12GetContentResponse\x12\x30\n\x05items\x18\x01 \x03(\x0b\x32!.aristech.nlp.ContentResponseItem\x12\x0f\n\x07\x63hat_id\x18\x02 \x01(\t\"N\n\rContentFilter\x12\r\n\x05\x66ield\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t\x12\x10\n\x08operator\x18\x03 \x01(\t\x12\r\n\x05label\x18\x04 \x03(\t\"p\n\x13\x43ontentResponseItem\x12\n\n\x02id\x18\x01 \x01(\t\x12\r\n\x05score\x18\x02 \x01(\x02\x12$\n\x06intent\x18\x03 \x01(\x0b\x32\x14.aristech.nlp.Intent\x12\x18\n\x10\x66\x61llback_message\x18\x04 \x01(\t\"\'\n\x11GetIntentsRequest\x12\x12\n\nproject_id\x18\x01 \x01(\t\":\n\x12GetIntentsResponse\x12$\n\x06intent\x18\x01 \x03(\x0b\x32\x14.aristech.nlp.Intent\"s\n\x15GetScoreLimitsRequest\x12\x12\n\nproject_id\x18\x01 \x01(\t\x12\"\n\x1atest_sentences_upper_limit\x18\x02 \x03(\t\x12\"\n\x1atest_sentences_lower_limit\x18\x03 \x03(\t\"F\n\x16GetScoreLimitsResponse\x12\x15\n\rmin_threshold\x18\x01 \x01(\x02\x12\x15\n\rmax_threshold\x18\x02 \x01(\x02\x42\x08P\x01\xa2\x02\x03\x41TSb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'intents_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'P\001\242\002\003ATS'
+  _globals['_INTENT']._serialized_start=32
+  _globals['_INTENT']._serialized_end=461
+  _globals['_INTENT_INPUTTYPE']._serialized_start=419
+  _globals['_INTENT_INPUTTYPE']._serialized_end=461
+  _globals['_INTENTINPUT']._serialized_start=463
+  _globals['_INTENTINPUT']._serialized_end=505
+  _globals['_RELATION']._serialized_start=507
+  _globals['_RELATION']._serialized_end=567
+  _globals['_KEYWORD']._serialized_start=569
+  _globals['_KEYWORD']._serialized_end=613
+  _globals['_UPDATECONTENTREQUEST']._serialized_start=615
+  _globals['_UPDATECONTENTREQUEST']._serialized_end=676
+  _globals['_UPDATECONTENTRESPONSE']._serialized_start=678
+  _globals['_UPDATECONTENTRESPONSE']._serialized_end=721
+  _globals['_REMOVECONTENTREQUEST']._serialized_start=723
+  _globals['_REMOVECONTENTREQUEST']._serialized_end=777
+  _globals['_REMOVECONTENTRESPONSE']._serialized_start=779
+  _globals['_REMOVECONTENTRESPONSE']._serialized_end=802
+  _globals['_GETCONTENTREQUEST']._serialized_start=805
+  _globals['_GETCONTENTREQUEST']._serialized_end=963
+  _globals['_GETCONTENTRESPONSE']._serialized_start=965
+  _globals['_GETCONTENTRESPONSE']._serialized_end=1052
+  _globals['_CONTENTFILTER']._serialized_start=1054
+  _globals['_CONTENTFILTER']._serialized_end=1132
+  _globals['_CONTENTRESPONSEITEM']._serialized_start=1134
+  _globals['_CONTENTRESPONSEITEM']._serialized_end=1246
+  _globals['_GETINTENTSREQUEST']._serialized_start=1248
+  _globals['_GETINTENTSREQUEST']._serialized_end=1287
+  _globals['_GETINTENTSRESPONSE']._serialized_start=1289
+  _globals['_GETINTENTSRESPONSE']._serialized_end=1347
+  _globals['_GETSCORELIMITSREQUEST']._serialized_start=1349
+  _globals['_GETSCORELIMITSREQUEST']._serialized_end=1464
+  _globals['_GETSCORELIMITSRESPONSE']._serialized_start=1466
+  _globals['_GETSCORELIMITSRESPONSE']._serialized_end=1536
+# @@protoc_insertion_point(module_scope)