@celigo/api-specs 0.2.214 → 0.2.216
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai-agent.yml +171 -55
- package/dist/api.yml +39 -18
- package/dist/asynchelper.yml +39 -18
- package/dist/export.yml +72 -21
- package/dist/flow.yml +37 -15
- package/dist/guardrail.yml +55 -17
- package/dist/import.yml +202 -57
- package/dist/processor.yml +31 -3
- package/dist/subscription.yml +13 -7
- package/dist/tool.yml +235 -60
- package/package.json +1 -1
- package/schemas.json +353 -339
package/dist/tool.yml
CHANGED
|
@@ -6276,12 +6276,16 @@ components:
|
|
|
6276
6276
|
- |-
|
|
6277
6277
|
On a grouped record (the export groups rows, so the record is an
|
|
6278
6278
|
array) only `create` can author output — build it from the rows with
|
|
6279
|
-
`$[0].field`, `$[*].field`, or a `buildArrayHelper` over `$[*]
|
|
6279
|
+
`$[0].field`, `$[*].field`, or a `buildArrayHelper` over `$[*]`
|
|
6280
|
+
(`$.rows[0].field` and `$.rows[*]` with `inputContext: envelope`).
|
|
6280
6281
|
`modify` has no object to overlay onto an array: the record passes
|
|
6281
|
-
through untouched and the processor reports success.
|
|
6282
|
-
|
|
6283
|
-
|
|
6284
|
-
|
|
6282
|
+
through untouched and the processor reports success. Paths written
|
|
6283
|
+
for one object record (`$.field`, an entry `$.lines[*]`) resolve
|
|
6284
|
+
nothing there, so `create` returns `{}` for each record, also with
|
|
6285
|
+
no error (live, 2026-10-30). Either mode reshapes the inside of one
|
|
6286
|
+
record; neither changes how many records the page carries (that is
|
|
6287
|
+
the export's `preSavePage` hook) or whether the export groups at all
|
|
6288
|
+
(that is its grouping setting).
|
|
6285
6289
|
examples:
|
|
6286
6290
|
- create
|
|
6287
6291
|
- modify
|
|
@@ -6346,8 +6350,8 @@ components:
|
|
|
6346
6350
|
- record
|
|
6347
6351
|
- envelope
|
|
6348
6352
|
x-enumDescriptions:
|
|
6349
|
-
record: The transform processor evaluates `mappings[].extract` JSONPath against the flat record itself (`$.field`, no `record.` segment) — the default when absent.
|
|
6350
|
-
envelope: The transform processor evaluates JSONPath against the wrapped runtime envelope `{record, job, testMode, settings, headers, queryParams}` (file-provider steps also carry `fileMeta`) — record fields need the `record.` segment (`$.record.field`), while `headers` and `queryParams` sit beside `record` (`$.headers['X-Id']`, `$.queryParams.src`).
|
|
6353
|
+
record: The transform processor evaluates `mappings[].extract` JSONPath against the flat record itself (`$.field`, no `record.` segment; a grouped record is the array of rows, `$[0].field`) — the default when absent.
|
|
6354
|
+
envelope: The transform processor evaluates JSONPath against the wrapped runtime envelope `{record, job, testMode, settings, headers, queryParams}` (file-provider steps also carry `fileMeta`) — record fields need the `record.` segment (`$.record.field`), and a grouped record sits under `rows` instead (`$.rows[0].field`), while `headers` and `queryParams` sit beside `record` (`$.headers['X-Id']`, `$.queryParams.src`).
|
|
6351
6355
|
description: |
|
|
6352
6356
|
Controls the JSON shape the transformTwoDotZero processor
|
|
6353
6357
|
evaluates `mappings[].extract` JSONPath values against at
|
|
@@ -6363,24 +6367,38 @@ components:
|
|
|
6363
6367
|
processor sees the FLAT record as its evaluation root.
|
|
6364
6368
|
`mappings[].extract` JSONPath MUST anchor directly at
|
|
6365
6369
|
`$` with NO `record.` segment — e.g. `"$.orderId"`,
|
|
6366
|
-
`"$.customer.email"
|
|
6370
|
+
`"$.customer.email"` on an object record, `"$[0].orderId"`
|
|
6371
|
+
on a grouped one; PLACEHOLDER extracts use
|
|
6367
6372
|
`"$.PLACEHOLDER_<field>"`.
|
|
6368
6373
|
This is the dominant Celigo idiom and the right choice for new transforms.
|
|
6369
6374
|
- `envelope`: the processor sees a wrapped object
|
|
6370
6375
|
`{record: {...}, job, testMode, settings, headers,
|
|
6371
6376
|
queryParams}` (plus `fileMeta` on file-provider steps).
|
|
6372
6377
|
`mappings[].extract` JSONPath MUST include the
|
|
6373
|
-
`record.` segment for record fields — e.g.
|
|
6374
|
-
`"$.record.orderId"
|
|
6378
|
+
`record.` segment for an object record's fields — e.g.
|
|
6379
|
+
`"$.record.orderId"`; a grouped record sits under `rows`
|
|
6380
|
+
instead (`"$.rows[0].orderId"`) — and reads `headers` and
|
|
6375
6381
|
`queryParams` beside it (`$.headers['X-Id']`);
|
|
6376
6382
|
PLACEHOLDER extracts use `"$.record.PLACEHOLDER_<field>"`.
|
|
6377
6383
|
Pick this only when the transform was authored against
|
|
6378
6384
|
the envelope shape on purpose.
|
|
6379
6385
|
- |-
|
|
6380
|
-
Handlebars expressions inside `extract`
|
|
6381
|
-
|
|
6382
|
-
|
|
6386
|
+
Handlebars expressions inside `extract` reference the
|
|
6387
|
+
`record` root on an object record (`{{record.field}}`,
|
|
6388
|
+
`{{dateFormat ... record.field}}`) and `rows` on a
|
|
6389
|
+
grouped one (`{{rows.0.field}}`), regardless of
|
|
6383
6390
|
`inputContext` — only JSONPath anchoring flips.
|
|
6391
|
+
- |-
|
|
6392
|
+
## Grouped records
|
|
6393
|
+
|
|
6394
|
+
When the export groups rows, each record is an array of
|
|
6395
|
+
rows. In `record` mode JSONPath roots at that array
|
|
6396
|
+
(`$[0].field`, `$[*]`); `envelope` binds it as `rows`,
|
|
6397
|
+
not `record` — `$.rows[0].field`, and an entry
|
|
6398
|
+
`$.rows[*]` whose children read `$.rows.field` — while
|
|
6399
|
+
`$.record[0].field` and `$.record[*]` resolve nothing,
|
|
6400
|
+
with no error (live, 2026-10-30). Handlebars extracts
|
|
6401
|
+
read it as `rows` in both modes (`{{rows.0.field}}`).
|
|
6384
6402
|
- |-
|
|
6385
6403
|
In `envelope` mode the output is still a bare record: a
|
|
6386
6404
|
`modify` transform returns the record with its mapped
|
|
@@ -6401,7 +6419,8 @@ components:
|
|
|
6401
6419
|
``mappings[].extract`` JSONPath values MUST anchor
|
|
6402
6420
|
directly at ``$`` with NO ``record.`` segment — for
|
|
6403
6421
|
example ``"$.orderId"`` or
|
|
6404
|
-
``"$.customer.email"
|
|
6422
|
+
``"$.customer.email"`` on an object record, and
|
|
6423
|
+
``"$[0].orderId"`` on a grouped one. PLACEHOLDER extracts use
|
|
6405
6424
|
``"$.PLACEHOLDER_<field>"``. This is the dominant
|
|
6406
6425
|
Celigo idiom and the right choice for new transforms.
|
|
6407
6426
|
|
|
@@ -6413,9 +6432,10 @@ components:
|
|
|
6413
6432
|
``record``) — the
|
|
6414
6433
|
same runtime-context envelope Handlebars / SQL /
|
|
6415
6434
|
GraphQL templates render against. ``mappings[].extract``
|
|
6416
|
-
JSONPath values for record fields MUST include the
|
|
6435
|
+
JSONPath values for an object record's fields MUST include the
|
|
6417
6436
|
``record.`` segment — for example ``"$.record.orderId"``
|
|
6418
|
-
or ``"$.record.customer.email"
|
|
6437
|
+
or ``"$.record.customer.email"``; a grouped record's rows
|
|
6438
|
+
sit under ``rows`` instead (``"$.rows[0].orderId"``) — while ``headers`` and
|
|
6419
6439
|
``queryParams`` are read beside it
|
|
6420
6440
|
(``"$.headers['X-Id']"``). PLACEHOLDER extracts
|
|
6421
6441
|
use ``"$.record.PLACEHOLDER_<field>"``. Pick this
|
|
@@ -6428,8 +6448,9 @@ components:
|
|
|
6428
6448
|
|
|
6429
6449
|
Handlebars expressions inside ``extract``
|
|
6430
6450
|
(``{{record.field}}``,
|
|
6431
|
-
``{{dateFormat ... record.field}}``, etc.)
|
|
6432
|
-
|
|
6451
|
+
``{{dateFormat ... record.field}}``, etc.) reference the
|
|
6452
|
+
runtime context's ``record`` root on an object record,
|
|
6453
|
+
and ``rows`` (``{{rows.0.field}}``) on a grouped one,
|
|
6433
6454
|
regardless of ``inputContext`` — the Handlebars runtime
|
|
6434
6455
|
always sees the wrapped envelope. Only JSONPath
|
|
6435
6456
|
behavior flips with this field.
|
|
@@ -21571,8 +21592,10 @@ components:
|
|
|
21571
21592
|
- **openai**: OpenAI models (GPT-4.1, GPT-5, etc.). Configure via the `openai` object.
|
|
21572
21593
|
- **gemini**: Google Gemini models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.gemini`.
|
|
21573
21594
|
- **anthropic**: Anthropic Claude models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.anthropic`.
|
|
21574
|
-
- **Catalog providers** —
|
|
21575
|
-
|
|
21595
|
+
- **Catalog providers** — every other value of `provider` (Mistral, xAI, Hugging Face,
|
|
21596
|
+
DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM,
|
|
21597
|
+
Ollama Cloud and Google Vertex AI today; the catalog grows without a platform release).
|
|
21598
|
+
Added as catalog data rather than platform code, they share one generic flat format:
|
|
21576
21599
|
`model`, `modelOptions`, `instructions`, `output`, and the `tools` / `prompts` /
|
|
21577
21600
|
`resources` arrays directly on this object.
|
|
21578
21601
|
|
|
@@ -21618,26 +21641,45 @@ components:
|
|
|
21618
21641
|
- deepseek
|
|
21619
21642
|
- cohere
|
|
21620
21643
|
- groq
|
|
21644
|
+
- together_ai
|
|
21645
|
+
- azure_ai
|
|
21646
|
+
- fireworks_ai
|
|
21647
|
+
- bedrock
|
|
21648
|
+
- nvidia_nim
|
|
21649
|
+
- ollama_chat
|
|
21650
|
+
- vertex_ai
|
|
21621
21651
|
x-enumDescriptions:
|
|
21622
|
-
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block)
|
|
21623
|
-
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block)
|
|
21624
|
-
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block)
|
|
21625
|
-
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
21626
|
-
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
21627
|
-
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
21628
|
-
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
21629
|
-
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
21630
|
-
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
21631
|
-
|
|
21652
|
+
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block; Celigo AI or BYOK)
|
|
21653
|
+
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
21654
|
+
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
21655
|
+
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
21656
|
+
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
21657
|
+
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
21658
|
+
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
21659
|
+
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
21660
|
+
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
21661
|
+
together_ai: Use models served by Together AI (catalog provider; generic flat format, BYOK)
|
|
21662
|
+
azure_ai: Use deployments on an Azure AI Foundry / Azure OpenAI resource — `model` is the deployment name (catalog provider; generic flat format, BYOK)
|
|
21663
|
+
fireworks_ai: Use models served by Fireworks AI (catalog provider; generic flat format, BYOK)
|
|
21664
|
+
bedrock: Use AWS Bedrock models through cross-region inference profile ids such as `global.anthropic.claude-sonnet-4-6` (catalog provider; generic flat format, BYOK)
|
|
21665
|
+
nvidia_nim: Use models served by NVIDIA NIM (catalog provider; generic flat format, BYOK)
|
|
21666
|
+
ollama_chat: Use models served by Ollama Cloud (catalog provider; generic flat format, BYOK)
|
|
21667
|
+
vertex_ai: Use Gemini models on Google Vertex AI with the customer's own GCP project (catalog provider; generic flat format, BYOK)
|
|
21668
|
+
description: |-
|
|
21669
|
+
AI provider to use. Built-in providers run on Celigo AI credentials or on a
|
|
21670
|
+
BYOK connection; every other provider is a catalog row that runs only on a BYOK
|
|
21671
|
+
connection. The catalog is data — a provider can be added without a platform
|
|
21672
|
+
release, and `GET /api/aiproviders` lists the rows currently offered.
|
|
21632
21673
|
x-celigo-ai-guidance:
|
|
21633
21674
|
- |-
|
|
21634
21675
|
The provider decides the configuration format, and the server rejects a
|
|
21635
21676
|
mismatch with 422 `invalid_provider_config_format`: `openai` needs the
|
|
21636
21677
|
`openai` block, `gemini` and `anthropic` need the `litellm` block (Gemini- or
|
|
21637
|
-
Claude-specific settings under `litellm._overrides`), and
|
|
21638
|
-
|
|
21639
|
-
|
|
21640
|
-
|
|
21678
|
+
Claude-specific settings under `litellm._overrides`), and every other
|
|
21679
|
+
provider (the catalog providers) needs the generic flat format — `model` and
|
|
21680
|
+
`modelOptions` directly on this object, never an `openai` or `litellm` block.
|
|
21681
|
+
Switching across that boundary replaces the whole configuration in the target
|
|
21682
|
+
format; nothing is translated field by field.
|
|
21641
21683
|
- |-
|
|
21642
21684
|
Catalog providers are BYOK-only, and the save enforces it through the model
|
|
21643
21685
|
catalog: without a `_connectionId` the agent fails to save with 422
|
|
@@ -21646,6 +21688,18 @@ components:
|
|
|
21646
21688
|
configuration.") — the model is a catalog row that is not offered on
|
|
21647
21689
|
platform-managed credentials. Attach an HTTP connection to the vendor's API
|
|
21648
21690
|
(token auth) before saving a catalog-provider agent.
|
|
21691
|
+
- |-
|
|
21692
|
+
Without a connection, a provider the catalog does not list is refused at the
|
|
21693
|
+
model check — 422 `ai_model_not_in_catalog` on `aiAgent.model` — so the
|
|
21694
|
+
message names the model, not the provider. Check the provider against the
|
|
21695
|
+
catalog before blaming the model.
|
|
21696
|
+
- |-
|
|
21697
|
+
For `azure_ai` and `bedrock` the vendor-specific settings ride the BYOK
|
|
21698
|
+
connection, not this object: an optional connection `baseURI` (the vendor
|
|
21699
|
+
endpoint the connector asks for), and connection settings forwarded to the
|
|
21700
|
+
vendor — Azure's `apiVersion`, Bedrock's `awsRegionName`. `bedrock`
|
|
21701
|
+
authenticates with a Bedrock API key (no IAM role); for `azure_ai`, `model` is
|
|
21702
|
+
the deployment name.
|
|
21649
21703
|
model:
|
|
21650
21704
|
type: string
|
|
21651
21705
|
description: |-
|
|
@@ -22118,13 +22172,27 @@ components:
|
|
|
22118
22172
|
web_search: Search the web for real-time information.
|
|
22119
22173
|
mcp: Connect to an MCP server for additional external tools.
|
|
22120
22174
|
image_generation: Generate images using an AI image model.
|
|
22121
|
-
code_execution: '
|
|
22175
|
+
code_execution: 'Let the model write and run code in OpenAI''s sandbox on a BYOK agent; carries no configuration block, send `{type: code_execution}` only'
|
|
22122
22176
|
tool: Reference a reusable Celigo Tool resource.
|
|
22123
22177
|
description: |-
|
|
22124
22178
|
Type of tool. Every type except `code_execution` is configured through the
|
|
22125
22179
|
sibling object of the same name; OpenAI spells this one `code_execution`, while
|
|
22126
22180
|
the Gemini and Anthropic overrides spell theirs `codeExecution` — the other spelling
|
|
22127
|
-
fails with 422 `enum`.
|
|
22181
|
+
fails with 422 `enum`. Code execution runs only on a BYOK agent and only on
|
|
22182
|
+
models that support it: the code runs in OpenAI's sandbox with no outbound
|
|
22183
|
+
network access, the session lasts one hour, and each execution is billed as an
|
|
22184
|
+
AI Action to the connection's OpenAI account rather than as Celigo AI credits.
|
|
22185
|
+
x-celigo-ai-guidance:
|
|
22186
|
+
- |-
|
|
22187
|
+
Add `code_execution` only when the agent has a `_connectionId`. The save does
|
|
22188
|
+
not check the credential type, but every run and preview of an agent on
|
|
22189
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22190
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22191
|
+
- |-
|
|
22192
|
+
Send the tool as `{type: code_execution}` with no other key — a sandbox or
|
|
22193
|
+
options object on it is rejected. Check that the chosen model supports code
|
|
22194
|
+
execution before adding it; the platform does not verify that at save and
|
|
22195
|
+
the UI hides the tool for models that lack it.
|
|
22128
22196
|
webSearch:
|
|
22129
22197
|
type: object
|
|
22130
22198
|
description: Web search configuration (empty object to enable)
|
|
@@ -22478,12 +22546,28 @@ components:
|
|
|
22478
22546
|
googleSearch: Use Google Search for real-time information grounding.
|
|
22479
22547
|
urlContext: Retrieve and use content from specified URLs.
|
|
22480
22548
|
fileSearch: Search through previously uploaded files.
|
|
22481
|
-
codeExecution: '
|
|
22549
|
+
codeExecution: 'Let the model write and run code in Gemini''s sandbox on a BYOK agent; carries no configuration block, send `{type: codeExecution}` only'
|
|
22482
22550
|
mcp: Connect to an MCP server for additional external tools.
|
|
22483
22551
|
tool: Reference a reusable Celigo Tool resource.
|
|
22484
22552
|
description: |-
|
|
22485
22553
|
Type of Gemini tool. `codeExecution` is the Gemini spelling — `code_execution`
|
|
22486
|
-
fails with 422 `enum`.
|
|
22554
|
+
fails with 422 `enum`. Code execution runs only on a BYOK agent and only on
|
|
22555
|
+
models that support it (not on `gemini-2.5-flash-image`): the code runs in
|
|
22556
|
+
Gemini's sandbox with no outbound network access for up to 30 seconds per
|
|
22557
|
+
execution and at most 5 executions per API call (the limit resets each turn),
|
|
22558
|
+
and each execution is billed as an AI Action to the connection's Google
|
|
22559
|
+
account rather than as Celigo AI credits.
|
|
22560
|
+
x-celigo-ai-guidance:
|
|
22561
|
+
- |-
|
|
22562
|
+
Add `codeExecution` only when the agent has a `_connectionId`. The save does
|
|
22563
|
+
not check the credential type, but every run and preview of an agent on
|
|
22564
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22565
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22566
|
+
- |-
|
|
22567
|
+
Send the tool as `{type: codeExecution}` with no other key — any other key on
|
|
22568
|
+
it is rejected. Check that the chosen model supports code execution before
|
|
22569
|
+
adding it; the platform does not verify that at save and the UI hides the
|
|
22570
|
+
tool for models that lack it.
|
|
22487
22571
|
googleSearch:
|
|
22488
22572
|
type: object
|
|
22489
22573
|
description: Google Search configuration (empty object to enable)
|
|
@@ -22815,10 +22899,26 @@ components:
|
|
|
22815
22899
|
tool: Reference a reusable Celigo Tool resource.
|
|
22816
22900
|
mcp: Connect to an MCP server for additional external tools.
|
|
22817
22901
|
webSearch: Search the web for real-time information.
|
|
22818
|
-
codeExecution: '
|
|
22902
|
+
codeExecution: 'Let the model write and run code in Anthropic''s sandbox on a BYOK agent (beta); carries no configuration block, send `{type: codeExecution}` only'
|
|
22819
22903
|
description: |-
|
|
22820
22904
|
Type of Claude tool. `codeExecution` is the Anthropic spelling — `code_execution`
|
|
22821
|
-
fails with 422 `enum`.
|
|
22905
|
+
fails with 422 `enum`. Code execution (beta on Anthropic) runs only on a BYOK
|
|
22906
|
+
agent and only on models that support it: the code runs per API call in
|
|
22907
|
+
Anthropic's sandbox (Python 3.11 with pandas, numpy and matplotlib) with no
|
|
22908
|
+
outbound network access and no state kept between turns, and each execution is
|
|
22909
|
+
billed as an AI Action to the connection's Anthropic account rather than as
|
|
22910
|
+
Celigo AI credits.
|
|
22911
|
+
x-celigo-ai-guidance:
|
|
22912
|
+
- |-
|
|
22913
|
+
Add `codeExecution` only when the agent has a `_connectionId`. The save does
|
|
22914
|
+
not check the credential type, but every run and preview of an agent on
|
|
22915
|
+
Celigo-managed credentials is refused with `Code Execution requires a BYOK
|
|
22916
|
+
connection.` — switch the agent to a BYOK connection or leave the tool out.
|
|
22917
|
+
- |-
|
|
22918
|
+
Send the tool as `{type: codeExecution}` with no other key — any other key on
|
|
22919
|
+
it is rejected. Check that the chosen model supports code execution before
|
|
22920
|
+
adding it; the platform does not verify that at save and the UI hides the
|
|
22921
|
+
tool for models that lack it.
|
|
22822
22922
|
tool:
|
|
22823
22923
|
type: object
|
|
22824
22924
|
description: Reference to a Celigo Tool resource, used when type is "tool".
|
|
@@ -23035,6 +23135,13 @@ components:
|
|
|
23035
23135
|
- deepseek
|
|
23036
23136
|
- cohere
|
|
23037
23137
|
- groq
|
|
23138
|
+
- together_ai
|
|
23139
|
+
- azure_ai
|
|
23140
|
+
- fireworks_ai
|
|
23141
|
+
- bedrock
|
|
23142
|
+
- nvidia_nim
|
|
23143
|
+
- ollama_chat
|
|
23144
|
+
- vertex_ai
|
|
23038
23145
|
required:
|
|
23039
23146
|
- provider
|
|
23040
23147
|
then:
|
|
@@ -23054,8 +23161,10 @@ components:
|
|
|
23054
23161
|
- **openai**: OpenAI models (GPT-4.1, GPT-5, etc.). Configure via the `openai` object.
|
|
23055
23162
|
- **gemini**: Google Gemini models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.gemini`.
|
|
23056
23163
|
- **anthropic**: Anthropic Claude models via the LiteLLM proxy. Configure via `litellm` with overrides in `litellm._overrides.anthropic`.
|
|
23057
|
-
- **Catalog providers** —
|
|
23058
|
-
|
|
23164
|
+
- **Catalog providers** — every other value of `provider` (Mistral, xAI, Hugging Face,
|
|
23165
|
+
DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM,
|
|
23166
|
+
Ollama Cloud and Google Vertex AI today; the catalog grows without a platform release).
|
|
23167
|
+
Added as catalog data rather than platform code, they share one generic flat format:
|
|
23059
23168
|
`model`, `modelOptions`, `instructions`, `output`, and the `prompts` / `resources`
|
|
23060
23169
|
arrays directly on this object.
|
|
23061
23170
|
|
|
@@ -23107,26 +23216,43 @@ components:
|
|
|
23107
23216
|
- deepseek
|
|
23108
23217
|
- cohere
|
|
23109
23218
|
- groq
|
|
23219
|
+
- together_ai
|
|
23220
|
+
- azure_ai
|
|
23221
|
+
- fireworks_ai
|
|
23222
|
+
- bedrock
|
|
23223
|
+
- nvidia_nim
|
|
23224
|
+
- ollama_chat
|
|
23225
|
+
- vertex_ai
|
|
23110
23226
|
x-enumDescriptions:
|
|
23111
|
-
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block)
|
|
23112
|
-
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block)
|
|
23113
|
-
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block)
|
|
23114
|
-
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
23115
|
-
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
23116
|
-
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
23117
|
-
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
23118
|
-
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
23119
|
-
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
23120
|
-
|
|
23227
|
+
openai: Use OpenAI models via the OpenAI Responses API (built-in; `openai` block; Celigo AI or BYOK)
|
|
23228
|
+
gemini: Use Google Gemini models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
23229
|
+
anthropic: Use Anthropic Claude models via the LiteLLM proxy (built-in; `litellm` block; Celigo AI or BYOK)
|
|
23230
|
+
mistral: Use Mistral models (catalog provider; generic flat format, BYOK)
|
|
23231
|
+
xai: Use xAI Grok models (catalog provider; generic flat format, BYOK)
|
|
23232
|
+
huggingface: Use Hugging Face inference endpoint models (catalog provider; generic flat format, BYOK)
|
|
23233
|
+
deepseek: Use DeepSeek models (catalog provider; generic flat format, BYOK)
|
|
23234
|
+
cohere: Use Cohere models (catalog provider; generic flat format, BYOK)
|
|
23235
|
+
groq: Use Groq-hosted models (catalog provider; generic flat format, BYOK)
|
|
23236
|
+
together_ai: Use models served by Together AI (catalog provider; generic flat format, BYOK)
|
|
23237
|
+
azure_ai: Use deployments on an Azure AI Foundry / Azure OpenAI resource — `model` is the deployment name (catalog provider; generic flat format, BYOK)
|
|
23238
|
+
fireworks_ai: Use models served by Fireworks AI (catalog provider; generic flat format, BYOK)
|
|
23239
|
+
bedrock: Use AWS Bedrock models through cross-region inference profile ids such as `global.anthropic.claude-sonnet-4-6` (catalog provider; generic flat format, BYOK)
|
|
23240
|
+
nvidia_nim: Use models served by NVIDIA NIM (catalog provider; generic flat format, BYOK)
|
|
23241
|
+
ollama_chat: Use models served by Ollama Cloud (catalog provider; generic flat format, BYOK)
|
|
23242
|
+
vertex_ai: Use Gemini models on Google Vertex AI with the customer's own GCP project (catalog provider; generic flat format, BYOK)
|
|
23243
|
+
description: |-
|
|
23244
|
+
AI provider to use. Built-in providers run on Celigo AI credentials or on a
|
|
23245
|
+
BYOK connection; every other provider is a catalog row that runs only on a BYOK
|
|
23246
|
+
connection. The catalog is data — a provider can be added without a platform
|
|
23247
|
+
release, and `GET /api/aiproviders` lists the rows currently offered.
|
|
23121
23248
|
x-celigo-ai-guidance:
|
|
23122
23249
|
- |-
|
|
23123
23250
|
The provider decides the configuration format, and the server rejects a
|
|
23124
23251
|
mismatch with 422 `invalid_provider_config_format`: `openai` needs the
|
|
23125
23252
|
`openai` block, `gemini` and `anthropic` need the `litellm` block (Gemini- or
|
|
23126
|
-
Claude-specific settings under `litellm._overrides`), and
|
|
23127
|
-
|
|
23128
|
-
|
|
23129
|
-
never an `openai` or `litellm` block.
|
|
23253
|
+
Claude-specific settings under `litellm._overrides`), and every other
|
|
23254
|
+
provider (the catalog providers) needs the generic flat format — `model` and
|
|
23255
|
+
`modelOptions` directly on this object, never an `openai` or `litellm` block.
|
|
23130
23256
|
- |-
|
|
23131
23257
|
Catalog providers are BYOK-only, and the save enforces it through the model
|
|
23132
23258
|
catalog: without a `_connectionId` the guardrail fails to save with 422
|
|
@@ -23135,6 +23261,18 @@ components:
|
|
|
23135
23261
|
configuration.") — the model is a catalog row that is not offered on
|
|
23136
23262
|
platform-managed credentials. Attach an HTTP connection to the vendor's API
|
|
23137
23263
|
(token auth) before saving a catalog-provider guardrail.
|
|
23264
|
+
- |-
|
|
23265
|
+
Without a connection, a provider the catalog does not list is refused at the
|
|
23266
|
+
model check — 422 `ai_model_not_in_catalog` on `guardrail.aiAgent.model` — so the
|
|
23267
|
+
message names the model, not the provider. Check the provider against the
|
|
23268
|
+
catalog before blaming the model.
|
|
23269
|
+
- |-
|
|
23270
|
+
For `azure_ai` and `bedrock` the vendor-specific settings ride the BYOK
|
|
23271
|
+
connection, not this object: an optional connection `baseURI` (the vendor
|
|
23272
|
+
endpoint the connector asks for), and connection settings forwarded to the
|
|
23273
|
+
vendor — Azure's `apiVersion`, Bedrock's `awsRegionName`. `bedrock`
|
|
23274
|
+
authenticates with a Bedrock API key (no IAM role); for `azure_ai`, `model` is
|
|
23275
|
+
the deployment name.
|
|
23138
23276
|
model:
|
|
23139
23277
|
type: string
|
|
23140
23278
|
description: |-
|
|
@@ -24018,6 +24156,13 @@ components:
|
|
|
24018
24156
|
- deepseek
|
|
24019
24157
|
- cohere
|
|
24020
24158
|
- groq
|
|
24159
|
+
- together_ai
|
|
24160
|
+
- azure_ai
|
|
24161
|
+
- fireworks_ai
|
|
24162
|
+
- bedrock
|
|
24163
|
+
- nvidia_nim
|
|
24164
|
+
- ollama_chat
|
|
24165
|
+
- vertex_ai
|
|
24021
24166
|
required:
|
|
24022
24167
|
- provider
|
|
24023
24168
|
then:
|
|
@@ -26145,7 +26290,7 @@ components:
|
|
|
26145
26290
|
MongodbImport: MongoDB database import for document-based operations.
|
|
26146
26291
|
DynamodbImport: Amazon DynamoDB import for NoSQL table operations.
|
|
26147
26292
|
WrapperImport: Custom adaptor import built outside of Celigo (rarely used).
|
|
26148
|
-
AiAgentImport: AI agent import using OpenAI, Gemini, Anthropic Claude, or a BYOK catalog provider (Mistral, xAI, Hugging Face, DeepSeek, Cohere, Groq) for data processing.
|
|
26293
|
+
AiAgentImport: AI agent import using OpenAI, Gemini, Anthropic Claude, or a BYOK catalog provider (Mistral, xAI, Hugging Face, DeepSeek, Cohere, Groq, Together AI, Azure OpenAI, Fireworks AI, AWS Bedrock, NVIDIA NIM, Ollama Cloud, Google Vertex AI) for data processing.
|
|
26149
26294
|
GuardrailImport: Safety and compliance check import for PII detection, moderation, or AI evaluation.
|
|
26150
26295
|
FileSystemImport: Local or network file system import.
|
|
26151
26296
|
ToolImport: Import that executes a reusable Celigo Tool resource.
|
|
@@ -38512,8 +38657,8 @@ components:
|
|
|
38512
38657
|
**Structure**
|
|
38513
38658
|
|
|
38514
38659
|
The mock output must follow the integrator.io canonical format, which consists of a
|
|
38515
|
-
`page_of_records` array
|
|
38516
|
-
property that contains the actual data fields
|
|
38660
|
+
`page_of_records` array of items. On an export that does not group rows, each item has a
|
|
38661
|
+
`record` property that contains the actual data fields:
|
|
38517
38662
|
|
|
38518
38663
|
```json
|
|
38519
38664
|
{
|
|
@@ -38530,6 +38675,19 @@ components:
|
|
|
38530
38675
|
}
|
|
38531
38676
|
```
|
|
38532
38677
|
|
|
38678
|
+
An export that groups rows (`groupByFields`) produces records that are arrays of rows, and
|
|
38679
|
+
each item then carries `rows` instead of `record`, holding the rows of one grouped record. A
|
|
38680
|
+
flow test run saves a grouped export's records in this form:
|
|
38681
|
+
|
|
38682
|
+
```json
|
|
38683
|
+
{
|
|
38684
|
+
"page_of_records": [
|
|
38685
|
+
{ "rows": [ { "field1": "value1" }, { "field1": "value2" } ] },
|
|
38686
|
+
...
|
|
38687
|
+
]
|
|
38688
|
+
}
|
|
38689
|
+
```
|
|
38690
|
+
|
|
38533
38691
|
**Usage**
|
|
38534
38692
|
|
|
38535
38693
|
In a flow test run, and for an upstream lookup during a page-processor preview
|
|
@@ -38562,7 +38720,8 @@ components:
|
|
|
38562
38720
|
|
|
38563
38721
|
- Maximum of 10 records
|
|
38564
38722
|
- Maximum size of 1 MB
|
|
38565
|
-
- Must follow the canonical
|
|
38723
|
+
- Must follow one of the canonical formats shown above: every item `{"record": {...}}`, or
|
|
38724
|
+
on a grouped export every item `{"rows": [...]}`
|
|
38566
38725
|
|
|
38567
38726
|
Mock output can be populated automatically from preview data (which is the parsed response,
|
|
38568
38727
|
before `transform` / `filter`) or entered manually.
|
|
@@ -38604,6 +38763,22 @@ components:
|
|
|
38604
38763
|
categories:
|
|
38605
38764
|
- Electronics
|
|
38606
38765
|
- Accessories
|
|
38766
|
+
rows:
|
|
38767
|
+
type: array
|
|
38768
|
+
description: |
|
|
38769
|
+
The rows of one grouped record, present instead of `record` when the export
|
|
38770
|
+
groups rows (`groupByFields`). Every item of a grouped export's mock carries
|
|
38771
|
+
`rows`.
|
|
38772
|
+
items:
|
|
38773
|
+
type: object
|
|
38774
|
+
additionalProperties: true
|
|
38775
|
+
example:
|
|
38776
|
+
- orderId: SO-1001
|
|
38777
|
+
sku: SKU-100
|
|
38778
|
+
quantity: 2
|
|
38779
|
+
- orderId: SO-1001
|
|
38780
|
+
sku: SKU-200
|
|
38781
|
+
quantity: 1
|
|
38607
38782
|
example:
|
|
38608
38783
|
page_of_records:
|
|
38609
38784
|
- record:
|