Skip to content

remove early docs #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jcatt-sf merged 1 commit into from
Apr 6, 2026
Merged

remove early docs #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 0 additions & 40 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,5 @@
# Changelog

## 1.0.1

### Added

- **`llm_gateway_generate_text()` UDF wrapper for AI-powered DataFrame transformations.**

New method on proxy providers to generate AI completions in DataFrame operations via a built-in UDF.

```python
from datacustomcode import Client
from pyspark.sql.functions import col

client = Client()

# Generate summaries in a DataFrame column
df = df.withColumn(
"summary",
client._proxy.llm_gateway_generate_text(
"Summarize {company}: revenue={revenue}, CEO={ceo}",
{
"company": col("company"),
"revenue": col("revenue"),
"ceo": col("ceo")
},
llmModelId="sfdc_ai__DefaultGPT4Omni",
maxTokens=200
)
)
```

**Local Development:** Returns placeholder string (doesn't execute)
**Production:** Calls a built-in UDF

**Parameters:**
- `template` (str): Prompt template with {placeholder} syntax
- `values` (dict or Column): Dict mapping placeholders to Columns, or pre-built named_struct
- `llmModelId` (str): Model identifier (required, e.g., "sfdc_ai__DefaultGPT4Omni")
- `maxTokens` (int): Maximum tokens that will be spent on this query


## 1.0.0

### Breaking Changes
Expand Down
28 changes: 0 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,34 +169,6 @@ client.write_to_dlo('output_DLO')
> [!WARNING]
> Currently we only support reading from DMOs and writing to DMOs or reading from DLOs and writing to DLOs, but they cannot mix.

### LLM Gateway

Generate AI completions in DataFrame transformations using the LLM gateway UDF.

```python
from datacustomcode import Client
from pyspark.sql.functions import col

client = Client()

# Use template with placeholders
df = df.withColumn(
"summary",
client._proxy.llm_gateway_generate_text(
"Summarize {company}: revenue={revenue}, CEO={ceo}",
{
"company": col("company"),
"revenue": col("revenue"),
"ceo": col("ceo")
},
llmModelId="sfdc_ai__DefaultGPT4Omni",
maxTokens=200
)
)
```

> [!WARNING]
> This method returns a placeholder string in local development. It only makes a LLM call and spends tokens when deployed, where it calls the real LLM Gateway service via a built-in UDF.

## CLI

Expand Down
Loading