@celigo/api-specs 0.2.76 → 0.2.78
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 +48 -24
- package/dist/guardrail.yml +33 -21
- package/dist/import.yml +100 -42
- package/dist/tool.yml +136 -50
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/ai-agent.yml
CHANGED
|
@@ -128,7 +128,8 @@ paths:
|
|
|
128
128
|
Hugging Face, DeepSeek, Cohere, and Groq — a block that does not match the
|
|
129
129
|
provider is rejected. For a built-in provider, omit `_connectionId` to
|
|
130
130
|
use platform-managed credentials or include it for BYOK; a catalog
|
|
131
|
-
provider
|
|
131
|
+
provider needs a BYOK connection to save — without one the request
|
|
132
|
+
fails with 422 `connection_required` on `_connectionId`.
|
|
132
133
|
operationId: createAiAgent
|
|
133
134
|
tags:
|
|
134
135
|
- AI Agents
|
|
@@ -679,8 +680,9 @@ components:
|
|
|
679
680
|
|
|
680
681
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
681
682
|
credentials. Without one, built-in providers run on platform-managed
|
|
682
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
683
|
-
save without
|
|
683
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
684
|
+
save requires one — without it the agent fails to save with 422
|
|
685
|
+
`connection_required` on `_connectionId`.
|
|
684
686
|
required:
|
|
685
687
|
- provider
|
|
686
688
|
properties:
|
|
@@ -717,10 +719,11 @@ components:
|
|
|
717
719
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
718
720
|
never an `openai` or `litellm` block.
|
|
719
721
|
- |-
|
|
720
|
-
Catalog providers are BYOK-only
|
|
721
|
-
|
|
722
|
-
key
|
|
723
|
-
|
|
722
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
723
|
+
the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
|
|
724
|
+
key is available for provider 'xai'. Add a connection for this provider with your
|
|
725
|
+
API key and select it on this agent."). Attach an HTTP connection to the vendor's
|
|
726
|
+
API (token auth) before saving a catalog-provider agent.
|
|
724
727
|
model:
|
|
725
728
|
type: string
|
|
726
729
|
description: |-
|
|
@@ -732,11 +735,11 @@ components:
|
|
|
732
735
|
Required for every catalog provider — omitting it or sending an empty string
|
|
733
736
|
fails the save with 422 `missing_required_field`.
|
|
734
737
|
- |-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
`
|
|
738
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
739
|
-
against the catalog or the vendor.
|
|
738
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
739
|
+
parent import a catalog-provider agent fails to save with 422
|
|
740
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
741
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
742
|
+
check it against the catalog or the vendor.
|
|
740
743
|
modelOptions:
|
|
741
744
|
type: object
|
|
742
745
|
description: |-
|
|
@@ -1060,12 +1063,22 @@ components:
|
|
|
1060
1063
|
- manual
|
|
1061
1064
|
- json
|
|
1062
1065
|
x-enumDescriptions:
|
|
1063
|
-
manual: The
|
|
1064
|
-
json: The
|
|
1066
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
1067
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
1065
1068
|
description: |-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider
|
|
1070
|
+
is the same either way, and the field is only meaningful when `type` is
|
|
1071
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
1072
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`,
|
|
1073
|
+
`required`, `items`, `description`, `enum`, `pattern`, length and numeric
|
|
1074
|
+
bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
|
|
1075
|
+
keywords are dropped without a prompt, and `integer` becomes `number`.
|
|
1076
|
+
x-celigo-ai-guidance:
|
|
1077
|
+
- |-
|
|
1078
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
|
|
1079
|
+
inside the keywords the visual editor keeps. A full PUT that omits the field
|
|
1080
|
+
clears it, and a value outside the enum fails the save with 422 `enum` on
|
|
1081
|
+
`aiAgent.openai.output.format.schemaMode`.
|
|
1069
1082
|
name:
|
|
1070
1083
|
type: string
|
|
1071
1084
|
description: Name for the output format (used with json_schema)
|
|
@@ -1418,12 +1431,22 @@ components:
|
|
|
1418
1431
|
- manual
|
|
1419
1432
|
- json
|
|
1420
1433
|
x-enumDescriptions:
|
|
1421
|
-
manual: The
|
|
1422
|
-
json: The
|
|
1434
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
1435
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
1423
1436
|
description: |-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1437
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
|
|
1438
|
+
the same either way, and the field is only meaningful when `type` is
|
|
1439
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
1440
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
|
|
1441
|
+
`items`, `description`, `enum`, `pattern`, length and numeric bounds,
|
|
1442
|
+
`multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
|
|
1443
|
+
dropped without a prompt, and `integer` becomes `number`.
|
|
1444
|
+
x-celigo-ai-guidance:
|
|
1445
|
+
- |-
|
|
1446
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
|
|
1447
|
+
the keywords the visual editor keeps. A full PUT that omits the field clears it,
|
|
1448
|
+
and a value outside the enum fails the save with 422 `enum` on
|
|
1449
|
+
`aiAgent.litellm.responseFormat.schemaMode`.
|
|
1427
1450
|
name:
|
|
1428
1451
|
type: string
|
|
1429
1452
|
description: Name for the output format (used with json_schema).
|
|
@@ -5225,8 +5248,9 @@ components:
|
|
|
5225
5248
|
Connection for BYOK (bring your own key) — an HTTP connection to the vendor's API.
|
|
5226
5249
|
Optional for the built-in providers (`openai`, `gemini`, `anthropic`), which run on
|
|
5227
5250
|
platform-managed credentials when it is omitted. Catalog providers (`mistral`, `xai`,
|
|
5228
|
-
`huggingface`, `deepseek`, `cohere`, `groq`) have no platform-managed credentials: the
|
|
5229
|
-
|
|
5251
|
+
`huggingface`, `deepseek`, `cohere`, `groq`) have no platform-managed credentials: the save
|
|
5252
|
+
requires it — without one the agent fails to save with 422 `connection_required` on
|
|
5253
|
+
`_connectionId`.
|
|
5230
5254
|
examples:
|
|
5231
5255
|
- 662aaa6576bf4040548dbbe4
|
|
5232
5256
|
_integrationId:
|
package/dist/guardrail.yml
CHANGED
|
@@ -602,8 +602,9 @@ components:
|
|
|
602
602
|
|
|
603
603
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
604
604
|
credentials. Without one, built-in providers run on platform-managed
|
|
605
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
606
|
-
save without
|
|
605
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
606
|
+
save requires one — without it the guardrail fails to save with 422
|
|
607
|
+
`connection_required` on `_connectionId`.
|
|
607
608
|
x-celigo-ai-guidance:
|
|
608
609
|
- |-
|
|
609
610
|
Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
|
|
@@ -646,10 +647,11 @@ components:
|
|
|
646
647
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
647
648
|
never an `openai` or `litellm` block.
|
|
648
649
|
- |-
|
|
649
|
-
Catalog providers are BYOK-only
|
|
650
|
-
|
|
651
|
-
key
|
|
652
|
-
|
|
650
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
651
|
+
the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
|
|
652
|
+
API key is available for provider 'xai'. Add a connection for this provider with
|
|
653
|
+
your API key and select it on this agent."). Attach an HTTP connection to the
|
|
654
|
+
vendor's API (token auth) before saving a catalog-provider guardrail.
|
|
653
655
|
model:
|
|
654
656
|
type: string
|
|
655
657
|
description: |-
|
|
@@ -661,11 +663,11 @@ components:
|
|
|
661
663
|
Required for every catalog provider — omitting it or sending an empty string
|
|
662
664
|
fails the save with 422 `missing_required_field`.
|
|
663
665
|
- |-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
`
|
|
667
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
668
|
-
against the catalog or the vendor.
|
|
666
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
667
|
+
parent import a catalog-provider guardrail fails to save with 422
|
|
668
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
669
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
670
|
+
check it against the catalog or the vendor.
|
|
669
671
|
modelOptions:
|
|
670
672
|
type: object
|
|
671
673
|
description: |-
|
|
@@ -930,12 +932,17 @@ components:
|
|
|
930
932
|
- manual
|
|
931
933
|
- json
|
|
932
934
|
x-enumDescriptions:
|
|
933
|
-
manual: The schema
|
|
934
|
-
json: The schema
|
|
935
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
936
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
935
937
|
description: |-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
938
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the
|
|
939
|
+
provider is the same either way. Stored and echoed on guardrails for parity
|
|
940
|
+
with the AI-agent format block — the guardrail form does not set it today.
|
|
941
|
+
x-celigo-ai-guidance:
|
|
942
|
+
- |-
|
|
943
|
+
Resend the stored value on every update — a full PUT that omits the field
|
|
944
|
+
clears it — and never invent one: a value outside the enum fails the save with
|
|
945
|
+
422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
|
|
939
946
|
name:
|
|
940
947
|
type: string
|
|
941
948
|
description: Name for the output format (used with json_schema)
|
|
@@ -1124,12 +1131,17 @@ components:
|
|
|
1124
1131
|
- manual
|
|
1125
1132
|
- json
|
|
1126
1133
|
x-enumDescriptions:
|
|
1127
|
-
manual: The schema
|
|
1128
|
-
json: The schema
|
|
1134
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
1135
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
1129
1136
|
description: |-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1137
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
|
|
1138
|
+
is the same either way. Stored and echoed on guardrails for parity with the
|
|
1139
|
+
AI-agent format block — the guardrail form does not set it today.
|
|
1140
|
+
x-celigo-ai-guidance:
|
|
1141
|
+
- |-
|
|
1142
|
+
Resend the stored value on every update — a full PUT that omits the field clears
|
|
1143
|
+
it — and never invent one: a value outside the enum fails the save with 422 `enum`
|
|
1144
|
+
on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
|
|
1133
1145
|
name:
|
|
1134
1146
|
type: string
|
|
1135
1147
|
description: Name for the output format (used with json_schema).
|
package/dist/import.yml
CHANGED
|
@@ -8400,6 +8400,19 @@ components:
|
|
|
8400
8400
|
- 100
|
|
8401
8401
|
File:
|
|
8402
8402
|
type: object
|
|
8403
|
+
x-celigo-excludeAdaptorTypes:
|
|
8404
|
+
- RDBMSImport
|
|
8405
|
+
- JDBCImport
|
|
8406
|
+
- SalesforceImport
|
|
8407
|
+
- NetSuiteImport
|
|
8408
|
+
- MongodbImport
|
|
8409
|
+
x-celigo-ai-guidance:
|
|
8410
|
+
- |-
|
|
8411
|
+
Never author or patch `file` on an `RDBMSImport`. On a bulk load the API echoes a
|
|
8412
|
+
platform-derived `file` object whose values a save cannot change: the write is accepted,
|
|
8413
|
+
the change is discarded, and a read-back shows the original values. Shape the records
|
|
8414
|
+
before the write (a preMap/postMap hook, the mapping, a transform) or correct the source
|
|
8415
|
+
data instead.
|
|
8403
8416
|
description: |-
|
|
8404
8417
|
**CRITICAL: This object is REQUIRED for all file-based import adaptor types.**
|
|
8405
8418
|
|
|
@@ -8420,6 +8433,17 @@ components:
|
|
|
8420
8433
|
- `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
|
|
8421
8434
|
- `MongodbImport`
|
|
8422
8435
|
- `RDBMSImport`
|
|
8436
|
+
- `JDBCImport`
|
|
8437
|
+
|
|
8438
|
+
**Read-only on database bulk loads**
|
|
8439
|
+
|
|
8440
|
+
An `RDBMSImport` whose `rdbms.queryType` is `bulk_load` returns a `file` object anyway: the
|
|
8441
|
+
platform's description of the staging file it generates for the load (delimiter, quoting,
|
|
8442
|
+
newline handling, and how the load is batched into files). It is derived on every read,
|
|
8443
|
+
never stored — a save that changes it is accepted and the change discarded (the audit log
|
|
8444
|
+
still records the request), and the import editor has no control for it. Change what
|
|
8445
|
+
reaches the destination with a preMap/postMap hook, the mapping, or a transform, or correct
|
|
8446
|
+
the source data.
|
|
8423
8447
|
|
|
8424
8448
|
**Minimum required fields**
|
|
8425
8449
|
|
|
@@ -9046,8 +9070,9 @@ components:
|
|
|
9046
9070
|
|
|
9047
9071
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
9048
9072
|
credentials. Without one, built-in providers run on platform-managed
|
|
9049
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
9050
|
-
save without
|
|
9073
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
9074
|
+
save requires one — without it the agent fails to save with 422
|
|
9075
|
+
`connection_required` on `_connectionId`.
|
|
9051
9076
|
required:
|
|
9052
9077
|
- provider
|
|
9053
9078
|
properties:
|
|
@@ -9084,10 +9109,11 @@ components:
|
|
|
9084
9109
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
9085
9110
|
never an `openai` or `litellm` block.
|
|
9086
9111
|
- |-
|
|
9087
|
-
Catalog providers are BYOK-only
|
|
9088
|
-
|
|
9089
|
-
key
|
|
9090
|
-
|
|
9112
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
9113
|
+
the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
|
|
9114
|
+
key is available for provider 'xai'. Add a connection for this provider with your
|
|
9115
|
+
API key and select it on this agent."). Attach an HTTP connection to the vendor's
|
|
9116
|
+
API (token auth) before saving a catalog-provider agent.
|
|
9091
9117
|
model:
|
|
9092
9118
|
type: string
|
|
9093
9119
|
description: |-
|
|
@@ -9099,11 +9125,11 @@ components:
|
|
|
9099
9125
|
Required for every catalog provider — omitting it or sending an empty string
|
|
9100
9126
|
fails the save with 422 `missing_required_field`.
|
|
9101
9127
|
- |-
|
|
9102
|
-
|
|
9103
|
-
|
|
9104
|
-
`
|
|
9105
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
9106
|
-
against the catalog or the vendor.
|
|
9128
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
9129
|
+
parent import a catalog-provider agent fails to save with 422
|
|
9130
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
9131
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
9132
|
+
check it against the catalog or the vendor.
|
|
9107
9133
|
modelOptions:
|
|
9108
9134
|
type: object
|
|
9109
9135
|
description: |-
|
|
@@ -9427,12 +9453,22 @@ components:
|
|
|
9427
9453
|
- manual
|
|
9428
9454
|
- json
|
|
9429
9455
|
x-enumDescriptions:
|
|
9430
|
-
manual: The
|
|
9431
|
-
json: The
|
|
9456
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
9457
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
9432
9458
|
description: |-
|
|
9433
|
-
|
|
9434
|
-
|
|
9435
|
-
|
|
9459
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider
|
|
9460
|
+
is the same either way, and the field is only meaningful when `type` is
|
|
9461
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
9462
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`,
|
|
9463
|
+
`required`, `items`, `description`, `enum`, `pattern`, length and numeric
|
|
9464
|
+
bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
|
|
9465
|
+
keywords are dropped without a prompt, and `integer` becomes `number`.
|
|
9466
|
+
x-celigo-ai-guidance:
|
|
9467
|
+
- |-
|
|
9468
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
|
|
9469
|
+
inside the keywords the visual editor keeps. A full PUT that omits the field
|
|
9470
|
+
clears it, and a value outside the enum fails the save with 422 `enum` on
|
|
9471
|
+
`aiAgent.openai.output.format.schemaMode`.
|
|
9436
9472
|
name:
|
|
9437
9473
|
type: string
|
|
9438
9474
|
description: Name for the output format (used with json_schema)
|
|
@@ -9785,12 +9821,22 @@ components:
|
|
|
9785
9821
|
- manual
|
|
9786
9822
|
- json
|
|
9787
9823
|
x-enumDescriptions:
|
|
9788
|
-
manual: The
|
|
9789
|
-
json: The
|
|
9824
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
9825
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
9790
9826
|
description: |-
|
|
9791
|
-
|
|
9792
|
-
|
|
9793
|
-
|
|
9827
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
|
|
9828
|
+
the same either way, and the field is only meaningful when `type` is
|
|
9829
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
9830
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
|
|
9831
|
+
`items`, `description`, `enum`, `pattern`, length and numeric bounds,
|
|
9832
|
+
`multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
|
|
9833
|
+
dropped without a prompt, and `integer` becomes `number`.
|
|
9834
|
+
x-celigo-ai-guidance:
|
|
9835
|
+
- |-
|
|
9836
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
|
|
9837
|
+
the keywords the visual editor keeps. A full PUT that omits the field clears it,
|
|
9838
|
+
and a value outside the enum fails the save with 422 `enum` on
|
|
9839
|
+
`aiAgent.litellm.responseFormat.schemaMode`.
|
|
9794
9840
|
name:
|
|
9795
9841
|
type: string
|
|
9796
9842
|
description: Name for the output format (used with json_schema).
|
|
@@ -10467,8 +10513,9 @@ components:
|
|
|
10467
10513
|
|
|
10468
10514
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
10469
10515
|
credentials. Without one, built-in providers run on platform-managed
|
|
10470
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
10471
|
-
save without
|
|
10516
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
10517
|
+
save requires one — without it the guardrail fails to save with 422
|
|
10518
|
+
`connection_required` on `_connectionId`.
|
|
10472
10519
|
x-celigo-ai-guidance:
|
|
10473
10520
|
- |-
|
|
10474
10521
|
Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
|
|
@@ -10511,10 +10558,11 @@ components:
|
|
|
10511
10558
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
10512
10559
|
never an `openai` or `litellm` block.
|
|
10513
10560
|
- |-
|
|
10514
|
-
Catalog providers are BYOK-only
|
|
10515
|
-
|
|
10516
|
-
key
|
|
10517
|
-
|
|
10561
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
10562
|
+
the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
|
|
10563
|
+
API key is available for provider 'xai'. Add a connection for this provider with
|
|
10564
|
+
your API key and select it on this agent."). Attach an HTTP connection to the
|
|
10565
|
+
vendor's API (token auth) before saving a catalog-provider guardrail.
|
|
10518
10566
|
model:
|
|
10519
10567
|
type: string
|
|
10520
10568
|
description: |-
|
|
@@ -10526,11 +10574,11 @@ components:
|
|
|
10526
10574
|
Required for every catalog provider — omitting it or sending an empty string
|
|
10527
10575
|
fails the save with 422 `missing_required_field`.
|
|
10528
10576
|
- |-
|
|
10529
|
-
|
|
10530
|
-
|
|
10531
|
-
`
|
|
10532
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
10533
|
-
against the catalog or the vendor.
|
|
10577
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
10578
|
+
parent import a catalog-provider guardrail fails to save with 422
|
|
10579
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
10580
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
10581
|
+
check it against the catalog or the vendor.
|
|
10534
10582
|
modelOptions:
|
|
10535
10583
|
type: object
|
|
10536
10584
|
description: |-
|
|
@@ -10795,12 +10843,17 @@ components:
|
|
|
10795
10843
|
- manual
|
|
10796
10844
|
- json
|
|
10797
10845
|
x-enumDescriptions:
|
|
10798
|
-
manual: The schema
|
|
10799
|
-
json: The schema
|
|
10846
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
10847
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
10800
10848
|
description: |-
|
|
10801
|
-
|
|
10802
|
-
|
|
10803
|
-
|
|
10849
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the
|
|
10850
|
+
provider is the same either way. Stored and echoed on guardrails for parity
|
|
10851
|
+
with the AI-agent format block — the guardrail form does not set it today.
|
|
10852
|
+
x-celigo-ai-guidance:
|
|
10853
|
+
- |-
|
|
10854
|
+
Resend the stored value on every update — a full PUT that omits the field
|
|
10855
|
+
clears it — and never invent one: a value outside the enum fails the save with
|
|
10856
|
+
422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
|
|
10804
10857
|
name:
|
|
10805
10858
|
type: string
|
|
10806
10859
|
description: Name for the output format (used with json_schema)
|
|
@@ -10989,12 +11042,17 @@ components:
|
|
|
10989
11042
|
- manual
|
|
10990
11043
|
- json
|
|
10991
11044
|
x-enumDescriptions:
|
|
10992
|
-
manual: The schema
|
|
10993
|
-
json: The schema
|
|
11045
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
11046
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
10994
11047
|
description: |-
|
|
10995
|
-
|
|
10996
|
-
|
|
10997
|
-
|
|
11048
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
|
|
11049
|
+
is the same either way. Stored and echoed on guardrails for parity with the
|
|
11050
|
+
AI-agent format block — the guardrail form does not set it today.
|
|
11051
|
+
x-celigo-ai-guidance:
|
|
11052
|
+
- |-
|
|
11053
|
+
Resend the stored value on every update — a full PUT that omits the field clears
|
|
11054
|
+
it — and never invent one: a value outside the enum fails the save with 422 `enum`
|
|
11055
|
+
on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
|
|
10998
11056
|
name:
|
|
10999
11057
|
type: string
|
|
11000
11058
|
description: Name for the output format (used with json_schema).
|
package/dist/tool.yml
CHANGED
|
@@ -5577,11 +5577,25 @@ components:
|
|
|
5577
5577
|
- manual
|
|
5578
5578
|
- json
|
|
5579
5579
|
x-enumDescriptions:
|
|
5580
|
-
manual: The
|
|
5581
|
-
json: The
|
|
5580
|
+
manual: The UI opens `schema` in the visual field-by-field editor
|
|
5581
|
+
json: The UI opens `schema` in the raw JSON editor
|
|
5582
5582
|
description: |-
|
|
5583
|
-
|
|
5584
|
-
the
|
|
5583
|
+
Which editor the UI opens `schema` in; invocation input validates the same either way.
|
|
5584
|
+
Unset opens the visual editor, and an edit there rebuilds `schema` from the field list,
|
|
5585
|
+
keeping only `type`, `properties`, `required`, `items`, `description`, `enum`, `pattern`,
|
|
5586
|
+
`minLength`/`maxLength`, `minimum`/`maximum`, `exclusiveMinimum`/`exclusiveMaximum`,
|
|
5587
|
+
`multipleOf`, `minItems`/`maxItems` and a `"null"` type — `format`, `const`, `default`,
|
|
5588
|
+
`additionalProperties`, `$ref` and `allOf`/`anyOf`/`oneOf`/`if` are dropped without a
|
|
5589
|
+
prompt, and `integer` becomes `number`.
|
|
5590
|
+
x-celigo-ai-guidance:
|
|
5591
|
+
- |-
|
|
5592
|
+
Set `json` on any schema written as raw JSON so the UI opens the JSON editor and warns
|
|
5593
|
+
before a switch to the visual editor can drop keywords; keep `manual` on a schema a
|
|
5594
|
+
user built in the visual editor and stay inside the keywords it keeps.
|
|
5595
|
+
- |-
|
|
5596
|
+
A full PUT that omits this field clears it — resend the stored value on every update.
|
|
5597
|
+
PATCH rejects the path ("/input/schemaMode is not a whitelisted property"), and a value
|
|
5598
|
+
outside the enum fails the save with 422 `enum` on `input.schemaMode`.
|
|
5585
5599
|
examples:
|
|
5586
5600
|
- json
|
|
5587
5601
|
transform:
|
|
@@ -5662,11 +5676,25 @@ components:
|
|
|
5662
5676
|
- manual
|
|
5663
5677
|
- json
|
|
5664
5678
|
x-enumDescriptions:
|
|
5665
|
-
manual: The
|
|
5666
|
-
json: The
|
|
5679
|
+
manual: The UI opens `schema` in the visual field-by-field editor
|
|
5680
|
+
json: The UI opens `schema` in the raw JSON editor
|
|
5667
5681
|
description: |-
|
|
5668
|
-
|
|
5669
|
-
the
|
|
5682
|
+
Which editor the UI opens `schema` in; the output validates the same either way. Unset
|
|
5683
|
+
opens the visual editor, and an edit there rebuilds `schema` from the field list, keeping
|
|
5684
|
+
only `type`, `properties`, `required`, `items`, `description`, `enum`, `pattern`,
|
|
5685
|
+
`minLength`/`maxLength`, `minimum`/`maximum`, `exclusiveMinimum`/`exclusiveMaximum`,
|
|
5686
|
+
`multipleOf`, `minItems`/`maxItems` and a `"null"` type — `format`, `const`, `default`,
|
|
5687
|
+
`additionalProperties`, `$ref` and `allOf`/`anyOf`/`oneOf`/`if` are dropped without a
|
|
5688
|
+
prompt, and `integer` becomes `number`.
|
|
5689
|
+
x-celigo-ai-guidance:
|
|
5690
|
+
- |-
|
|
5691
|
+
Set `json` on any schema written as raw JSON so the UI opens the JSON editor and warns
|
|
5692
|
+
before a switch to the visual editor can drop keywords; keep `manual` on a schema a
|
|
5693
|
+
user built in the visual editor and stay inside the keywords it keeps.
|
|
5694
|
+
- |-
|
|
5695
|
+
A full PUT that omits this field clears it — resend the stored value on every update.
|
|
5696
|
+
PATCH rejects the path ("/output/schemaMode is not a whitelisted property"), and a
|
|
5697
|
+
value outside the enum fails the save with 422 `enum` on `output.schemaMode`.
|
|
5670
5698
|
examples:
|
|
5671
5699
|
- manual
|
|
5672
5700
|
mappings:
|
|
@@ -18770,6 +18798,19 @@ components:
|
|
|
18770
18798
|
- 100
|
|
18771
18799
|
File:
|
|
18772
18800
|
type: object
|
|
18801
|
+
x-celigo-excludeAdaptorTypes:
|
|
18802
|
+
- RDBMSImport
|
|
18803
|
+
- JDBCImport
|
|
18804
|
+
- SalesforceImport
|
|
18805
|
+
- NetSuiteImport
|
|
18806
|
+
- MongodbImport
|
|
18807
|
+
x-celigo-ai-guidance:
|
|
18808
|
+
- |-
|
|
18809
|
+
Never author or patch `file` on an `RDBMSImport`. On a bulk load the API echoes a
|
|
18810
|
+
platform-derived `file` object whose values a save cannot change: the write is accepted,
|
|
18811
|
+
the change is discarded, and a read-back shows the original values. Shape the records
|
|
18812
|
+
before the write (a preMap/postMap hook, the mapping, a transform) or correct the source
|
|
18813
|
+
data instead.
|
|
18773
18814
|
description: |-
|
|
18774
18815
|
**CRITICAL: This object is REQUIRED for all file-based import adaptor types.**
|
|
18775
18816
|
|
|
@@ -18790,6 +18831,17 @@ components:
|
|
|
18790
18831
|
- `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
|
|
18791
18832
|
- `MongodbImport`
|
|
18792
18833
|
- `RDBMSImport`
|
|
18834
|
+
- `JDBCImport`
|
|
18835
|
+
|
|
18836
|
+
**Read-only on database bulk loads**
|
|
18837
|
+
|
|
18838
|
+
An `RDBMSImport` whose `rdbms.queryType` is `bulk_load` returns a `file` object anyway: the
|
|
18839
|
+
platform's description of the staging file it generates for the load (delimiter, quoting,
|
|
18840
|
+
newline handling, and how the load is batched into files). It is derived on every read,
|
|
18841
|
+
never stored — a save that changes it is accepted and the change discarded (the audit log
|
|
18842
|
+
still records the request), and the import editor has no control for it. Change what
|
|
18843
|
+
reaches the destination with a preMap/postMap hook, the mapping, or a transform, or correct
|
|
18844
|
+
the source data.
|
|
18793
18845
|
|
|
18794
18846
|
**Minimum required fields**
|
|
18795
18847
|
|
|
@@ -19416,8 +19468,9 @@ components:
|
|
|
19416
19468
|
|
|
19417
19469
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
19418
19470
|
credentials. Without one, built-in providers run on platform-managed
|
|
19419
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
19420
|
-
save without
|
|
19471
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
19472
|
+
save requires one — without it the agent fails to save with 422
|
|
19473
|
+
`connection_required` on `_connectionId`.
|
|
19421
19474
|
required:
|
|
19422
19475
|
- provider
|
|
19423
19476
|
properties:
|
|
@@ -19454,10 +19507,11 @@ components:
|
|
|
19454
19507
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
19455
19508
|
never an `openai` or `litellm` block.
|
|
19456
19509
|
- |-
|
|
19457
|
-
Catalog providers are BYOK-only
|
|
19458
|
-
|
|
19459
|
-
key
|
|
19460
|
-
|
|
19510
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
19511
|
+
the agent fails to save with 422 `connection_required` on `_connectionId` ("No API
|
|
19512
|
+
key is available for provider 'xai'. Add a connection for this provider with your
|
|
19513
|
+
API key and select it on this agent."). Attach an HTTP connection to the vendor's
|
|
19514
|
+
API (token auth) before saving a catalog-provider agent.
|
|
19461
19515
|
model:
|
|
19462
19516
|
type: string
|
|
19463
19517
|
description: |-
|
|
@@ -19469,11 +19523,11 @@ components:
|
|
|
19469
19523
|
Required for every catalog provider — omitting it or sending an empty string
|
|
19470
19524
|
fails the save with 422 `missing_required_field`.
|
|
19471
19525
|
- |-
|
|
19472
|
-
|
|
19473
|
-
|
|
19474
|
-
`
|
|
19475
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
19476
|
-
against the catalog or the vendor.
|
|
19526
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
19527
|
+
parent import a catalog-provider agent fails to save with 422
|
|
19528
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
19529
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
19530
|
+
check it against the catalog or the vendor.
|
|
19477
19531
|
modelOptions:
|
|
19478
19532
|
type: object
|
|
19479
19533
|
description: |-
|
|
@@ -19797,12 +19851,22 @@ components:
|
|
|
19797
19851
|
- manual
|
|
19798
19852
|
- json
|
|
19799
19853
|
x-enumDescriptions:
|
|
19800
|
-
manual: The
|
|
19801
|
-
json: The
|
|
19854
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
19855
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
19802
19856
|
description: |-
|
|
19803
|
-
|
|
19804
|
-
|
|
19805
|
-
|
|
19857
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider
|
|
19858
|
+
is the same either way, and the field is only meaningful when `type` is
|
|
19859
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
19860
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`,
|
|
19861
|
+
`required`, `items`, `description`, `enum`, `pattern`, length and numeric
|
|
19862
|
+
bounds, `multipleOf`, `minItems`/`maxItems` and a `"null"` type — other
|
|
19863
|
+
keywords are dropped without a prompt, and `integer` becomes `number`.
|
|
19864
|
+
x-celigo-ai-guidance:
|
|
19865
|
+
- |-
|
|
19866
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay
|
|
19867
|
+
inside the keywords the visual editor keeps. A full PUT that omits the field
|
|
19868
|
+
clears it, and a value outside the enum fails the save with 422 `enum` on
|
|
19869
|
+
`aiAgent.openai.output.format.schemaMode`.
|
|
19806
19870
|
name:
|
|
19807
19871
|
type: string
|
|
19808
19872
|
description: Name for the output format (used with json_schema)
|
|
@@ -20155,12 +20219,22 @@ components:
|
|
|
20155
20219
|
- manual
|
|
20156
20220
|
- json
|
|
20157
20221
|
x-enumDescriptions:
|
|
20158
|
-
manual: The
|
|
20159
|
-
json: The
|
|
20222
|
+
manual: The UI opens `jsonSchema` in the visual field-by-field editor
|
|
20223
|
+
json: The UI opens `jsonSchema` in the raw JSON editor
|
|
20160
20224
|
description: |-
|
|
20161
|
-
|
|
20162
|
-
|
|
20163
|
-
|
|
20225
|
+
Which editor the UI opens `jsonSchema` in; the schema sent to the provider is
|
|
20226
|
+
the same either way, and the field is only meaningful when `type` is
|
|
20227
|
+
"json_schema". Unset opens the visual editor, and an edit there rebuilds
|
|
20228
|
+
`jsonSchema` from the field list, keeping only `type`, `properties`, `required`,
|
|
20229
|
+
`items`, `description`, `enum`, `pattern`, length and numeric bounds,
|
|
20230
|
+
`multipleOf`, `minItems`/`maxItems` and a `"null"` type — other keywords are
|
|
20231
|
+
dropped without a prompt, and `integer` becomes `number`.
|
|
20232
|
+
x-celigo-ai-guidance:
|
|
20233
|
+
- |-
|
|
20234
|
+
Set `json` on a schema written as raw JSON; keep a user's `manual` and stay inside
|
|
20235
|
+
the keywords the visual editor keeps. A full PUT that omits the field clears it,
|
|
20236
|
+
and a value outside the enum fails the save with 422 `enum` on
|
|
20237
|
+
`aiAgent.litellm.responseFormat.schemaMode`.
|
|
20164
20238
|
name:
|
|
20165
20239
|
type: string
|
|
20166
20240
|
description: Name for the output format (used with json_schema).
|
|
@@ -20837,8 +20911,9 @@ components:
|
|
|
20837
20911
|
|
|
20838
20912
|
A `_connectionId` on the parent import selects bring-your-own-key (BYOK)
|
|
20839
20913
|
credentials. Without one, built-in providers run on platform-managed
|
|
20840
|
-
credentials; catalog providers have no platform-managed credentials, so
|
|
20841
|
-
save without
|
|
20914
|
+
credentials; catalog providers have no platform-managed credentials, so the
|
|
20915
|
+
save requires one — without it the guardrail fails to save with 422
|
|
20916
|
+
`connection_required` on `_connectionId`.
|
|
20842
20917
|
x-celigo-ai-guidance:
|
|
20843
20918
|
- |-
|
|
20844
20919
|
Do not send `tools` on any block. A non-empty array at `tools`, `openai.tools`,
|
|
@@ -20881,10 +20956,11 @@ components:
|
|
|
20881
20956
|
generic flat format — `model` and `modelOptions` directly on this object,
|
|
20882
20957
|
never an `openai` or `litellm` block.
|
|
20883
20958
|
- |-
|
|
20884
|
-
Catalog providers are BYOK-only
|
|
20885
|
-
|
|
20886
|
-
key
|
|
20887
|
-
|
|
20959
|
+
Catalog providers are BYOK-only, and the save enforces it: without a `_connectionId`
|
|
20960
|
+
the guardrail fails to save with 422 `connection_required` on `_connectionId` ("No
|
|
20961
|
+
API key is available for provider 'xai'. Add a connection for this provider with
|
|
20962
|
+
your API key and select it on this agent."). Attach an HTTP connection to the
|
|
20963
|
+
vendor's API (token auth) before saving a catalog-provider guardrail.
|
|
20888
20964
|
model:
|
|
20889
20965
|
type: string
|
|
20890
20966
|
description: |-
|
|
@@ -20896,11 +20972,11 @@ components:
|
|
|
20896
20972
|
Required for every catalog provider — omitting it or sending an empty string
|
|
20897
20973
|
fails the save with 422 `missing_required_field`.
|
|
20898
20974
|
- |-
|
|
20899
|
-
|
|
20900
|
-
|
|
20901
|
-
`
|
|
20902
|
-
`_connectionId` (BYOK) any model string saves — the server does not
|
|
20903
|
-
against the catalog or the vendor.
|
|
20975
|
+
The connection is checked before the model: without a `_connectionId` on the
|
|
20976
|
+
parent import a catalog-provider guardrail fails to save with 422
|
|
20977
|
+
`connection_required` whatever the model string (an unknown id included).
|
|
20978
|
+
With a `_connectionId` (BYOK) any model string saves — the server does not
|
|
20979
|
+
check it against the catalog or the vendor.
|
|
20904
20980
|
modelOptions:
|
|
20905
20981
|
type: object
|
|
20906
20982
|
description: |-
|
|
@@ -21165,12 +21241,17 @@ components:
|
|
|
21165
21241
|
- manual
|
|
21166
21242
|
- json
|
|
21167
21243
|
x-enumDescriptions:
|
|
21168
|
-
manual: The schema
|
|
21169
|
-
json: The schema
|
|
21244
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
21245
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
21170
21246
|
description: |-
|
|
21171
|
-
|
|
21172
|
-
|
|
21173
|
-
|
|
21247
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the
|
|
21248
|
+
provider is the same either way. Stored and echoed on guardrails for parity
|
|
21249
|
+
with the AI-agent format block — the guardrail form does not set it today.
|
|
21250
|
+
x-celigo-ai-guidance:
|
|
21251
|
+
- |-
|
|
21252
|
+
Resend the stored value on every update — a full PUT that omits the field
|
|
21253
|
+
clears it — and never invent one: a value outside the enum fails the save with
|
|
21254
|
+
422 `enum` on `guardrail.aiAgent.openai.output.format.schemaMode`.
|
|
21174
21255
|
name:
|
|
21175
21256
|
type: string
|
|
21176
21257
|
description: Name for the output format (used with json_schema)
|
|
@@ -21359,12 +21440,17 @@ components:
|
|
|
21359
21440
|
- manual
|
|
21360
21441
|
- json
|
|
21361
21442
|
x-enumDescriptions:
|
|
21362
|
-
manual: The schema
|
|
21363
|
-
json: The schema
|
|
21443
|
+
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
21444
|
+
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
21364
21445
|
description: |-
|
|
21365
|
-
|
|
21366
|
-
|
|
21367
|
-
|
|
21446
|
+
Which view a schema editor opens `jsonSchema` in; the schema sent to the provider
|
|
21447
|
+
is the same either way. Stored and echoed on guardrails for parity with the
|
|
21448
|
+
AI-agent format block — the guardrail form does not set it today.
|
|
21449
|
+
x-celigo-ai-guidance:
|
|
21450
|
+
- |-
|
|
21451
|
+
Resend the stored value on every update — a full PUT that omits the field clears
|
|
21452
|
+
it — and never invent one: a value outside the enum fails the save with 422 `enum`
|
|
21453
|
+
on `guardrail.aiAgent.litellm.responseFormat.schemaMode`.
|
|
21368
21454
|
name:
|
|
21369
21455
|
type: string
|
|
21370
21456
|
description: Name for the output format (used with json_schema).
|
package/package.json
CHANGED