salesforce-data-customcode 6.0.3.dev1__py3-none-any.whl → 6.0.3.dev2__py3-none-any.whl

datacustomcode/client.py

@@ -62,15 +62,23 @@ def llm_gateway_generate_text_col(
 ) -> "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",
-        ...     ),
+        >>> 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,7 +89,11 @@ def llm_gateway_generate_text_col(
         model_id: LLM model id. Defaults to ``sfdc_ai__DefaultGPT4Omni``.
 
     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)

datacustomcode/llm_gateway/spark_base.py

@@ -50,4 +50,13 @@ class SparkLLMGateway(ABC, UserExtendableNamedConfigMixin):
         values: Union[Dict[str, "Column"], "Column"],
         model_id: Optional[str] = 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.
+        """

datacustomcode/llm_gateway/spark_default.py

@@ -28,10 +28,16 @@ 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"
 
+_STATUS_SUCCESS = "SUCCESS"
+_STATUS_ERROR = "ERROR"
+
 
 class DefaultSparkLLMGateway(SparkLLMGateway):
 
@@ -60,9 +66,17 @@ class DefaultSparkLLMGateway(SparkLLMGateway):
         values: Union[Dict[str, "Column"], "Column"],
         model_id: Optional[str] = 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()])
@@ -70,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)
+            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":
@@ -97,22 +124,33 @@ 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],
-) -> str:
-    from datacustomcode.llm_gateway.errors import LLMGatewayCallError
+) -> "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)
+        .build()
     )
-    response = gateway.generate_text(builder.build())
+    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}, "
@@ -123,3 +161,24 @@ def _invoke_llm_gateway(
             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,
+    }

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,7 +27,7 @@ def main():
             ...         "In one sentence, greet {name} from {city}.",
             ...         {"name": col("name__c"), "city": col("homecity__c")},
             ...         model_id="sfdc_ai__DefaultGPT4Omni",
-            ...     ),
+            ...     )["response"],
             ... )
 
     You can also invoke the LLM with a literal plain text prompt — no

{salesforce_data_customcode-6.0.3.dev1.dist-info → salesforce_data_customcode-6.0.3.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: salesforce-data-customcode
-Version: 6.0.3.dev1
+Version: 6.0.3.dev2
 Summary: Data Cloud Custom Code SDK
 License-Expression: Apache-2.0
 License-File: LICENSE.txt
@@ -341,13 +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
-    ),
+    )["response"],
   )
 
   dlo_name = "Output_dll"

{salesforce_data_customcode-6.0.3.dev1.dist-info → salesforce_data_customcode-6.0.3.dev2.dist-info}/RECORD

@@ -1,7 +1,7 @@
 datacustomcode/__init__.py,sha256=qx-X3U9lU_791ZbAxhGqQeyDw6eqTi9-E9AbYnwJfxU,2071
 datacustomcode/auth.py,sha256=fpSjhIBdv9trC8yq2vuljAix_Euu-4Ah7HDCGhYjOxI,8309
 datacustomcode/cli.py,sha256=ObqhOasZSZ8ZNFP6pywV3FpsUOz45_KaZdMNT4BHOKs,13069
-datacustomcode/client.py,sha256=NzPtJkHszRh0GqKUkobPyDUCDauUIaeI-zrac9VR7l8,12813
+datacustomcode/client.py,sha256=eV_Bv-YfxXcayjgtAbu9tXb_UcHgcE2f3-L_3vvc0cI,13616
 datacustomcode/cmd.py,sha256=ZMs46aydJw2EaU26JgCtZmnqESQFHvvaJz10hnjZTBk,3537
 datacustomcode/common_config.py,sha256=SAUnxj3kqmOeWwPmFoYq4tuxokMgURVm4QwcGi-avL4,1928
 datacustomcode/config.py,sha256=2Pk61ieQsEWSxKDxlS66_rliKE8iX0j-9LweEm0aaGo,4072
@@ -41,8 +41,8 @@ datacustomcode/llm_gateway/__init__.py,sha256=rcoGpSkv36tZuAOcTxKkhNpM0qV03qgmer
 datacustomcode/llm_gateway/base.py,sha256=CTUhZiZ0JFlmWj6kQpTR4_-mUvqkBKl_Fkdvv9VwxY8,1262
 datacustomcode/llm_gateway/default.py,sha256=QiwrDaUvrh00I-fYYhmogTtqC5r0fmm-JrXxNQLvTc0,1854
 datacustomcode/llm_gateway/errors.py,sha256=ABjztpJwAYMBlmFX808CHHtu4nD6zA4ECelzNJQkJg0,1197
-datacustomcode/llm_gateway/spark_base.py,sha256=apM3FYDPNz3JTgEdlf-7jeryzTYmSzjJsCIt95ZEpvg,1553
-datacustomcode/llm_gateway/spark_default.py,sha256=ctBzkP1vDxgrmoIC6PvfmwxmlPVotkcADK3-M5qyFKI,3794
+datacustomcode/llm_gateway/spark_base.py,sha256=caf-fHTOo9SMTkK5Ozhrt70b51Rz_6hDY0rwa6jKwuE,2000
+datacustomcode/llm_gateway/spark_default.py,sha256=7yC8lSJ7DKXTqtm_i0JjFqxML8hkT65h6n3i1CID8Ds,5745
 datacustomcode/llm_gateway/types/__init__.py,sha256=gamfOD1VnAtEslRBpqh-yKiVjkG_wYWYdSatGIfsN-w,621
 datacustomcode/llm_gateway/types/generate_text_request.py,sha256=ChxOCzp7St1EYgwl4tWiwfrPyVci4zPyBhnEjWc1Vfs,1448
 datacustomcode/llm_gateway/types/generate_text_request_builder.py,sha256=R4hCgatMPSfWYqaOmeC1IMQj753iDgu7wU992c4tkmk,2565
@@ -86,13 +86,13 @@ datacustomcode/templates/script/examples/employee_hierarchy/employee_data.csv,sh
 datacustomcode/templates/script/examples/employee_hierarchy/entrypoint.py,sha256=Mfm3iQtEHTQRW6cmZTwRKdTh3IeGWR-teXrd6x-YLSY,2223
 datacustomcode/templates/script/jupyterlab.sh,sha256=IHR3YQ8d_busuyvesByhJgzCKULIFPI-Hqogs0NPhCs,2432
 datacustomcode/templates/script/payload/config.json,sha256=0d2mEMt4NHIeOUTsgiPMuRKdOLIQxmh-Wq-IfEqU-gc,28
-datacustomcode/templates/script/payload/entrypoint.py,sha256=Ox2guNka3r0GW2jzKsmH7AP70j1-1Qqr_jhtH5dkPOM,1590
+datacustomcode/templates/script/payload/entrypoint.py,sha256=bLUhC4l03H-OQJKdMf11vGXmBnga6QitRXo-g9HibZg,1741
 datacustomcode/templates/script/requirements-dev.txt,sha256=OWwuy1awesqOZOS3Zizmdd6BDnSePpGFN5bq5IrALvc,176
 datacustomcode/templates/script/requirements.txt,sha256=qJbqzs5z0Hrx590U3T7dHq_m8UQEx2TdhgrJSz-QHIQ,40
 datacustomcode/token_provider.py,sha256=KPj_ca6mcBmhXHaPmZjAI4it8QvOWdwKJL8yfqxfYwU,5446
 datacustomcode/version.py,sha256=9LlbVrzwBvut1L308QbwNBgxdQk5CrghH39JARVSxms,989
-salesforce_data_customcode-6.0.3.dev1.dist-info/METADATA,sha256=wmHyC6LrpV7uYwKuMBQEwfrztUX9gLb7v7YRwsYYGAg,21724
-salesforce_data_customcode-6.0.3.dev1.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
-salesforce_data_customcode-6.0.3.dev1.dist-info/entry_points.txt,sha256=WpQ94UB7UuRCYGOLtJV3vAgm1tl7iVf43VYRWIuNu5Y,74
-salesforce_data_customcode-6.0.3.dev1.dist-info/licenses/LICENSE.txt,sha256=iOi8EmQpfkFhMENi7VYtkl2EqS14pEOccoXHiW2dyPU,11443
-salesforce_data_customcode-6.0.3.dev1.dist-info/RECORD,,
+salesforce_data_customcode-6.0.3.dev2.dist-info/METADATA,sha256=jplSGhHPtA0lYdotZM5jQLNH8WFhDRsE5yv5KRDFCYM,21930
+salesforce_data_customcode-6.0.3.dev2.dist-info/WHEEL,sha256=eY7nduwzv-ldUxpzbRlxwvC693Hg6PX8bWDjEHjZ_dk,88
+salesforce_data_customcode-6.0.3.dev2.dist-info/entry_points.txt,sha256=WpQ94UB7UuRCYGOLtJV3vAgm1tl7iVf43VYRWIuNu5Y,74
+salesforce_data_customcode-6.0.3.dev2.dist-info/licenses/LICENSE.txt,sha256=iOi8EmQpfkFhMENi7VYtkl2EqS14pEOccoXHiW2dyPU,11443
+salesforce_data_customcode-6.0.3.dev2.dist-info/RECORD,,