Add new connection type: OpenShift

scripts/json_schema/gen_json_schema.py

@@ -142,7 +142,7 @@ def get_required(self, obj):
 from promptflow._sdk.schemas._connection import AzureOpenAIConnectionSchema, OpenAIConnectionSchema, \
 QdrantConnectionSchema, CognitiveSearchConnectionSchema, SerpConnectionSchema, AzureContentSafetyConnectionSchema, \
 FormRecognizerConnectionSchema, CustomConnectionSchema, WeaviateConnectionSchema, ServerlessConnectionSchema, \
-CustomStrongTypeConnectionSchema, AzureAIServicesConnectionSchema
+OpenShiftConnectionSchema, CustomStrongTypeConnectionSchema, AzureAIServicesConnectionSchema
 from promptflow._sdk.schemas._run import RunSchema
 from promptflow._sdk.schemas._flow import FlowSchema, FlexFlowSchema
 
@@ -168,7 +168,7 @@ def dump_json(file_name, dct):
         args.output_file = ["Run", "Flow", "AzureOpenAIConnection", "OpenAIConnection", "QdrantConnection",
                             "CognitiveSearchConnection", "SerpConnection", "AzureContentSafetyConnection",
                             "FormRecognizerConnection", "CustomConnection", "WeaviateConnection", "ServerlessConnection",
-                            "CustomStrongTypeConnection", "AzureAIServicesConnection"]
+                            "OpenShiftConnection", "CustomStrongTypeConnection", "AzureAIServicesConnection"]
 
     # Special case for Flow and EagerFlow
     if "Flow" in args.output_file:

src/promptflow-core/promptflow/_constants.py

@@ -239,6 +239,7 @@ class ConnectionType(str, Enum):
     WEAVIATE = "Weaviate"
     SERVERLESS = "Serverless"
     CUSTOM = "Custom"
+    OPENSHIFT = "OpenShift"
 
 
 class CustomStrongTypeConnectionConfigs:

src/promptflow-core/promptflow/_core/data/tool.schema.json

@@ -216,6 +216,7 @@
         "FunctionStr",
         "FormRecognizerConnection",
         "ServerlessConnection",
+        "OpenShiftConnection",
         "AzureAIServicesConnection",
         "FilePath",
         "Image",
@@ -246,6 +247,7 @@
         "function_str",
         "FormRecognizerConnection",
         "ServerlessConnection",
+        "OpenShiftConnection",
         "AzureAIServicesConnection",
         "file_path",
         "image",

src/promptflow-core/promptflow/connections/__init__.py

@@ -16,6 +16,7 @@
     OpenAIConnection,
     SerpConnection,
     ServerlessConnection,
+    OpenShiftConnection,
     _Connection,
 )
 from promptflow.core._connection_provider._connection_provider import ConnectionProvider
@@ -41,6 +42,7 @@ class BingConnection:
     "CustomConnection",
     "CustomStrongTypeConnection",
     "ServerlessConnection",
+    "OpenShiftConnection",
     "AzureAIServicesConnection",
     "ConnectionProvider",
 ]

src/promptflow-core/promptflow/core/_connection.py

@@ -368,6 +368,35 @@ def api_base(self, value):
         self.configs["api_base"] = value
 
 
