salesforce-data-customcode 6.0.2.dev1__tar.gz → 6.0.3.dev2__tar.gz

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: salesforce-data-customcode
-Version: 6.0.2.dev1
+Version: 6.0.3.dev2
 Summary: Data Cloud Custom Code SDK
 License-Expression: Apache-2.0
 License-File: LICENSE.txt
@@ -341,14 +341,16 @@ from datacustomcode.client import Client, llm_gateway_generate_text_col
 def main():
   client = Client()
   df = client.read_dlo("Input__dll")
+  # llm_gateway_generate_text_col returns a struct
+  # {status, response, error_code, error_message} per row, so per-row
+  # failures don't abort the Spark job. Pick the field you want with [].
   df_generated = df.withColumn(
     "greeting__c",
     llm_gateway_generate_text_col(
         "In one sentence, greet {name} from {city}.",
         {"name": col("name__c"), "city": col("homecity__c")},
         model_id="sfdc_ai__DefaultGPT4Omni", # An AI model in your org
-        max_tokens=100,
-    ),
+    )["response"],
   )
 
   dlo_name = "Output_dll"

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/README.md

@@ -316,14 +316,16 @@ from datacustomcode.client import Client, llm_gateway_generate_text_col
 def main():
   client = Client()
   df = client.read_dlo("Input__dll")
+  # llm_gateway_generate_text_col returns a struct
+  # {status, response, error_code, error_message} per row, so per-row
+  # failures don't abort the Spark job. Pick the field you want with [].
   df_generated = df.withColumn(
     "greeting__c",
     llm_gateway_generate_text_col(
         "In one sentence, greet {name} from {city}.",
         {"name": col("name__c"), "city": col("homecity__c")},
         model_id="sfdc_ai__DefaultGPT4Omni", # An AI model in your org
-        max_tokens=100,
-    ),
+    )["response"],
   )
 
   dlo_name = "Output_dll"

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/pyproject.toml

@@ -18,7 +18,7 @@ license = "Apache-2.0"
 name = "salesforce-data-customcode"
 readme = "README.md"
 requires-python = ">=3.10,<3.12"
