spicepod.yaml
Spice.ai OSS Spicepod Manifest file
| Type | object |
|---|---|
| File match |
spicepod.yml
spicepod.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/spicepod-yaml/latest.json |
| Source | https://raw.githubusercontent.com/spiceai/spiceai/trunk/.schema/spicepod.schema.json |
Validate with Lintel
npx @lintel/lintel checkA Spicepod definition is a YAML file that describes a Spicepod.
Properties
The name of the Spicepod
Helper struct for deserializing Runtime with custom logic for handling memory_limit/temp_directory deprecation
19 nested properties
If set, the runtime will configure all endpoints to use TLS
5 nested properties
Custom key/value attributes attached to telemetry metrics emitted by
spiced. Applied as OpenTelemetry resource attributes on the runtime's
MeterProvider, so they appear as dimensions on every metric exported
via the Prometheus scrape endpoint, the cluster on-demand OTLP reader,
and the otel_exporter push exporter, and as labels on anonymous
usage telemetry. Currently does not affect tracing spans or logs.
Example: { environment: prod, region: us-west-2, team: data-platform }.
{}Optional prefix prepended to every exported metric name.
Useful for namespacing Spice metrics in shared backends (e.g. Datadog,
Grafana Cloud) so they don't collide with metrics from other services.
For example, with metric_prefix: "spiceai." the runtime metric
query_duration_ms is exported as spiceai.query_duration_ms.
The prefix is applied via an OpenTelemetry View on the runtime's
MeterProvider, so it affects every metric reader attached to that
provider — the Prometheus scrape endpoint (--metrics), the cluster
on-demand OTLP reader, and the otel_exporter push reader.
OpenTelemetry 0.31's SDK does not support per-reader name transforms,
so this knob is intentionally placed at the telemetry level rather
than under any single exporter.
Optional configuration for pushing metrics to an OpenTelemetry collector
8 nested properties
2 nested properties
[
"*"
]Configures where the runtime will store temporary files needed for operations like spilling to disk for queries & accelerations that are larger than memory.
Specifies the runtime memory limit. When configured, will spill to disk for supported queries larger than memory.
Configures how long the runtime waits for connections to be gracefully drained and components to shut down cleanly during runtime termination
Controls when the runtime readiness probe reports the runtime as ready.
Configures log level for the runtime. Can be overriden if flags or environment variables are set.
Optional management configuration
Optional acceleration snapshot configuration
Optional extensions configuration
Optional spicepod secrets configuration Default value is:
secrets:
- from: env
name: env
Definitions
Helper struct for deserializing Runtime with custom logic for handling memory_limit/temp_directory deprecation
If set, the runtime will configure all endpoints to use TLS
5 nested properties
Custom key/value attributes attached to telemetry metrics emitted by
spiced. Applied as OpenTelemetry resource attributes on the runtime's
MeterProvider, so they appear as dimensions on every metric exported
via the Prometheus scrape endpoint, the cluster on-demand OTLP reader,
and the otel_exporter push exporter, and as labels on anonymous
usage telemetry. Currently does not affect tracing spans or logs.
Example: { environment: prod, region: us-west-2, team: data-platform }.
{}Optional prefix prepended to every exported metric name.
Useful for namespacing Spice metrics in shared backends (e.g. Datadog,
Grafana Cloud) so they don't collide with metrics from other services.
For example, with metric_prefix: "spiceai." the runtime metric
query_duration_ms is exported as spiceai.query_duration_ms.
The prefix is applied via an OpenTelemetry View on the runtime's
MeterProvider, so it affects every metric reader attached to that
provider — the Prometheus scrape endpoint (--metrics), the cluster
on-demand OTLP reader, and the otel_exporter push reader.
OpenTelemetry 0.31's SDK does not support per-reader name transforms,
so this knob is intentionally placed at the telemetry level rather
than under any single exporter.
Optional configuration for pushing metrics to an OpenTelemetry collector
8 nested properties
2 nested properties
[
"*"
]Configures where the runtime will store temporary files needed for operations like spilling to disk for queries & accelerations that are larger than memory.
Specifies the runtime memory limit. When configured, will spill to disk for supported queries larger than memory.
Configures how long the runtime waits for connections to be gracefully drained and components to shut down cleanly during runtime termination
Controls when the runtime readiness probe reports the runtime as ready.
Configures log level for the runtime. Can be overriden if flags or environment variables are set.
Maximum stale-while-revalidate duration to add to the cache TTL.
Maximum age for serving stale cached results while revalidating in the background. When set, cached results past their TTL (but within this additional window) will be served immediately while a background refresh is triggered. Format: duration string (e.g., "30s", "5m"). This is a response directive.
If set, the runtime will configure all endpoints to use TLS
A filesystem path to a file containing the PEM encoded certificate
A PEM encoded certificate
A filesystem path to a file containing the PEM encoded private key
A PEM encoded private key
Custom key/value attributes attached to telemetry metrics emitted by
spiced. Applied as OpenTelemetry resource attributes on the runtime's
MeterProvider, so they appear as dimensions on every metric exported
via the Prometheus scrape endpoint, the cluster on-demand OTLP reader,
and the otel_exporter push exporter, and as labels on anonymous
usage telemetry. Currently does not affect tracing spans or logs.
Example: { environment: prod, region: us-west-2, team: data-platform }.
{}Optional prefix prepended to every exported metric name.
Useful for namespacing Spice metrics in shared backends (e.g. Datadog,
Grafana Cloud) so they don't collide with metrics from other services.
For example, with metric_prefix: "spiceai." the runtime metric
query_duration_ms is exported as spiceai.query_duration_ms.
The prefix is applied via an OpenTelemetry View on the runtime's
MeterProvider, so it affects every metric reader attached to that
provider — the Prometheus scrape endpoint (--metrics), the cluster
on-demand OTLP reader, and the otel_exporter push reader.
OpenTelemetry 0.31's SDK does not support per-reader name transforms,
so this knob is intentionally placed at the telemetry level rather
than under any single exporter.
Optional configuration for pushing metrics to an OpenTelemetry collector
Configuration for pushing metrics to an OpenTelemetry collector.
The protocol is inferred from the endpoint:
- HTTP: When endpoint has
<http://>or<https://>scheme, or contains/v1/metrics - gRPC: When endpoint is just a hostname and optional port (defaults to 4317)
Examples
gRPC (hostname only, port defaults to 4317):
otel_exporter:
enabled: true
endpoint: "otel-collector"
With metric whitelist:
otel_exporter:
enabled: true
endpoint: "otel-collector:4317"
metrics:
- requests_total
- request_duration_seconds
HTTP:
otel_exporter:
enabled: true
endpoint: "<http://localhost:4318/v1/metrics>"
The endpoint of the OTEL collector.
For gRPC: use hostname with optional port (e.g., otel-collector or localhost:4317)
For HTTP: use full URL (e.g., <http://localhost:4318/v1/metrics>)
Whether the OTEL exporter is enabled
How often to push metrics to the collector (e.g., "30s", "1m", "5m")
Optional whitelist of metric names to export. If not specified or empty, all metrics are exported.
Optional headers to send with each export request.
For HTTP: sent as HTTP headers. For gRPC: sent as metadata entries
(keys must be lowercase ASCII, e.g. use authorization not Authorization).
Values support secret replacement syntax (e.g., ${secrets:api_key}).
Aggregation temporality preference for the OTEL metrics push exporter.
Controls how counter and histogram values are encoded on the wire:
Delta(default): each export contains the change since the previous export. Required by Datadog's OTLP intake and recommended by AWSCloudWatch, New Relic, and most push-basedSaaSbackends. Aligns with theOpenTelemetryguidance for push exporters.Cumulative: each export carries the running total since process start. Use this forOTelcollectors that downstream into Prometheus or other pull-based / cumulative-native backends.LowMemory: counters use cumulative, histograms use delta. Reduces the SDK's in-process state for histogram-heavy workloads.
This setting only affects the OTLP push exporter; the runtime's Prometheus scrape endpoint always exposes cumulative metrics regardless of this value.
Aggregation temporality preference for the OTEL metrics push exporter.
Controls how counter and histogram values are encoded on the wire:
Delta(default): each export contains the change since the previous export. Required by Datadog's OTLP intake and recommended by AWSCloudWatch, New Relic, and most push-basedSaaSbackends. Aligns with theOpenTelemetryguidance for push exporters.Cumulative: each export carries the running total since process start. Use this forOTelcollectors that downstream into Prometheus or other pull-based / cumulative-native backends.LowMemory: counters use cumulative, histograms use delta. Reduces the SDK's in-process state for histogram-heavy workloads.
This setting only affects the OTLP push exporter; the runtime's Prometheus scrape endpoint always exposes cumulative metrics regardless of this value.
API key for authentication. Keys can be read-only or read-write. The key value is redacted in Debug output to prevent credential leakage.
All comparisons (both ApiKey to ApiKey and ApiKey to &str) use
constant-time comparison via the subtle crate to prevent timing attacks.
[
"*"
]Whether to enable rate limiting on Flight DoPut (write) requests.
Defaults to true. Set to false to disable write rate limiting for bulk ingest workloads.
Controls when the runtime readiness probe reports the runtime as ready.
Specifies the runtime memory limit. When configured, will spill to disk for supported queries larger than memory.
Configures where the runtime will store temporary files needed for operations like spilling to disk for queries & accelerations that are larger than memory.
Specifies the compression codec used when spilling data to disk.
Root URI for shared cluster state.
Optional object store params for the shared cluster state.
Partition management configuration
Datasets accelerated using a file-mode acceleration
engine (i.e. Sqlite or DuckDB) can bootstrap from a DB
file on object storage (i.e. S3) if the acceleration file
does not exist on startup using this configuration.
Each dataset needs to opt-in for snapshots in addition to this config.
Global enable/disable for dataset snapshots.
The object store location pointing to a folder
containing the dataset snapshots.
i.e. s3://my-bucket/spice/snapshots/
Auth params for accessing the object store location.
For S3, this is the same as the S3 dataset connector params
with the notable exception that s3_auth is set to iam_role by default.
The secrets configuration for a Spicepod.
Example:
secrets:
- from: env
name: env
- from: kubernetes:my_secret_name
name: k8s
A catalog definition. The params field is validated based on the catalog connector type specified in 'from'.
A dataset definition. The params field is validated based on the connector type specified in 'from'.
Optional semantic details about the column
Configuration for if and how a dataset's column should be embedded.
Different to [crate::component::embeddings::ColumnEmbeddingConfig],
as [ColumnLevelEmbeddingConfig] should be a property of [Column],
not [super::Dataset].
[crate::component::embeddings::ColumnEmbeddingConfig] will be
deprecated long term in favour of [ColumnLevelEmbeddingConfig].
Aggregation strategy for multi-vector embeddings. Only meaningful
when the underlying column is list-typed. Defaults to max.
Maximum number of list elements embedded per row for multi-vector
columns. Defaults to 32; hard-capped at 1024.
Aggregation strategy applied when a multi-vector (list-typed) column is queried. Each list element produces its own embedding; at query time the per-element similarities are combined into a single per-row score using this aggregation.
Max is the ColBERT-style MaxSim default — a row scores as high as
its best-matching element.
Configuration parameters for the acceleration engine. The available parameters depend on the engine type specified in 'engine' (default: arrow). Available engines: arrow, cayenne, duckdb, postgres, sqlite, turso.
Behavior when a query on an accelerated table returns zero results.
Partition expressions used to physically partition accelerated data.
Each item accepts either:
- a plain expression string, for example
"YEAR(created_at)"or"bucket(100, user_id)"; or - a single-entry mapping of a partition name to an expression, for
example
{ year: "YEAR(created_at)" }.
Behavior when a query on an accelerated table returns zero results.
Controls when the dataset is marked ready for queries.
Configuration for if and how a dataset's column should be embedded.
Prefer to use [super::dataset::column::ColumnLevelEmbeddingConfig] going
forward. Support for [ColumnEmbeddingConfig] will be removed in future.
Aggregation strategy for multi-vector embeddings. Only meaningful
when the underlying column is list-typed (List<Utf8> /
LargeList<Utf8>). Defaults to max (ColBERT-style MaxSim).
Maximum number of list elements embedded per row for multi-vector
columns. Defaults to 32; hard-capped at 1024. Excess elements
are dropped with a warning log.
This is deprecated, use unsupported_type_action instead.
Partition expressions used to organize vector data.
Each item accepts either:
- a plain expression string, for example
"YEAR(created_at)"or"bucket(100, user_id)"; or - a single-entry mapping of a partition name to an expression, for
example
{ year: "YEAR(created_at)" }.
Controls whether the federated table periodically has its availability checked.
Inline SQL that describes a view.
Reference to a SQL file that describes a view.
Controls when the dataset is marked ready for queries.
A model definition. The params field is validated based on the model source type specified in 'from'.
Should use [Self::file_type] to access.
Azure Storage account name.
Azure Storage container name.
Azure Storage account access key.
Bearer token to use in Azure requests.
Azure client ID.
Azure client secret.
Azure tenant ID.
Azure SAS string.
Azure Storage endpoint.
Use the Azure Storage emulator.
Use the Azure Storage fabric endpoint.
Allow insecure HTTP connections.
Sets an alternative authority host.
The maximum number of retries.
Retry timeout.
Initial backoff duration.
Maximum backoff duration.
The base of the exponential to use
Proxy URL to use when connecting
CA certificate for the proxy.
Set list of hosts to exclude from proxy connections
Sets the endpoint for acquiring managed identity tokens.
Sets a file path for acquiring Azure federated identity token in Kubernetes
Set if the Azure CLI should be used for acquiring access tokens.
Skip fetching credentials and skip signing requests. Used for interacting with public containers.
Ignore any tags provided to put_opts
The timeout setting for Azure client.
Enables Azure blob versioning support when set to 'enabled'. Defaults to 'disabled'.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
Azure Storage account name.
Azure Storage container name.
Azure Storage account access key.
Bearer token to use in Azure requests.
Azure client ID.
Azure client secret.
Azure tenant ID.
Azure SAS string.
Azure Storage endpoint.
Use the Azure Storage emulator.
Use the Azure Storage fabric endpoint.
Allow insecure HTTP connections.
Sets an alternative authority host.
The maximum number of retries.
Retry timeout.
Initial backoff duration.
Maximum backoff duration.
The base of the exponential to use
Proxy URL to use when connecting
CA certificate for the proxy.
Set list of hosts to exclude from proxy connections
Sets the endpoint for acquiring managed identity tokens.
Sets a file path for acquiring Azure federated identity token in Kubernetes
Set if the Azure CLI should be used for acquiring access tokens.
Skip fetching credentials and skip signing requests. Used for interacting with public containers.
Ignore any tags provided to put_opts
The timeout setting for Azure client.
Enables Azure blob versioning support when set to 'enabled'. Defaults to 'disabled'.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
The message broker transport to use. The default is kafka.
The message format to use. The default is json.
A list of host/port pairs for establishing the initial Kafka cluster connection.
Security protocol for Kafka connections. Default: 'sasl_ssl'. Options: 'plaintext', 'ssl', 'sasl_plaintext', 'sasl_ssl'.
SASL authentication mechanism. Default: 'SCRAM-SHA-512'. Options: 'PLAIN', 'SCRAM-SHA-256', 'SCRAM-SHA-512'.
SASL username.
SASL password.
Path to the SSL/TLS CA certificate file for server verification.
Enable SSL/TLS certificate verification. Default: 'true'.
SSL/TLS endpoint identification algorithm. Default: 'https'. Options: 'none', 'https'.
Kafka consumer group id to use for this dataset. If not set, a unique id will be generated.
Maximum number of change events to batch together before processing
Maximum time to wait for a batch to fill before processing
The AWS region to use for DynamoDB.
The AWS access key ID to use for DynamoDB.
The AWS secret access key to use for DynamoDB.
The AWS session token to use for DynamoDB.
Authentication method. Use 'iam_role' for IAM role-based authentication or 'key' for explicit access key credentials
IAM role credential source (only used when aws_auth is 'iam_role'). 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables
Maximum nesting depth for unnesting embedded documents into a flattened structure. Higher values expand deeper nested fields.
Number of documents to use to infer the schema. Defaults to 10.
Number of segments. 'auto' by default.
Interval in milliseconds between polling for new records in a DynamoDB stream.
Go-style time format used for parsing/formatting timestamps
When using Streams, once tables reaches this lag, it will be reported as Ready
Custom endpoint URL for DynamoDB-compatible services (e.g., DynamoDB Local, ScyllaDB Alternator).
Behavior when stream lag exceeds shard retention (24h). 'error' marks dataset as Error, 'ready_before_load' marks Ready then re-bootstraps, 'ready_after_load' re-bootstraps then marks Ready
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
Path to a GCS service account JSON key file.
GCS service account JSON key as a string.
Use Google Application Default Credentials for authentication. If GOOGLE_APPLICATION_CREDENTIALS env var is set, uses that path.
Allow insecure HTTP connections.
The maximum number of retries.
Retry timeout.
Initial backoff duration.
Maximum backoff duration.
The base of the exponential to use
Skip signing requests. Used for public buckets.
The timeout setting for GCS client.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
Include only files matching the glob pattern. Multiple patterns can be separated by comma or semicolon.
Whether to fetch file content. Set to 'true' to include file content in the 'content' column.
Custom path for the local Git repository cache. If not specified, uses system temp directory.
Maximum number of files to materialize from a Git repository. Default: 5000. Hard limit: 50000.
Maximum size (bytes) for an individual file when fetching content. Files larger than this value are skipped. Default: 524288. Maximum: 5242880 (5 MiB).
Username for HTTP(S) basic authentication.
Password or personal access token for HTTP(S) basic authentication.
Personal access token used for HTTP(S) authentication. Equivalent to providing a username of 'x-access-token' with the token as the password.
Absolute path to an SSH private key used to authenticate to the remote repository.
Passphrase for the SSH private key identified by 'ssh_key'.
When 'true', attempt to authenticate via the running ssh-agent when no explicit ssh_key is provided. Defaults to 'true'.
Whether to fetch git-lfs objects after clone/fetch. Requires the 'git-lfs' CLI to be available on PATH.
Maximum number of concurrent Git network operations (clone/fetch) across datasets that share the same repository URL.
Maximum number of retries when the connector encounters a transient error cloning or fetching from the remote.
Backoff strategy for retries on transient errors.
When true, a permanent error (authentication failure, access denied) will disable the connector to prevent a thundering herd of failed requests.
DEPRECATED: Rename 'git_include' to 'include'.
[deprecated] Use unprefixed 'include'.
DEPRECATED: Rename 'git_fetch_content' to 'fetch_content'.
[deprecated] Use unprefixed 'fetch_content'.
DEPRECATED: Rename 'git_cache_path' to 'cache_path'.
[deprecated] Use unprefixed 'cache_path'.
DEPRECATED: Rename 'git_max_files' to 'max_files'.
[deprecated] Use unprefixed 'max_files'.
DEPRECATED: Rename 'git_max_file_bytes' to 'max_file_bytes'.
[deprecated] Use unprefixed 'max_file_bytes'.
DEPRECATED: Rename 'git_enable_lfs' to 'enable_lfs'.
[deprecated] Use unprefixed 'enable_lfs'.
A Github token.
The Github App Client ID.
The Github App private key.
The Github App installation ID.
Specify what search mode (REST, GraphQL, Search API) to use when retrieving results.
The Github API endpoint.
Specifies the types of comments to fetch: 'all', 'review', 'discussion', or 'none'.
Maximum number of comments to fetch per discussion or review thread.
Whether to fetch commit information (created_at, updated_at) for files. Set to 'true' to enable.
Whether to download and include workflow run logs. Set to 'enabled' to download logs for each workflow run. Defaults to 'disabled'.
Include only files matching the pattern.
Controls S3 URL addressing style. Supported values: 'vhost' and 'path'. When not set, auto-detected from the endpoint.
Configures the authentication method for S3. Supported methods are: public (i.e. no auth), iam_role, key.
IAM role credential source (used when auth is 'iam_role' or unset, i.e. default IAM-based auth). 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables.
Enables S3 object versioning support when set to 'enabled'. Defaults to 'enabled'.
The timeout setting for S3 client.
Allow HTTP protocol for S3 endpoint.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
Path to a GCS service account JSON key file.
GCS service account JSON key as a string.
Use Google Application Default Credentials for authentication. If GOOGLE_APPLICATION_CREDENTIALS env var is set, uses that path.
Allow insecure HTTP connections.
The maximum number of retries.
Retry timeout.
Initial backoff duration.
Maximum backoff duration.
The base of the exponential to use
Skip signing requests. Used for public buckets.
The timeout setting for GCS client.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
The port to connect to.
The timeout setting for HTTP(S) client requests (in seconds). Default: 30
The timeout for establishing HTTP(S) connections (in seconds). Default: 10
Maximum number of idle connections to keep alive per host. Default: 10
Timeout for idle connections in the pool (in seconds). Default: 90
Custom HTTP headers to include in requests. Format: 'Header1: Value1, Header2: Value2'. Headers are applied to all requests.
Maximum number of retries for HTTP requests. Default: 3
Retry backoff method: 'fibonacci' (default), 'linear', or 'exponential'.
Maximum total duration for all retries (e.g., '30s', '5m'). If not set, retries will continue up to max_retries.
Randomization factor for retry delays (0.0 to 1.0). Default: 0.3 (30% randomization). Set to 0 for no jitter.
Comma-separated list of request_path values that users are allowed to query. Required to enable request_path filters.
Set to 'enabled' or 'disabled' to control whether request_query filters can be pushed down to HTTP requests.
Maximum length (in characters) for request_query filter values. Default: 1024.
Set to 'enabled' or 'disabled' to control whether request_body filters can be pushed down as HTTP request bodies.
Maximum size (in bytes) for request_body filter values. Default: 16384 (16KiB).
Custom health probe path for endpoint validation (e.g., '/health', '/api/status'). The endpoint must return a 2xx status code to pass validation. If not set, a random path is used and any status (including 404) is accepted.
Pagination mode. 'auto' (default): auto-detects Link headers. 'enabled': explicitly enable with config. 'disabled': no pagination.
JSON pointer (RFC 6901) to the next page URL or cursor in the response body (e.g., '/next', '/pagination/cursor', '/links/next').
Whether to follow HTTP Link headers with rel="next" for pagination. Default: 'enabled' (auto-detected). Set to 'disabled' to ignore Link headers.
When set, the value from 'pagination_next_pointer' is treated as a cursor/token and passed as this query parameter name in subsequent requests. When not set, the value is treated as a full URL.
JSON pointer (RFC 6901) to the data array in each page's response (e.g., '/data', '/results', '/items'). When set, only the array at this path is returned as data rows.
Maximum number of pages to fetch for pagination. Default: 100.
When 'enabled', if the data at pagination_data_pointer (or the top-level response) is a JSON object/map, extract its values as rows instead of treating it as a single row. Default: 'disabled'.
Query parameter template for client-driven pagination. Supports {offset}, {limit}, and {page} variables. Example: 'offset={offset}&limit={limit}'. Requires pagination_page_size.
Number of items per page for query-parameter pagination. Must be a positive integer greater than 0. Used to expand {limit} in pagination_query_params and to detect the last page (fewer results than page_size = done).
OAuth2 token endpoint URL. When set together with http_auth_refresh_token, the connector exchanges the refresh token for short-lived access tokens (RFC 6749 §6) and attaches 'Authorization: Bearer
OAuth2 refresh token exchanged against auth_token_url to obtain access tokens. Required when auth_token_url is set.
OAuth2 client_id presented to the token endpoint. Required for confidential clients; optional for public clients. Paired with http_auth_client_secret.
OAuth2 client_secret presented to the token endpoint. Required when the client is confidential; must be set together with http_auth_client_id.
Space-separated OAuth2 scopes to request when refreshing. Omit to inherit the scopes bound to the refresh token. Optional.
How client credentials are sent to the token endpoint: 'basic' (HTTP Basic header, default per RFC 6749 §2.3.1) or 'body' (client_id/client_secret in the form body). Case-insensitive.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
The port to connect to.
The timeout setting for HTTP(S) client requests (in seconds). Default: 30
The timeout for establishing HTTP(S) connections (in seconds). Default: 10
Maximum number of idle connections to keep alive per host. Default: 10
Timeout for idle connections in the pool (in seconds). Default: 90
Custom HTTP headers to include in requests. Format: 'Header1: Value1, Header2: Value2'. Headers are applied to all requests.
Maximum number of retries for HTTP requests. Default: 3
Retry backoff method: 'fibonacci' (default), 'linear', or 'exponential'.
Maximum total duration for all retries (e.g., '30s', '5m'). If not set, retries will continue up to max_retries.
Randomization factor for retry delays (0.0 to 1.0). Default: 0.3 (30% randomization). Set to 0 for no jitter.
Comma-separated list of request_path values that users are allowed to query. Required to enable request_path filters.
Set to 'enabled' or 'disabled' to control whether request_query filters can be pushed down to HTTP requests.
Maximum length (in characters) for request_query filter values. Default: 1024.
Set to 'enabled' or 'disabled' to control whether request_body filters can be pushed down as HTTP request bodies.
Maximum size (in bytes) for request_body filter values. Default: 16384 (16KiB).
Custom health probe path for endpoint validation (e.g., '/health', '/api/status'). The endpoint must return a 2xx status code to pass validation. If not set, a random path is used and any status (including 404) is accepted.
Pagination mode. 'auto' (default): auto-detects Link headers. 'enabled': explicitly enable with config. 'disabled': no pagination.
JSON pointer (RFC 6901) to the next page URL or cursor in the response body (e.g., '/next', '/pagination/cursor', '/links/next').
Whether to follow HTTP Link headers with rel="next" for pagination. Default: 'enabled' (auto-detected). Set to 'disabled' to ignore Link headers.
When set, the value from 'pagination_next_pointer' is treated as a cursor/token and passed as this query parameter name in subsequent requests. When not set, the value is treated as a full URL.
JSON pointer (RFC 6901) to the data array in each page's response (e.g., '/data', '/results', '/items'). When set, only the array at this path is returned as data rows.
Maximum number of pages to fetch for pagination. Default: 100.
When 'enabled', if the data at pagination_data_pointer (or the top-level response) is a JSON object/map, extract its values as rows instead of treating it as a single row. Default: 'disabled'.
Query parameter template for client-driven pagination. Supports {offset}, {limit}, and {page} variables. Example: 'offset={offset}&limit={limit}'. Requires pagination_page_size.
Number of items per page for query-parameter pagination. Must be a positive integer greater than 0. Used to expand {limit} in pagination_query_params and to detect the last page (fewer results than page_size = done).
OAuth2 token endpoint URL. When set together with http_auth_refresh_token, the connector exchanges the refresh token for short-lived access tokens (RFC 6749 §6) and attaches 'Authorization: Bearer
OAuth2 refresh token exchanged against auth_token_url to obtain access tokens. Required when auth_token_url is set.
OAuth2 client_id presented to the token endpoint. Required for confidential clients; optional for public clients. Paired with http_auth_client_secret.
OAuth2 client_secret presented to the token endpoint. Required when the client is confidential; must be set together with http_auth_client_id.
Space-separated OAuth2 scopes to request when refreshing. Omit to inherit the scopes bound to the refresh token. Optional.
How client credentials are sent to the token endpoint: 'basic' (HTTP Basic header, default per RFC 6749 §2.3.1) or 'body' (client_id/client_secret in the form body). Case-insensitive.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
The path including scheme to the metadata file for the Hadoop table. Must specify a path to a .json file. For example, s3a://my-bucket/warehouse/namespace/table/metadata/v1.metadata.json
Bearer token value to use for Authorization header.
Credential to use for OAuth2 client credential flow when initializing the catalog. Separated by a colon as <client_id>:<client_secret>.
The URL to use for OAuth2 token endpoint.
The scope to use for OAuth2 token endpoint (default: catalog).
URL of the OAuth2 server tokens endpoint.
Enable SigV4 authentication for the catalog (for connecting to AWS Glue).
The region to use when signing the request for SigV4. Defaults to the region in the catalog URL if available.
The name to use when signing the request for SigV4.
Name of the Iceberg warehouse.
Configure an alternative endpoint for the S3 service. This can be any s3-compatible object storage service. i.e. Minio, Cloudflare R2, etc.
The AWS access key ID to use for S3 storage.
The AWS secret access key to use for S3 storage.
Configure the static session token used for S3 storage.
IAM role credential source. 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables.
The AWS S3 region to use.
An optional identifier for the assumed role session for auditing purposes.
The Amazon Resource Name (ARN) of the role to assume. If provided instead of s3_access_key_id and s3_secret_access_key, temporary credentials will be fetched by assuming this role
Configure socket connection timeout, in seconds (default: 60).
The Google Cloud project ID for GCS storage.
Base64-encoded Google Cloud service account credentials JSON for GCS storage.
OAuth2 token to use for GCS authentication.
Custom endpoint URL for GCS (for emulators or custom endpoints).
Set to 'true' to allow anonymous access to GCS (for public buckets).
A list of host/port pairs for establishing the initial Kafka cluster connection.
Security protocol for Kafka connections. Default: 'sasl_ssl'. Options: 'plaintext', 'ssl', 'sasl_plaintext', 'sasl_ssl'.
SASL authentication mechanism. Default: 'SCRAM-SHA-512'. Options: 'PLAIN', 'SCRAM-SHA-256', 'SCRAM-SHA-512'.
SASL username.
SASL password.
Path to the SSL/TLS CA certificate file for server verification.
Enable SSL/TLS certificate verification. Default: 'true'.
SSL/TLS endpoint identification algorithm. Default: 'https'. Options: 'none', 'https'.
Number of Kafka messages to sample for schema inference. Default: '1'. Increase if your data has optional fields or varying structure.
Set true to flatten nested structs in JSON as separate columns.
Kafka consumer group id to use for this dataset. If not set, a unique id will be generated.
Maximum number of change events to batch together before processing
Maximum time to wait for a batch to fill before processing
Controls S3 URL addressing style. Supported values: 'vhost' and 'path'. When not set, auto-detected from the endpoint.
Configures the authentication method for S3. Supported methods are: public (i.e. no auth), iam_role, key.
IAM role credential source (used when auth is 'iam_role' or unset, i.e. default IAM-based auth). 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables.
Enables S3 object versioning support when set to 'enabled'. Defaults to 'enabled'.
The timeout setting for S3 client.
Allow HTTP protocol for S3 endpoint.
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
Set true to indicate that the first line is a header.
The quote character in a row.
The escape character in a row.
DEPRECATED: use 'schema_infer_max_records' instead
Set a limit in terms of records to scan to infer the schema.
The character separating values within a row.
The type of compression used on the file. Supported types are: GZIP, BZIP2, XZ, ZSTD, UNCOMPRESSED
Enable partitioning using hive-style partitioning from the folder structure. Defaults to false.
Specify a path to use for schema inference.
json | jsonl | ndjson | ldjson | array | object | soda | socrata | auto. When 'file_format' is explicitly 'json', effective default is 'json' (no SODA auto-detection).
An RFC 6901 JSON Pointer to extract data from within a JSON value. E.g. '/data' for {"data": [...]} or '/response/items' for nested objects. A leading '/' is added automatically if missing.
Alias for 'json_pointer'. An RFC 6901 JSON Pointer to extract data from within a JSON value.
Set true to flatten nested structs in JSON as separate columns.
Set to 'enabled' to include Socrata internal metadata columns (sid, id, position, etc.) in the schema for SODA format responses. Defaults to disabled.
Control skipping refreshes for single-file S3 datasets when cached ETag/Version metadata matches. Set to 'enabled' (default) or 'disabled'.
Enable hash index for fast primary key lookups. Set to 'enabled' to enable (requires primary_key). Default: disabled.
Comma-separated list of columns to sort data by during inserts (e.g., 'timestamp,user_id').
AWS region for S3 Express One Zone storage. If not specified, derived from cayenne_s3_zone_ids.
Custom S3 endpoint URL for S3 Express One Zone.
AWS access key ID for S3 authentication.
AWS secret access key for S3 authentication.
AWS session token for temporary credentials (optional).
Authentication method for S3 Express One Zone. Options: 'iam_role' (default, uses environment credentials), 'key' (uses explicit cayenne_s3_key/cayenne_s3_secret).
Timeout for S3 client operations (e.g., '30s', '5m'). Default: 120s.
Allow HTTP (non-TLS) connections to S3. Default: false.
Use unsigned payload for S3 Express One Zone requests. Only applies when S3 Express mode is enabled (via cayenne_s3_zone_ids or directory bucket path). Skips SHA-256 computation for request body, improving upload performance. S3 Express One Zone uses session-based auth, making payload signing unnecessary. Default: true.
Comma-separated list of Availability Zone IDs for S3 Express One Zone storage (e.g., 'usw2-az1' or 'usw2-az1,usw2-az2'). When specified without 'cayenne_file_path', auto-generates bucket name from app and dataset name, and creates the bucket if needed. For multi-zone redundancy, specify multiple zones. Data is written to all zones with ACID guarantees - writes succeed only if all zones succeed. Reads are served from the primary (first) zone with fallback to replicas.
Path for storing Cayenne data files (Vortex files). Can be a local path or an S3 Express One Zone path. For S3 Express One Zone, use format: 's3://{bucket-name}--{zone-id}--x-s3/{prefix}/'. When S3 Express One Zone is specified, data files are stored exclusively in S3 while metadata (SQLite) remains on local disk.
Path for storing Cayenne metadata (SQLite catalog). If not specified, defaults to '{cayenne_file_path}/metadata'.
Metastore backend for Cayenne catalog. Options: 'sqlite' (default), 'turso' (requires 'turso' feature enabled at build time)
How to handle data types not natively supported by Cayenne (internally using Vortex format) (Time32, Time64, Duration, Interval, etc.). Options: 'string' (convert schema to Utf8, default - requires data source to provide string data), 'error' (fail on unsupported types), 'warn' (include in schema, may fail on insert), 'ignore' (skip unsupported fields)
Size of the in-memory Vortex footer cache in MB. Larger values improve query performance for repeated scans. Default: 128 MB
Size of the in-memory Vortex segment cache in MB. Set > 0 to cache decompressed data segments. Default: 256 MB
Target size for Vortex data files in MB. Default: 256 MB. Adjust as needed for S3 Express or remote upload scenarios.
Comma-separated list of columns to sort data by during inserts (e.g., 'timestamp,user_id').
Compression strategy to use for Vortex files. Options: 'btrblocks' (default), 'zstd'
Maximum number of concurrent file uploads when writing multiple Vortex files. Default: 4.
The maximum number of client connections created in the duckdb connection pool.
The minimum number of connections to keep open in the pool, lazily created when requested.
The maximum number of connections created in the connection pool.
Path to the Turso database file. If not specified, defaults to {spice_data_dir}/{dataset_name}.turso
Internal timestamp storage format: 'rfc3339' (default, preserves precision/timezone) or 'integer_millis' (performance, millisecond precision only)
Bearer token value to use for Authorization header.
Credential to use for OAuth2 client credential flow when initializing the catalog. Separated by a colon as <client_id>:<client_secret>.
The URL to use for OAuth2 token endpoint.
The scope to use for OAuth2 token endpoint (default: catalog).
URL of the OAuth2 server tokens endpoint.
Enable SigV4 authentication for the catalog (for connecting to AWS Glue).
The region to use when signing the request for SigV4. Defaults to the region in the catalog URL if available.
The name to use when signing the request for SigV4.
Name of the Iceberg warehouse.
Configure an alternative endpoint for the S3 service. This can be any s3-compatible object storage service. i.e. Minio, Cloudflare R2, etc.
The AWS access key ID to use for S3 storage.
The AWS secret access key to use for S3 storage.
Configure the static session token used for S3 storage.
IAM role credential source. 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables.
The AWS S3 region to use.
An optional identifier for the assumed role session for auditing purposes.
The Amazon Resource Name (ARN) of the role to assume. If provided instead of s3_access_key_id and s3_secret_access_key, temporary credentials will be fetched by assuming this role
Configure socket connection timeout, in seconds (default: 60).
The Google Cloud project ID for GCS storage.
Base64-encoded Google Cloud service account credentials JSON for GCS storage.
OAuth2 token to use for GCS authentication.
Custom endpoint URL for GCS (for emulators or custom endpoints).
Set to 'true' to allow anonymous access to GCS (for public buckets).
The personal access token used to authenticate against the Unity Catalog API.
The AWS region to use for S3 storage.
The AWS access key ID to use for S3 storage.
The AWS secret access key to use for S3 storage.
The AWS endpoint to use for S3 storage.
The storage account to use for Azure storage.
The storage account key to use for Azure storage.
The service principal client id for accessing the storage account.
The service principal client secret for accessing the storage account.
The shared access signature key for accessing the storage account.
The endpoint for the Azure Blob storage account.
Filesystem path to the Google service account JSON key file.
The endpoint of the Databricks instance.
The personal access token used to authenticate against the DataBricks API.
The execution mode for querying against Databricks.
The timeout setting for object store client.
The ID of the compute cluster in Databricks to use for the query. Only valid when mode is spark_connect.
Use a TLS connection to connect to the Databricks Spark Connect endpoint.
The SQL Warehouse ID to use when 'mode' is set to 'sql_warehouse'
Maximum number of concurrent HTTP requests to the SQL Warehouse API.
Maximum number of HTTP-level retries for transient failures (429, 5xx).
Backoff strategy for transient HTTP retries.
Maximum number of poll retries when waiting for async statement completion.
When true, non-retryable errors (401, 403, 404) permanently disable the connector to prevent a thundering herd of failed requests.
The client ID of the Databricks service principal.
The client secret of the Databricks service principal.
The AWS region to use for S3 storage.
The AWS access key ID to use for S3 storage.
The AWS secret access key to use for S3 storage.
The AWS endpoint to use for S3 storage.
The storage account to use for Azure storage.
The storage account key to use for Azure storage.
The service principal client id for accessing the storage account.
The service principal client secret for accessing the storage account.
The shared access signature key for accessing the storage account.
The endpoint for the Azure Blob storage account.
Filesystem path to the Google service account JSON key file.
The OpenAI API base endpoint. Can be overridden to use a compatible provider (i.e. Nvidia NIM).
The OpenAI API key.
The OpenAI organization ID.
The OpenAI project ID.
The current usage tier for the OpenAI account associated with the API key: 'free', 'tier1', 'tier2', 'tier3', 'tier4', or 'tier5'.
Whether to enable use of this model via the Responses API. disabled by default.
The OpenAI Responses tools to use when calling the model from the Responses API
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: Use 'frequency_penalty' without prefix
DEPRECATED: Use 'logit_bias' without prefix
DEPRECATED: Use 'logprobs' without prefix
DEPRECATED: Use 'top_logprobs' without prefix
DEPRECATED: Use 'max_completion_tokens' without prefix
DEPRECATED: Use 'reasoning_effort' without prefix
DEPRECATED: Use 'store' without prefix
DEPRECATED: Use 'metadata' without prefix
DEPRECATED: Use 'n' without prefix
DEPRECATED: Use 'presence_penalty' without prefix
DEPRECATED: Use 'response_format' without prefix
DEPRECATED: Use 'seed' without prefix
DEPRECATED: Use 'stop' without prefix
DEPRECATED: Use 'stream' without prefix
DEPRECATED: Use 'stream_options' without prefix
DEPRECATED: Use 'temperature' without prefix
DEPRECATED: Use 'top_p' without prefix
DEPRECATED: Use 'tools' without prefix
DEPRECATED: Use 'tool_choice' without prefix
DEPRECATED: Use 'parallel_tool_calls' without prefix
DEPRECATED: Use 'user' without prefix
The Azure OpenAI resource endpoint, e.g., https://resource-name.openai.azure.com.
The API version used for the Azure OpenAI service.
The name of the model deployment.
The Azure OpenAI API key from the models deployment page.
The Azure Entra token for authentication.
Comma-separated list of OpenAI-hosted tools exposed via the Responses API for this model.
Whether to enable use of this model via the Responses API. disabled by default.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
Customizes the transformation of OpenAI chat messages into a character stream for the model.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The Databricks workspace endpoint, e.g., dbc-a12cd3e4-56f7.cloud.databricks.com.
The Databricks API token to authenticate with the Databricks Models API.
The Databricks Service Principal Client ID. Can't be used with databricks_token.
The Databricks Service Principal Client Secret. Can't be used with databricks_token.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The architecture to load the model as. Supported values: mistral, gemma, mixtral, llama, phi2, phi3, qwen2, gemma2, starcoder2, phi3.5moe, deepseekv2, deepseekv3
Customizes the transformation of OpenAI chat messages into a character stream for the model.
The Huggingface access token.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The Anthropic API base endpoint.
The Anthropic API key.
The Anthropic Auth Token.
Anthropic usage tier (1-4). Used for rate limit defaults.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The xAI API key.
xAI usage tier (0-4). Used for rate limit defaults.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The AWS access key ID to use for Bedrock models
The AWS secret access key to use for Bedrock models
The AWS session token to use for Bedrock models.
The AWS region to use for Bedrock models.
IAM role credential source. 'auto' uses the default AWS credential chain, 'metadata' uses only instance/container metadata (IMDS, ECS, EKS/IRSA), 'env' uses only environment variables.
Identifier for the guardrail. Pattern: (([a-z0-9]+) | (arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+)). Length: 0-2048.
Guardrail version. Pattern: (([1-9][0-9]{0,7})|(DRAFT))
Trace behavior for the guardrail. Valid values: enabled, disabled, enabled_full
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
The Google Generative AI API key.
Which tools should be made available to the model. Set to 'auto' to use all available tools.
An additional system prompt used for all chat completions to this model.
Maximum number of concurrent requests for this model. Overrides provider defaults.
Maximum requests per minute for this model. Overrides provider defaults.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
DEPRECATED: The openai_<param> language model overrides parameter is deprecated and will be removed in a future release. Please use <model_prefix>_<param> parameter name instead.
Data source path for abfs connector. Format: abfs:
Connection parameters for the abfs data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for abfss connector. Format: abfss:
Connection parameters for the abfss data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for debezium connector. Format: debezium:
Connection parameters for the debezium data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for dynamodb connector. Format: dynamodb:
Connection parameters for the dynamodb data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for file connector. Format: file:
Connection parameters for the file data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for gcs connector. Format: gcs:
Connection parameters for the gcs data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for git connector. Format: git:
Connection parameters for the git data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for github connector. Format: github:
Connection parameters for the github data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for glue connector. Format: glue:
Connection parameters for the glue data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for gs connector. Format: gs:
Connection parameters for the gs data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for http connector. Format: http:
Connection parameters for the http data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for https connector. Format: https:
Connection parameters for the https data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for iceberg connector. Format: iceberg:
Connection parameters for the iceberg data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for kafka connector. Format: kafka:
Connection parameters for the kafka data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for localpod connector. Format: localpod:
Connection parameters for the localpod data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for memory connector. Format: memory:
Connection parameters for the memory data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for s3 connector. Format: s3:
Connection parameters for the s3 data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for sink connector. Format: sink:
Connection parameters for the sink data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Data source path for spice.ai connector. Format: spice.ai:
Connection parameters for the spice.ai data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with arrow acceleration engine.
2 nested properties
Configuration parameters for the arrow acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with cayenne acceleration engine.
2 nested properties
Configuration parameters for the cayenne acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with duckdb acceleration engine.
2 nested properties
Configuration parameters for the duckdb acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with postgres acceleration engine.
2 nested properties
Configuration parameters for the postgres acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with sqlite acceleration engine.
2 nested properties
Configuration parameters for the sqlite acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Dataset with turso acceleration engine.
2 nested properties
Configuration parameters for the turso acceleration engine.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Catalog source for iceberg connector. Format: iceberg:<catalog_path>
Connection parameters for the iceberg catalog connector.
Catalog source for spice.ai connector. Format: spice.ai:<catalog_path>
Connection parameters for the spice.ai catalog connector.
Catalog source for unity_catalog connector. Format: unity_catalog:<catalog_path>
Connection parameters for the unity_catalog catalog connector.
Catalog source for databricks connector. Format: databricks:<catalog_path>
Connection parameters for the databricks catalog connector.
Model source for openai provider. Format: openai:<model_id>
Configuration parameters for the openai model provider.
Model source for azure provider. Format: azure:<model_id>
Configuration parameters for the azure model provider.
Model source for file provider. Format: file:<model_id>
Configuration parameters for the file model provider.
Model source for databricks provider. Format: databricks:<model_id>
Configuration parameters for the databricks model provider.
Model source for huggingface provider. Format: huggingface:<model_id>
Configuration parameters for the huggingface model provider.
Model source for anthropic provider. Format: anthropic:<model_id>
Configuration parameters for the anthropic model provider.
Model source for xai provider. Format: xai:<model_id>
Configuration parameters for the xai model provider.
Model source for bedrock provider. Format: bedrock:<model_id>
Configuration parameters for the bedrock model provider.
Model source for google provider. Format: google:<model_id>
Configuration parameters for the google model provider.
Generic dataset for custom or unknown connectors.
Connection parameters for the data connector.
Controls when the dataset is marked ready for queries.
Controls whether the federated table periodically has its availability checked.
Generic catalog for custom or unknown connectors.
Generic model for custom or unknown model sources.
Configuration parameters for the model provider.