+class OpenShiftConnection(_StrongTypeConnection):
+    """OpenShift connection.
+
+    :param token: The api token.
+    :type token: str
+    :param endpoint: The api endpoint.
+    :type endpoint: str
+    :param name: Connection name.
+    :type name: str
+    """
+
+    TYPE = ConnectionType.OPENSHIFT.value
+
+    def __init__(self, token: str, endpoint: str, **kwargs):
+        secrets = {"token": token}
+        configs = {"endpoint": endpoint}
+        super().__init__(secrets=secrets, configs=configs, **kwargs)
+
+    @property
+    def endpoint(self):
+        """Return the connection api endpoint."""
+        return self.configs.get("endpoint")
+
+    @endpoint.setter
+    def endpoint(self, value):
+        """Set the connection api endpoint."""
+        self.configs["endpoint"] = value
+
+
 class SerpConnection(_StrongTypeConnection):
     """Serp connection.
 

src/promptflow-devkit/promptflow/_sdk/entities/__init__.py

@@ -17,6 +17,7 @@
     FormRecognizerConnection,
     CustomStrongTypeConnection,
     ServerlessConnection,
+    OpenShiftConnection,
 )
 from ._run import Run
 from ._validation import ValidationResult
@@ -35,6 +36,7 @@
     "WeaviateConnection",
     "FormRecognizerConnection",
     "ServerlessConnection",
+    "OpenShiftConnection",
     # endregion
     # region Run
     "Run",

src/promptflow-devkit/promptflow/_sdk/entities/_connection.py

@@ -42,6 +42,7 @@
     QdrantConnectionSchema,
     SerpConnectionSchema,
     ServerlessConnectionSchema,
+    OpenShiftConnectionSchema,
     WeaviateConnectionSchema,
 )
 from promptflow._utils.logger_utils import LoggerFactory
@@ -58,6 +59,7 @@
 from promptflow.core._connection import QdrantConnection as _CoreQdrantConnection
 from promptflow.core._connection import SerpConnection as _CoreSerpConnection
 from promptflow.core._connection import ServerlessConnection as _CoreServerlessConnection
+from promptflow.core._connection import OpenShiftConnection as _CoreOpenShiftConnection
 from promptflow.core._connection import WeaviateConnection as _CoreWeaviateConnection
 from promptflow.core._connection import _Connection as _CoreConnection
 from promptflow.core._connection import _StrongTypeConnection as _CoreStrongTypeConnection
@@ -315,6 +317,15 @@ def _get_schema_cls(cls):
         return ServerlessConnectionSchema
 
 
+class OpenShiftConnection(_CoreOpenShiftConnection, _StrongTypeConnection):
+    __doc__ = _CoreOpenShiftConnection.__doc__
+    DATA_CLASS = _CoreOpenShiftConnection
+
+    @classmethod
+    def _get_schema_cls(cls):
+        return OpenShiftConnectionSchema
+
+
 class SerpConnection(_CoreSerpConnection, _StrongTypeConnection):
     __doc__ = _CoreSerpConnection.__doc__
     DATA_CLASS = _CoreSerpConnection

src/promptflow-devkit/promptflow/_sdk/schemas/_connection.py

@@ -69,6 +69,12 @@ class ServerlessConnectionSchema(ConnectionSchema):
     api_base = fields.Str(required=True)
 
 
+class OpenShiftConnectionSchema(ConnectionSchema):
+    type = StringTransformedEnum(allowed_values=camel_to_snake(ConnectionType.OPENSHIFT), required=True)
+    token = fields.Str(required=True)
+    endpoint = fields.Str(required=True)
+
+
 class EmbeddingStoreConnectionSchema(ConnectionSchema):
     module = fields.Str(dump_default="promptflow_vectordb.connections")
     api_key = fields.Str(required=True)

src/promptflow-devkit/tests/sdk_cli_test/unittests/test_connection.py

@@ -23,6 +23,7 @@
     QdrantConnection,
     SerpConnection,
     ServerlessConnection,
+    OpenShiftConnection,
     WeaviateConnection,
     _Connection,
 )
@@ -222,6 +223,19 @@ class TestConnection:
                     "type": "serverless",
                 },
             ),
+            (
+                "openshift_connection.yaml",
+                OpenShiftConnection,
+                {
+                    "name": "my_openshift_connection",
+                    "token": "<to-be-replaced>",
+                    "endpoint": "https://mock.api.base",
+                },
+                {
+                    "module": "promptflow.connections",
+                    "type": "openshift",
+                },
+            ),
             (
                 "azure_ai_services_connection.yaml",
                 AzureAIServicesConnection,

src/promptflow-tools/connections.json.example

@@ -93,5 +93,13 @@
       "api_base": "serverless-embedding-endpoint-url"
     },
     "module": "promptflow.connections"
+  },
+  "openshift_connection": {
+    "type": "OpenShiftConnection",
+    "value": {
+      "endpoint": "openshift-endpoint",
+      "token": "openshift-token"
+    },
+    "module": "promtflow.connections"
   }
 }

src/promptflow/tests/test_configs/connections/openshift_connection.yaml

@@ -0,0 +1,5 @@
+$schema: https://azuremlschemas.azureedge.net/promptflow/latest/OpenShiftConnection.schema.json
+name: my_openshift_connection
+type: openshift
+token: "<to-be-replaced>"
+endpoint: "https://mock.api.base"