-version = "6.0.2.dev1"
+version = "6.0.3.dev2"
 
 [tool.black]
 exclude = '''

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/client.py

@@ -59,20 +59,26 @@ def llm_gateway_generate_text_col(
     template: str,
     values: Union[Dict[str, "Column"], "Column"],
     model_id: Optional[str] = None,
-    max_tokens: Optional[int] = None,
 ) -> "Column":
     """Build a Spark Column that runs the LLM Gateway per row.
 
+    The returned Column yields a struct ``{status, response, error_code,
+    error_message}`` for each row. Use ``[...]`` (or ``getField``) to pick the
+    field you want, e.g. ``llm_gateway_generate_text_col(...)["response"]``.
+    Per-row failures populate ``status`` / ``error_code`` / ``error_message``
+    so a single bad row does not abort the whole Spark job.
+
     Example:
 
-        >>> df.withColumn(
-        ...     "greeting__c",
-        ...     llm_gateway_generate_text_col(
-        ...         "In one sentence, greet {name} from {city}.",
-        ...         {"name": col("name__c"), "city": col("homecity__c")},
-        ...         model_id="sfdc_ai__DefaultGPT4Omni",
-        ...         max_tokens=100,
-        ...     ),
+        >>> result = llm_gateway_generate_text_col(
+        ...     "In one sentence, greet {name} from {city}.",
+        ...     {"name": col("name__c"), "city": col("homecity__c")},
+        ...     model_id="sfdc_ai__DefaultGPT4Omni",
+        ... )
+        >>> df.withColumn("greeting__c", result["response"])
+        >>> # …or keep the struct around and inspect failures:
+        >>> df.withColumn("llm", result).select(
+        ...     "llm.status", "llm.response", "llm.error_message"
         ... )
 
     Args:
@@ -81,15 +87,16 @@ def llm_gateway_generate_text_col(
         values: Either a mapping from placeholder name to Spark ``Column``, or
             a single ``Column`` whose value is already a struct.
         model_id: LLM model id. Defaults to ``sfdc_ai__DefaultGPT4Omni``.
-        max_tokens: Maximum tokens to generate. Defaults to 200.
 
     Returns:
-        A Spark ``Column`` that, when evaluated, produces the generated text.
+        A Spark ``Column`` of ``StructType`` with fields ``status``,
+        ``response``, ``error_code``, and ``error_message`` (all nullable
+        strings). On success, ``status == "SUCCESS"`` and ``response`` holds
+        the generated text; on failure, ``status == "ERROR"`` and the
+        ``error_*`` fields carry diagnostic detail.
     """
     gateway = Client()._get_spark_llm_gateway()
-    return gateway.llm_gateway_generate_text_col(
-        template, values, model_id=model_id, max_tokens=max_tokens
-    )
+    return gateway.llm_gateway_generate_text_col(template, values, model_id=model_id)
 
 
 class DataCloudObjectType(Enum):
@@ -150,9 +157,7 @@ class Client:
         finder: Find a file path
         reader: A custom reader to use for reading Data Cloud objects.
         writer: A custom writer to use for writing Data Cloud objects.
-        spark_llm_gateway: Optional custom :class:`SparkLLMGateway`. When
-            omitted, the gateway is lazily resolved from
-            ``spark_llm_gateway_config``.
+        spark_llm_gateway: Optional custom :class:`SparkLLMGateway`.
 
     Example:
     >>> client = Client()
@@ -292,7 +297,6 @@ class Client:
         self,
         prompt: str,
         model_id: Optional[str] = None,
-        max_tokens: Optional[int] = None,
     ) -> str:
         """Issue a one-shot LLM Gateway call. This is the scalar counterpart to
         :func:`llm_gateway_generate_text_col`: it runs **once**  — not per row.
@@ -310,15 +314,13 @@ class Client:
                 ``{field}`` substitution is performed on this string.
             model_id: LLM model id to target. Defaults to
                 ``sfdc_ai__DefaultGPT4Omni`` when ``None``.
-            max_tokens: Hard upper bound on the number of tokens the model
-                may generate. Defaults to 200 when ``None``.
 
         Returns:
             The generated text as a plain Python ``str``; empty when the
             gateway response carries no generated text.
         """
         return self._get_spark_llm_gateway().llm_gateway_generate_text(
-            prompt, model_id=model_id, max_tokens=max_tokens
+            prompt, model_id=model_id
         )
 
     def _get_spark_llm_gateway(self) -> SparkLLMGateway:

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/__init__.py

@@ -15,6 +15,7 @@
 
 from datacustomcode.llm_gateway.base import LLMGateway
 from datacustomcode.llm_gateway.default import DefaultLLMGateway
+from datacustomcode.llm_gateway.errors import LLMGatewayCallError
 from datacustomcode.llm_gateway.spark_base import SparkLLMGateway
 from datacustomcode.llm_gateway.spark_default import DefaultSparkLLMGateway
 
@@ -22,5 +23,6 @@ __all__ = [
     "DefaultLLMGateway",
     "DefaultSparkLLMGateway",
     "LLMGateway",
+    "LLMGatewayCallError",
     "SparkLLMGateway",
 ]

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/default.py

@@ -34,8 +34,6 @@ class DefaultLLMGateway(EinsteinPlatformClient, LLMGateway):
 
         payload: Dict[str, Any] = {"prompt": request.prompt}
 
-        if request.max_tokens is not None:
-            payload["max_tokens"] = request.max_tokens
         if request.localization:
             payload["localization"] = request.localization
         if request.tags:

salesforce_data_customcode-6.0.3.dev2/src/datacustomcode/llm_gateway/errors.py

@@ -0,0 +1,36 @@
+# Copyright (c) 2025, Salesforce, Inc.
+# SPDX-License-Identifier: Apache-2
+#
+# 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.
+"""Exceptions raised by LLM Gateway implementations."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+
+class LLMGatewayCallError(RuntimeError):
+    """Raised when an LLM Gateway call returns an error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status: Optional[object] = None,
+        error_code: Optional[str] = None,
+        error_message: Optional[str] = None,
+    ) -> None:
+        super().__init__(message)
+        self.status = status
+        self.error_code = error_code
+        self.error_message = error_message

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/spark_base.py

@@ -40,7 +40,6 @@ class SparkLLMGateway(ABC, UserExtendableNamedConfigMixin):
         self,
         prompt: str,
         model_id: Optional[str] = None,
-        max_tokens: Optional[int] = None,
     ) -> str:
         """Issue a one-shot LLM Gateway call and return the generated text."""
 
@@ -50,6 +49,14 @@ class SparkLLMGateway(ABC, UserExtendableNamedConfigMixin):
         template: str,
         values: Union[Dict[str, "Column"], "Column"],
         model_id: Optional[str] = None,
-        max_tokens: Optional[int] = None,
     ) -> "Column":
-        """Build a Spark ``Column`` that invokes the LLM Gateway per row."""
+        """Build a Spark ``Column`` that invokes the LLM Gateway per row and
+        yields a struct ``{status, response, error_code, error_message}``.
+
+        Select an individual field, e.g.
+        ``llm_gateway_generate_text_col(...)["response"]``. Returning a struct
+        means a single failing row doesn't abort the Spark job.
+        Failing row leaves the rest of the DataFrame intact — callers can
+        inspect ``status`` / ``error_code`` per row instead of having the
+        Spark job abort.
+        """

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/spark_default.py

@@ -28,10 +28,15 @@ if TYPE_CHECKING:
     from pyspark.sql import Column
 
     from datacustomcode.llm_gateway.base import LLMGateway
+    from datacustomcode.llm_gateway.types.generate_text_response import (
+        GenerateTextResponse,
+    )
 
 
 _DEFAULT_LLM_MODEL_ID = "sfdc_ai__DefaultGPT4Omni"
-_DEFAULT_LLM_MAX_TOKENS = 200
+
+_STATUS_SUCCESS = "SUCCESS"
+_STATUS_ERROR = "ERROR"
 
 
 class DefaultSparkLLMGateway(SparkLLMGateway):
@@ -52,20 +57,26 @@ class DefaultSparkLLMGateway(SparkLLMGateway):
         self,
         prompt: str,
         model_id: Optional[str] = None,
-        max_tokens: Optional[int] = None,
     ) -> str:
-        return _invoke_llm_gateway(self._llm_gateway, prompt, model_id, max_tokens)
+        return _invoke_llm_gateway(self._llm_gateway, prompt, model_id)
 
     def llm_gateway_generate_text_col(
         self,
         template: str,
         values: Union[Dict[str, "Column"], "Column"],
         model_id: Optional[str] = None,
-        max_tokens: Optional[int] = None,
     ) -> "Column":
-
+        """Build a per-row UDF that returns a struct ``{status, response,
+        error_code, error_message}`` so per-row failures do not abort the
+        Spark job. Callers select the field they want, e.g.
+        ``llm_gateway_generate_text_col(...)["response"]``.
+        """
         from pyspark.sql.functions import struct, udf
-        from pyspark.sql.types import StringType
+        from pyspark.sql.types import (
+            StringType,
+            StructField,
+            StructType,
+        )
 
         if isinstance(values, dict):
             values_col = struct(*[v.alias(k) for k, v in values.items()])
@@ -73,19 +84,32 @@ class DefaultSparkLLMGateway(SparkLLMGateway):
             values_col = values
 
         gateway = self._llm_gateway
+        result_schema = StructType(
+            [
+                StructField("status", StringType(), True),
+                StructField("response", StringType(), True),
+                StructField("error_code", StringType(), True),
+                StructField("error_message", StringType(), True),
+            ]
+        )
 
-        def _generate(values_row: Any) -> str:
+        def _generate(values_row: Any) -> Dict[str, Optional[str]]:
             if values_row is None:
-                return ""
+                return {
+                    "status": _STATUS_ERROR,
+                    "response": None,
+                    "error_code": None,
+                    "error_message": "values column was null for this row",
+                }
             subs = (
                 values_row.asDict()
                 if hasattr(values_row, "asDict")
                 else dict(values_row)
             )
             prompt = template.format(**subs)
-            return _invoke_llm_gateway(gateway, prompt, model_id, max_tokens)
+            return _invoke_llm_gateway_as_struct(gateway, prompt, model_id)
 
-        return udf(_generate, StringType())(values_col)
+        return udf(_generate, result_schema)(values_col)
 
 
 def _build_underlying_gateway() -> "LLMGateway":
@@ -100,20 +124,61 @@ def _build_underlying_gateway() -> "LLMGateway":
     return cfg.to_object()
 
 
-def _invoke_llm_gateway(
+def _call_llm_gateway(
     gateway: "LLMGateway",
     prompt: str,
     model_id: Optional[str],
-    max_tokens: Optional[int],
-) -> str:
+) -> "GenerateTextResponse":
+    """Build the request and dispatch it to the underlying gateway."""
     from datacustomcode.llm_gateway.types.generate_text_request_builder import (
         GenerateTextRequestBuilder,
     )
 
-    builder = (
+    request = (
         GenerateTextRequestBuilder()
         .set_prompt(prompt)
         .set_model(model_id or _DEFAULT_LLM_MODEL_ID)
-        .set_max_tokens(max_tokens or _DEFAULT_LLM_MAX_TOKENS)
+        .build()
     )
-    return gateway.generate_text(builder.build()).text
+    return gateway.generate_text(request)
+
+
+def _invoke_llm_gateway(
+    gateway: "LLMGateway",
+    prompt: str,
+    model_id: Optional[str],
+) -> str:
+    from datacustomcode.llm_gateway.errors import LLMGatewayCallError
+
+    response = _call_llm_gateway(gateway, prompt, model_id)
+    if response.is_error:
+        raise LLMGatewayCallError(
+            f"LLM Gateway call failed: status_code={response.status_code}, "
+            f"error_code={response.error_code!r}, "
+            f"message={response.data!r}",
+            status=response.status_code,
+            error_code=response.error_code or None,
+            error_message=str(response.data) if response.data else None,
+        )
+    return response.text
+
+
+def _invoke_llm_gateway_as_struct(
+    gateway: "LLMGateway",
+    prompt: str,
+    model_id: Optional[str],
+) -> Dict[str, Optional[str]]:
+    response = _call_llm_gateway(gateway, prompt, model_id)
+    if response.is_error:
+        return {
+            "status": _STATUS_ERROR,
+            "response": None,
+            "error_code": response.error_code or None,
+            "error_message": str(response.data) if response.data else None,
+        }
+    return {
+        "status": _STATUS_SUCCESS,
+        "response": response.text,
+        "error_code": None,
+        "error_message": None,
+    }

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/types/generate_text_request.py

@@ -40,13 +40,6 @@ class GenerateTextRequest(BaseModel):
     )
     model_name: str = Field(..., min_length=1, description="Name of the model to use")
     prompt: str = Field(..., description="Input prompt")
-    max_tokens: Optional[int] = Field(
-        default=None,
-        ge=1,
-        description=(
-            "Maximum number of tokens to generate. If None, server default applies."
-        ),
-    )
     localization: Optional[Dict[str, Any]] = Field(
         default=None, description="Localization settings"
     )

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/llm_gateway/types/generate_text_request_builder.py

@@ -26,7 +26,6 @@ class GenerateTextRequestBuilder:
     def __init__(self) -> None:
         self._prompt = ""
         self._model_name = ""
-        self._max_tokens: Optional[int] = None
         self._localization: Optional[Dict[str, Any]] = None
         self._tags: Optional[Dict[str, Any]] = None
 
@@ -38,10 +37,6 @@ class GenerateTextRequestBuilder:
         self._model_name = model_name
         return self
 
-    def set_max_tokens(self, max_tokens: int) -> "GenerateTextRequestBuilder":
-        self._max_tokens = max_tokens
-        return self
-
     def set_localization(
         self,
         localization: Optional[Dict[str, Any]] = None,
@@ -80,7 +75,6 @@ class GenerateTextRequestBuilder:
         request = GenerateTextRequest(
             prompt=self._prompt,
             model_name=self._model_name,
-            max_tokens=self._max_tokens,
             localization=self._localization,
             tags=self._tags,
         )

{salesforce_data_customcode-6.0.2.dev1 → salesforce_data_customcode-6.0.3.dev2}/src/datacustomcode/templates/script/payload/entrypoint.py

@@ -16,7 +16,9 @@ def main():
     You can use your AI models configured in Salesforce to generate column
     values. See README.md for how to test locally before deploying to Data Cloud.
 
-    Example:
+    Example (the per-row helper returns a struct
+    ``{status, response, error_code, error_message}`` — pick the field you
+    want with ``[...]``):
 
         >>> from datacustomcode.client import llm_gateway_generate_text_col
             df_generated = df.withColumn(
@@ -25,8 +27,7 @@ def main():
             ...         "In one sentence, greet {name} from {city}.",
             ...         {"name": col("name__c"), "city": col("homecity__c")},
             ...         model_id="sfdc_ai__DefaultGPT4Omni",
-            ...         max_tokens=100,
-            ...     ),
+            ...     )["response"],
             ... )
 
     You can also invoke the LLM with a literal plain text prompt — no
@@ -35,7 +36,7 @@ def main():
     Example:
 
         >>> generated_text = client.llm_gateway_generate_text(
-        ...     prompt, model_id, max_tokens
+        ...     prompt, model_id
         ... )
     """