sfdc-agentforce-byoc-python-sdk 0.1.0__py3-none-any.whl

agentforce_byoc/runtime/base.py

@@ -0,0 +1,54 @@
+# Copyright (c) 2026, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Base class for runtime providers."""
+
+from abc import ABC, abstractmethod
+
+from agentforce_byoc.gateway.base import BaseRelayGatewayClient
+
+
+class BaseRuntimeProvider(ABC):
+    """
+    Abstract base class for runtime environment providers.
+
+    Each runtime provider encapsulates the configuration and gateway clients
+    for a specific execution environment (Agentforce runtime or local mock).
+    """
+
+    def __init__(self):
+        """Initialize runtime provider."""
+        self._relay_gateway_client: BaseRelayGatewayClient = None
+
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """Return the runtime provider name."""
+        pass
+
+    @property
+    def relay_gateway_client(self) -> BaseRelayGatewayClient:
+        """
+        Get the Relay gateway client for this runtime.
+
+        Returns:
+            Configured Relay gateway client instance
+
+        Raises:
+            RuntimeError: If the Relay gateway client is not configured
+        """
+        if self._relay_gateway_client is None:
+            raise RuntimeError(f"Relay gateway client not configured for runtime: {self.name}")
+        return self._relay_gateway_client

agentforce_byoc/runtime/mock_runtime.py

@@ -0,0 +1,50 @@
+# Copyright (c) 2026, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Mock runtime provider for local testing."""
+
+from agentforce_byoc.gateway.mock_relay_client import MockRelayGatewayClient
+from agentforce_byoc.runtime.base import BaseRuntimeProvider
+
+
+class MockRuntimeProvider(BaseRuntimeProvider):
+    """
+    Mock runtime provider for local development outside the managed sandbox.
+
+    Wires up the :class:`MockRelayGatewayClient`, which behaves like the
+    Agentforce client but takes the org JWT from the SDK author (constructor
+    arg or the ``ORG_JWT_TOKEN`` env var).
+
+    Example:
+        This provider is selected when the AGENTFORCE_BYOC_MOCK env var is set:
+
+        >>> import os
+        >>> os.environ["AGENTFORCE_BYOC_MOCK"] = "1"
+        >>> from agentforce_byoc import get_client
+        >>> client = get_client()
+        >>> client.call_llm_generations(
+        ...     parameter={"prompt": "What is AI?"},
+        ... )
+    """
+
+    def __init__(self):
+        """Initialize mock runtime provider."""
+        super().__init__()
+        self._relay_gateway_client = MockRelayGatewayClient()
+
+    @property
+    def name(self) -> str:
+        """Return runtime name."""
+        return "mock"

agentforce_byoc/schema_utils/__init__.py

@@ -0,0 +1,35 @@
+# Copyright (c) 2026, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Schema utilities for Agentforce BYOC functions."""
+
+from agentforce_byoc.schema_utils.entry_func import entry_func
+from agentforce_byoc.schema_utils.generator import (
+    extract_entry_functions,
+    generate_openapi,
+    generate_schema,
+    generate_schema_yaml,
+)
+from agentforce_byoc.schema_utils.schema import requestSchema, responseSchema
+
+__all__ = [
+    "entry_func",
+    "requestSchema",
+    "responseSchema",
+    "extract_entry_functions",
+    "generate_openapi",
+    "generate_schema",
+    "generate_schema_yaml",
+]

agentforce_byoc/schema_utils/entry_func.py

@@ -0,0 +1,48 @@
+# Copyright (c) 2026, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import functools
+from typing import Any, Callable, TypeVar
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+def entry_func(fn: F) -> F:
+    """Mark a function as the BYOC entry point.
+
+    The ``@entry_func`` decorator identifies a function whose signature
+    will be extracted by ``generate_byoc_schema.py`` to produce an
+    OpenAPI specification.  At runtime the decorator is a pass-through —
+    it returns the original function unchanged.
+
+    All parameters of the decorated function **must** have type
+    annotations; the schema generator will reject untyped parameters.
+
+    Example::
+
+        from agentforce_byoc.schema_utils.entry_func import entry_func
+
+        @entry_func
+        def add(a: int, b: int = 0) -> int:
+            return a + b
+    """
+
+    @functools.wraps(fn)
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        return fn(*args, **kwargs)
+
+    return wrapper  # type: ignore[return-value]